Skip to content

Commit

Permalink
target pattern file: allow comments
Browse files Browse the repository at this point in the history
`--target_pattern_file` could be a great tool assisting migration of a
code base from one Bazel config to another.  User could define a list of
targets that can be built with the new configs and incrementally expand
that list with each change that was introduced.  Multiple users / teams
could collaborate on such migration by adding / removing their targets
into / from the pattern file.

Having the ability to provide comments to annotate the targets in the
pattern file with extra information during the migration process added a
great value and context for build maintainers to track migration
progress.

Add support for Bash-style comments to the target-pattern file.

Closes bazelbuild#15903.

PiperOrigin-RevId: 461861131
Change-Id: I401f71fcf1e343c8689424979e4f48fb723fba9f
  • Loading branch information
sluongng authored and aranguyen committed Jul 20, 2022
1 parent 3179496 commit f17658a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

package com.google.devtools.build.lib.runtime.commands;

import static com.google.common.collect.ImmutableList.toImmutableList;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.common.base.Preconditions;
Expand All @@ -29,6 +30,7 @@
import com.google.devtools.common.options.OptionsParsingResult;
import java.io.IOException;
import java.util.List;
import java.util.function.Predicate;

/** Provides support for reading target patterns from a file or the command-line. */
final class TargetPatternsHelper {
Expand All @@ -54,7 +56,12 @@ public static List<String> readFrom(CommandEnvironment env, OptionsParsingResult
Path residuePath =
env.getWorkingDirectory().getRelative(buildRequestOptions.targetPatternFile);
try {
targets = FileSystemUtils.readLines(residuePath, UTF_8);
targets =
FileSystemUtils.readLines(residuePath, UTF_8).stream()
.map(s -> s.split("#")[0])
.map(String::trim)
.filter(Predicate.not(String::isEmpty))
.collect(toImmutableList());
} catch (IOException e) {
throw new TargetPatternsHelperException(
"I/O error reading from " + residuePath.getPathString() + ": " + e.getMessage(),
Expand Down
3 changes: 2 additions & 1 deletion src/test/shell/integration/target_pattern_file_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ sh_test(name = "y", srcs = ["x.out"])
EOF

cat >build.params <<'EOF'
//:x
# Test comment
//:x # Trailing comment
//:y
EOF
}
Expand Down

0 comments on commit f17658a

Please sign in to comment.