Merge pull request #64 from zcervink/62

Fix the issues reported from the SonarCloud

Author: odockal

.github/workflows/mac.yml

@@ -1,7 +1,7 @@
 # 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 - maccOS
+name: Java CI with Gradle - macOS
 
 on:
   push:

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/utils/labels/ButtonLabels.java

@@ -8,13 +8,14 @@
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
  ******************************************************************************/
-package com.redhat.devtools.intellij.commonUiTestLibrary;
+package com.redhat.devtools.intellij.commonuitest;
 
 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;
+import com.redhat.devtools.intellij.commonuitest.exceptions.UITestException;
+import com.redhat.devtools.intellij.commonuitest.fixtures.dialogs.FlatWelcomeFrame;
 
 import java.io.File;
 import java.io.FileOutputStream;
@@ -28,6 +29,8 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.time.Duration;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import static com.intellij.remoterobot.stepsProcessing.StepWorkerKt.step;
 import static com.intellij.remoterobot.utils.RepeatUtilsKt.waitFor;
@@ -38,7 +41,12 @@
  * @author [email protected]
  */
 public class UITestRunner {
-    private static final int defaultPort = 8580;
+    private static final int DEFAULT_PORT = 8580;
+    private static final String ACCEPTED_SOURCE_LOCATION = "accepted";
+    private static final String COPY_ACCEPTED_FILE_STEP_DESCRIPTION = "Copy the 'accepted' file to the appropriate location";
+    private static final Logger LOGGER = Logger.getLogger(UITestRunner.class.getName());
+    private static final String OS_NAME = System.getProperty("os.name").toLowerCase();
+    private static final String USER_HOME = System.getProperty("user.home");
     private static RemoteRobot remoteRobot = null;
     private static Process ideProcess;
     private static IdeaVersion ideaVersion;
@@ -57,16 +65,15 @@ public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
             UITestRunner.ideaVersion = ideaVersion;
             makeSureAllTermsAndConditionsAreAccepted();
 
-            String osName = System.getProperty("os.name").toLowerCase();
-            String fileExtension = osName.contains("windows") ? ".bat" : "";
+            String fileExtension = OS_NAME.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);
                 remoteRobot = getRemoteRobotConnection(port);
-            } catch (IOException | InterruptedException e) {
-                e.printStackTrace();
+            } catch (IOException e) {
+                LOGGER.log(Level.SEVERE, e.getMessage(), e);
             }
 
             remoteRobot.find(FlatWelcomeFrame.class, Duration.ofSeconds(10)).clearWorkspace();
