Add check so --flag_alias can be enabled/disabled on the command line.
For #11750
RELNOTES: None.
PiperOrigin-RevId: 332302279
diff --git a/src/main/java/com/google/devtools/build/lib/runtime/BlazeOptionHandler.java b/src/main/java/com/google/devtools/build/lib/runtime/BlazeOptionHandler.java
index 08ee88c..6f56907 100644
--- a/src/main/java/com/google/devtools/build/lib/runtime/BlazeOptionHandler.java
+++ b/src/main/java/com/google/devtools/build/lib/runtime/BlazeOptionHandler.java
@@ -20,6 +20,7 @@
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ListMultimap;
import com.google.common.flogger.GoogleLogger;
+import com.google.devtools.build.lib.analysis.config.CoreOptions;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
@@ -41,6 +42,7 @@
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
+import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
@@ -217,7 +219,6 @@
// proper rcfiles. The --default_override options should be parsed with the --rc_source since
// {@link #parseRcOptions} depends on the list populated by the {@link
// ClientOptions#OptionOverrideConverter}.
-
ImmutableList.Builder<String> defaultOverridesAndRcSources = new ImmutableList.Builder<>();
ImmutableList.Builder<String> remainingCmdLine = new ImmutableList.Builder<>();
partitionCommandLineArgs(cmdLineAfterCommand, defaultOverridesAndRcSources, remainingCmdLine);
@@ -242,6 +243,9 @@
optionsParser.parseWithSourceFunction(
PriorityCategory.COMMAND_LINE, commandOptionSourceFunction, remainingCmdLine.build());
+ // TODO(b/132346407) : Remove when shorthand aliasing is fully implemented
+ validateFlagAliasUsage(optionsParser);
+
if (commandAnnotation.builds()) {
// splits project files from targets in the traditional sense
ProjectFileSupport.handleProjectFiles(
@@ -517,4 +521,41 @@
}
}
}
+
+ private static void validateFlagAliasUsage(OptionsParser optionsParser)
+ throws OptionsParsingException {
+
+ CoreOptions coreOptions = optionsParser.getOptions(CoreOptions.class);
+
+ // --flag_alias would've thrown an error before reaching this if it was used, but CoreOptions
+ // may not necessarily be present
+ if (coreOptions == null) {
+ return;
+ }
+
+ List<Map.Entry<String, String>> collectedAliases = coreOptions.commandLineFlagAliases;
+ if (collectedAliases.isEmpty()) {
+ return;
+ }
+
+ if (coreOptions.enableFlagAlias) {
+ return;
+ }
+
+ String detectedAliases =
+ "Detected aliases: --flag_alias="
+ + collectedAliases.get(0).getKey()
+ + "="
+ + collectedAliases.get(0).getValue();
+ for (int i = 1; i < collectedAliases.size(); i++) {
+ Map.Entry<String, String> entry = collectedAliases.get(i);
+ String aliasString = ", --flag_alias=" + entry.getKey() + "=" + entry.getValue();
+ detectedAliases += aliasString;
+ }
+
+ throw new OptionsParsingException(
+ "--flag_alias is experimental. Set --experimental_enable_flag_alias to true to make use of"
+ + " it. "
+ + detectedAliases);
+ }
}
diff --git a/src/test/java/com/google/devtools/build/lib/runtime/AbstractBlazeOptionHandlerTest.java b/src/test/java/com/google/devtools/build/lib/runtime/AbstractBlazeOptionHandlerTest.java
index 350f0b4..5e6fc31 100644
--- a/src/test/java/com/google/devtools/build/lib/runtime/AbstractBlazeOptionHandlerTest.java
+++ b/src/test/java/com/google/devtools/build/lib/runtime/AbstractBlazeOptionHandlerTest.java
@@ -16,6 +16,7 @@
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.ServerDirectories;
+import com.google.devtools.build.lib.analysis.config.CoreOptions;
import com.google.devtools.build.lib.bazel.rules.BazelRulesModule;
import com.google.devtools.build.lib.events.StoredEventHandler;
import com.google.devtools.build.lib.runtime.proto.InvocationPolicyOuterClass.InvocationPolicy;
@@ -28,6 +29,7 @@
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
+// TODO(b/132346407): Consider refactoring into a helper object instead of an abstract class
/** Abstract class for setting up tests that make use of {@link BlazeOptionHandler}. */
@RunWith(JUnit4.class)
public abstract class AbstractBlazeOptionHandlerTest {
@@ -42,7 +44,11 @@
public void initStuff() throws Exception {
parser =
OptionsParser.builder()
- .optionsClasses(TestOptions.class, CommonCommandOptions.class, ClientOptions.class)
+ .optionsClasses(
+ TestOptions.class,
+ CommonCommandOptions.class,
+ ClientOptions.class,
+ CoreOptions.class)
.allowResidue(true)
.build();
String productName = TestConstants.PRODUCT_NAME;
diff --git a/src/test/java/com/google/devtools/build/lib/runtime/FlagAliasTest.java b/src/test/java/com/google/devtools/build/lib/runtime/FlagAliasTest.java
new file mode 100644
index 0000000..34ff029
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/lib/runtime/FlagAliasTest.java
@@ -0,0 +1,85 @@
+// Copyright 2020 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.
+package com.google.devtools.build.lib.runtime;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.common.collect.ImmutableList;
+import com.google.devtools.build.lib.events.Event;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests --flag_alias functionality in {@link BlazeOptionHandler}. */
+@RunWith(JUnit4.class)
+public final class FlagAliasTest extends AbstractBlazeOptionHandlerTest {
+
+ @Test
+ public void useAliasWithoutSettingFeature() {
+ ImmutableList<String> args =
+ ImmutableList.of("c0", "--rc_source=/somewhere/.blazerc", "--flag_alias=foo=bar");
+ optionHandler.parseOptions(args, eventHandler);
+ assertThat(eventHandler.getEvents())
+ .contains(
+ Event.error(
+ "--flag_alias is experimental. Set --experimental_enable_flag_alias to true to"
+ + " make use of it. Detected aliases: --flag_alias=foo=bar"));
+ }
+
+ @Test
+ public void useAliasWithSetDisabledFeature() {
+ ImmutableList<String> args =
+ ImmutableList.of(
+ "c0",
+ "--rc_source=/somewhere/.blazerc",
+ "--noexperimental_enable_flag_alias",
+ "--flag_alias=foo=bar");
+ optionHandler.parseOptions(args, eventHandler);
+ assertThat(eventHandler.getEvents())
+ .contains(
+ Event.error(
+ "--flag_alias is experimental. Set --experimental_enable_flag_alias to true to"
+ + " make use of it. Detected aliases: --flag_alias=foo=bar"));
+ }
+
+ @Test
+ public void useAliasWithSetEnabledFeature() {
+ ImmutableList<String> args =
+ ImmutableList.of(
+ "c0",
+ "--rc_source=/somewhere/.blazerc",
+ "--experimental_enable_flag_alias",
+ "--flag_alias=foo=bar");
+ optionHandler.parseOptions(args, eventHandler);
+ assertThat(eventHandler.hasErrors()).isFalse();
+ }
+
+ @Test
+ public void multipleAliasesLoggedInError() {
+ ImmutableList<String> args =
+ ImmutableList.of(
+ "c0",
+ "--rc_source=/somewhere/.blazerc",
+ "--noexperimental_enable_flag_alias",
+ "--flag_alias=foo=bar",
+ "--flag_alias=baz=baz2");
+ optionHandler.parseOptions(args, eventHandler);
+ assertThat(eventHandler.getEvents())
+ .contains(
+ Event.error(
+ "--flag_alias is experimental. Set --experimental_enable_flag_alias to true to"
+ + " make use of it. Detected aliases: --flag_alias=foo=bar,"
+ + " --flag_alias=baz=baz2"));
+ }
+}
