target pattern file: allow comments

sluongng · copybara-github · commit 2a8d0ad71035 · 2022-07-19T05:53:58.000-07:00
`--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 #15903. PiperOrigin-RevId: 461861131 Change-Id: I401f71fcf1e343c8689424979e4f48fb723fba9f
diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/TargetPatternsHelper.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/TargetPatternsHelper.java
@@ -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;
@@ -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 {
@@ -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(),
diff --git a/src/test/shell/integration/target_pattern_file_test.sh b/src/test/shell/integration/target_pattern_file_test.sh
@@ -73,7 +73,8 @@ sh_test(name = "y", srcs = ["x.out"])
 EOF
 
   cat >build.params <<'EOF'
-//:x
+# Test comment
+//:x # Trailing comment
 //:y
 EOF
 }

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,8 @@ sh_test(name = "y", srcs = ["x.out"])`
`73`	`73`	`EOF`
`74`	`74`
`75`	`75`	`cat >build.params <<'EOF'`
`76`		`-//:x`
	`76`	`+# Test comment`
	`77`	`+//:x # Trailing comment`
`77`	`78`	`//:y`
`78`	`79`	`EOF`
`79`	`80`	`}`