Refactor the Bazel Test configuration to support running tests on a single file or a single test

resources/META-INF/plugin.xml

@@ -720,7 +720,9 @@
     <programRunner implementation="io.flutter.run.bazel.BazelRunner"/>
 
     <configurationType implementation="io.flutter.run.bazelTest.FlutterBazelTestConfigurationType"/>
+    <runConfigurationProducer implementation="io.flutter.run.bazelTest.BazelTestConfigProducer"/>
     <programRunner implementation="io.flutter.run.bazelTest.BazelTestRunner"/>
+    <runLineMarkerContributor language="Dart" implementationClass="io.flutter.run.bazelTest.FlutterBazelTestLineMarkerContributor"/>
 
     <configurationType implementation="io.flutter.run.test.TestConfigType"/>
     <runConfigurationProducer implementation="io.flutter.run.test.TestConfigProducer"/>

resources/META-INF/plugin_template.xml

@@ -196,7 +196,9 @@
     <programRunner implementation="io.flutter.run.bazel.BazelRunner"/>
 
     <configurationType implementation="io.flutter.run.bazelTest.FlutterBazelTestConfigurationType"/>
+    <runConfigurationProducer implementation="io.flutter.run.bazelTest.BazelTestConfigProducer"/>
     <programRunner implementation="io.flutter.run.bazelTest.BazelTestRunner"/>
+    <runLineMarkerContributor language="Dart" implementationClass="io.flutter.run.bazelTest.FlutterBazelTestLineMarkerContributor"/>
 
     <configurationType implementation="io.flutter.run.test.TestConfigType"/>
     <runConfigurationProducer implementation="io.flutter.run.test.TestConfigProducer"/>

src/io/flutter/FlutterBundle.properties

@@ -70,6 +70,8 @@ flutter.run.bazel.noLaunchingScript=No launching script specified
 flutter.run.bazel.launchingScriptNotFound=Launching script not found: {0}
 flutter.run.bazel.noTargetSet=No Bazel target set
 flutter.run.bazel.startWithSlashSlash=Bazel targets should start with '//'
+flutter.run.bazel.newBazelTestRunnerUnavailable=The new Bazel test runner is not available. Only Bazel targets can be run with the old test runner
+flutter.run.bazel.mustUseNewBazelTestRunner=The new Bazel test runner must be enabled to run tests from a specific file or test name. Enable this option from the Flutter plugin settings
 
 flutter.perf.linter.statefulWidget.url=https://docs.flutter.io/flutter/widgets/StatefulWidget-class.html#performance-considerations
 flutter.perf.linter.listViewLoad.url=https://docs.flutter.io/flutter/widgets/ListView-class.html
@@ -221,3 +223,5 @@ settings.flutter.version=Version:
 settings.open.inspector.on.launch=Open Flutter Inspector view on app launch
 settings.hot.reload.on.save=Perform hot reload on save
 settings.disable.tracking.widget.creation=Disable tracking widget creation locations
+settings.enable.bazel.test.runner=Enable new Bazel test runner
+settings.enable.bazel.test.runner.mustSyncClientWarning=(Sync required)

src/io/flutter/bazel/PluginConfig.java

@@ -5,6 +5,7 @@
  */
 package io.flutter.bazel;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Objects;
 import com.google.gson.Gson;
 import com.google.gson.JsonSyntaxException;
@@ -25,7 +26,7 @@
 /**
  * An in-memory snapshot of the flutter.json file from a Bazel workspace.
  */
