base/src/com/google/idea/blaze/base/run/state/BlazeCommandRunConfigurationCommonState.java

/*
 * Copyright 2016 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.idea.blaze.base.run.state;

import com.google.idea.blaze.base.command.BlazeCommandName;
import com.google.idea.blaze.base.command.BlazeFlags;
import com.google.idea.blaze.base.run.state.BlazeRunOnDistributedExecutorState.RunOnExecutorStateEditor;
import com.google.idea.blaze.base.settings.Blaze.BuildSystem;
import com.intellij.execution.configurations.RuntimeConfigurationError;
import com.intellij.execution.configurations.RuntimeConfigurationException;
import com.intellij.openapi.project.Project;
import java.io.File;
import javax.annotation.Nullable;

/**
 * Shared state common to several {@link
 * com.google.idea.blaze.base.run.confighandler.BlazeCommandRunConfigurationHandler} types.
 */
public final class BlazeCommandRunConfigurationCommonState extends RunConfigurationCompositeState {
  private static final String USER_BLAZE_FLAG_TAG = "blaze-user-flag";
  private static final String USER_EXE_FLAG_TAG = "blaze-user-exe-flag";

  private final BlazeCommandState command;
  private final RunConfigurationFlagsState blazeFlags;
  private final RunConfigurationFlagsState exeFlags;
  private final BlazeBinaryState blazeBinary;
  private final BlazeRunOnDistributedExecutorState runOnDistributedExecutor;

  public BlazeCommandRunConfigurationCommonState(BuildSystem buildSystem) {
    command = new BlazeCommandState();
    blazeFlags = new RunConfigurationFlagsState(USER_BLAZE_FLAG_TAG, buildSystem + " flags:");
    exeFlags = new RunConfigurationFlagsState(USER_EXE_FLAG_TAG, "Executable flags:");
    blazeBinary = new BlazeBinaryState();
    runOnDistributedExecutor = new BlazeRunOnDistributedExecutorState(buildSystem);
    addStates(command, blazeFlags, exeFlags, blazeBinary, runOnDistributedExecutor);
  }

  /** @return The list of blaze flags that the user specified manually. */
  public RunConfigurationFlagsState getBlazeFlagsState() {
    return blazeFlags;
  }

  /** @return The list of executable flags the user specified manually. */
  public RunConfigurationFlagsState getExeFlagsState() {
    return exeFlags;
  }

  public BlazeBinaryState getBlazeBinaryState() {
    return blazeBinary;
  }

  public BlazeCommandState getCommandState() {
    return command;
  }

  public BlazeRunOnDistributedExecutorState getRunOnDistributedExecutorState() {
    return runOnDistributedExecutor;
  }

  /** Searches through all blaze flags for the first one beginning with '--test_filter' */
  @Nullable
  public String getTestFilterFlag() {
    for (String flag : getBlazeFlagsState().getExpandedFlags()) {
      if (flag.startsWith(BlazeFlags.TEST_FILTER)) {
        return flag;
      }
    }
    return null;
  }

  public void validate(String buildSystemName) throws RuntimeConfigurationException {
    if (getCommandState().getCommand() == null) {
      throw new RuntimeConfigurationError("You must specify a command.");
    }
    String blazeBinaryString = getBlazeBinaryState().getBlazeBinary();
    if (blazeBinaryString != null && !(new File(blazeBinaryString).exists())) {
      throw new RuntimeConfigurationError(buildSystemName + " binary does not exist");
    }
  }

  @Override
  public RunConfigurationStateEditor getEditor(Project project) {
    return new RunConfigurationCompositeStateEditor(project, getStates()) {

      @Nullable
      private final RunOnExecutorStateEditor runOnExecutorEditor =
          (RunOnExecutorStateEditor)
              editors
                  .stream()
                  .filter(editor -> editor instanceof RunOnExecutorStateEditor)
                  .findFirst()
                  .orElse(null);

      @Override
      public void applyEditorTo(RunConfigurationState genericState) {
        BlazeCommandRunConfigurationCommonState state =
            (BlazeCommandRunConfigurationCommonState) genericState;
        super.applyEditorTo(genericState);

        // this editor needs to update based on state provided by other children.
        if (runOnExecutorEditor != null) {
          boolean isTest = BlazeCommandName.TEST.equals(state.getCommandState().getCommand());
          runOnExecutorEditor.updateVisibility(isTest);
        }
      }
    };
  }
}