Skip to content

Make the default behavior of pkg_files#strip_prefix more intuitive; rename it to srcs_strip_prefix #656

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.

Sign up for GitHub

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

Open
nacl wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Make the default behavior of pkg_files#strip_prefix more intuitive; rename it to srcs_strip_prefix #656

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6f25b27
Implement the changes
nacl Jan 5, 2023
a0e439f
Implement the migration script
nacl Jan 5, 2023
f23749f
Implement manual updates
nacl Jan 5, 2023
c2850e7
Apply the migration script
nacl Jan 5, 2023
8ea822b
Update examples to account for new behavior
nacl Jan 5, 2023
e725679
Include in distro tarball
nacl Jan 5, 2023
3b1c784
Subclass from a different codemod transformer; fill in bugs; fix inde…
nacl Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Implement manual updates 
The migration script, due to its relative simplicity, only knows how to operate
on BUILD files.  This change provides analogous changes within our macros, which
are mostly used in our unit tests.
  • Loading branch information
@nacl
nacl committed Jan 5, 2023
commit f23749f044aff6c08c83cc03ebc2c7d384802571
2 changes: 1 addition & 1 deletion tests/mappings/external_repo/pkg/test.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def test_referencing_remote_file(name):
prefix = "usr/share",
srcs = ["@//tests:loremipsum_txt"],
# The prefix in rules_pkg. Why yes, this is knotty
strip_prefix = strip_prefix.from_root("tests"),
srcs_strip_prefix = strip_prefix.from_root("tests"),
tags = ["manual"],
)

