Create a wizard fixture with the appropriate pages to handle new project creation (#50)

Author: zcervink

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/UITestRunner.java

@@ -15,10 +15,10 @@
 import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.FlatWelcomeFrame;
 
 import java.io.File;
+import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.io.FileOutputStream;
 import java.net.InetSocketAddress;
 import java.net.Socket;
 import java.net.SocketAddress;

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/exceptions/UITestException.java

@@ -0,0 +1,22 @@
+/*******************************************************************************
+ * Copyright (c) 2021 Red Hat, Inc.
+ * Distributed under license by Red Hat, Inc. All rights reserved.
+ * This program is made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution,
+ * and is available at https://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ * Red Hat, Inc. - initial API and implementation
+ ******************************************************************************/
+package com.redhat.devtools.intellij.commonUiTestLibrary.exceptions;
+
+/**
+ * IntelliJ UI test library runtime exception
+ *
+ * @author [email protected]
+ */
+public class UITestException extends RuntimeException {
+    public UITestException(String errorMsg) {
+        super(errorMsg);
+    }
+}

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/FlatWelcomeFrame.java

@@ -19,6 +19,7 @@
 import com.intellij.remoterobot.fixtures.JButtonFixture;
 import com.intellij.remoterobot.fixtures.JListFixture;
 import com.intellij.remoterobot.fixtures.JPopupMenuFixture;
+import com.intellij.remoterobot.utils.UtilsKt;
 import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
 import com.redhat.devtools.intellij.commonUiTestLibrary.UITestRunner;
 import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.errors.IdeFatalErrorsDialog;
@@ -33,8 +34,6 @@
 import java.util.List;
 
 import static com.intellij.remoterobot.search.locators.Locators.byXpath;
-import static com.intellij.remoterobot.utils.UtilsKt.hasAnyComponent;
-import static com.redhat.devtools.intellij.commonUiTestLibrary.UITestRunner.getIdeaVersion;
 
 /**
  * Welcome to IntelliJ IDEA dialog fixture
@@ -48,20 +47,29 @@ public class FlatWelcomeFrame extends CommonContainerFixture {
 
     public FlatWelcomeFrame(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
         super(remoteRobot, remoteComponent);
-        this.intelliJVersion = getIdeaVersion();
+        this.intelliJVersion = UITestRunner.getIdeaVersion();
     }
 
     /**
      * Click on the 'New Project' link
      */
     public void createNewProject() {
+        clickOnLink("New Project");
+    }
+
+    /**
+     * Click on the link according to given label
+     *
+     * @param label label of the link to click on
+     */
+    public void clickOnLink(String label) {
         // Code for IntelliJ Idea 2020.3 or newer
         if (intelliJVersion.toInt() >= 20203) {
-            welcomeFrameLink("New Project").click();
+            welcomeFrameLink(label).click();
         }
         // Code for IntelliJ Idea 2020.2 or earlier
         else {
-            actionLink("New Project").click();
+            actionLink(label).click();
         }
     }
 
@@ -112,7 +120,7 @@ public void clearExceptions() {
 
     // Works for IntelliJ Idea 2020.3+
     private JButtonFixture welcomeFrameLink(String text) {
-        if (hasAnyComponent(this, byXpath("//div[@class='NewRecentProjectPanel']"))) {
+        if (UtilsKt.hasAnyComponent(this, byXpath("//div[@class='NewRecentProjectPanel']"))) {
             return button(byXpath("//div[@class='JBOptionButton' and @text='" + text + "']"), Duration.ofSeconds(2));
         }
         return button(byXpath("//div[@class='NonOpaquePanel'][./div[@text='" + text + "']]"), Duration.ofSeconds(2));

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/errors/IdeFatalErrorsDialog.java

@@ -15,10 +15,9 @@
 import com.intellij.remoterobot.fixtures.CommonContainerFixture;
 import com.intellij.remoterobot.fixtures.DefaultXpath;
 import com.intellij.remoterobot.fixtures.FixtureName;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
 import org.jetbrains.annotations.NotNull;
 
-import static com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels.clearAllLabel;
-
 /**
  * IDE Fatal Errors dialog fixture
  *
@@ -35,6 +34,6 @@ public IdeFatalErrorsDialog(@NotNull RemoteRobot remoteRobot, @NotNull RemoteCom
      * Click on the 'Clear all' button
      */
     public void clearAll() {
-        button(clearAllLabel).click();
+        button(ButtonLabels.clearAllLabel).click();
     }
 }

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/information/ProjectStructureDialog.java

@@ -15,10 +15,9 @@
 import com.intellij.remoterobot.fixtures.CommonContainerFixture;
 import com.intellij.remoterobot.fixtures.DefaultXpath;
 import com.intellij.remoterobot.fixtures.FixtureName;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
 import org.jetbrains.annotations.NotNull;
 
-import static com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels.cancelLabel;
-
 /**
  * Project Structure dialog fixture
  *
@@ -35,6 +34,6 @@ public ProjectStructureDialog(@NotNull RemoteRobot remoteRobot, @NotNull RemoteC
      * Cancel the 'Project Structure'
      */
     public void cancel() {
-        button(cancelLabel).click();
+        button(ButtonLabels.cancelLabel).click();
     }
 }

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/information/TipDialog.java

@@ -16,12 +16,11 @@
 import com.intellij.remoterobot.fixtures.DefaultXpath;
 import com.intellij.remoterobot.fixtures.FixtureName;
 import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
 import org.jetbrains.annotations.NotNull;
 
 import java.time.Duration;
 
-import static com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels.closeLabel;
-
 /**
  * Tip of the Day dialog fixture
  *
@@ -42,7 +41,7 @@ public TipDialog(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remo
     public static void closeTipDialogIfItAppears(RemoteRobot remoteRobot) {
         try {
             TipDialog tipDialog = remoteRobot.find(TipDialog.class, Duration.ofSeconds(20));
-            tipDialog.button(closeLabel).click();
+            tipDialog.button(ButtonLabels.closeLabel).click();
         } catch (WaitForConditionTimeoutException e) {
             e.printStackTrace();
         }

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/navigation/SearchEverywherePopup.java

@@ -12,10 +12,16 @@
 
 import com.intellij.remoterobot.RemoteRobot;
 import com.intellij.remoterobot.data.RemoteComponent;
-import com.intellij.remoterobot.fixtures.*;
+import com.intellij.remoterobot.fixtures.CommonContainerFixture;
+import com.intellij.remoterobot.fixtures.DefaultXpath;
+import com.intellij.remoterobot.fixtures.FixtureName;
+import com.intellij.remoterobot.fixtures.JListFixture;
+import com.intellij.remoterobot.fixtures.JTextFieldFixture;
 import com.intellij.remoterobot.fixtures.dataExtractor.RemoteText;
 import com.intellij.remoterobot.utils.Keyboard;
 import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.exceptions.UITestException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.textTranformation.TextUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.awt.event.KeyEvent;
@@ -24,7 +30,6 @@
 
 import static com.intellij.remoterobot.search.locators.Locators.byXpath;
 import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
-import static com.redhat.devtools.intellij.commonUiTestLibrary.utils.textTranformation.TextUtils.listOfRemoteTextToString;
 
 /**
  * Search everywhere popup fixture
@@ -50,7 +55,7 @@ public void activateTab(String tabName) {
         try {
             button(byXpath("//div[@text='" + tabName + "']"), Duration.ofSeconds(2)).click();
         } catch (WaitForConditionTimeoutException e) {
-            throw new RuntimeException("The '" + tabName + "' tab cannot be found.");
+            throw new UITestException("The '" + tabName + "' tab cannot be found.");
         }
     }
 
@@ -68,7 +73,7 @@ public void invokeCmd(String cmdToEnter) {
     }
 
     private boolean didSearchFinish(String cmdToInvoke) {
-        String searchResultsString = listOfRemoteTextToString(getSearchResults());
+        String searchResultsString = TextUtils.listOfRemoteTextToString(getSearchResults());
         return searchResultsString.toLowerCase().contains(cmdToInvoke.toLowerCase());
     }
 

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/project/NewProjectDialogWizard.java

@@ -0,0 +1,78 @@
+/*******************************************************************************
+ * Copyright (c) 2021 Red Hat, Inc.
+ * Distributed under license by Red Hat, Inc. All rights reserved.
+ * This program is made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution,
+ * and is available at https://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ * Red Hat, Inc. - initial API and implementation
+ ******************************************************************************/
+package com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.project;
+
+import com.intellij.remoterobot.RemoteRobot;
+import com.intellij.remoterobot.data.RemoteComponent;
+import com.intellij.remoterobot.fixtures.CommonContainerFixture;
+import com.intellij.remoterobot.fixtures.DefaultXpath;
+import com.intellij.remoterobot.fixtures.FixtureName;
+import com.intellij.remoterobot.fixtures.JButtonFixture;
+import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.exceptions.UITestException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * New Project dialog wizard fixture
+ *
+ * @author [email protected]
+ */
+@DefaultXpath(by = "MyDialog type", xpath = "//div[@accessiblename='New Project' and @class='MyDialog']")
+@FixtureName(name = "New Project Dialog")
+public class NewProjectDialogWizard extends CommonContainerFixture {
+    public NewProjectDialogWizard(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
+        super(remoteRobot, remoteComponent);
+    }
+
+    /**
+     * Move to the previous page of the 'New Project' dialog by clicking on the 'Previous' button
+     */
+    public void previous() {
+        clickOnButton(ButtonLabels.previousLabel);
+    }
+
+    /**
+     * Move to the next page of the 'New Project' dialog by clicking on the 'Next' button
+     */
+    public void next() {
+        clickOnButton(ButtonLabels.nextLabel);
+    }
+
+    /**
+     * Finish the 'New Project' dialog by clicking on the 'Finish' button
+     */
+    public void finish() {
+        clickOnButton(ButtonLabels.finishLabel);
+    }
+
+    /**
+     * Close the 'New Project' dialog by clicking on the 'Cancel' button
+     */
+    public void cancel() {
+        button(ButtonLabels.cancelLabel).click();
+    }
+
+    private void clickOnButton(String label) {
+        JButtonFixture button;
+        try {
+            button = button(label);
+        } catch (WaitForConditionTimeoutException e) {
+            throw new UITestException("The '" + label + "' button has not been found.");
+        }
+
+        if (button.isEnabled()) {
+            button.click();
+        } else {
+            throw new UITestException("The '" + label + "' button is not enabled.");
+        }
+    }
+}

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/fixtures/dialogs/project/pages/AbstractNewProjectFinalPage.java

@@ -0,0 +1,87 @@
+/*******************************************************************************
+ * Copyright (c) 2021 Red Hat, Inc.
+ * Distributed under license by Red Hat, Inc. All rights reserved.
+ * This program is made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution,
+ * and is available at https://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ * Red Hat, Inc. - initial API and implementation
+ ******************************************************************************/
+package com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.project.pages;
+
+import com.intellij.remoterobot.RemoteRobot;
+import com.intellij.remoterobot.data.RemoteComponent;
+import com.intellij.remoterobot.fixtures.CommonContainerFixture;
+import com.intellij.remoterobot.fixtures.DefaultXpath;
+import com.intellij.remoterobot.fixtures.FixtureName;
+import com.intellij.remoterobot.fixtures.JTextFieldFixture;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * New Project dialog abstract terminal page fixture
+ *
+ * @author [email protected]
+ */
+@DefaultXpath(by = "MyDialog type", xpath = "//div[@class='DialogRootPane']")
+@FixtureName(name = "New Project Dialog")
+public abstract class AbstractNewProjectFinalPage extends CommonContainerFixture {
+    public AbstractNewProjectFinalPage(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
+        super(remoteRobot, remoteComponent);
+    }
+
+    /**
+     * Get the project name for new project in the 'New Project' dialog
+     *
+     * @return currently set new project name
+     */
+    public String getProjectName() {
+        return textFields(JTextFieldFixture.Companion.byType()).get(0).getText();
+    }
+
+    /**
+     * Set the project name for new project in the 'New Project' dialog
+     *
+     * @param projectName name of the new project
+     */
+    public void setProjectName(String projectName) {
+        textFields(JTextFieldFixture.Companion.byType()).get(0).setText(projectName);
+    }
+
+    /**
+     * Get the project location for new project in the 'New Project' dialog
+     *
+     * @return currently set new project location
+     */
+    public String getProjectLocation() {
+        return textFields(JTextFieldFixture.Companion.byType()).get(1).getText();
+    }
+
+    /**
+     * Set the project location for new project in the 'New Project' dialog
+     *
+     * @param projectLocation project location of the new project
+     */
+    public void setProjectLocation(String projectLocation) {
+        textFields(JTextFieldFixture.Companion.byType()).get(1).setText(projectLocation);
+    }
+
+    /**
+     * Enumeration defining values of the 'Project format' combo box
+     */
+    public enum ProjectFormatType {
+        IDEA_DIRECTORY_BASED(".idea"),
+        IPR_FILE_BASED(".ipr");
+
+        private String textRepresentation;
+
+        ProjectFormatType(String textRepresentation) {
+            this.textRepresentation = textRepresentation;
+        }
+
+        @Override
+        public String toString() {
+            return this.textRepresentation;
+        }
+    }
+}