diff --git a/MODULE.bazel b/MODULE.bazel index 84e1dc35..7ebe7a30 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -5,6 +5,13 @@ module( repo_name = "rules_pkg", ) +local_repository = use_repo_rule("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository") + +local_repository( + name = "rules_pkg_providers", + path = "providers", +) + # Do not update to newer versions until you need a specific new feature. bazel_dep(name = "rules_license", version = "1.0.0") bazel_dep(name = "rules_python", version = "1.0.0") @@ -36,8 +43,6 @@ register_toolchains( dev_dependency = True, ) -local_repository = use_repo_rule("@bazel_tools//tools/build_defs/repo:local.bzl", "local_repository") - local_repository( name = "mappings_test_external_repo", path = "tests/mappings/external_repo", diff --git a/distro/BUILD b/distro/BUILD index d105f560..7ce4dffd 100644 --- a/distro/BUILD +++ b/distro/BUILD @@ -97,6 +97,7 @@ py_test( ":distro", ":small_module", "//:standard_package", + "@rules_pkg_providers//:providers.bzl", ], env_inherit = ["PATH"], imports = [".."], diff --git a/distro/packaging_test.py b/distro/packaging_test.py index f1146256..46ded0cc 100644 --- a/distro/packaging_test.py +++ b/distro/packaging_test.py @@ -97,7 +97,7 @@ def CopyTestFile(source_name, dest_name): def _select_bazel_supported_setup(self): output = subprocess.check_output(['bazel', 'version'], text=True) major_version = re.search(r'Build label:\s+(\d+)', output) - if major_version and int(major_version.group(1)) >= 9: + if major_version and int(major_version.group(1)) >= 8: return 'MODULE.bazel', self._module_bazel_lines, [] return 'WORKSPACE', self._workspace_lines, ['--enable_workspace'] @@ -106,6 +106,7 @@ def _module_bazel_lines(self, local_path, sha256): 'module(name = "test_rules_pkg_packaging")', f'bazel_dep(name = "{self.source_repo}", version = "{self.version}", repo_name = "{self.dest_repo}")', f'archive_override(module_name = "{self.source_repo}", sha256 = "{sha256}", url = "file://{local_path}")', + f'bazel_dep(name = "rules_pkg_providers", version = "1.0.0")', ) def _workspace_lines(self, local_path, sha256): diff --git a/pkg/providers.bzl b/pkg/providers.bzl index 6d5fc271..da1e9ae9 100644 --- a/pkg/providers.bzl +++ b/pkg/providers.bzl @@ -14,78 +14,19 @@ """Packaging related providers.""" -PackageArtifactInfo = provider( - doc = """Metadata about a package artifact.""", - fields = { - "file": "File object for said artifact", - "file_name": "DEPRECATED (use fields of file instead): The file name of the artifact.", - "label": "Label which produced it", - }, +load( + "@rules_pkg_providers//:providers.bzl", + _PackageArtifactInfo = "PackageArtifactInfo", + _PackageDirsInfo = "PackageDirsInfo", + _PackageFilegroupInfo = "PackageFilegroupInfo", + _PackageFilesInfo = "PackageFilesInfo", + _PackageSymlinkInfo = "PackageSymlinkInfo", + _PackageVariablesInfo = "PackageVariablesInfo", ) -PackageVariablesInfo = provider( - doc = """Variables which may be substituted into package names and content.""", - fields = { - "values": "Dict of name/value pairs", - }, -) - -PackageFilesInfo = provider( - doc = """Provider representing the installation of one or more files to destination with attributes""", - fields = { - "attributes": """Attribute information, represented as a `dict`. - -Keys are strings representing attribute identifiers, values are -arbitrary data structures that represent the associated data. These are -most often strings, but are not explicitly defined. - -For known attributes and data type expectations, see the Common -Attributes documentation in the `rules_pkg` reference. - """, - - # This is a mapping of destinations to sources to allow for the same - # target to be installed to multiple locations within a package within a - # single provider. - "dest_src_map": """Map of file destinations to sources. - - Sources are represented by bazel `File` structures.""", - }, -) - -PackageDirsInfo = provider( - doc = """Provider representing the creation of one or more directories in a package""", - fields = { - "attributes": """See `attributes` in PackageFilesInfo.""", - "dirs": """string list: installed directory names""", - }, -) - -PackageSymlinkInfo = provider( - doc = """Provider representing the creation of a single symbolic link in a package""", - fields = { - "attributes": """See `attributes` in PackageFilesInfo.""", - "destination": """string: Filesystem link 'name'""", - "target": """string or Label: Filesystem link 'target'. - - TODO(nacl): Label sources not yet supported. - """, - }, -) - -# Grouping provider: the only one that needs to be consumed by packaging (or -# other) rules that materialize paths. -PackageFilegroupInfo = provider( - doc = """Provider representing a collection of related packaging providers, - - In the "fields" documentation, "origin" refers to the label identifying the - where the provider was originally defined. This can be used by packaging - rules to provide better diagnostics related to where packaging rules were - created. - - """, - fields = { - "pkg_files": "list of tuples of (PackageFilesInfo, origin)", - "pkg_dirs": "list of tuples of (PackageDirsInfo, origin)", - "pkg_symlinks": "list of tuples of (PackageSymlinkInfo, origin)", - }, -) +PackageArtifactInfo = _PackageArtifactInfo +PackageDirsInfo = _PackageDirsInfo +PackageFilegroupInfo = _PackageFilegroupInfo +PackageFilesInfo = _PackageFilesInfo +PackageSymlinkInfo = _PackageSymlinkInfo +PackageVariablesInfo = _PackageVariablesInfo diff --git a/providers/BUILD b/providers/BUILD new file mode 100644 index 00000000..5a1a4887 --- /dev/null +++ b/providers/BUILD @@ -0,0 +1,33 @@ +# Copyright 2026 The Bazel Authors. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +load("@rules_license//rules:license.bzl", "license") + +package( + default_package_metadata = [":license"], + default_visibility = ["//visibility:public"], +) + +license( + name = "license", + license_kinds = [ + "@rules_license//licenses/spdx:Apache-2.0", + ], + license_text = "LICENSE", +) + +filegroup( + name = "all_srcs", + srcs = glob(["**"]), +) diff --git a/providers/LICENSE b/providers/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/providers/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/providers/MODULE.bazel b/providers/MODULE.bazel new file mode 100644 index 00000000..fa4467dc --- /dev/null +++ b/providers/MODULE.bazel @@ -0,0 +1,9 @@ +module( + name = "rules_pkg_providers", + version = "", # set by release pipeline from version.bzl. + compatibility_level = 1, + repo_name = "rules_pkg_providers", +) + +# Do not update to newer versions until you need a specific new feature. +bazel_dep(name = "rules_license", version = "1.0.0") diff --git a/providers/providers.bzl b/providers/providers.bzl new file mode 100644 index 00000000..6d5fc271 --- /dev/null +++ b/providers/providers.bzl @@ -0,0 +1,91 @@ +# Copyright 2020 The Bazel Authors. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""Packaging related providers.""" + +PackageArtifactInfo = provider( + doc = """Metadata about a package artifact.""", + fields = { + "file": "File object for said artifact", + "file_name": "DEPRECATED (use fields of file instead): The file name of the artifact.", + "label": "Label which produced it", + }, +) + +PackageVariablesInfo = provider( + doc = """Variables which may be substituted into package names and content.""", + fields = { + "values": "Dict of name/value pairs", + }, +) + +PackageFilesInfo = provider( + doc = """Provider representing the installation of one or more files to destination with attributes""", + fields = { + "attributes": """Attribute information, represented as a `dict`. + +Keys are strings representing attribute identifiers, values are +arbitrary data structures that represent the associated data. These are +most often strings, but are not explicitly defined. + +For known attributes and data type expectations, see the Common +Attributes documentation in the `rules_pkg` reference. + """, + + # This is a mapping of destinations to sources to allow for the same + # target to be installed to multiple locations within a package within a + # single provider. + "dest_src_map": """Map of file destinations to sources. + + Sources are represented by bazel `File` structures.""", + }, +) + +PackageDirsInfo = provider( + doc = """Provider representing the creation of one or more directories in a package""", + fields = { + "attributes": """See `attributes` in PackageFilesInfo.""", + "dirs": """string list: installed directory names""", + }, +) + +PackageSymlinkInfo = provider( + doc = """Provider representing the creation of a single symbolic link in a package""", + fields = { + "attributes": """See `attributes` in PackageFilesInfo.""", + "destination": """string: Filesystem link 'name'""", + "target": """string or Label: Filesystem link 'target'. + + TODO(nacl): Label sources not yet supported. + """, + }, +) + +# Grouping provider: the only one that needs to be consumed by packaging (or +# other) rules that materialize paths. +PackageFilegroupInfo = provider( + doc = """Provider representing a collection of related packaging providers, + + In the "fields" documentation, "origin" refers to the label identifying the + where the provider was originally defined. This can be used by packaging + rules to provide better diagnostics related to where packaging rules were + created. + + """, + fields = { + "pkg_files": "list of tuples of (PackageFilesInfo, origin)", + "pkg_dirs": "list of tuples of (PackageDirsInfo, origin)", + "pkg_symlinks": "list of tuples of (PackageSymlinkInfo, origin)", + }, +)