Expand Down
8 changes: 4 additions & 4 deletions tests/mappings/mappings_external_repo_test.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def _test_pkg_files_extrepo():
pkg_files(
name = "pf_extrepo_strip_from_pkg_g",
srcs = ["@mappings_test_external_repo//pkg:dir/script"],
strip_prefix = strip_prefix.from_pkg("dir"),
srcs_strip_prefix = strip_prefix.from_pkg("dir"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand All @@ -59,7 +59,7 @@ def _test_pkg_files_extrepo():
pkg_files(
name = "pf_extrepo_strip_from_root_g",
srcs = ["@mappings_test_external_repo//pkg:dir/script"],
strip_prefix = strip_prefix.from_root("pkg"),
srcs_strip_prefix = strip_prefix.from_root("pkg"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand All @@ -80,7 +80,7 @@ def _test_pkg_files_extrepo():
srcs = [":extrepo_test_fg"],
# Files within filegroups should be considered relative to their
# destination paths.
strip_prefix = strip_prefix.from_pkg(""),
srcs_strip_prefix = strip_prefix.from_pkg(""),
)
pkg_files_contents_test(
name = "pf_extrepo_filegroup_strip_from_pkg",
Expand All @@ -94,7 +94,7 @@ def _test_pkg_files_extrepo():
srcs = [":extrepo_test_fg"],
# Files within filegroups should be considered relative to their
# destination paths.
strip_prefix = strip_prefix.from_root("pkg"),
srcs_strip_prefix = strip_prefix.from_root("pkg"),
)
pkg_files_contents_test(
name = "pf_extrepo_filegroup_strip_from_root",
Expand Down
35 changes: 18 additions & 17 deletions tests/mappings/mappings_test.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ pkg_files_contents_test = analysistest.make(
)

def _test_pkg_files_contents():
# Test stripping when no arguments are provided (same as strip_prefix.files_only())
# Test stripping when no arguments are provided (same as strip_prefix.flatten())
pkg_files(
name = "pf_no_strip_prefix_g",
srcs = ["testdata/hello.txt"],
Expand All @@ -120,17 +120,17 @@ def _test_pkg_files_contents():
),
)

# And now, files_only = True
# And now, flatten = True
pkg_files(
name = "pf_files_only_g",
name = "pf_flatten_g",
srcs = ["testdata/hello.txt"],
strip_prefix = strip_prefix.files_only(),
srcs_strip_prefix = strip_prefix.flatten(),
tags = ["manual"],
)

pkg_files_contents_test(
name = "pf_files_only",
target_under_test = ":pf_files_only_g",
name = "pf_flatten",
target_under_test = ":pf_flatten_g",
expected_dests = ["hello.txt"],
)

Expand All @@ -148,7 +148,7 @@ def _test_pkg_files_contents():
"testdata/hello.txt",
":testdata/test_script",
],
strip_prefix = strip_prefix.from_pkg("testdata/"),
srcs_strip_prefix = strip_prefix.from_pkg("testdata/"),
tags = ["manual"],
)

Expand All @@ -174,7 +174,7 @@ def _test_pkg_files_contents():
pkg_files(
name = "pf_from_root_g",
srcs = [":testdata/test_script"],
strip_prefix = strip_prefix.from_root("tests/mappings"),
srcs_strip_prefix = strip_prefix.from_root("tests/mappings"),
tags = ["manual"],
)

Expand All @@ -194,7 +194,7 @@ def _test_pkg_files_contents():
pkg_files(
name = "pf_attributes_mode_overlay_if_not_provided_g",
srcs = ["foo"],
strip_prefix = strip_prefix.from_pkg(),
srcs_strip_prefix = strip_prefix.from_pkg(),
attributes = pkg_attributes(
user = "foo",
group = "bar",
Expand All @@ -219,6 +219,7 @@ def _test_pkg_files_contents():
pkg_files(
name = "pf_destination_collision_invalid_g",
srcs = ["foo", "bar/foo"],
srcs_strip_prefix = strip_prefix.flatten(),
tags = ["manual"],
)
generic_negative_test(
Expand All @@ -230,7 +231,7 @@ def _test_pkg_files_contents():
pkg_files(
name = "pf_strip_prefix_from_package_invalid_g",
srcs = ["foo/foo", "bar/foo"],
strip_prefix = strip_prefix.from_pkg("bar"),
srcs_strip_prefix = strip_prefix.from_pkg("bar"),
tags = ["manual"],
)
generic_negative_test(
Expand All @@ -242,7 +243,7 @@ def _test_pkg_files_contents():
pkg_files(
name = "pf_strip_prefix_from_root_invalid_g",
srcs = ["foo", "bar"],
strip_prefix = strip_prefix.from_root("not/the/root"),
srcs_strip_prefix = strip_prefix.from_root("not/the/root"),
tags = ["manual"],
)
generic_negative_test(
Expand Down Expand Up @@ -293,7 +294,7 @@ def _test_pkg_files_exclusions():
name = "pf_exclude_by_label_strip_from_pkg_g",
srcs = [":test_base_fg"],
excludes = ["//tests/mappings:testdata/config"],
strip_prefix = strip_prefix.from_pkg("testdata"),
srcs_strip_prefix = strip_prefix.from_pkg("testdata"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand All @@ -306,7 +307,7 @@ def _test_pkg_files_exclusions():
name = "pf_exclude_by_filename_strip_from_pkg_g",
srcs = [":test_base_fg"],
excludes = ["testdata/config"],
strip_prefix = strip_prefix.from_pkg("testdata"),
srcs_strip_prefix = strip_prefix.from_pkg("testdata"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand All @@ -320,7 +321,7 @@ def _test_pkg_files_exclusions():
name = "pf_exclude_by_label_strip_from_root_g",
srcs = [":test_base_fg"],
excludes = ["//tests/mappings:testdata/config"],
strip_prefix = strip_prefix.from_root("tests/mappings"),
srcs_strip_prefix = strip_prefix.from_root("tests/mappings"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand All @@ -333,7 +334,7 @@ def _test_pkg_files_exclusions():
name = "pf_exclude_by_filename_strip_from_root_g",
srcs = [":test_base_fg"],
excludes = ["testdata/config"],
strip_prefix = strip_prefix.from_root("tests/mappings"),
srcs_strip_prefix = strip_prefix.from_root("tests/mappings"),
tags = ["manual"],
)
pkg_files_contents_test(
Expand Down Expand Up @@ -874,7 +875,7 @@ def _test_pkg_filegroup(name):

def _strip_prefix_test_impl(ctx):
env = unittest.begin(ctx)
asserts.equals(env, ".", strip_prefix.files_only())
asserts.equals(env, ".", strip_prefix.flatten())
asserts.equals(env, "path", strip_prefix.from_pkg("path"))
asserts.equals(env, "path", strip_prefix.from_pkg("/path"))
asserts.equals(env, "/path", strip_prefix.from_root("path"))
Expand Down Expand Up @@ -903,7 +904,7 @@ def mappings_analysis_tests():
# buildifier: don't sort
# Simple tests
":pf_no_strip_prefix",
":pf_files_only",
":pf_flatten",
":pf_strip_testdata_from_pkg",
":pf_strip_prefix_from_root",
":pf_attributes_mode_overlay_if_not_provided",
Expand Down