Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a helper rule for selecting a file from outputs of another rul… #233

Merged
merged 7 commits into from Feb 27, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions rules/select_file.bzl
@@ -0,0 +1,36 @@
"""
select_file() build rule implementation.

Selects a single file from the outputs of some target by given relative path.
"""

def _impl(ctx):
if ctx.attr.subpath and len(ctx.attr.subpath) == 0:
fail("Subpath can not be empty.")

out = None
canonical = ctx.attr.subpath.replace("\\", "/")
jin marked this conversation as resolved.
Show resolved Hide resolved
for file_ in ctx.attr.srcs.files.to_list():
if file_.path.replace("\\", "/").endswith(canonical):
out = file_
break
if not out:
files_str = ",\n".join([str(f.path) \
for f in ctx.attr.srcs.files.to_list()])
irengrig marked this conversation as resolved.
Show resolved Hide resolved
fail("Can not find specified file in [%s]" % files_str)
return [DefaultInfo(files = depset([out]))]

select_file = rule(
implementation = _impl,
doc = "Selects a single file from the outputs of some target \
by given relative path",
attrs = {
"srcs": attr.label(
irengrig marked this conversation as resolved.
Show resolved Hide resolved
allow_files = True,
mandatory = True,
doc = "The target producing the file among other outputs"),
"subpath": attr.string(
mandatory = True,
doc = "Relative path to the file"),
},
)
34 changes: 34 additions & 0 deletions tests/select_file/BUILD
@@ -0,0 +1,34 @@
load("//rules:select_file.bzl", "select_file")
load("//rules:diff_test.bzl", "diff_test")

filegroup(
name = "fg",
srcs = [
"subdir/inner.txt",
":select_me.txt",
],
)

select_file(
name = "select_me",
srcs = ":fg",
subpath = "select_me.txt",
)

select_file(
name = "select_inner",
srcs = ":fg",
subpath = "subdir/inner.txt",
)

diff_test(
irengrig marked this conversation as resolved.
Show resolved Hide resolved
name = "selected_me",
file1 = ":select_me",
file2 = ":select_me.txt",
)

diff_test(
name = "selected_inner",
file1 = ":select_inner",
file2 = "subdir/inner.txt",
)
1 change: 1 addition & 0 deletions tests/select_file/select_me.txt
@@ -0,0 +1 @@
Outer
1 change: 1 addition & 0 deletions tests/select_file/subdir/inner.txt
@@ -0,0 +1 @@
Inner