@@ -81,7 +88,7 @@ public static RemoteRobot runIde(IdeaVersion ideaVersion, int port) {
      * @return instance of the RemoteRobot
      */
     public static RemoteRobot runIde(IdeaVersion ideaVersion) {
-        return runIde(ideaVersion, defaultPort);
+        return runIde(ideaVersion, DEFAULT_PORT);
     }
 
     /**
@@ -121,9 +128,8 @@ public static RemoteRobot getRemoteRobot() {
      *
      * @param port port number
      * @return instance of the RemoteRobot
-     * @throws InterruptedException may be thrown in Thread.sleep()
      */
-    public static RemoteRobot getRemoteRobotConnection(int port) throws InterruptedException {
+    public static RemoteRobot getRemoteRobotConnection(int port) {
         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++) {
@@ -133,7 +139,8 @@ public static RemoteRobot getRemoteRobotConnection(int port) throws InterruptedE
                     try {
                         Thread.sleep(1000);
                     } catch (InterruptedException e2) {
-                        e2.printStackTrace();
+                        LOGGER.log(Level.SEVERE, e2.getMessage(), e2);
+                        Thread.currentThread().interrupt();
                     }
                 }
             }
@@ -149,7 +156,7 @@ public enum IdeaVersion {
         V_2020_2("IC-2020.2"),
         V_2020_3("IC-2020.3");
 
-        final private String ideaVersionStringRepresentation;
+        private final String ideaVersionStringRepresentation;
 
         IdeaVersion(String ideaVersionStringRepresentation) {
             this.ideaVersionStringRepresentation = ideaVersionStringRepresentation;
@@ -167,64 +174,62 @@ public int toInt() {
     }
 
     private static void makeSureAllTermsAndConditionsAreAccepted() {
-        String osName = System.getProperty("os.name").toLowerCase();
-
-        if (osName.contains("linux")) {
+        if (OS_NAME.contains("linux")) {
             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@==";
+                String prefsXmlDir = 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";
+            step(COPY_ACCEPTED_FILE_STEP_DESCRIPTION, () -> {
+                String acceptedDir = USER_HOME + "/.local/share/JetBrains/consentOptions";
                 createDirectoryHierarchy(acceptedDir);
-                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
+                copyFileFromJarResourceDir(ACCEPTED_SOURCE_LOCATION, acceptedDir + "/accepted");
             });
-        } else if (osName.contains("os x")) {
+        } else if (OS_NAME.contains("os x")) {
             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";
+                String plistDir = 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";
+            step(COPY_ACCEPTED_FILE_STEP_DESCRIPTION, () -> {
+                String acceptedDir = USER_HOME + "/Library/Application Support/JetBrains/consentOptions";
                 createDirectoryHierarchy(acceptedDir);
-                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "/accepted");
+                copyFileFromJarResourceDir(ACCEPTED_SOURCE_LOCATION, acceptedDir + "/accepted");
 
                 // run the 'killall cfprefsd' cmd to force OS X to reload preferences files
-                ProcessBuilder pb = new ProcessBuilder("killall", "cfprefsd");
+                ProcessBuilder pb = new ProcessBuilder("/usr/bin/killall", "cfprefsd");
                 try {
                     Process p = pb.start();
                     p.waitFor();
                 } catch (IOException | InterruptedException e) {
-                    e.printStackTrace();
+                    LOGGER.log(Level.SEVERE, e.getMessage(), e);
+                    Thread.currentThread().interrupt();
                 }
             });
-        } else if (osName.contains("windows")) {
-            step("Copy the 'accepted' file to the appropriate location", () -> {
-                String acceptedSourceLocation = "accepted";
-                String acceptedDir = System.getProperty("user.home") + "\\AppData\\Roaming\\JetBrains\\consentOptions";
+        } else if (OS_NAME.contains("windows")) {
+            step(COPY_ACCEPTED_FILE_STEP_DESCRIPTION, () -> {
+                String acceptedDir = USER_HOME + "\\AppData\\Roaming\\JetBrains\\consentOptions";
                 createDirectoryHierarchy(acceptedDir);
-                copyFileFromJarResourceDir(acceptedSourceLocation, acceptedDir + "\\accepted");
+                copyFileFromJarResourceDir(ACCEPTED_SOURCE_LOCATION, 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'");
+                String registryPath = "HKCU:" + "\\Software\\JavaSoft\\Prefs\\jetbrains\\privacy_policy";
+                String powershellLocation = "C:\\Windows\\system32\\WindowsPowerShell\\v1.0\\powershell.exe";
+                ProcessBuilder pb1 = new ProcessBuilder(powershellLocation, "New-Item", "-Path", registryPath, "-Force");
+                ProcessBuilder pb2 = new ProcessBuilder(powershellLocation, "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();
+                    LOGGER.log(Level.SEVERE, e.getMessage(), e);
+                    Thread.currentThread().interrupt();
                 }
             });
         }
@@ -240,35 +245,43 @@ private static boolean isIntelliJUIVisible(int 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) {
+        try (Socket socket = new Socket()) {
+            connectToHost(socket, sockaddr);
+        } catch (IOException e) {
             return false;
         }
         return true;
     }
 
+    private static void connectToHost(Socket socket, SocketAddress sockaddr) throws IOException {
+        socket.connect(sockaddr, 10000);
+        try {
+            socket.close();
+        } catch (IOException e) {
+            LOGGER.log(Level.SEVERE, e.getMessage(), e);
+        }
+    }
+
     private static void createDirectoryHierarchy(String location) {
         Path path = Paths.get(location);
         try {
             Files.createDirectories(path);
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.log(Level.SEVERE, e.getMessage(), e);
         }
     }
 
     private static void copyFileFromJarResourceDir(String sourceFileLocation, String destFileLocation) {
         InputStream resourceStream = UITestRunner.class.getClassLoader().getResourceAsStream(sourceFileLocation);
-        try {
+        try (OutputStream outStream = new FileOutputStream(new File(destFileLocation))) {
             byte[] buffer = new byte[resourceStream.available()];
-            resourceStream.read(buffer);
-            File targetFile = new File(destFileLocation);
-            OutputStream outStream = new FileOutputStream(targetFile);
+            int count = resourceStream.read(buffer);
+            if (count == 0) {
+                throw new UITestException("Reading from buffer was unsuccessful.");
+            }
             outStream.write(buffer);
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.log(Level.SEVERE, e.getMessage(), e);
         }
     }
 }

src/main/java/com/redhat/devtools/intellij/commonUiTestLibrary/UITestRunner.java renamed to src/main/java/com/redhat/devtools/intellij/commonuitest/UITestRunner.java

@@ -8,7 +8,7 @@
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
  ******************************************************************************/
-package com.redhat.devtools.intellij.commonUiTestLibrary.exceptions;
+package com.redhat.devtools.intellij.commonuitest.exceptions;
 
 /**
  * IntelliJ UI test library runtime exception

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

@@ -8,7 +8,7 @@
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
  ******************************************************************************/
-package com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs;
+package com.redhat.devtools.intellij.commonuitest.fixtures.dialogs;
 
 import com.intellij.remoterobot.RemoteRobot;
 import com.intellij.remoterobot.data.RemoteComponent;
@@ -21,8 +21,8 @@
 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;
+import com.redhat.devtools.intellij.commonuitest.UITestRunner;
+import com.redhat.devtools.intellij.commonuitest.fixtures.dialogs.errors.IdeFatalErrorsDialog;
 import org.apache.commons.io.FileUtils;
 import org.jetbrains.annotations.NotNull;
 
@@ -32,6 +32,8 @@
 import java.nio.file.Paths;
 import java.time.Duration;
 import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import static com.intellij.remoterobot.search.locators.Locators.byXpath;
 
@@ -43,6 +45,7 @@
 @DefaultXpath(by = "FlatWelcomeFrame type", xpath = "//div[@class='FlatWelcomeFrame']")
 @FixtureName(name = "Welcome To IntelliJ IDEA Dialog")
 public class FlatWelcomeFrame extends CommonContainerFixture {
+    private static final Logger LOGGER = Logger.getLogger(FlatWelcomeFrame.class.getName());
     private UITestRunner.IdeaVersion intelliJVersion;
 
     public FlatWelcomeFrame(@NotNull RemoteRobot remoteRobot, @NotNull RemoteComponent remoteComponent) {
@@ -98,7 +101,7 @@ public void clearWorkspace() {
                 Files.createDirectory(Paths.get(pathToDirToMakeEmpty));
             }
         } catch (IOException e) {
-            e.printStackTrace();
+            LOGGER.log(Level.SEVERE, e.getMessage(), e);
         }
     }
 
@@ -109,7 +112,7 @@ public void clearExceptions() {
         try {
             ideErrorsIcon().click();
         } catch (WaitForConditionTimeoutException e) {
-            e.printStackTrace();
+            LOGGER.log(Level.SEVERE, e.getMessage(), e);
             return;
         }
 

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

@@ -8,14 +8,14 @@
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
  ******************************************************************************/
-package com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.errors;
+package com.redhat.devtools.intellij.commonuitest.fixtures.dialogs.errors;
 
 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.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
+import com.redhat.devtools.intellij.commonuitest.utils.labels.ButtonLabels;
 import org.jetbrains.annotations.NotNull;
 
 /**
@@ -34,6 +34,6 @@ public IdeFatalErrorsDialog(@NotNull RemoteRobot remoteRobot, @NotNull RemoteCom
      * Click on the 'Clear all' button
      */
     public void clearAll() {
-        button(ButtonLabels.clearAllLabel).click();
+        button(ButtonLabels.CLEAR_ALL_LABEL).click();
     }
 }

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

@@ -8,14 +8,14 @@
  * Contributors:
  * Red Hat, Inc. - initial API and implementation
  ******************************************************************************/
-package com.redhat.devtools.intellij.commonUiTestLibrary.fixtures.dialogs.information;
+package com.redhat.devtools.intellij.commonuitest.fixtures.dialogs.information;
 
 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.redhat.devtools.intellij.commonUiTestLibrary.utils.labels.ButtonLabels;
+import com.redhat.devtools.intellij.commonuitest.utils.labels.ButtonLabels;
 import org.jetbrains.annotations.NotNull;
 
 /**
@@ -34,6 +34,6 @@ public ProjectStructureDialog(@NotNull RemoteRobot remoteRobot, @NotNull RemoteC
      * Cancel the 'Project Structure'
      */
     public void cancel() {
-        button(ButtonLabels.cancelLabel).click();
+        button(ButtonLabels.CANCEL_LABEL).click();
     }
 }