xref: /aosp_15_r20/external/bazelbuild-rules_license/rules/check_licenses_shim.bzl (revision f578df4fd057ffe2023728444759535685631548)
1*f578df4fSJingwen Chen# Copyright 2022 Google LLC
2*f578df4fSJingwen Chen#
3*f578df4fSJingwen Chen# Licensed under the Apache License, Version 2.0 (the "License");
4*f578df4fSJingwen Chen# you may not use this file except in compliance with the License.
5*f578df4fSJingwen Chen# You may obtain a copy of the License at
6*f578df4fSJingwen Chen#
7*f578df4fSJingwen Chen# https://www.apache.org/licenses/LICENSE-2.0
8*f578df4fSJingwen Chen#
9*f578df4fSJingwen Chen# Unless required by applicable law or agreed to in writing, software
10*f578df4fSJingwen Chen# distributed under the License is distributed on an "AS IS" BASIS,
11*f578df4fSJingwen Chen# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*f578df4fSJingwen Chen# See the License for the specific language governing permissions and
13*f578df4fSJingwen Chen# limitations under the License.
14*f578df4fSJingwen Chen"""This module provides a custom Starlark rule used to create wrappers for targets that
15*f578df4fSJingwen Chencan have blaze build --check_licenses executed against them."""
16*f578df4fSJingwen Chen
17*f578df4fSJingwen Chendef _shim_rule_impl(ctx):
18*f578df4fSJingwen Chen    # This rule doesn't need to return anything. It only exists to propagate the dependency supplied
19*f578df4fSJingwen Chen    # by the label_flag
20*f578df4fSJingwen Chen    return []
21*f578df4fSJingwen Chen
22*f578df4fSJingwen Chenshim_rule = rule(
23*f578df4fSJingwen Chen    doc = """This rule exists to configure a dependent target via label. An instantiation of this
24*f578df4fSJingwen Chen    rule is then used as a dependency for the legacy_check_target rule, which can be built with --check_licenses
25*f578df4fSJingwen Chen    to get the effect of running --check_licenses on an arbitrary target which may or may not have a distribs
26*f578df4fSJingwen Chen    attribute""",
27*f578df4fSJingwen Chen    implementation = _shim_rule_impl,
28*f578df4fSJingwen Chen    # The definition of this attribute creates a dependency relationship on the manually provided label.
29*f578df4fSJingwen Chen    attrs = {"target": attr.label(default = ":check_licenses_target")},
30*f578df4fSJingwen Chen)
31