"Set defaults for the pip-compile command to run it under Bazel"

import os

import sys

from shutil import copyfile

from piptools.scripts.compile import cli

def _select_golden_requirements_file(

requirements_txt, requirements_linux, requirements_darwin, requirements_windows

):

"""Switch the golden requirements file, used to validate if updates are needed,

to a specified platform specific one. Fallback on the platform independent one.

"""

plat = sys.platform

if plat == "linux" and requirements_linux is not None:

return requirements_linux

elif plat == "darwin" and requirements_darwin is not None:

return requirements_darwin

elif plat == "win32" and requirements_windows is not None:

return requirements_windows

else:

return requirements_txt

if __name__ == "__main__":

if len(sys.argv) < 4:

print(

"Expected at least two arguments: requirements_in requirements_out",

file=sys.stderr,

)

sys.exit(1)

parse_str_none = lambda s: None if s == "None" else s

requirements_in = os.path.relpath(sys.argv.pop(1))

requirements_txt = os.path.relpath(sys.argv.pop(1))

requirements_linux = parse_str_none(sys.argv.pop(1))

requirements_darwin = parse_str_none(sys.argv.pop(1))

requirements_windows = parse_str_none(sys.argv.pop(1))

parts = requirements_in.split(os.path.sep, 2)

if parts[0] == "external":

requirements_in = parts[2]

requirements_txt = requirements_txt if "BUILD_WORKSPACE_DIRECTORY" in os.environ else os.path.join("..", "..", requirements_txt)

os.chdir(os.path.join(parts[0], parts[1]))

update_target_label = sys.argv.pop(1)

# Before loading click, set the locale for its parser.

# If it leaks through to the system setting, it may fail:

# RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII

# as encoding for the environment. Consult https://click.palletsprojects.com/python3/ for

# mitigation steps.

os.environ["LC_ALL"] = "C.UTF-8"

os.environ["LANG"] = "C.UTF-8"

UPDATE = True

# Detect if we are running under `bazel test`

if "TEST_TMPDIR" in os.environ:

UPDATE = False

# pip-compile wants the cache files to be writeable, but if we point

# to the real user cache, Bazel sandboxing makes the file read-only

# and we fail.

# In theory this makes the test more hermetic as well.

sys.argv.append("--cache-dir")

sys.argv.append(os.environ["TEST_TMPDIR"])

# Make a copy for pip-compile to read and mutate

requirements_out = os.path.join(

os.environ["TEST_TMPDIR"], os.path.basename(requirements_txt) + ".out"

)

copyfile(requirements_txt, requirements_out)

elif "BUILD_WORKSPACE_DIRECTORY" in os.environ:

# This value, populated when running under `bazel run`, is a path to the

# "root of the workspace where the build was run."

# This matches up with the values passed in via the macro using the 'rootpath' Make variable,

# which for source files provides a path "relative to your workspace root."

#

# Changing to the WORKSPACE root avoids 'file not found' errors when the `.update` target is run

# from different directories within the WORKSPACE.

requirements_txt = os.path.join(os.environ["BUILD_WORKSPACE_DIRECTORY"], requirements_txt)

else:

err_msg = (

"Expected to find BUILD_WORKSPACE_DIRECTORY (running under `bazel run`) or "

"TEST_TMPDIR (running under `bazel test`) in environment."

)

print(

err_msg,

file=sys.stderr,

)

sys.exit(1)

update_command = os.getenv("CUSTOM_COMPILE_COMMAND") or "bazel run %s" % (

update_target_label,

)

os.environ["CUSTOM_COMPILE_COMMAND"] = update_command

os.environ["PIP_CONFIG_FILE"] = os.getenv("PIP_CONFIG_FILE") or os.devnull

sys.argv.append("--generate-hashes")

sys.argv.append("--output-file")

sys.argv.append(requirements_txt if UPDATE else requirements_out)

sys.argv.append(requirements_in)

if UPDATE:

print("Updating " + requirements_txt)

cli()

else:

# cli will exit(0) on success

try:

print("Checking " + requirements_txt)

cli()

print("cli() should exit", file=sys.stderr)

sys.exit(1)

except SystemExit as e:

if e.code == 2:

print(

"pip-compile exited with code 2. This means that pip-compile found "

"incompatible requirements or could not find a version that matches "

f"the install requirement in {requirements_in}.",

file=sys.stderr,

)

sys.exit(1)

elif e.code == 0:

golden_filename = _select_golden_requirements_file(

requirements_txt,

requirements_darwin,

requirements_linux,

requirements_windows,

)

golden = open(golden_filename).readlines()

out = open(requirements_out).readlines()

if golden != out:

import difflib

print("".join(difflib.unified_diff(golden, out)), file=sys.stderr)

print(

"Lock file out of date. Run '"

+ update_command

+ "' to update.",

file=sys.stderr,

)

sys.exit(1)

sys.exit(0)

else:

print(

f"pip-compile unexpectedly exited with code {e.code}.",

file=sys.stderr,

)

sys.exit(1)