aswb/src/com/google/idea/blaze/android/run/test/BlazeAndroidTestRunConfigurationType.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.android.run.test;

import com.google.idea.blaze.base.run.BlazeCommandRunConfiguration;
import com.google.idea.blaze.base.run.BlazeCommandRunConfigurationType;
import com.google.idea.blaze.base.settings.Blaze;
import com.intellij.execution.BeforeRunTask;
import com.intellij.execution.configurations.ConfigurationFactory;
import com.intellij.execution.configurations.ConfigurationType;
import com.intellij.execution.configurations.ConfigurationTypeUtil;
import com.intellij.execution.configurations.UnknownConfigurationType;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Key;
import com.intellij.ui.LayeredIcon;
import icons.AndroidIcons;
import javax.swing.Icon;
import org.jetbrains.annotations.NotNull;

/**
 * A type for Android test run configurations adapted specifically to run android_test targets.
 *
 * @deprecated See {@link com.google.idea.blaze.base.run.BlazeCommandRunConfigurationType}. Retained
 *     in 1.9 for legacy purposes, to allow existing BlazeAndroidTestRunConfigurations to be updated
 *     to BlazeCommandRunConfigurations. Intended to be removed in 2.1.
 */
// Hack: extend UnknownConfigurationType to completely hide it in the Run/Debug Configurations UI.
@Deprecated
public class BlazeAndroidTestRunConfigurationType extends UnknownConfigurationType {
  private static final Icon ANDROID_TEST_ICON;

  static {
    LayeredIcon icon = new LayeredIcon(2);
    icon.setIcon(AndroidIcons.Android, 0);
    icon.setIcon(AllIcons.Nodes.JunitTestMark, 1);
    ANDROID_TEST_ICON = icon;
  }

  private final BlazeAndroidTestRunConfigurationFactory factory =
      new BlazeAndroidTestRunConfigurationFactory(this);

  static class BlazeAndroidTestRunConfigurationFactory extends ConfigurationFactory {

    protected BlazeAndroidTestRunConfigurationFactory(@NotNull ConfigurationType type) {
      super(type);
    }

    @Override
    public String getName() {
      // Used to look up this ConfigurationFactory.
      // Preserve value so legacy configurations can be loaded.
      return Blaze.defaultBuildSystemName() + " Android Test";
    }

    @Override
    @NotNull
    public BlazeCommandRunConfiguration createTemplateConfiguration(@NotNull Project project) {
      // Create a BlazeCommandRunConfiguration instead, to update legacy configurations.
      return BlazeCommandRunConfigurationType.getInstance()
          .getFactory()
          .createTemplateConfiguration(project);
    }

    @Override
    public boolean canConfigurationBeSingleton() {
      return false;
    }

    @Override
    public boolean isApplicable(@NotNull Project project) {
      return Blaze.isBlazeProject(project);
    }

    @Override
    public void configureBeforeRunTaskDefaults(
        Key<? extends BeforeRunTask> providerID, BeforeRunTask task) {
      // Removed BlazeAndroidBeforeRunTaskProvider; this method won't be called anymore anyhow.
    }

    @Override
    public boolean isConfigurationSingletonByDefault() {
      return true;
    }
  }

  public static BlazeAndroidTestRunConfigurationType getInstance() {
    return ConfigurationTypeUtil.findConfigurationType(BlazeAndroidTestRunConfigurationType.class);
  }

  @Override
  public String getDisplayName() {
    return "Legacy " + Blaze.defaultBuildSystemName() + " Android Test";
  }

  @Override
  public String getConfigurationTypeDescription() {
    return "Launch/debug configuration for android_test rules "
        + "Use Blaze Command instead; this legacy configuration type is being removed.";
  }

  @Override
  public Icon getIcon() {
    return ANDROID_TEST_ICON;
  }

  @Override
  @NotNull
  public String getId() {
    // Used to look up this ConfigurationType.
    // Preserve value so legacy configurations can be loaded.
    return "BlazeAndroidTestRunConfigurationType";
  }

  @Override
  public BlazeAndroidTestRunConfigurationFactory[] getConfigurationFactories() {
    return new BlazeAndroidTestRunConfigurationFactory[] {factory};
  }
}