feat: Redirecting outputs of intellij instance process improvements (#215)

* feat: Redirect intellij process outputs to user.dir

Signed-off-by: Richard Kocian <[email protected]>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

* feat: Redirecting intellij process outputs depends on intellij_debug property

Signed-off-by: Richard Kocian <[email protected]>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

* feat: Redirect intellij process outputs in test-project

Signed-off-by: Richard Kocian <[email protected]>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

* docs: Added info about intellij_debug

Signed-off-by: Richard Kocian <[email protected]>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

Author: richardkocian

README.md

@@ -81,6 +81,16 @@ systemProperties['testProjectLocation'] = project.hasProperty('testProjectLocati
 ./gradlew integrationTest -PtestProjectLocation=${env.HOME}/IdeaProjects/intellij-ui-test-projects/
 ```
 
+### Remote-robot IntelliJ instance logs
+If developers want to view the remote-robot intellij instance logs, they can specify system property intellij_debug to save these logs to files, which will be stored inside $user.dir/intellij_debug folder.
+```
+task integrationTest(type: Test) {
+    ...
+    systemProperties['intellij_debug'] = 'true'
+    ...
+}
+```
+
 ## Start and quit IntelliJ IDEA
 Use the following code to start IntelliJ before running the first UI test. The runIde() method not only starts the IDE for UI tests, it also returns reference to the Remote-Robot instance which will be useful later to access UI elements such as buttons, inputs etc.
 ```

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

@@ -78,7 +78,11 @@ public static RemoteRobot runIde(IntelliJVersion ideaVersion, int port) {
 
             String fileExtension = OS_NAME.contains("windows") ? ".bat" : "";
             ProcessBuilder pb = new ProcessBuilder("." + File.separator + "gradlew" + fileExtension, "runIdeForUiTests", "-PideaVersion=" + ideaVersion, "-Drobot-server.port=" + port);
-            redirectProcessOutputs(pb);
+
+            boolean isDebugOn = Boolean.parseBoolean(System.getProperty("intellij_debug", "false")); // For more info on intellij_debug please check README
+            if (isDebugOn) {
+                redirectProcessOutputs(pb);
+            }
 
             try {
                 ideProcess = pb.start();
@@ -316,10 +320,10 @@ private static void copyFileFromJarResourceDir(String sourceFileLocation, String
      * @param pb    Process builder of running subprocess
      */
     private static void redirectProcessOutputs(ProcessBuilder pb) {
-        String outDir = System.getProperty("user.home") + File.separator + "IntelliJ_debug";
+        String outDir = System.getProperty("user.dir") + File.separator + "intellij_debug";
 
         if (!new File(outDir).mkdirs()) {
-            LOGGER.log(Level.SEVERE, "Cannot create user.home/debug directory");
+            LOGGER.log(Level.SEVERE, "Cannot create user.dir/intellij_debug directory");
         }
 
         File stdoutLog = new File(outDir + File.separator + "stdout.log");

src/test-project/build.gradle

@@ -31,5 +31,6 @@ patchPluginXml {
 }
 
 test {
+    systemProperties['intellij_debug'] = 'true'
     useJUnitPlatform()
 }