Integrate the remote-robot step logging solution (#60)

* Integrate the remote-robot step logging solution

Fixes #44

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

Author: zcervink

.github/workflows/linux.yml

@@ -37,3 +37,9 @@ jobs:
         name: ${{ runner.os }}-screenshots
         path: src/test-project/build/screenshots/*
       if: always()
+    - name: Archiving StepLogger logs
+      uses: actions/upload-artifact@v2
+      with: 
+        name: ${{ runner.os }}-steplogger-logs
+        path: src/test-project/build/test-results/*
+      if: always()

.github/workflows/mac.yml

@@ -35,3 +35,9 @@ jobs:
         name: ${{ runner.os }}-screenshots
         path: src/test-project/build/screenshots/*
       if: always()
+    - name: Archiving StepLogger logs
+      uses: actions/upload-artifact@v2
+      with: 
+        name: ${{ runner.os }}-steplogger-logs
+        path: src/test-project/build/test-results/*
+      if: always()

.github/workflows/windows.yml

@@ -36,3 +36,9 @@ jobs:
         name: ${{ runner.os }}-screenshots
         path: src\test-project\build\screenshots\*
       if: always()
+    - name: Archiving StepLogger logs
+      uses: actions/upload-artifact@v2
+      with: 
+        name: ${{ runner.os }}-steplogger-logs
+        path: src\test-project\build\test-results\*
+      if: always()

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

@@ -11,6 +11,8 @@
 package com.redhat.devtools.intellij.commonUiTestLibrary;
 
 import com.intellij.remoterobot.RemoteRobot;
+import com.intellij.remoterobot.stepsProcessing.StepLogger;
+import com.intellij.remoterobot.stepsProcessing.StepWorker;
 import com.intellij.remoterobot.utils.WaitForConditionTimeoutException;
 import com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.FlatWelcomeFrame;
 
@@ -27,6 +29,7 @@
 import java.nio.file.Paths;
 import java.time.Duration;
 
+import static com.intellij.remoterobot.stepsProcessing.StepWorkerKt.step;
 import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
 
 /**
@@ -48,23 +51,27 @@ public class UITestRunner {
      * @return instance of the RemoteRobot
      */
     public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
-        UITestRunner.ideaVersion = ideaVersion;
-        makeSureAllTermsAndConditionsAreAccepted();
+        StepWorker.registerProcessor(new StepLogger());
 
-        String osName = System.getProperty("os.name").toLowerCase();
-        String fileExtension = osName.contains("windows") ? ".bat" : "";
-        ProcessBuilder pb = new ProcessBuilder("." + File.separator + "gradlew" + fileExtension, "runIdeForUiTests", "-PideaVersion=" + ideaVersion.toString(), "-Drobot-server.port=" + port);
+        return step("Start IntelliJ Idea ('" + ideaVersion.toString() + "') listening on port " + port, () -> {
+            UITestRunner.ideaVersion = ideaVersion;
+            makeSureAllTermsAndConditionsAreAccepted();
 
-        try {
-            ideProcess = pb.start();
-            waitUntilIntelliJStarts(port);
-            remoteRobot = getRemoteRobotConnection(port);
-        } catch (IOException | InterruptedException e) {
-            e.printStackTrace();
-        }
+            String osName = System.getProperty("os.name").toLowerCase();
+            String fileExtension = osName.contains("windows") ? ".bat" : "";
+            ProcessBuilder pb = new ProcessBuilder("." + File.separator + "gradlew" + fileExtension, "runIdeForUiTests", "-PideaVersion=" + ideaVersion.toString(), "-Drobot-server.port=" + port);
 
-        remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10)).clearWorkspace();
-        return remoteRobot;
+            try {
+                ideProcess = pb.start();
+                waitUntilIntelliJStarts(port);
+                remoteRobot = getRemoteRobotConnection(port);
+            } catch (IOException | InterruptedException e) {
+                e.printStackTrace();
+            }
+
+            remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10)).clearWorkspace();
+            return remoteRobot;
+        });
     }
 
     /**
@@ -81,12 +88,14 @@ public static RemoteRobot runIde(IdeaVersion ideaVersion) {
      * Close the IntelliJ Idea IDE from the 'Welcome to IntelliJ IDEA' dialog
      */
     public static void closeIde() {
-        if (remoteRobot.isWin()) {
-            remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10)).runJs("const horizontal_offset = component.getWidth() - 24;\n" +
-                    "robot.click(component, new Point(horizontal_offset, 14), MouseButton.LEFT_BUTTON, 2);");
-        } else {
-            ideProcess.destroy();
-        }
+        step("Close IntelliJ Idea", () -> {
+            if (remoteRobot.isWin()) {
+                remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10)).runJs("const horizontal_offset = component.getWidth() - 24;\n" +
+                        "robot.click(component, new Point(horizontal_offset, 14), MouseButton.LEFT_BUTTON, 2);");
+            } else {
+                ideProcess.destroy();
+            }
+        });
     }
 
     /**
@@ -115,16 +124,22 @@ public static RemoteRobot getRemoteRobot() {
      * @throws InterruptedException may be thrown in Thread.sleep()
      */
     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 step("Create an instance of the RemoteRobot listening on port " + port, () -> {
+            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) {
+                    try {
+                        Thread.sleep(1000);
+                    } catch (InterruptedException e2) {
+                        e2.printStackTrace();
+                    }
+                }
             }
