Add JUnit test for starting and closing the IntelliJ for UI tests, perform some refactoring

Fixes #17

Signed-off-by: Zbynek Cervinka <[email protected]>

Author: zcervink

.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Java CI with Gradle
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 11
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+    - name: Run integration tests
+      run: |
+        export DISPLAY=:99.0
+        Xvfb -ac :99 -screen 0 1920x1080x16 &
+        cd test-project
+        chmod +x gradlew
+        ./gradlew clean test
+    - uses: actions/upload-artifact@v1
+      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/*
+
+  build-macos:
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 11
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+    - name: Run integration tests
+      run: |
+        cd test-project
+        chmod +x gradlew
+        ./gradlew clean test
+    - uses: actions/upload-artifact@v1
+      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: ${{ runner.os }}-screenshots
+        path: |
+          test-project/build/screenshots/*
+
+  build-windows:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 11
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+    - name: Run integration tests
+      run: |
+        cd test-project
+        chmod +x gradlew.bat
+        .\gradlew.bat clean test
+      shell: powershell
+    - uses: actions/upload-artifact@v1
+      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: ${{ runner.os }}-screenshots
+        path: |
+          test-project/build/screenshots/*
+

README.md

@@ -57,4 +57,13 @@ public static void runIdeForUiTests() {
 public static void closeIde() {
     UITestRunner.closeIde();
 }
-```
+```
+
+### Run JUnit tests to test this library
+
+You can run JUnit tests contained in this repository to test this library by executing the following command:
+
+```sh
+cd test-project
+./gradlew test
+```

build.gradle

@@ -8,9 +8,6 @@ plugins {
 group 'com.redhat.devtools.intellij'
 version projectVersion
 
-apply plugin: 'maven'
-apply plugin: 'io.github.gradle-nexus.publish-plugin'
-
 def remoteRobotVersion = '0.11.2'
 def fixturesVersion = '1.1.18'
 

gradle.properties

@@ -1,3 +1,3 @@
-projectVersion=0.0.1
+projectVersion=0.0.2-SNAPSHOT
 nexusUser=invalid
 nexusPassword=invalid

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

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

@@ -11,12 +11,22 @@
 package com.redhat.devtools.intellij.commonUiTestLibrary;
 
 import com.intellij.remoterobot.RemoteRobot;
-import com.redhat.devtools.intellij.commonUiTestLibrary.utils.GlobalUtils;
-
-import java.io.*;
+import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.WelcomeFrameDialog;
+
+import java.io.File;
+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;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.time.Duration;
+
+import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
 
 /**
  * Basic methods for starting and quiting the IntelliJ Idea IDE for UI tests
@@ -34,20 +44,21 @@ public static RemoteRobot runIde(String ideaVersion, int port) {
         String osName = System.getProperty("os.name").toLowerCase();
         ProcessBuilder pb;
         if (osName.contains("windows")) {
-            pb = new ProcessBuilder("powershell.exe", "Start-Process", ".\\gradlew.bat", "-ArgumentList", "\"runIdeForUiTests -PideaVersion=" + ideaVersion + "\"", "-WindowStyle", "hidden");
+            pb = new ProcessBuilder(".\\gradlew.bat", "runIdeForUiTests", "-PideaVersion=" + ideaVersion, "-Drobot-server.port=" + port);
         } else {
             pb = new ProcessBuilder("./gradlew", "runIdeForUiTests", "-PideaVersion=" + ideaVersion, "-Drobot-server.port=" + port);
         }
 
         try {
             ideProcess = pb.start();
-            GlobalUtils.waitUntilIntelliJStarts(port);
-            robot = GlobalUtils.getRemoteRobotConnection(port);
+            waitUntilIntelliJStarts(port);
+            robot = getRemoteRobotConnection(port);
         } catch (IOException | InterruptedException e) {
             e.printStackTrace();
         }
 
-        GlobalUtils.clearTheWorkspace();
+        WelcomeFrameDialog wfd = robot.find(WelcomeFrameDialog.class, Duration.ofSeconds(10));
+        wfd.clearTheWorkspace();
         return robot;
     }
 
@@ -56,7 +67,11 @@ public static RemoteRobot runIde(String ideaVersion) {
     }
 
     public static void closeIde() {
-        ideProcess.destroy();
+        if (robot.isWin()) {
+            robot.find(WelcomeFrameDialog.class, Duration.ofSeconds(10)).windowsCloseButton().click();
+        } else {
+            ideProcess.destroy();
+        }
     }
 
     public static RemoteRobot getRemoteRobotInstance() {
@@ -76,8 +91,7 @@ private static void makeSureAllTermsAndConditionsAreAccepted() {
             String acceptedDir = System.getProperty("user.home") + "/.local/share/JetBrains/consentOptions";
             createDirectoryHierarchy(acceptedDir);
             copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
-        }
-        else if (osName.contains("os x")) {
+        } else if (osName.contains("os x")) {
             String plistSourceLocation = "com.apple.java.util.prefs.plist";
             String plistDir = System.getProperty("user.home") + "/Library/Preferences";
             copyFileFromJarResourceDir(plistSourceLocation, plistDir + "/com.apple.java.util.prefs.plist");
@@ -95,16 +109,15 @@ else if (osName.contains("os x")) {
             } catch (IOException | InterruptedException e) {
                 e.printStackTrace();
             }
-        }
-        else if (osName.contains("windows")) {
+        } else if (osName.contains("windows")) {
             String acceptedSourceLocation = "accepted";
             String acceptedDir = System.getProperty("user.home") + "\\AppData\\Roaming\\JetBrains\\consentOptions";
             createDirectoryHierarchy(acceptedDir);
             copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "\\accepted");
 
             String registryPath = "HKCU:\\Software\\JavaSoft\\Prefs\\jetbrains\\privacy_policy";
             ProcessBuilder pb1 = new ProcessBuilder("powershell.exe", "New-Item", "-Path", registryPath, "-Force");
-            ProcessBuilder pb2 = new ProcessBuilder("powershell.exe", "New-ItemProperty", "-Path", registryPath, "-Name", "accepted_version", "-Value", "\"2.1\"");
+            ProcessBuilder pb2 = new ProcessBuilder("powershell.exe", "New-ItemProperty", "-Path", registryPath, "-Name", "accepted_version", "-Value", "'2.1'");
 
             try {
                 Process p1 = pb1.start();
@@ -117,6 +130,39 @@ else if (osName.contains("windows")) {
         }
     }
 
+    private static void waitUntilIntelliJStarts(int port) {
+        waitFor(Duration.ofSeconds(600), Duration.ofSeconds(3), "The IntelliJ Idea did not start in 10 minutes.", () -> isIntelliJUIVisible(port));
+    }
+
+    private static boolean isIntelliJUIVisible(int port) {
+        return isHostOnIpAndPortAccessible("127.0.0.1", port);
+    }
+
+    private static boolean isHostOnIpAndPortAccessible(String ip, int port) {
+        SocketAddress sockaddr = new InetSocketAddress(ip, port);
+        Socket socket = new Socket();
+
+        try {
+            socket.connect(sockaddr, 10000);
+        } catch (IOException IOException) {
+            return false;
+        }
+        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/WelcomeFrameDialog.java

@@ -16,10 +16,20 @@
 import com.intellij.remoterobot.fixtures.ContainerFixture;
 import com.intellij.remoterobot.fixtures.DefaultXpath;
 import com.intellij.remoterobot.fixtures.FixtureName;
+import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
 import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.other.ActionLink;
+import com.redhat.devtools.intellij.commonUiTestLibrary.utils.TextHelper;
+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.stepsProcessing.StepWorkerKt.step;
 
 /**
  * Welcome to IntelliJ IDEA dialog fixture
@@ -44,4 +54,69 @@ public ComponentFixture importProjectLink() {
     public ComponentFixture ideErrorsIcon() {
         return find(ComponentFixture.class, byXpath("//div[@class='IdeErrorsIcon']"));
     }
+
+    public ComponentFixture windowsCloseButton() {
+        return find(ComponentFixture.class, byXpath("//div[@accessiblename='Close' and @class='JButton']"));
+    }
+
+    public void clearTheWorkspace() {
+        step("Delete all the projects in the workspace", () -> {
+            // delete all the projects' links from the 'Welcome to IntelliJ IDEA' dialog
+            int numberOfLinks = getNumberOfProjectLinks();
+            for (int i = 0; i < numberOfLinks; i++) {
+                ComponentFixture cf = this.find(ComponentFixture.class, byXpath("//div[@accessiblename='Recent Projects' and @class='MyList']"));
+                cf.runJs("const horizontal_offset = component.getWidth()-22;\n" +
+                        "robot.click(component, new Point(horizontal_offset, 22), MouseButton.LEFT_BUTTON, 1);");
+            }
+
+            // delete all the files and folders in the IdeaProjects folder
+            try {
+                String pathToDirToMakeEmpty = System.getProperty("user.home") + File.separator + "IdeaProjects";
+                boolean doesTheProjectDirExists = Files.exists(Paths.get(pathToDirToMakeEmpty));
+                if (doesTheProjectDirExists) {
+                    FileUtils.cleanDirectory(new File(pathToDirToMakeEmpty));
+                } else {
+                    Files.createDirectory(Paths.get(pathToDirToMakeEmpty));
+                }
+            } catch (IOException e) {
+                e.printStackTrace();
+            }
+        });
+    }
+
+    private int getNumberOfProjectLinks() {
+        try {
+            ComponentFixture cf = this.find(ComponentFixture.class, byXpath("//div[@accessiblename='Recent Projects' and @class='MyList']"));
+            int numberOfProjectsLinks = cf.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;
+        }
+    }
+
+    public void checkForExceptions(RemoteRobot robot) {
+        step("Check for exceptions and other errors", () -> {
+            try {
+                this.ideErrorsIcon().click();
+            } catch (WaitForConditionTimeoutException e) {
+                e.printStackTrace();
+                return;
+            }
+
+            final IdeFatalErrorsDialog ideFatalErrorsDialogFixture = robot.find(IdeFatalErrorsDialog.class, Duration.ofSeconds(10));
+            String exceptionNumberLabel = ideFatalErrorsDialogFixture.numberOfExcetionsJBLabel().findAllText().get(0).getText();
+            int numberOfExceptions = Integer.parseInt(exceptionNumberLabel.substring(5));
+
+            for (int i = 0; i < numberOfExceptions; i++) {
+                String exceptionStackTrace = TextHelper.listOfRemoteTextToString(ideFatalErrorsDialogFixture.exceptionDescriptionJTextArea().findAllText());
+
+                if (i + 1 < numberOfExceptions) {
+                    ideFatalErrorsDialogFixture.nextExceptionButton().click();
+                }
+            }
+
+            ideFatalErrorsDialogFixture.button("Clear all").click();
+        });
+    }
 }