test(pip_parse): add integration tests for macros in requirements.bzl

.bazelrc

@@ -3,8 +3,8 @@
 # This lets us glob() up all the files inside the examples to make them inputs to tests
 # (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
 # To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
-build --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/py_proto_library,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
-query --deleted_packages=examples/build_file_generation,examples/build_file_generation/get_url,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/multi_python_versions,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/py_proto_library,examples/relative_requirements,tests/compile_pip_requirements,tests/pip_repository_entry_points,tests/pip_deps
+build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_parse,tests/pip_parse/aliases,tests/pip_parse/regular,tests/pip_repository_entry_points
+query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_parse,tests/pip_parse/aliases,tests/pip_parse/regular,tests/pip_repository_entry_points
 
 test --test_output=errors
 

python/pip_install/BUILD.bazel

@@ -1,6 +1,9 @@
 filegroup(
     name = "distribution",
-    srcs = glob(["*.bzl"]) + [
+    srcs = glob([
+        "*.bzl",
+        "*.bzl.tmpl",
+    ]) + [
         "BUILD.bazel",
         "//python/pip_install/private:distribution",
         "//python/pip_install/tools/dependency_resolver:distribution",

python/pip_install/pip_repository.bzl

@@ -379,11 +379,11 @@ def _pip_repository_bzlmod_impl(rctx):
     rctx.file("BUILD.bazel", build_contents)
     rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
         "%%ALL_REQUIREMENTS%%": _format_repr_list([
-            "@{}//{}".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:pkg".format(rctx.attr.name, p)
+            macro_tmpl.format(p, "pkg")
             for p in bzl_packages
         ]),
         "%%ALL_WHL_REQUIREMENTS%%": _format_repr_list([
-            "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
+            macro_tmpl.format(p, "whl")
             for p in bzl_packages
         ]),
         "%%MACRO_TMPL%%": macro_tmpl,

tests/BUILD.bazel

@@ -12,6 +12,12 @@ bazel_integration_test(
     tags = ["fix-windows"],
 )
 
+bazel_integration_test(
+    name = "pip_parse_test",
+    timeout = "long",
+    dirname = "pip_parse",
+)
+
 build_test(
     name = "bzl_libraries_build_test",
     targets = [

tests/pip_parse/.bazelrc

@@ -0,0 +1,7 @@
+# Bazel configuration flags
+
+build --enable_runfiles
+startup --windows_enable_symlinks
+
+# https://docs.bazel.build/versions/main/best-practices.html#using-the-bazelrc-file
+try-import %workspace%/user.bazelrc

tests/pip_parse/.gitignore

@@ -0,0 +1,4 @@
+# git ignore patterns
+
+/bazel-*
+user.bazelrc

tests/pip_parse/BUILD.bazel

@@ -0,0 +1,12 @@
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
+
+compile_pip_requirements(
+    name = "requirements",
+    extra_args = [
+        "--allow-unsafe",
+        "--resolver=backtracking",
+    ],
+    requirements_in = "requirements.in",
+    requirements_txt = "requirements_lock.txt",
+    requirements_windows = "requirements_windows.txt",
+)

tests/pip_parse/MODULE.bazel

@@ -0,0 +1,45 @@
+module(
+    name = "example_bzlmod",
+    version = "0.0.0",
+    compatibility_level = 1,
+)
+
+bazel_dep(name = "bazel_skylib", version = "1.3.0")
+bazel_dep(name = "rules_python", version = "0.0.0")
+local_path_override(
+    module_name = "rules_python",
+    path = "../..",
+)
+
+python = use_extension("@rules_python//python:extensions.bzl", "python")
+python.toolchain(
+    name = "python3_9",
+    configure_coverage_tool = True,
+    python_version = "3.9",
+)
+use_repo(
+    python,
+    "python3_9",
+    "python3_9_host_interpreter",
+    "python3_9_toolchains",
+)
+
+register_toolchains(
+    "@python3_9_toolchains//:all",
+)
+
+pip = use_extension("@rules_python//python:extensions.bzl", "pip")
+pip.parse(
+    name = "pypi",
+    python_interpreter_target = "@python3_9_host_interpreter//:python",
+    requirements_lock = "//:requirements_lock.txt",
+    requirements_windows = "//:requirements_windows.txt",
+)
+pip.parse(
+    name = "pypi_aliases",
+    incompatible_generate_aliases = True,
+    python_interpreter_target = "@python3_9_host_interpreter//:python",
+    requirements_lock = "//:requirements_lock.txt",
+    requirements_windows = "//:requirements_windows.txt",
+)
+use_repo(pip, "pypi", "pypi_aliases")

tests/pip_parse/README.md

@@ -0,0 +1,8 @@
+# pip_parse integration tests
+
+This directory contains tests for both, the `pip_parse` repository rules and
+the extensions in order to ensure that the resultant contents of the
+`@<name>//:requirements.bzl` work as intended.
+
+For now we only try to build the targets that we can access via the macros or
+the label lists.

tests/pip_parse/WORKSPACE

@@ -0,0 +1,43 @@
+workspace(name = "pip_parse_tests")
+
+local_repository(
+    name = "rules_python",
+    path = "../..",
+)
+
+load("@rules_python//python:repositories.bzl", "py_repositories", "python_register_toolchains")
+
+py_repositories()
+
+python_register_toolchains(
+    name = "python3_9",
+    python_version = "3.9",
+)
+
+load("@python3_9//:defs.bzl", "interpreter")
+load("@rules_python//python:pip.bzl", "pip_parse")
+
+# For a more thorough example of `pip_parse`. See `@rules_python//examples/pip_parse`
+pip_parse(
+    name = "pypi",
+    incompatible_generate_aliases = False,
+    python_interpreter_target = interpreter,
+    requirements_lock = "//:requirements_lock.txt",
+    requirements_windows = "//:requirements_windows.txt",
+)
+
+load("@pypi//:requirements.bzl", install_regular_deps = "install_deps")
+
+install_regular_deps()
+
+pip_parse(
+    name = "pypi_aliases",
+    incompatible_generate_aliases = True,
+    python_interpreter_target = interpreter,
+    requirements = "//:requirements_lock.txt",
+    requirements_windows = "//:requirements_windows.txt",
+)
+
+load("@pypi_aliases//:requirements.bzl", install_alias_deps = "install_deps")
+
+install_alias_deps()

tests/pip_parse/aliases/BUILD.bazel

@@ -0,0 +1,41 @@
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
+load("@pypi_aliases//:requirements.bzl", "all_requirements", "all_whl_requirements", "data_requirement", "dist_info_requirement", "requirement", "whl_requirement")
+
+build_test(
+    name = "build_all_pkgs",
+    targets = all_requirements,
+)
+
+build_test(
+    name = "build_all_whls",
+    targets = all_whl_requirements,
+)
+
+_PACKAGES = [
+    "requests",
+    "s3cmd",
+    "yamllint",
+    "tabulate",
+    "pylint",
+    "python-dateutil",
+]
+
+build_test(
+    name = "build_pkgs",
+    targets = [requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_whls",
+    targets = [whl_requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_data",
+    targets = [data_requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_dist_info",
+    targets = [dist_info_requirement(p) for p in _PACKAGES],
+)

tests/pip_parse/regular/BUILD.bazel

@@ -0,0 +1,41 @@
+load("@bazel_skylib//rules:build_test.bzl", "build_test")
+load("@pypi//:requirements.bzl", "all_requirements", "all_whl_requirements", "data_requirement", "dist_info_requirement", "requirement", "whl_requirement")
+
+build_test(
+    name = "build_all_pkgs",
+    targets = all_requirements,
+)
+
+build_test(
+    name = "build_all_whls",
+    targets = all_whl_requirements,
+)
+
+_PACKAGES = [
+    "requests",
+    "s3cmd",
+    "yamllint",
+    "tabulate",
+    "pylint",
+    "python-dateutil",
+]
+
+build_test(
+    name = "build_pkgs",
+    targets = [requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_whls",
+    targets = [whl_requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_data",
+    targets = [data_requirement(p) for p in _PACKAGES],
+)
+
+build_test(
+    name = "build_dist_info",
+    targets = [dist_info_requirement(p) for p in _PACKAGES],
+)

tests/pip_parse/requirements.in

@@ -0,0 +1,6 @@
+requests~=2.25.1
+s3cmd~=2.1.0
+yamllint>=1.28.0
+tabulate~=0.9.0
+pylint~=2.15.5
+python-dateutil>=2.8.2