OSSPantsActionOverrideTest.java

// Copyright 2016 Pants project contributors (see CONTRIBUTORS.md).
// Licensed under the Apache License, Version 2.0 (see LICENSE).

package com.twitter.intellij.pants.integration;

import com.intellij.openapi.actionSystem.ActionManager;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.DataContext;
import com.intellij.openapi.actionSystem.IdeActions;
import com.twitter.intellij.pants.testFramework.OSSPantsIntegrationTest;
import com.twitter.intellij.pants.ui.PantsOverrideAction;
import com.twitter.intellij.pants.ui.ShieldAction;
import com.twitter.intellij.pants.util.PantsConstants;


public class OSSPantsActionOverrideTest extends OSSPantsIntegrationTest {

  private final String PANTS_ON = "actively overriding";
  private final DataContext PANTS_PROJECT_DATA = s -> s.equals("project") ? myProject : null;

  public void testPantsRebuildOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_COMPILE_PROJECT,
      true,
      "PantsRebuildAction",
      "testprojects/tests/java/org/pantsbuild/testproject/annotation"
    );
  }

  public void testNonPantsRebuildOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_COMPILE_PROJECT,
      false,
      "PantsRebuildAction"
    );
  }

  public void testPantsCompileOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_COMPILE,
      true,
      "ShieldAction",
      "testprojects/tests/java/org/pantsbuild/testproject/cwdexample"
    );
  }

  public void testPantsNonCompileOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_COMPILE,
      false,
      "ShieldAction"
    );
  }

  public void testPantsMakeOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_MAKE_MODULE,
      true,
      "PantsCompileAllTargetsInModuleAction",
      "testprojects/tests/java/org/pantsbuild/testproject/matcher"
    );
  }

  public void testNonPantsMakeOverride() throws Throwable {
    makeActionOverrideTest(
      IdeActions.ACTION_MAKE_MODULE,
      false,
      "PantsCompileAllTargetsInModuleAction"
    );
  }

  public void testPantsCompileAllOverride() throws Throwable {
    makeActionOverrideTest(
      PantsConstants.ACTION_MAKE_PROJECT_ID,
      true,
      "PantsCompileAllTargetsAction",
      "testprojects/tests/java/org/pantsbuild/testproject/unicode"
    );
  }

  public void testNonPantsCompileAllOverride() throws Throwable {
    makeActionOverrideTest(
      PantsConstants.ACTION_MAKE_PROJECT_ID,
      false,
      "PantsCompileAllTargetsAction"
    );
  }

  public void testPantsOverrideAction() throws Throwable {
    doImport("testprojects/tests/java/org/pantsbuild/testproject/annotation");

    MemorableAction primary = new MemorableAction();
    MemorableAction secondary = new MemorableAction();
    PantsOverrideAction pantsOverrideAction = new PantsOverrideAction(primary, secondary);

    pantsOverrideAction.actionPerformed(AnActionEvent.createFromDataContext("", null, PANTS_PROJECT_DATA));
    assertTrue(primary.hasBeenClicked());
    assertFalse(secondary.hasBeenClicked());
  }

  public void testNonPantsOverrideAction() throws Throwable {
    MemorableAction primary = new MemorableAction();
    MemorableAction secondary = new MemorableAction();
    PantsOverrideAction pantsOverrideAction = new PantsOverrideAction(primary, secondary);

    pantsOverrideAction.actionPerformed(AnActionEvent.createFromDataContext("", null, PANTS_PROJECT_DATA));
    assertTrue(secondary.hasBeenClicked());
    assertFalse(primary.hasBeenClicked());
  }


  public void testPantsShieldAction() throws Throwable {
    doImport("testprojects/tests/java/org/pantsbuild/testproject/annotation");

    MemorableAction primary = new MemorableAction();
    ShieldAction shieldAction = new ShieldAction(primary);
    shieldAction.actionPerformed(AnActionEvent.createFromDataContext("", null, PANTS_PROJECT_DATA));

    assertFalse(primary.hasBeenClicked());
  }

  public void testNonPantsShieldAction() throws Throwable {
    MemorableAction action = new MemorableAction();
    ShieldAction shieldAction = new ShieldAction(action);
    shieldAction.actionPerformed(AnActionEvent.createFromDataContext("", null, PANTS_PROJECT_DATA));

    assertFalse(action.hasBeenClicked());
  }

  /**
   * This function generates tests that ensure an action is being properly overriden (or not) depending on whether or not
   * the project is a Pants project.
   *
   * @param actionId             The ID of the action to override
   * @param isPantsProject       Whether or not the project is intended to be a Pants project
   * @param pantsActionClassName The short Class name of the Pants action that is overriding the function
   * @param projectPaths         The (optional) projects paths to import
   */
  private void makeActionOverrideTest(String actionId, boolean isPantsProject, String pantsActionClassName, String... projectPaths) {
    for (String path : projectPaths) {
      doImport(path);
    }

    ActionManager actionManager = ActionManager.getInstance();
    AnAction action = actionManager.getAction(actionId);

    //  Updates the action and passes in the data context on the current project it is in.
    action.update(AnActionEvent.createFromDataContext("", null, PANTS_PROJECT_DATA));
    String actionString = action.toString();

    if (isPantsProject) {
      assertTrue(actionString, actionString.contains(PANTS_ON));
    }
    else {
      assertFalse(actionString, actionString.contains(PANTS_ON));
    }
    assertTrue(actionString, actionString.contains(pantsActionClassName));
  }

  private class MemorableAction extends AnAction {
    private int clickCounts = 0;
    @Override
    public void actionPerformed(AnActionEvent event) {
      clickCounts++;
    }

    private boolean hasBeenClicked() {
      return clickCounts > 0;
    }
  }
}