diff --git a/BUILD.bazel b/BUILD.bazel index 4af734601c..17fd456e9e 100644 --- a/BUILD.bazel +++ b/BUILD.bazel @@ -12,6 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +load("@bazel_skylib//:bzl_library.bzl", "bzl_library") +load("@package_metadata//licenses/rules:license.bzl", "license") +load("@package_metadata//purl:purl.bzl", "purl") +load("@package_metadata//rules:package_metadata.bzl", "package_metadata") + # Resolve rules_cc Starlark libraries to their correct targets # gazelle:resolve starlark @rules_cc//cc/common:cc_info.bzl @rules_cc//cc/common:common # gazelle:resolve starlark @rules_cc//cc/common:cc_common.bzl @rules_cc//cc/common:common @@ -51,6 +56,24 @@ package(default_visibility = ["//visibility:public"]) licenses(["notice"]) +package_metadata( + name = "package_metadata", + attributes = [ + ":license", + ], + purl = purl.bazel( + module_name() or "rules_python", + module_version(), + ), + visibility = ["//visibility:public"], +) + +license( + name = "license", + kind = "@package_metadata//licenses/spdx:Apache-2.0", + text = ":LICENSE", +) + exports_files([ ".clippy.toml", "LICENSE", @@ -68,7 +91,11 @@ exports_files( ) exports_files( - glob(["*.md"]), + glob( + ["*.md"], + # Not all files are present when used as an integration test fixture + allow_empty = True, + ), visibility = ["//docs:__subpackages__"], ) @@ -100,7 +127,9 @@ filegroup( name = "distribution", srcs = [ "BUILD.bazel", + "LICENSE", "MODULE.bazel", + "REPO.bazel", "WORKSPACE", "WORKSPACE.bzlmod", "internal_dev_deps.bzl", diff --git a/MODULE.bazel b/MODULE.bazel index 51139cbe6d..977a957e02 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -6,7 +6,7 @@ module( bazel_dep(name = "bazel_features", version = "1.55.0") bazel_dep(name = "bazel_skylib", version = "1.8.2") -bazel_dep(name = "package_metadata", version = "0.0.7") +bazel_dep(name = "package_metadata", version = "0.0.13") bazel_dep(name = "platforms", version = "0.0.11") bazel_dep(name = "rules_cc", version = "0.2.17") bazel_dep(name = "toml.bzl", version = "0.4.1") diff --git a/REPO.bazel b/REPO.bazel new file mode 100644 index 0000000000..bbbb673139 --- /dev/null +++ b/REPO.bazel @@ -0,0 +1,7 @@ +"""File declaring metadata applying to all packages and targets in the Bazel module.""" + +repo( + default_package_metadata = [ + "//:package_metadata", + ], +) diff --git a/news/4276.changed.md b/news/4276.changed.md new file mode 100644 index 0000000000..f1ef7fa9ae --- /dev/null +++ b/news/4276.changed.md @@ -0,0 +1,5 @@ +(workspace) **BREAKING** `rules_python` now requires `package_metadata` 0.0.13 +or newer. WORKSPACE users who define `@package_metadata` themselves (e.g. via +another dependency) must update it, e.g. with an `http_archive` of +`package_metadata-0.0.13` (`strip_prefix = "package_metadata-0.0.13/metadata"`). +([#4276](https://github.com/bazel-contrib/rules_python/pull/4276)) diff --git a/python/private/py_repositories.bzl b/python/private/py_repositories.bzl index 3489613a6c..5353b8b8c5 100644 --- a/python/private/py_repositories.bzl +++ b/python/private/py_repositories.bzl @@ -80,9 +80,9 @@ def py_repositories(transition_settings = []): ) http_archive( name = "package_metadata", - sha256 = "8f27dc7393e3f3bdc793bdc4ba36d67a63c22cc9d38cc65d3204654974ea4563", - strip_prefix = "supply-chain-0.0.7/metadata", - url = "https://github.com/bazel-contrib/supply-chain/releases/download/v0.0.7/supply-chain-v0.0.7.tar.gz", + sha256 = "755bd6c8a3751982e2555d96c913ec070954ca9d01f935563392255da4ebad72", + strip_prefix = "package_metadata-0.0.13/metadata", + url = "https://github.com/bazel-contrib/supply-chain/releases/download/package_metadata-0.0.13/package_metadata-0.0.13.tar.gz", ) # Needed by rules_cc, triggered by @rules_java_prebuilt in Bazel by using @rules_cc//cc:defs.bzl diff --git a/python/private/pypi/BUILD.bazel b/python/private/pypi/BUILD.bazel index 03a9e113d5..84352bce5d 100644 --- a/python/private/pypi/BUILD.bazel +++ b/python/private/pypi/BUILD.bazel @@ -629,6 +629,15 @@ bzl_library( ], ) +bzl_library( + name = "whl_package_metadata", + srcs = ["whl_package_metadata.bzl"], + deps = [ + "@package_metadata//purl:srcs", + "@package_metadata//rules:srcs", + ], +) + bzl_library( name = "argparse", srcs = ["argparse.bzl"], diff --git a/python/private/pypi/generate_whl_library_build_bazel.bzl b/python/private/pypi/generate_whl_library_build_bazel.bzl index bec45bb08f..c8a46b5f2d 100644 --- a/python/private/pypi/generate_whl_library_build_bazel.bzl +++ b/python/private/pypi/generate_whl_library_build_bazel.bzl @@ -44,11 +44,9 @@ package(default_visibility = ["//visibility:public"]) ) """ -_PURL = """\ -package_metadata( - name = "package_metadata", - purl = {purl}, - visibility = ["//:__subpackages__"], +_PACKAGE_METADATA = """\ +whl_package_metadata( +{kwargs} ) """ @@ -66,7 +64,8 @@ def generate_whl_library_build_bazel( metadata_version: The version to use for tag generation. annotation: The annotation for the build file. config_load: {type}`str` The location from where to load the config. - purl: The purl. + purl: {type}`dict[str, str] | None` The fields of the PyPI PURL passed + to {obj}`whl_package_metadata`. requires_dist: {type}`list[str]` The list of dependencies from the METADATA file. **kwargs: Extra args serialized to be passed to the {obj}`whl_library_targets`. @@ -75,9 +74,7 @@ def generate_whl_library_build_bazel( A complete BUILD file as a string """ - loads = [ - """load("@package_metadata//rules:package_metadata.bzl", "package_metadata")""", - ] + loads = [] if kwargs.get("repo"): fn = "whl_library_deps_targets" @@ -103,6 +100,8 @@ def generate_whl_library_build_bazel( loads.extend([ """load("@rules_python//python/private/pypi:{}.bzl", "{}")""".format(fn, fn), ]) + if purl: + loads.append("""load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata")""") additional_content = [] if annotation: @@ -124,7 +123,10 @@ def generate_whl_library_build_bazel( for k, v in sorted(kwargs.items()) ])), ), - ] + ([_PURL.format(purl = repr(purl))] if purl else []) + additional_content, + ] + ([_PACKAGE_METADATA.format(kwargs = render.indent("\n".join([ + "{} = {},".format(k, repr(v)) + for k, v in sorted(purl.items()) + ])))] if purl else []) + additional_content, ) # NOTE: Ensure that we terminate with a new line diff --git a/python/private/pypi/patch_and_extract_whl.bzl b/python/private/pypi/patch_and_extract_whl.bzl index 37c90e3221..0c73568806 100644 --- a/python/private/pypi/patch_and_extract_whl.bzl +++ b/python/private/pypi/patch_and_extract_whl.bzl @@ -41,21 +41,25 @@ def _move_scripts_needing_shebang_rewrite(rctx, entry_points): def _to_purl(*, index, metadata, filename): """ - Produce a PyPI PURL from the metadata. + Return the fields of the PyPI PURL from the metadata. + + The PURL is built in the generated BUILD file, so that `@package_metadata` + is not loaded by the repository rules. https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md """ # https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md#name-definition - name = normalize_name(metadata.name).replace("_", "-") - - qualifiers = {} + purl = { + "distribution": normalize_name(metadata.name).replace("_", "-"), + "version": metadata.version, + } if index: - qualifiers["repository_url"] = index + purl["repository_url"] = index if filename: - qualifiers["file_name"] = filename + purl["file_name"] = filename - return "pkg:pypi/{}@{}?{}".format(name, metadata.version, "&".join(["{}={}".format(key, val) for key, val in qualifiers.items()])) + return purl def _remove_files(rctx, *basenames): paths = list(rctx.path(".").readdir()) diff --git a/python/private/pypi/whl_package_metadata.bzl b/python/private/pypi/whl_package_metadata.bzl new file mode 100644 index 0000000000..51d4e86a83 --- /dev/null +++ b/python/private/pypi/whl_package_metadata.bzl @@ -0,0 +1,39 @@ +"""The package metadata for the whl repositories. + +This is loaded only by the generated `BUILD.bazel` files of the whl +repositories, so that the `@package_metadata` repository is not needed when +loading the repository rules, e.g. in `WORKSPACE`. +""" + +load("@package_metadata//purl:purl.bzl", "purl") +load("@package_metadata//rules:package_metadata.bzl", "package_metadata") + +def whl_package_metadata( + *, + distribution, + version, + repository_url = None, + file_name = None, + name = "package_metadata"): + """Create the `package_metadata` target with a PyPI PURL. + + See https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md + + Args: + distribution: {type}`str` the normalized name of the distribution. + version: {type}`str` the version of the package. + repository_url: {type}`str | None` the index URL. + file_name: {type}`str | None` the name of the whl or sdist file. + name: {type}`str` the name of the target. + """ + builder = purl.builder().type("pypi").name(distribution).version(version) + if repository_url: + builder.add_qualifier("repository_url", repository_url) + if file_name: + builder.add_qualifier("file_name", file_name) + + package_metadata( + name = name, + purl = builder.build(), + visibility = ["//:__subpackages__"], + ) diff --git a/tests/integration/bzlmod_lockfile/MODULE.bazel.lock b/tests/integration/bzlmod_lockfile/MODULE.bazel.lock index 5fd682aaf8..bc8cbd1a07 100644 --- a/tests/integration/bzlmod_lockfile/MODULE.bazel.lock +++ b/tests/integration/bzlmod_lockfile/MODULE.bazel.lock @@ -67,9 +67,10 @@ "https://bcr.bazel.build/modules/libpfm/4.11.0/MODULE.bazel": "45061ff025b301940f1e30d2c16bea596c25b176c8b6b3087e92615adbd52902", "https://bcr.bazel.build/modules/nlohmann_json/3.6.1/MODULE.bazel": "6f7b417dcc794d9add9e556673ad25cb3ba835224290f4f848f8e2db1e1fca74", "https://bcr.bazel.build/modules/nlohmann_json/3.6.1/source.json": "f448c6e8963fdfa7eb831457df83ad63d3d6355018f6574fb017e8169deb43a9", + "https://bcr.bazel.build/modules/package_metadata/0.0.13/MODULE.bazel": "a9cc7e81640c1e7eaca5a465cdf4b63c88d416ca998fcded3680181b1602eee2", + "https://bcr.bazel.build/modules/package_metadata/0.0.13/source.json": "f488e4534468eac223f6417dfdf8d3b7299166d36536408d37c2493ca1e8539d", "https://bcr.bazel.build/modules/package_metadata/0.0.3/MODULE.bazel": "77890552ecea9e284b5424c9de827a58099348763a4359e975c359a83d4faa83", "https://bcr.bazel.build/modules/package_metadata/0.0.7/MODULE.bazel": "7adb03933fc8401f495800cf4eafcff0edc6da0ff55c7db223ef69d19f689486", - "https://bcr.bazel.build/modules/package_metadata/0.0.7/source.json": "50639625e937b56115012674c797cca7a05a96b4878c87d803c13dc2b31de8a0", "https://bcr.bazel.build/modules/platforms/0.0.10/MODULE.bazel": "8cb8efaf200bdeb2150d93e162c40f388529a25852b332cec879373771e48ed5", "https://bcr.bazel.build/modules/platforms/0.0.11/MODULE.bazel": "0daefc49732e227caa8bfa834d65dc52e8cc18a2faf80df25e8caea151a9413f", "https://bcr.bazel.build/modules/platforms/0.0.4/MODULE.bazel": "9b328e31ee156f53f3c416a64f8491f7eb731742655a47c9eec4703a71644aee", diff --git a/tests/integration/whl_library/MODULE.bazel b/tests/integration/whl_library/MODULE.bazel index 9059879187..ffacb7cac8 100644 --- a/tests/integration/whl_library/MODULE.bazel +++ b/tests/integration/whl_library/MODULE.bazel @@ -1,6 +1,6 @@ module(name = "integration_test") -bazel_dep(name = "package_metadata", version = "0.0.7") +bazel_dep(name = "package_metadata", version = "0.0.13") bazel_dep(name = "rules_python", version = "0.0.0") local_path_override( module_name = "rules_python", diff --git a/tests/integration/whl_library/test_contents.py b/tests/integration/whl_library/test_contents.py index 58f13354e3..e34063cf4d 100644 --- a/tests/integration/whl_library/test_contents.py +++ b/tests/integration/whl_library/test_contents.py @@ -164,6 +164,10 @@ def test_whl_deps_ar_the_same(self): "@whl_archive//:site-packages/requests/structures.py", "@whl_archive//:site-packages/requests/utils.py", "@whl_archive//:srcs", + "@package_metadata//licenses/spdx:Apache-2.0", + "@rules_python//:LICENSE", + "@rules_python//:license", + "@rules_python//:package_metadata", "@rules_python//python:none", "@rules_python//python/config_settings:_is_venvs_site_packages_yes", "@rules_python//python/config_settings:add_srcs_to_runfiles", diff --git a/tests/pypi/generate_whl_library_build_bazel/generate_whl_library_build_bazel_tests.bzl b/tests/pypi/generate_whl_library_build_bazel/generate_whl_library_build_bazel_tests.bzl index d3a390d9bb..646e4f2370 100644 --- a/tests/pypi/generate_whl_library_build_bazel/generate_whl_library_build_bazel_tests.bzl +++ b/tests/pypi/generate_whl_library_build_bazel/generate_whl_library_build_bazel_tests.bzl @@ -21,9 +21,9 @@ _tests = [] def _test_all_workspace(env): want = """\ -load("@package_metadata//rules:package_metadata.bzl", "package_metadata") load("@pypi//:config.bzl", "packages") load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets") +load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata") package(default_visibility = ["//visibility:public"]) @@ -61,10 +61,10 @@ whl_library_targets( ], ) -package_metadata( - name = "package_metadata", - purl = "foo", - visibility = ["//:__subpackages__"], +whl_package_metadata( + distribution = "foo", + file_name = "foo.whl", + version = "0", ) # SOMETHING SPECIAL AT THE END @@ -87,7 +87,7 @@ package_metadata( config_load = "@pypi//:config.bzl", group_name = "qux", group_deps = ["foo", "fox", "qux"], - purl = "foo", + purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"}, ) env.expect.that_str(actual.replace("@@", "@")).equals(want) @@ -95,9 +95,9 @@ _tests.append(_test_all_workspace) def _test_all(env): want = """\ -load("@package_metadata//rules:package_metadata.bzl", "package_metadata") load("@pypi//:config.bzl", "packages") load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets") +load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata") package(default_visibility = ["//visibility:public"]) @@ -135,10 +135,10 @@ whl_library_targets( ], ) -package_metadata( - name = "package_metadata", - purl = "foo", - visibility = ["//:__subpackages__"], +whl_package_metadata( + distribution = "foo", + file_name = "foo.whl", + version = "0", ) # SOMETHING SPECIAL AT THE END @@ -160,7 +160,7 @@ package_metadata( ), config_load = "@pypi//:config.bzl", group_name = "qux", - purl = "foo", + purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"}, group_deps = ["foo", "fox", "qux"], ) env.expect.that_str(actual.replace("@@", "@")).equals(want) @@ -169,9 +169,9 @@ _tests.append(_test_all) def _test_all_with_loads(env): want = """\ -load("@package_metadata//rules:package_metadata.bzl", "package_metadata") load("@pypi//:config.bzl", "packages") load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets") +load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata") package(default_visibility = ["//visibility:public"]) @@ -209,10 +209,10 @@ whl_library_targets( ], ) -package_metadata( - name = "package_metadata", - purl = "foo", - visibility = ["//:__subpackages__"], +whl_package_metadata( + distribution = "foo", + file_name = "foo.whl", + version = "0", ) # SOMETHING SPECIAL AT THE END @@ -235,7 +235,7 @@ package_metadata( group_name = "qux", config_load = "@pypi//:config.bzl", group_deps = ["foo", "fox", "qux"], - purl = "foo", + purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"}, ) env.expect.that_str(actual.replace("@@", "@")).equals(want) @@ -243,7 +243,6 @@ _tests.append(_test_all_with_loads) def _test_deps_targets(env): want = """\ -load("@package_metadata//rules:package_metadata.bzl", "package_metadata") load("@rules_python//python/private/pypi:whl_library_deps_targets.bzl", "whl_library_deps_targets") package(default_visibility = ["//visibility:public"]) diff --git a/tests/pypi/whl_package_metadata/BUILD.bazel b/tests/pypi/whl_package_metadata/BUILD.bazel new file mode 100644 index 0000000000..269fade0c2 --- /dev/null +++ b/tests/pypi/whl_package_metadata/BUILD.bazel @@ -0,0 +1,5 @@ +load(":whl_package_metadata_tests.bzl", "whl_package_metadata_test_suite") + +whl_package_metadata_test_suite( + name = "whl_package_metadata_tests", +) diff --git a/tests/pypi/whl_package_metadata/whl_package_metadata_tests.bzl b/tests/pypi/whl_package_metadata/whl_package_metadata_tests.bzl new file mode 100644 index 0000000000..db80212890 --- /dev/null +++ b/tests/pypi/whl_package_metadata/whl_package_metadata_tests.bzl @@ -0,0 +1,59 @@ +"" + +load("@rules_testing//lib:analysis_test.bzl", "analysis_test") +load("@rules_testing//lib:test_suite.bzl", "test_suite") +load("//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata") # buildifier: disable=bzl-visibility + +_tests = [] + +def _purl(env, target): + return json.decode(env.expect.that_target(target).action_generating( + "{package}/{name}.package-metadata.json", + ).actual.content)["purl"] + +def _test_purl(name): + whl_package_metadata( + name = name + "_subject", + distribution = "foo-bar", + version = "1.0.0", + ) + analysis_test( + name = name, + impl = _test_purl_impl, + target = name + "_subject", + ) + +def _test_purl_impl(env, target): + env.expect.that_str(_purl(env, target)).equals("pkg:pypi/foo-bar@1.0.0") + +_tests.append(_test_purl) + +def _test_purl_with_qualifiers(name): + whl_package_metadata( + name = name + "_subject", + distribution = "foo-bar", + version = "1.0.0+local", + repository_url = "https://example.org/simple", + file_name = "foo_bar-1.0.0+local-py3-none-any.whl", + ) + analysis_test( + name = name, + impl = _test_purl_with_qualifiers_impl, + target = name + "_subject", + ) + +def _test_purl_with_qualifiers_impl(env, target): + # The qualifiers are sorted and the values are percent-encoded. + env.expect.that_str(_purl(env, target)).equals( + "pkg:pypi/foo-bar@1.0.0%2Blocal?file_name=foo_bar-1.0.0%2Blocal-py3-none-any.whl&repository_url=https:%2F%2Fexample.org%2Fsimple", + ) + +_tests.append(_test_purl_with_qualifiers) + +def whl_package_metadata_test_suite(name): + """Create the test suite. + + Args: + name: the name of the test suite + """ + test_suite(name = name, tests = _tests)