Skip to content

Commit

Permalink
Starlarkify sh_library
Browse files Browse the repository at this point in the history
  • Loading branch information
fmeum committed Sep 18, 2024
1 parent a345cda commit e24e487
Show file tree
Hide file tree
Showing 5 changed files with 118 additions and 154 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
package com.google.devtools.build.lib.bazel.rules;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider.RuleSet;
import com.google.devtools.build.lib.bazel.rules.sh.BazelShBinaryRule;
import com.google.devtools.build.lib.bazel.rules.sh.BazelShLibraryRule;
import com.google.devtools.build.lib.bazel.rules.sh.BazelShRuleClasses;
import com.google.devtools.build.lib.bazel.rules.sh.BazelShTestRule;
import com.google.devtools.build.lib.rules.core.CoreRules;
Expand All @@ -37,7 +37,7 @@ private ShRules() {
@Override
public void init(ConfiguredRuleClassProvider.Builder builder) {
builder.addRuleDefinition(new BazelShRuleClasses.ShRule());
builder.addRuleDefinition(new BazelShLibraryRule());
builder.addRuleDefinition(new BaseRuleClasses.EmptyRule("sh_library") {});
builder.addRuleDefinition(new BazelShBinaryRule());
builder.addRuleDefinition(new BazelShTestRule());
try {
Expand Down

This file was deleted.

This file was deleted.

2 changes: 2 additions & 0 deletions src/main/starlark/builtins_bzl/bazel/exports.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ load("@_builtins//:common/python/py_library_macro.bzl", "py_library")
load("@_builtins//:common/python/py_test_macro.bzl", "py_test")
load(":bazel/java/bazel_java_binary.bzl", "java_test")
load(":bazel/java/bazel_java_binary_wrapper.bzl", "java_binary")
load(":bazel/sh/sh_library.bzl", "sh_library")
load(":common/java/java_package_configuration.bzl", "java_package_configuration")
load(":common/java/java_runtime.bzl", "java_runtime")
load(":common/java/java_toolchain.bzl", "java_toolchain")
Expand Down Expand Up @@ -56,5 +57,6 @@ exported_rules = {
"py_binary": py_binary,
"py_test": py_test,
"py_library": py_library,
"sh_library": sh_library,
}
exported_to_java = {}
114 changes: 114 additions & 0 deletions src/main/starlark/builtins_bzl/bazel/sh/sh_library.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# Copyright 2024 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.

coverage_common = _builtins.toplevel.coverage_common

def _sh_library_impl(ctx):
transitive_files = []
for target in ctx.attr.srcs:
transitive_files.append(target[DefaultInfo].files)
for target in ctx.attr.deps:
transitive_files.append(target[DefaultInfo].files)
for target in ctx.attr.data:
transitive_files.append(target[DefaultInfo].files)
files = depset(transitive = transitive_files)

runfiles = ctx.runfiles(transitive_files = files, collect_default = True)

instrumented_files_info = coverage_common.instrumented_files_info(
source_attributes = ["srcs"],
dependency_attributes = ["deps", "data"],
)

return [
DefaultInfo(
files = files,
runfiles = runfiles,
),
instrumented_files_info,
]

sh_library = rule(
_sh_library_impl,
doc = """
<p>
The main use for this rule is to aggregate together a logical
"library" consisting of related scripts&mdash;programs in an
interpreted language that does not require compilation or linking,
such as the Bourne shell&mdash;and any data those programs need at
run-time. Such "libraries" can then be used from
the <code>data</code> attribute of one or
more <code>sh_binary</code> rules.
</p>
<p>
You can use the <a href="${link filegroup}"><code>filegroup</code></a> rule to aggregate data
files.
</p>
<p>
In interpreted programming languages, there's not always a clear
distinction between "code" and "data": after all, the program is
just "data" from the interpreter's point of view. For this reason
this rule has three attributes which are all essentially equivalent:
<code>srcs</code>, <code>deps</code> and <code>data</code>.
The current implementation does not distinguish between the elements of these lists.
All three attributes accept rules, source files and generated files.
It is however good practice to use the attributes for their usual purpose (as with other rules).
</p>
<h4 id="sh_library_examples">Examples</h4>
<pre class="code">
sh_library(
name = "foo",
data = [
":foo_service_script", # an sh_binary with srcs
":deploy_foo", # another sh_binary with srcs
],
)
</pre>
""",
attrs = {
"srcs": attr.label_list(
allow_files = True,
doc = """
The list of input files.
<p>
This attribute should be used to list shell script source files that belong to
this library. Scripts can load other scripts using the shell's <code>source</code>
or <code>.</code> command.
</p>
""",
),
"data": attr.label_list(
allow_files = True,
flags = ["SKIP_CONSTRAINTS_OVERRIDE"],
),
"deps": attr.label_list(
allow_rules = ["sh_library"],
doc = """
The list of "library" targets to be aggregated into this target.
See general comments about <code>deps</code>
at <a href="${link common-definitions#typical.deps}">Typical attributes defined by
most build rules</a>.
<p>
This attribute should be used to list other <code>sh_library</code> rules that provide
interpreted program source code depended on by the code in <code>srcs</code>. The files
provided by these rules will be present among the <code>runfiles</code> of this target.
</p>
""",
),
},
)

0 comments on commit e24e487

Please sign in to comment.