-        }
 
-        return remoteRobot;
+            return remoteRobot;
+        });
     }
 
     /**
@@ -155,51 +170,63 @@ private static void makeSureAllTermsAndConditionsAreAccepted() {
         String osName = System.getProperty("os.name").toLowerCase();
 
         if (osName.contains("linux")) {
-            String prefsXmlSourceLocation = "prefs.xml";
-            String prefsXmlDir = System.getProperty("user.home") + "/.java/.userPrefs/jetbrains/_!(!!cg\"p!(}!}@\"j!(k!|w\"w!'8!b!\"p!':!e@==";
-            createDirectoryHierarchy(prefsXmlDir);
-            copyFileFromJarResourceDir(prefsXmlSourceLocation, prefsXmlDir + "/prefs.xml");
-
-            String acceptedSourceLocation = "accepted";
-            String acceptedDir = System.getProperty("user.home") + "/.local/share/JetBrains/consentOptions";
-            createDirectoryHierarchy(acceptedDir);
-            copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
+            step("Copy the 'prefs.xml' file to the appropriate location", () -> {
+                String prefsXmlSourceLocation = "prefs.xml";
+                String prefsXmlDir = System.getProperty("user.home") + "/.java/.userPrefs/jetbrains/_!(!!cg\"p!(}!}@\"j!(k!|w\"w!'8!b!\"p!':!e@==";
+                createDirectoryHierarchy(prefsXmlDir);
+                copyFileFromJarResourceDir(prefsXmlSourceLocation, prefsXmlDir + "/prefs.xml");
+            });
+
+            step("Copy the 'accepted' file to the appropriate location", () -> {
+                String acceptedSourceLocation = "accepted";
+                String acceptedDir = System.getProperty("user.home") + "/.local/share/JetBrains/consentOptions";
+                createDirectoryHierarchy(acceptedDir);
+                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
+            });
         } 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");
-
-            String acceptedSourceLocation = "accepted";
-            String acceptedDir = System.getProperty("user.home") + "/Library/Application Support/JetBrains/consentOptions";
-            createDirectoryHierarchy(acceptedDir);
-            copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
-
-            // run the 'killall cfprefsd' cmd to force OS X to reload preferences files
-            ProcessBuilder pb = new ProcessBuilder("killall", "cfprefsd");
-            try {
-                Process p = pb.start();
-                p.waitFor();
-            } catch (IOException | InterruptedException e) {
-                e.printStackTrace();
-            }
+            step("Copy the 'com.apple.java.util.prefs.plist' file to the appropriate location", () -> {
+                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");
+            });
+
+            step("Copy the 'accepted' file to the appropriate location", () -> {
+                String acceptedSourceLocation = "accepted";
+                String acceptedDir = System.getProperty("user.home") + "/Library/Application Support/JetBrains/consentOptions";
+                createDirectoryHierarchy(acceptedDir);
+                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
+
+                // run the 'killall cfprefsd' cmd to force OS X to reload preferences files
+                ProcessBuilder pb = new ProcessBuilder("killall", "cfprefsd");
+                try {
+                    Process p = pb.start();
+                    p.waitFor();
+                } catch (IOException | InterruptedException e) {
+                    e.printStackTrace();
+                }
+            });
         } 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'");
-
-            try {
-                Process p1 = pb1.start();
-                p1.waitFor();
-                Process p2 = pb2.start();
-                p2.waitFor();
-            } catch (IOException | InterruptedException e) {
-                e.printStackTrace();
-            }
+            step("Copy the 'accepted' file to the appropriate location", () -> {
+                String acceptedSourceLocation = "accepted";
+                String acceptedDir = System.getProperty("user.home") + "\\AppData\\Roaming\\JetBrains\\consentOptions";
+                createDirectoryHierarchy(acceptedDir);
+                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "\\accepted");
+            });
+
+            step("Create appropriate registry entries", () -> {
+                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'");
+
+                try {
+                    Process p1 = pb1.start();
+                    p1.waitFor();
+                    Process p2 = pb2.start();
+                    p2.waitFor();
+                } catch (IOException | InterruptedException e) {
+                    e.printStackTrace();
+                }
+            });
         }
     }
 

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

@@ -63,11 +63,11 @@ public void createNewProject() {
      * @param label label of the link to click on
      */
     public void clickOnLink(String label) {
-        // Code for IntelliJ Idea 2020.3 or newer
+        // Code for IntelliJ IDEA 2020.3 or newer
         if (intelliJVersion.toInt() >= 20203) {
             welcomeFrameLink(label).click();
         }
-        // Code for IntelliJ Idea 2020.2 or earlier
+        // Code for IntelliJ IDEA 2020.2 or earlier
         else {
             actionLink(label).click();
         }
@@ -77,7 +77,6 @@ public void clickOnLink(String label) {
      * 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
         List<JListFixture> jListFixtures = jLists(byXpath("//div[@accessiblename='Recent Projects']"));
         while (!jListFixtures.isEmpty() && jListFixtures.get(0).findAllText().size() != 1) {
             JListFixture recentProjectsList = jListFixtures.get(0);
@@ -90,7 +89,6 @@ public void clearWorkspace() {
             }
         }
 
-        // 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));
@@ -119,11 +117,11 @@ public void clearExceptions() {
     }
 
     // Works for IntelliJ Idea 2020.3+
-    private JButtonFixture welcomeFrameLink(String text) {
+    private JButtonFixture welcomeFrameLink(String label) {
         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='JBOptionButton' and @text='" + label + "']"), Duration.ofSeconds(2));
         }
-        return button(byXpath("//div[@class='NonOpaquePanel'][./div[@text='" + text + "']]"), Duration.ofSeconds(2));
+        return button(byXpath("//div[@class='NonOpaquePanel'][./div[@text='" + label + "']]"), Duration.ofSeconds(2));
     }
 
     private ComponentFixture ideErrorsIcon() {

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

@@ -32,7 +32,7 @@
 import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
 
 /**
- * Search everywhere popup fixture
+ * Search Everywhere popup fixture
  *
  * @author [email protected]
  */

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

@@ -23,6 +23,7 @@
 import java.time.Duration;
 
 import static com.intellij.remoterobot.search.locators.Locators.byXpath;
+import static com.intellij.remoterobot.stepsProcessing.StepWorkerKt.step;
 
 /**
  * New Project dialog java project third page fixture
@@ -32,31 +33,32 @@
 @DefaultXpath(by = "MyDialog type", xpath = "//div[@class='DialogRootPane']")
 @FixtureName(name = "New Project Dialog")
 public class JavaNewProjectFinalPage extends AbstractNewProjectFinalPage {
-    private RemoteRobot remoteRobot;
-
     public JavaNewProjectFinalPage(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
         super(remoteRobot, remoteComponent);
-        this.remoteRobot = remoteRobot;
     }
 
     /**
      * Open the 'More settings' options
      */
     public void openMoreSettings() {
-        boolean isAlreadyOpened = isMoreSettingOpened();
-        if (!isAlreadyOpened) {
-            jLabel(ButtonLabels.moreSettings).click();
-        }
+        step("Open the 'More settings' options", () -> {
+            boolean isAlreadyOpened = isMoreSettingOpened();
+            if (!isAlreadyOpened) {
+                jLabel(ButtonLabels.moreSettings).click();
+            }
+        });
     }
 
     /**
      * Close the 'More settings' options
      */
     public void closeMoreSettings() {
-        boolean isAlreadyOpened = isMoreSettingOpened();
-        if (isAlreadyOpened) {
-            jLabel(ButtonLabels.moreSettings).click();
-        }
+        step("Close the 'More settings' options", () -> {
+            boolean isAlreadyOpened = isMoreSettingOpened();
+            if (isAlreadyOpened) {
+                jLabel(ButtonLabels.moreSettings).click();
+            }
+        });
     }
 
     /**

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

@@ -21,6 +21,7 @@
 import java.util.List;
 
 import static com.intellij.remoterobot.search.locators.Locators.byXpath;
+import static com.intellij.remoterobot.stepsProcessing.StepWorkerKt.step;
 
 /**
  * New Project dialog maven project second page fixture
@@ -38,18 +39,22 @@ public MavenGradleNewProjectFinalPage(@NotNull RemoteRobot remoteRobot, @NotNull
      * Open the 'Artifact Coordinates' options
      */
     public void openArtifactCoordinates() {
-        if (!isArtifactCoordinatesOpened()) {
-            jLabel(ButtonLabels.artifactCoordinates).click();
-        }
+        step("Open the 'Artifact Coordinates' options", () -> {
+            if (!isArtifactCoordinatesOpened()) {
+                jLabel(ButtonLabels.artifactCoordinates).click();
+            }
+        });
     }
 
     /**
      * Close the 'Artifact Coordinates' options
      */
     public void closeArtifactCoordinates() {
-        if (isArtifactCoordinatesOpened()) {
-            jLabel(ButtonLabels.artifactCoordinates).click();
-        }
+        step("Close the 'Artifact Coordinates' options", () -> {
+            if (isArtifactCoordinatesOpened()) {
+                jLabel(ButtonLabels.artifactCoordinates).click();
+            }
+        });
     }
 
     /**