Introduce fixtures & tests, config update

Author: zcervink

.github/workflows/ci.yml

@@ -22,21 +22,21 @@ jobs:
     - name: Run integration tests
       run: |
         export DISPLAY=:99.0
-        Xvfb -ac :99 -screen 0 1920x1080x16 &
+        Xvfb -ac :99 -screen 0 1920x1080x24 &
         cd test-project
         chmod +x gradlew
-        ./gradlew clean test
-    - uses: actions/upload-artifact@v1
+        ./gradlew clean test --warning-mode none
+    - uses: actions/upload-artifact@v2
       with:
         name: ${{ runner.os }}-test-reports
         path: test-project/build/reports/tests/test
       if: always()
     - name: Archiving screenshots
       uses: actions/upload-artifact@v2
       with: 
-        name: screenshots
-        path: |
-          test-project/build/screenshots/*
+        name: ${{ runner.os }}-screenshots
+        path: test-project/build/screenshots/*
+      if: always()
 
   build-macos:
     runs-on: macos-latest
@@ -51,8 +51,8 @@ jobs:
       run: |
         cd test-project
         chmod +x gradlew
-        ./gradlew clean test
-    - uses: actions/upload-artifact@v1
+        ./gradlew clean test --warning-mode none
+    - uses: actions/upload-artifact@v2
       with:
         name: ${{ runner.os }}-test-reports
         path: test-project/build/reports/tests/test
@@ -61,8 +61,8 @@ jobs:
       uses: actions/upload-artifact@v2
       with: 
         name: ${{ runner.os }}-screenshots
-        path: |
-          test-project/build/screenshots/*
+        path: test-project/build/screenshots/*
+      if: always()
 
   build-windows:
     runs-on: windows-latest
@@ -77,9 +77,9 @@ jobs:
       run: |
         cd test-project
         chmod +x gradlew.bat
-        .\gradlew.bat clean test
+        .\gradlew.bat clean test --warning-mode none
       shell: powershell
-    - uses: actions/upload-artifact@v1
+    - uses: actions/upload-artifact@v2
       with:
         name: ${{ runner.os }}-test-reports
         path: test-project/build/reports/tests/test
@@ -88,6 +88,5 @@ jobs:
       uses: actions/upload-artifact@v2
       with: 
         name: ${{ runner.os }}-screenshots
-        path: |
-          test-project/build/screenshots/*
-
+        path: test-project/build/screenshots/*
+      if: always()

build.gradle

@@ -8,8 +8,7 @@ plugins {
 group 'com.redhat.devtools.intellij'
 version projectVersion
 
-def remoteRobotVersion = '0.11.2'
-def fixturesVersion = '1.1.18'
+def remoteRobotVersion = '0.11.6'
 
 repositories {
     mavenLocal()
@@ -26,7 +25,7 @@ dependencies {
     api 'org.junit.jupiter:junit-jupiter-api:5.3.1'
     api 'org.junit.jupiter:junit-jupiter-engine:5.3.1'
     api "com.intellij.remoterobot:remote-robot:$remoteRobotVersion"
-    api "com.intellij.remoterobot:remote-fixtures:$fixturesVersion"
+    api "com.intellij.remoterobot:remote-fixtures:$remoteRobotVersion"
 }
 
 java {

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

@@ -11,7 +11,9 @@
 package com.redhat.devtools.intellij.commonUiTestLibrary;
 
 import com.intellij.remoterobot.RemoteRobot;
-import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.WelcomeFrameDialog;
+import com.intellij.remoterobot.fixtures.ComponentFixture;
+import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.FlatWelcomeFrame;
 
 import java.io.File;
 import java.io.IOException;
@@ -26,6 +28,7 @@
 import java.nio.file.Paths;
 import java.time.Duration;
 
+import static com.intellij.remoterobot.search.locators.Locators.byXpath;
 import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
 
 /**
@@ -35,47 +38,117 @@
  */
 public class UITestRunner {
     private static final int defaultPort = 8580;
-    private static RemoteRobot robot = null;
+    private static RemoteRobot remoteRobot = null;
     private static Process ideProcess;
-
-    public static RemoteRobot runIde(String ideaVersion, int port) {
+    private static IdeaVersion ideaVersion;
+
+    /**
+     * Start the given version of IntelliJ Idea listening on the given port
+     *
+     * @param ideaVersion version of the IntelliJ Idea to start
+     * @param port        port number on which will the IntelliJ Idea be listening
+     */
+    public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
+        UITestRunner.ideaVersion = ideaVersion;
         makeSureAllTermsAndConditionsAreAccepted();
 
         String osName = System.getProperty("os.name").toLowerCase();
-        ProcessBuilder pb;
-        if (osName.contains("windows")) {
-            pb = new ProcessBuilder(".\\gradlew.bat", "runIdeForUiTests", "-PideaVersion=" + ideaVersion, "-Drobot-server.port=" + port);
-        } else {
-            pb = new ProcessBuilder("./gradlew", "runIdeForUiTests", "-PideaVersion=" + ideaVersion, "-Drobot-server.port=" + port);
-        }
+        String fileExtension = osName.contains("windows") ? ".bat" : "";
+        ProcessBuilder pb = new ProcessBuilder("." + File.separator + "gradlew" + fileExtension, "runIdeForUiTests", "-PideaVersion=" + ideaVersion.toString(), "-Drobot-server.port=" + port);
 
         try {
             ideProcess = pb.start();
             waitUntilIntelliJStarts(port);
-            robot = getRemoteRobotConnection(port);
+            remoteRobot = getRemoteRobotConnection(port);
         } catch (IOException | InterruptedException e) {
             e.printStackTrace();
         }
 
-        WelcomeFrameDialog wfd = robot.find(WelcomeFrameDialog.class, Duration.ofSeconds(10));
-        wfd.clearTheWorkspace();
-        return robot;
+        FlatWelcomeFrame flatWelcomeFrame = remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10));
+        flatWelcomeFrame.clearWorkspace();
+        return remoteRobot;
     }
 