-class PluginConfig {
+public class PluginConfig {
   private final @NotNull Fields fields;
 
   private PluginConfig(@NotNull Fields fields) {
@@ -47,6 +48,11 @@ String getLaunchScript() {
     return fields.launchScript;
   }
 
+  @Nullable
+  String getTestScript() {
+    return fields.testScript;
+  }
+
   @Override
   public boolean equals(Object obj) {
     if (!(obj instanceof PluginConfig)) return false;
@@ -91,6 +97,22 @@ PluginConfig load(@NotNull VirtualFile file) {
     return ApplicationManager.getApplication().runReadAction(readAction);
   }
 
+  @VisibleForTesting
+  public static PluginConfig forTest(
+    @Nullable String daemonScript,
+    @Nullable String doctorScript,
+    @Nullable String launchScript,
+    @Nullable String testScript
+  ) {
+    final Fields fields = new Fields(
+      daemonScript,
+      doctorScript,
+      launchScript,
+      testScript
+    );
+    return new PluginConfig(fields);
+  }
+
   /**
    * The JSON fields in a PluginConfig, as loaded from disk.
    */
@@ -109,26 +131,43 @@ private static class Fields {
     private String doctorScript;
 
     /**
-     *
+     * The script to run to start 'bazel'
      */
     @SerializedName("launchScript")
     private String launchScript;
 
+    /**
+     * The script to run to start 'flutter test'
+     */
+    @SerializedName("testScript")
+    private String testScript;
+
     Fields() {
     }
 
+    /**
+     * Convenience constructor that takes all
+     */
+    Fields(String daemonScript, String doctorScript, String launchScript, String testScript) {
+      this.daemonScript = daemonScript;
+      this.doctorScript = doctorScript;
+      this.launchScript = launchScript;
+      this.testScript = testScript;
+    }
+
     @Override
     public boolean equals(Object obj) {
       if (!(obj instanceof Fields)) return false;
       final Fields other = (Fields)obj;
       return Objects.equal(daemonScript, other.daemonScript)
              && Objects.equal(doctorScript, other.doctorScript)
-             && Objects.equal(launchScript, other.launchScript);
+             && Objects.equal(launchScript, other.launchScript)
+             && Objects.equal(testScript, other.testScript);
     }
 
     @Override
     public int hashCode() {
-      return Objects.hashCode(daemonScript, doctorScript, launchScript);
+      return Objects.hashCode(daemonScript, doctorScript, launchScript, testScript);
     }
   }
 

src/io/flutter/bazel/Workspace.java

@@ -5,6 +5,7 @@
  */
 package io.flutter.bazel;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Joiner;
 import com.google.common.base.Objects;
 import com.google.common.collect.ImmutableSet;
@@ -35,15 +36,18 @@ public class Workspace {
   @Nullable private final PluginConfig config;
   @Nullable private final String daemonScript;
   @Nullable private final String doctorScript;
+  @Nullable private final String testScript;
 
   private Workspace(@NotNull VirtualFile root,
                     @Nullable PluginConfig config,
                     @Nullable String daemonScript,
-                    @Nullable String doctorScript) {
+                    @Nullable String doctorScript,
+                    @Nullable String testScript) {
     this.root = root;
     this.config = config;
     this.daemonScript = daemonScript;
     this.doctorScript = doctorScript;
+    this.testScript = testScript;
   }
 
   /**
@@ -119,6 +123,14 @@ public String getLaunchScript() {
     return (config == null) ? null : config.getLaunchScript();
   }
 
+  /**
+   * Returns the script that starts 'flutter test', or null if not configured.
+   */
+  @Nullable
+  public String getTestScript() {
+    return testScript;
+  }
+
   /**
    * Returns true if the plugin config was loaded.
    */
@@ -171,45 +183,48 @@ public static Workspace load(@NotNull Project project) {
     }
     final PluginConfig config = configFile == null ? null : PluginConfig.load(configFile);
 
-    final String daemonScript;
-    if (config == null || config.getDaemonScript() == null) {
-      daemonScript = null;
-    }
-    else {
-      final String script = config.getDaemonScript();
-      final String readonlyScript = readonlyPath + "/" + script;
-      if (root.findFileByRelativePath(script) != null) {
-        daemonScript = script;
-      }
-      else if (root.findFileByRelativePath(readonlyScript) != null) {
-        daemonScript = readonlyScript;
-      }
-      else {
-        daemonScript = null;
-      }
-    }
+    final String daemonScript = config == null ? null : getScriptFromPath(root, readonlyPath, config.getDaemonScript());
+
+    final String doctorScript = config == null ? null : getScriptFromPath(root, readonlyPath, config.getDoctorScript());
+
+    final String testScript = config == null ? null : getScriptFromPath(root, readonlyPath, config.getTestScript());
+
+    return new Workspace(root, config, daemonScript, doctorScript, testScript);
+  }
+
+  @VisibleForTesting
+  public static Workspace forTest(VirtualFile workspaceRoot, PluginConfig pluginConfig) {
+    return new Workspace(
+      workspaceRoot,
+      pluginConfig,
+      pluginConfig.getDaemonScript(),
+      pluginConfig.getDoctorScript(),
+      pluginConfig.getTestScript()
+    );
+  }
 
-    final String doctorScript;
-    if (config == null || config.getDoctorScript() == null) {
-      doctorScript = null;
+  /**
+   * Attempts to find a script inside of the workspace.
+   * @param root the workspace root.
+   * @param readonlyPath the relative path to the readonly contents of the workspace.
+   * @param relativeScriptPath the relative path to the desired script inside of the workspace.
+   * @return the script's path relative to the workspace, or null if it was not found.
+   */
+  private static String getScriptFromPath(@NotNull VirtualFile root, @NotNull String readonlyPath, @Nullable String relativeScriptPath) {
+    if (relativeScriptPath == null) {
+      return null;
     }
-    else {
-      final String script = config.getDoctorScript();
-      final String readonlyScript = readonlyPath + "/" + script;
-      if (root.findFileByRelativePath(script) != null) {
-        doctorScript = script;
-      }
-      else if (root.findFileByRelativePath(readonlyScript) != null) {
-        doctorScript = readonlyScript;
-      }
-      else {
-        doctorScript = null;
-      }
+    final String readonlyScriptPath = readonlyPath + "/" + relativeScriptPath;
+    if (root.findFileByRelativePath(relativeScriptPath) != null) {
+      return relativeScriptPath;
     }
-
-    return new Workspace(root, config, daemonScript, doctorScript);
+    if (root.findFileByRelativePath(readonlyScriptPath) != null) {
+      return readonlyScriptPath;
+    }
+    return null;
   }
 
+
   /**
    * Returns the Bazel WORKSPACE file for a Project, or null if not using Bazel.
    * <p>

src/io/flutter/run/bazelTest/BazelTestConfig.java

@@ -15,17 +15,20 @@
 import com.intellij.openapi.util.WriteExternalException;
 import com.intellij.util.xmlb.SkipDefaultValuesSerializationFilters;
 import com.intellij.util.xmlb.XmlSerializer;
+import io.flutter.bazel.Workspace;
 import org.jdom.Element;
 import org.jetbrains.annotations.NotNull;
 
 /**
  * The Bazel version of the {@link io.flutter.run.test.TestConfig}.
  */
 public class BazelTestConfig extends LocatableConfigurationBase {
-  @NotNull private BazelTestFields fields = new BazelTestFields();
+  @NotNull private BazelTestFields fields;
 
   BazelTestConfig(@NotNull final Project project, @NotNull final ConfigurationFactory factory, @NotNull final String name) {
     super(project, factory, name);
+    final Workspace workspace = Workspace.load(project);
+    fields = new BazelTestFields(null, null, null);
   }
 
   @NotNull
@@ -72,12 +75,12 @@ RunConfiguration copyTemplateToNonTemplate(String name) {
   @Override
   public void writeExternal(@NotNull final Element element) throws WriteExternalException {
     super.writeExternal(element);
-    XmlSerializer.serializeInto(fields, element, new SkipDefaultValuesSerializationFilters());
+    fields.writeTo(element);
   }
 
   @Override
   public void readExternal(@NotNull final Element element) throws InvalidDataException {
     super.readExternal(element);
-    XmlSerializer.deserializeInto(fields, element);
+    fields = BazelTestFields.readFrom(element);
   }
 }