blob: 4c20753dd202cce90979c27c40dde9f3b4c28386 [file] [log] [blame]
#!/usr/bin/env vpython3
# Copyright 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Can be used to point environment variable to hermetic Go toolset.
Usage (on linux and mac):
$ eval `./`
$ go version
Or it can be used to wrap a command:
$ ./ go version
# This script *must* be the entry point.
assert __name__ == '__main__'
import os
import pipes
import subprocess
import sys
# This should import ./
import bootstrap
# Make sure we picked up the correct bootstrap file.
want = os.path.realpath(os.path.abspath(
os.path.join(os.path.dirname(__file__), '')))
# Allow `bootstrap.__file__` to be a .py or .pyc file.
if os.path.abspath(bootstrap.__file__) not in (want, want + 'c'):
raise AssertionError(
'Imported wrong %s instead of %s' %
(bootstrap.__file__, want))
def _escape_special(v):
"""Returns (str): The supplied value, with special shell characters escaped.
Replace special characters with their escaped form. This will allow them
to be interpreted by the shell using the $'...' notation.
v (str): The input value to escape.
for f, r in (
('\n', '\\n'),
('\b', '\\b'),
('\r', '\\r'),
('\t', '\\t'),
('\v', '\\v')):
v = v.replace(f, r)
return v
if sys.platform == 'win32':
def emit_env_var(key, value):
# TODO: The quoting here is probably insufficient for all corner cases.
# We strip "'" because cmd.exe doesn't like it in PATH for some reason.
print('set %s=%s' % (key, pipes.quote(value).strip("'")))
def unset_env_var(key):
print('set %s=' % (key,))
def emit_env_var(key, value):
orig_value, value = value, _escape_special(value)
# We will only use the $'...' notation if there was an escaped character
# in the string.
print('export %s=%s%s;' % (key, ('$') if orig_value != value else
(''), pipes.quote(value)))
def unset_env_var(key):
print('unset %s;' % (key,))
def main():
args = sys.argv[1:]
if args and args[0] == '--':
old = os.environ.copy()
new = bootstrap.prepare_go_environ()
# If given args, it means is executed as a wrapper.
if args:
exe = args[0]
if exe == 'python':
exe = sys.executable
# Help Windows to find the executable in new PATH, do it only when
# executable is referenced by name (and not by path).
if os.sep not in exe:
exe = bootstrap.find_executable(exe, [bootstrap.WORKSPACE])
sys.exit([exe] + args[1:], env=new))
# If not given args, emit a shell script to modify environ.
for key, value in sorted(new.items()):
if old.get(key) != value:
emit_env_var(key, value)
for key in sorted(old):
if key not in new:
# VIRTUAL_ENV is added by the vpython wrapper. It usually *does not* exist
# in os.environ of the outer shell that executes eval `./`. Since we
# are about to replace the native python in PATH with virtualenv's one, we
# must also make sure the new environment has VIRTUAL_ENV set. Otherwise
# some virtualenv-aware tools (like gcloud) get confused.
# Note that once finishes execution, nothing is holding a lock on
# vpython virtualenv directory, and it may eventually be garbage collected
# (while the user is still inside a shell that references it). We assume it
# is rare, and the users can manually recover (by reexecuting This
# won't be happening on bots, since they don't use eval `./`.
if 'VIRTUAL_ENV' in old:
emit_env_var('VIRTUAL_ENV', old['VIRTUAL_ENV'])
# Warn for common misuse.
if sys.platform != 'win32' and sys.stdout.isatty():
print('# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
print('# eval `./`')
print('# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')