Identify and properly label all compat projects (#753)

Author: etanshaul

google-cloud-tools-plugin/resources/messages/CloudToolsBundle.properties

@@ -23,6 +23,7 @@ plugin.compatibility.error.update.link=Please {0}click here{1} to ensure that yo
 
 appengine.name=App Engine (BETA)
 appengine.environment.name.flexible=App Engine flexible
+appengine.environment.name.mvm=App Engine MVM
 appengine.environment.name.standard=App Engine standard
 appengine.tools.menu.item.label=Deploy to App Engine...
 appengine.version.label=Version\:

google-cloud-tools-plugin/src/com/google/cloud/tools/intellij/appengine/cloud/AppEngineDeploymentRunConfigurationEditor.java

@@ -46,6 +46,7 @@
 import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.xml.XmlTag;
 import com.intellij.remoteServer.configuration.deployment.DeploymentSource;
 import com.intellij.ui.DocumentAdapter;
 import com.intellij.ui.awt.RelativePoint;
@@ -78,6 +79,7 @@
  */
 public class AppEngineDeploymentRunConfigurationEditor extends
     SettingsEditor<AppEngineDeploymentConfiguration> {
+  private Project project;
 
   private JComboBox configTypeComboBox;
   private JPanel appEngineConfigFilesPanel;
@@ -113,6 +115,7 @@ public AppEngineDeploymentRunConfigurationEditor(
       final Project project,
       final AppEngineDeployable deploymentSource,
       final AppEngineHelper appEngineHelper) {
+    this.project = project;
     this.deploymentSource = deploymentSource;
 
     versionIdField.setPlaceholderText(GctBundle.message("appengine.flex.version.placeholder.text"));
@@ -122,7 +125,7 @@ public AppEngineDeploymentRunConfigurationEditor(
 
     environment = deploymentSource.getEnvironment();
 
-    if (environment == AppEngineEnvironment.APP_ENGINE_FLEX) {
+    if (environment.isFlexible()) {
       appEngineCostWarningLabel.setText(
           GctBundle.message("appengine.flex.deployment.cost.warning",
               COST_WARNING_OPEN_TAG,
@@ -131,8 +134,10 @@ public AppEngineDeploymentRunConfigurationEditor(
               COST_WARNING_CLOSE_TAG));
       appEngineCostWarningLabel.addHyperlinkListener(new BrowserOpeningHyperLinkListener());
       appEngineCostWarningLabel.setBackground(editorPanel.getBackground());
+      environmentLabel.setText(getEnvironmentDisplayableLabel());
     } else {
       appEngineCostWarningLabel.setVisible(false);
+      environmentLabel.setText(environment.localizedLabel());
     }
 
     configTypeComboBox.setModel(new DefaultComboBoxModel(ConfigType.values()));
@@ -214,7 +219,6 @@ public File get() {
     versionOverrideCheckBox.addItemListener(
         new CustomFieldOverrideListener(versionOverrideCheckBox, versionIdField));
 
-    environmentLabel.setText(environment.localizedLabel());
     appEngineFlexConfigPanel.setVisible(
         environment == AppEngineEnvironment.APP_ENGINE_FLEX
             && !AppEngineUtil.isFlexCompat(project, deploymentSource));
@@ -278,6 +282,23 @@ void setProjectSelector(ProjectSelector projectSelector) {
     this.projectSelector = projectSelector;
   }
 
+  /**
+   * If a project's appengine-web.xml contains <env>flex</env> then we want to override
+   * the default localized label of the environment
+   */
+  private String getEnvironmentDisplayableLabel() {
+    XmlTag compatConfig = AppEngineUtil.getFlexCompatXmlConfiguration(project, deploymentSource);
+
+    if (compatConfig != null) {
+      if ("env".equalsIgnoreCase(compatConfig.getName())
+          && "flex".equalsIgnoreCase(compatConfig.getValue().getTrimmedText())) {
+        return GctBundle.message("appengine.environment.name.mvm");
+      }
+    }
+
+    return environment.localizedLabel();
+  }
+
   private void updateJarWarSelector() {
     userSpecifiedArtifactPanel.setVisible(isUserSpecifiedPathDeploymentSource());
   }

google-cloud-tools-plugin/src/com/google/cloud/tools/intellij/appengine/util/AppEngineUtil.java

@@ -40,6 +40,7 @@
 import com.intellij.psi.PsiManager;
 import com.intellij.psi.xml.XmlFile;
 import com.intellij.psi.xml.XmlTag;
+import com.intellij.remoteServer.configuration.deployment.ArtifactDeploymentSource;
 import com.intellij.remoteServer.configuration.deployment.DeploymentSource;
 import com.intellij.remoteServer.configuration.deployment.ModuleDeploymentSource;
 import com.intellij.util.xml.DomFileElement;
@@ -130,30 +131,25 @@ && isJarOrWarMavenBuild(project, module)) {
   }
 
   /**
-   * Determines if a project is set up like an App Engine standard project but is configured
-   * in 'compatibility' mode. This indicates that the project runs in the flexible environment.
+   * Returns the xml tag corresponding to the project's appengine-web.xml compat configuration
+   * or null if there isn't one.
    */
-  public static boolean isFlexCompat(@NotNull Project project, @NotNull DeploymentSource source) {
-    Artifact artifact;
-    if (source instanceof AppEngineArtifactDeploymentSource) {
-      artifact = ((AppEngineArtifactDeploymentSource) source).getArtifact();
-      if (artifact != null) {
-        return isFlexCompat(project, artifact);
-      }
-    }
-
-    return false;
+  @Nullable
+  public static XmlTag getFlexCompatXmlConfiguration(@NotNull Project project,
+      @NotNull DeploymentSource source)  {
+    return getFlexCompatXmlConfiguration(project, getArtifact(source));
   }
 
-  private static boolean isFlexCompat(@NotNull Project project,
-      @NotNull Artifact artifact) {
-    if (!isAppEngineStandardArtifact(project, artifact)) {
-      return false;
+  @Nullable
+  private static XmlTag getFlexCompatXmlConfiguration(@NotNull Project project,
+      @Nullable Artifact artifact) {
+
+    if (artifact == null || !isAppEngineStandardArtifact(project, artifact)) {
+      return null;
     }
 
     XmlFile webXml = loadAppEngineStandardWebXml(project, artifact);
 
-    boolean isVmTrue = false;
     if (webXml != null) {
       DomManager manager = DomManager.getDomManager(project);
       DomFileElement element = manager.getFileElement(webXml);
@@ -163,13 +159,60 @@ private static boolean isFlexCompat(@NotNull Project project,
         if (root != null) {
           XmlTag vmTag = root.findFirstSubTag("vm");
           if (vmTag != null) {
-            isVmTrue = Boolean.parseBoolean(vmTag.getValue().getTrimmedText());
+            return vmTag;
+          } else {
+            return root.findFirstSubTag("env");
           }
         }
       }
     }
 
-    return isVmTrue;
+    return null;
+  }
+
+  /**
+   * Determines if a project is set up like an App Engine standard project but is configured
+   * in 'compatibility' mode. This indicates that the project runs in the flexible environment.
+   *
+   * <p>A flex compat project has an appengine-web.xml with either:
+   * {@code
+   * <vm>true</vm>
+   * <env>flex</env>
+   * }
+   */
+  public static boolean isFlexCompat(@NotNull Project project, @NotNull DeploymentSource source) {
+    return isFlexCompat(project, getArtifact(source));
+  }
+
+  private static boolean isFlexCompat(@NotNull Project project, @Nullable Artifact artifact) {
+    if (artifact == null) {
+      return false;
+    }
+
+    XmlTag compatConfig = getFlexCompatXmlConfiguration(project, artifact);
+
+    if (compatConfig == null) {
+      return false;
+    }
+
+    String tagName = compatConfig.getName();
+
+    if ("vm".equalsIgnoreCase(tagName)) {
+      return Boolean.parseBoolean(compatConfig.getValue().getTrimmedText());
+    } else if ("env".equalsIgnoreCase(tagName)) {
+      return "flex".equalsIgnoreCase(compatConfig.getValue().getTrimmedText());
+    } else {
+      return false;
+    }
+  }
+
+  @Nullable
+  private static Artifact getArtifact(@NotNull DeploymentSource source) {
+    if (source instanceof ArtifactDeploymentSource) {
+      return ((ArtifactDeploymentSource) source).getArtifact();
+    }
+
+    return null;
   }
 
   private static AppEngineArtifactDeploymentSource createArtifactDeploymentSource(