-    public static RemoteRobot runIde(String ideaVersion) {
+    /**
+     * Start the given version of IntelliJ Idea listening on the default port
+     *
+     * @param ideaVersion version of the IntelliJ Idea to start
+     */
+    public static RemoteRobot runIde(IdeaVersion ideaVersion) {
         return runIde(ideaVersion, defaultPort);
     }
 
+    /**
+     * Close the IntelliJ Idea IDE from the 'Welcome to IntelliJ IDEA' dialog
+     */
     public static void closeIde() {
-        if (robot.isWin()) {
-            robot.find(WelcomeFrameDialog.class, Duration.ofSeconds(10)).windowsCloseButton().click();
+        if (remoteRobot.isWin()) {
+            ComponentFixture windowsCloseButton = remoteRobot.find(ComponentFixture.class, byXpath("//div[@accessiblename='Close' and @class='JButton']"), Duration.ofSeconds(10));
+            windowsCloseButton.click();
         } else {
             ideProcess.destroy();
         }
     }
 
-    public static RemoteRobot getRemoteRobotInstance() {
-        return robot;
+    /**
+     * Return the integer representation of the currently running IntelliJ Idea version
+     *
+     * @return version of the currently running IntelliJ Idea
+     */
+    public static IdeaVersion getIdeaVersion() {
+        return ideaVersion;
+    }
+
+    /**
+     * Return the reference to the Remote Robot instance
+     *
+     * @return reference to the Remote Robot instance
+     */
+    public static RemoteRobot getRemoteRobot() {
+        return remoteRobot;
+    }
+
+    /**
+     * Create an instance of the RemoteRobot listening on the given port
+     *
+     * @param port port number
+     * @return instance of the RemoteRobot
+     */
+    public static RemoteRobot getRemoteRobotConnection(int port) throws InterruptedException {
+        RemoteRobot remoteRobot = new RemoteRobot("http://127.0.0.1:" + port);
+        for (int i = 0; i < 60; i++) {
+            try {
+                remoteRobot.find(FlatWelcomeFrame.class);
+            } catch (WaitForConditionTimeoutException e) {
+                Thread.sleep(1000);
+            }
+        }
+
+        return remoteRobot;
+    }
+
+    /**
+     * Enumeration for supported versions of the IntelliJ Idea
+     */
+    public enum IdeaVersion {
+        V_2020_2("IC-2020.2"),
+        V_2020_3("IC-2020.3");
+
+        final private String ideaVersionStringRepresentation;
+
+        IdeaVersion(String ideaVersionStringRepresentation) {
+            this.ideaVersionStringRepresentation = ideaVersionStringRepresentation;
+        }
+
+        @Override
+        public String toString() {
+            return ideaVersionStringRepresentation;
+        }
+
+        public int toInt() {
+            String ideaVersion = this.ideaVersionStringRepresentation.substring(3).replace(".", "");
+            return Integer.parseInt(ideaVersion);
+        }
     }
 
     private static void makeSureAllTermsAndConditionsAreAccepted() {
@@ -150,19 +223,6 @@ private static boolean isHostOnIpAndPortAccessible(String ip, int port) {
         return true;
     }
 
-    public static RemoteRobot getRemoteRobotConnection(int port) throws InterruptedException {
-        RemoteRobot remoteRobot = new RemoteRobot("http://127.0.0.1:" + port);
-        for (int i = 0; i < 60; i++) {
-            try {
-                remoteRobot.find(WelcomeFrameDialog.class);
-            } catch (Exception ex) {
-                Thread.sleep(1000);
-            }
-        }
-
-        return remoteRobot;
-    }
-
     private static void createDirectoryHierarchy(String location) {
         Path path = Paths.get(location);
         try {

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

@@ -0,0 +1,129 @@
+/*******************************************************************************
+ * 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;
+
+import com.intellij.remoterobot.RemoteRobot;
+import com.intellij.remoterobot.data.RemoteComponent;
+import com.intellij.remoterobot.fixtures.*;
+import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
+import com.redhat.devtools.intellij.commonUiTestLibrary.UITestRunner;
+import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.errors.IdeFatalErrorsDialog;
+import org.apache.commons.io.FileUtils;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.time.Duration;
+
+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
+ *
+ * @author [email protected]
+ */
+@DefaultXpath(by = "FlatWelcomeFrame type", xpath = "//div[@class='FlatWelcomeFrame']")
+@FixtureName(name = "Welcome To IntelliJ IDEA Dialog")
+public class FlatWelcomeFrame extends CommonContainerFixture {
+    private UITestRunner.IdeaVersion intelliJVersion;
+
+    public FlatWelcomeFrame(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
+        super(remoteRobot, remoteComponent);
+        this.intelliJVersion = getIdeaVersion();
+    }
+
+    /**
+     * Click on the 'New Project' link
+     */
+    public void createNewProject() {
+        // Code for IntelliJ Idea 2020.3 or newer
+        if (intelliJVersion.toInt() >= 20203) {
+            welcomeFrameLink("New Project").click();
+        }
+        // Code for IntelliJ Idea 2020.2 or earlier
+        else {
+            actionLink("New Project").click();
+        }
+    }
+
+    /**
+     * Clear the workspace by deleting the content of the IdeaProjects folder and clearing all the projects' links in the 'Welcome to IntelliJ IDEA' dialog
+     */
+    public void clearWorkspace() {
+        // delete all the projects' links from the 'Welcome to IntelliJ IDEA' dialog
+        int numberOfLinks = getNumberOfProjectLinks();
+        for (int i = 0; i < numberOfLinks; i++) {
+            ComponentFixture recentProjectsList = find(ComponentFixture.class, byXpath("//div[@accessiblename='Recent Projects' and @class='MyList']"), Duration.ofSeconds(10));
+            recentProjectsList.runJs("const horizontal_offset = component.getWidth()-22;\n" +
+                    "robot.click(component, new Point(horizontal_offset, 22), MouseButton.LEFT_BUTTON, 1);");
+            // Code for IntelliJ Idea 2020.3 or newer
+            if (intelliJVersion.toInt() >= 20203) {
+                JPopupMenuFixture contextMenu = find(JPopupMenuFixture.class, JPopupMenuFixture.Companion.byType(), Duration.ofSeconds(10));
+                contextMenu.select("Remove from Recent Projects");
+            }
+        }
+
+        // delete all the files and folders in the IdeaProjects folder
+        try {
+            String pathToDirToMakeEmpty = System.getProperty("user.home") + File.separator + "IdeaProjects";
+            boolean doesProjectDirExists = Files.exists(Paths.get(pathToDirToMakeEmpty));
+            if (doesProjectDirExists) {
+                FileUtils.cleanDirectory(new File(pathToDirToMakeEmpty));
+            } else {
+                Files.createDirectory(Paths.get(pathToDirToMakeEmpty));
+            }
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+
+    /**
+     * Clear all exceptions
+     */
+    public void clearExceptions() {
+        try {
+            ideErrorsIcon().click();
+        } catch (WaitForConditionTimeoutException e) {
+            e.printStackTrace();
+            return;
+        }
+
+        IdeFatalErrorsDialog ideFatalErrorsDialog = find(IdeFatalErrorsDialog.class, Duration.ofSeconds(10));
+        ideFatalErrorsDialog.clearAll();
+    }
+
+    // Works for IntelliJ Idea 2020.3+
+    private ComponentFixture welcomeFrameLink(String text) {
+        if (hasAnyComponent(this, byXpath("//div[@class='NewRecentProjectPanel']"))) {
+            return find(ComponentFixture.class, byXpath("//div[@class='JBOptionButton' and @text='" + text + "']"));
+        }
+        return find(ComponentFixture.class, byXpath("//div[@class='NonOpaquePanel'][./div[@text='" + text + "']]//div[@class='JButton']"));
+    }
+
+    private int getNumberOfProjectLinks() {
+        try {
+            ComponentFixture recentProjectsList = find(ComponentFixture.class, byXpath("//div[@accessiblename='Recent Projects' and @class='MyList']"), Duration.ofSeconds(10));
+            int numberOfProjectsLinks = recentProjectsList.findAllText().size() / 2;    // 2 items per 1 project link (project path and project name)
+            return numberOfProjectsLinks;
+        } catch (WaitForConditionTimeoutException e) {
+            // the list with accessible name 'Recent Projects' is not available -> 0 links in the 'Welcome to IntelliJ IDEA' dialog
+            return 0;
+        }
+    }
+
+    private ComponentFixture ideErrorsIcon() {
+        return find(ComponentFixture.class, byXpath("//div[@class='IdeErrorsIcon']"), Duration.ofSeconds(10));
+    }
+}