aboutsummaryrefslogtreecommitdiff
path: root/rules/license.bzl
diff options
context:
space:
mode:
authorJingwen Chen <jingwen@google.com>2023-03-25 07:33:36 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-03-25 07:33:36 +0000
commitffc082fc7b3bc779251846c063bd127b941a3d52 (patch)
tree39314478665e3c080e3df6fe4a97609182f089b5 /rules/license.bzl
parent8a99d2b6dff36f04be445f3c5e8f69874da57a04 (diff)
parent0f22c081a0b9df29e574400ebf7003014b04a06d (diff)
downloadbazelbuild-rules_license-c169b295c49f32d6448235f9796fae47e94e4743.tar.gz
Merge remote-tracking branch 'aosp/upstream-main' into mymerge am: 748e62d604 am: dad1665d12 am: eb146bbc49 am: 0f22c081a0aml_wif_341711020aml_wif_341610000aml_wif_341510000aml_wif_341410080aml_wif_341310010aml_wif_341110010aml_wif_341011010aml_wif_340913010aml_uwb_341710010aml_uwb_341513070aml_uwb_341511050aml_uwb_341310300aml_uwb_341310030aml_uwb_341111010aml_uwb_341011000aml_tet_341712060aml_tet_341610020aml_tet_341511010aml_tet_341411060aml_tet_341310230aml_tet_341112070aml_tet_341010040aml_tet_340913030aml_swc_341711000aml_swc_341619000aml_swc_341513600aml_swc_341312300aml_swc_341312020aml_swc_341111000aml_swc_341011020aml_swc_340922010aml_sta_341710000aml_sta_341615000aml_sta_341511040aml_sta_341410000aml_sta_341311010aml_sta_341114000aml_sta_341111000aml_sta_341010020aml_sta_340912000aml_sta_340911000aml_sdk_341710000aml_sdk_341510000aml_sdk_341410000aml_sdk_341110080aml_sdk_341110000aml_sdk_341010000aml_sdk_340912010aml_sch_341510000aml_res_341510000aml_res_341410010aml_res_341311030aml_res_341110000aml_res_340912000aml_per_341711000aml_per_341614000aml_per_341510010aml_per_341410020aml_per_341311000aml_per_341110020aml_per_341110010aml_per_341011100aml_per_341011020aml_per_340916010aml_odp_341717000aml_odp_341610000aml_neu_341510000aml_neu_341010080aml_neu_341010000aml_net_341710020aml_net_341610030aml_net_341510050aml_net_341510000aml_net_341411030aml_net_341311010aml_net_341310020aml_net_341111030aml_net_341014000aml_net_340913000aml_mpr_341713020aml_mpr_341614010aml_mpr_341511070aml_mpr_341411070aml_mpr_341313030aml_mpr_341111030aml_mpr_341111020aml_mpr_341015090aml_mpr_341015030aml_mpr_340919000aml_med_341711000aml_med_341619000aml_med_341513600aml_med_341312300aml_med_341312020aml_med_341111000aml_med_341011000aml_med_340922010aml_ips_341611000aml_ips_341510000aml_ips_340914280aml_ips_340914200aml_ips_340914000aml_ext_341716000aml_ext_341620040aml_ext_341518010aml_ext_341414010aml_ext_341317010aml_ext_341131030aml_ext_341027030aml_doc_341713000aml_doc_341610010aml_doc_341510050aml_doc_341312010aml_doc_341112000aml_doc_341012000aml_doc_340916000aml_con_341614000aml_con_341511080aml_con_341410300aml_con_341310090aml_con_341110000aml_cbr_341710000aml_cbr_341610000aml_cbr_341510010aml_cbr_341410010aml_cbr_341311010aml_cbr_341110000aml_cbr_341011000aml_cbr_340914000aml_ase_341510000aml_ase_341410000aml_ase_341310010aml_ase_341113000aml_ase_340913000aml_art_341711000aml_art_341615020aml_art_341514450aml_art_341514410aml_art_341411300aml_art_341311100aml_art_341110110aml_art_341110060aml_art_341010050aml_art_340915060aml_ads_341720000aml_ads_341615050aml_ads_341517040aml_ads_341413000aml_ads_341316030aml_ads_341131050aml_ads_341027030aml_ads_340915050aml_adb_341520010aml_adb_341517070aml_adb_340912530aml_adb_340912350aml_adb_340912200aml_adb_340912000android14-mainline-wifi-releaseandroid14-mainline-uwb-releaseandroid14-mainline-tethering-releaseandroid14-mainline-sdkext-releaseandroid14-mainline-resolv-releaseandroid14-mainline-permission-releaseandroid14-mainline-os-statsd-releaseandroid14-mainline-networking-releaseandroid14-mainline-mediaprovider-releaseandroid14-mainline-media-swcodec-releaseandroid14-mainline-media-releaseandroid14-mainline-extservices-releaseandroid14-mainline-conscrypt-releaseandroid14-mainline-cellbroadcast-releaseandroid14-mainline-art-releaseandroid14-mainline-appsearch-releaseandroid14-mainline-adservices-releaseandroid14-mainline-adbd-release
Original change: https://android-review.googlesource.com/c/platform/external/bazelbuild-rules_license/+/2500461 Change-Id: I9a081aeaf4c868c4c980290ec0b7732f1714447e Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'rules/license.bzl')
-rw-r--r--rules/license.bzl117
1 files changed, 63 insertions, 54 deletions
diff --git a/rules/license.bzl b/rules/license.bzl
index f726be1..032599d 100644
--- a/rules/license.bzl
+++ b/rules/license.bzl
@@ -1,4 +1,4 @@
-# Copyright 2020 Google LLC
+# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -11,54 +11,43 @@
# 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.
+"""Rules for declaring the compliance licenses used by a package.
-"""Rules for declaring the licenses used by a package."""
+"""
load(
"@rules_license//rules:providers.bzl",
- "LicenseInfo",
"LicenseKindInfo",
)
+load(
+ "@rules_license//rules:license_impl.bzl",
+ "license_rule_impl",
+)
-# Debugging verbosity
-_VERBOSITY = 0
-
-def _debug(loglevel, msg):
- if _VERBOSITY > loglevel:
- print(msg) # buildifier: disable=print
-
-#
-# license()
-#
-
-def _license_impl(ctx):
- provider = LicenseInfo(
- license_kinds = tuple([k[LicenseKindInfo] for k in ctx.attr.license_kinds]),
- copyright_notice = ctx.attr.copyright_notice,
- package_name = ctx.attr.package_name,
- package_url = ctx.attr.package_url,
- package_version = ctx.attr.package_version,
- license_text = ctx.file.license_text,
- rule = ctx.label,
- )
- _debug(0, provider)
- return [provider]
+# Enable this if your organization requires the license text to be a file
+# checked into source control instead of, possibly, another rule.
+_require_license_text_is_a_file = False
+# This rule must be named "_license" for backwards compatability with older
+# or Bazel that checked that name explicitly. See
+# https://github.com/bazelbuild/bazel/commit/bbc221f60bc8c9177470529d85c3e47a5d9aaf21
+# TODO(after bazel 7.0 release): Feel free to rename the rule and move.
_license = rule(
- implementation = _license_impl,
+ implementation = license_rule_impl,
attrs = {
- "copyright_notice": attr.string(
- doc = "Copyright notice.",
- ),
"license_kinds": attr.label_list(
- mandatory = True,
+ mandatory = False,
doc = "License kind(s) of this license. If multiple license kinds are" +
" listed in the LICENSE file, and they all apply, then all" +
" should be listed here. If the user can choose a single one" +
" of many, then only list one here.",
providers = [LicenseKindInfo],
+ # This should be the null configuration, not the exec.
cfg = "exec",
),
+ "copyright_notice": attr.string(
+ doc = "Copyright notice.",
+ ),
"license_text": attr.label(
allow_single_file = True,
default = "LICENSE",
@@ -80,51 +69,71 @@ _license = rule(
" by an applicatation. It should be a value that" +
" increases over time, rather than a commit hash."
),
+ "namespace": attr.string(
+ doc = "A human readable name used to organize licenses into categories." +
+ " This is used in google3 to differentiate third party licenses used" +
+ " for compliance versus internal licenses used by SLAsan for internal" +
+ " teams' SLAs.",
+ ),
},
)
# buildifier: disable=function-docstring-args
-def license(name,
- copyright_notice = None,
- license_kinds = None,
- license_text = None,
- package_name = None,
- package_url = None,
- package_version = None,
- tags = None,
- **kwargs):
+def license(
+ name,
+ license_text = "LICENSE",
+ license_kind = None,
+ license_kinds = None,
+ copyright_notice = None,
+ package_name = None,
+ package_url = None,
+ package_version = None,
+ namespace = "compliance",
+ tags = [],
+ visibility = ["//visibility:public"]):
"""Wrapper for license rule.
+ @wraps(_license)
+
Args:
name: str target name.
+ license_text: str Filename of the license file
+ license_kind: label a single license_kind. Only one of license_kind or license_kinds may
+ be specified
license_kinds: list(label) list of license_kind targets.
- license_kind: label a single license_kind. Only one of license_kind or
- license_kinds may be specified
copyright_notice: str Copyright notice associated with this package.
package_name: str A human readable name identifying this package. This
may be used to produce an index of OSS packages used by
- an applicatation.
- package_url: The URL this instance was downloaded from.
- package_version: The version number of this package. This should be a
- value that increases over time, rather than a commit
- hash.
- kwargs: Other things may be specified, but they are explicitly ignored.
+ an application.
+ package_url: str The canonical URL this package was downloaded from.
+ package_version: str The version corresponding the the URL.
+ namespace: str Undocumened. Internal.
+ tags: list(str) tags applied to the rule
+ visibility: list(label) visibility spec.
"""
- single_kind = kwargs.pop("license_kind", default = None)
- if single_kind:
+ if license_kind:
if license_kinds:
fail("Can not use both license_kind and license_kinds")
- license_kinds = [single_kind]
- tags = tags or []
+ license_kinds = [license_kind]
+
+ if _require_license_text_is_a_file:
+ # Make sure the file exists as named in the rule. A glob expression that
+ # expands to the name of the file is not acceptable.
+ srcs = native.glob([license_text])
+ if len(srcs) != 1 or srcs[0] != license_text:
+ fail("Specified license file doesn't exist: %s" % license_text)
+
_license(
name = name,
license_kinds = license_kinds,
- license_text = license_text or "LICENSE",
+ license_text = license_text,
copyright_notice = copyright_notice,
package_name = package_name,
package_url = package_url,
package_version = package_version,
+ namespace = namespace,
applicable_licenses = [],
+ visibility = visibility,
tags = tags,
- visibility = ["//visibility:public"],
+ testonly = 0,
)