Merge pull request #158 from adangel:windows

Fix tests to run under Windows and MacOS #158

Author: adangel

.ci/build.sh

@@ -14,20 +14,24 @@ function build() {
         pmd_ci_openjdk_setdefault 11
     pmd_ci_log_group_end
 
-    pmd_ci_log_group_start "Install xvfb"
-        #see https://github.com/GabrielBB/xvfb-action
-        sudo apt-get install --yes xvfb
-        sudo apt-get install --yes libgtk2.0-0
-    pmd_ci_log_group_end
-
     echo
     pmd_ci_maven_display_info_banner
     pmd_ci_utils_determine_build_env pmd/pmd-eclipse-plugin
     echo
 
+    xvfb_cmd=""
+    if [ "$(pmd_ci_utils_get_os)" == "linux" ]; then
+    pmd_ci_log_group_start "Install xvfb (linux only)"
+        #see https://github.com/GabrielBB/xvfb-action
+        sudo apt-get install --yes xvfb
+        sudo apt-get install --yes libgtk2.0-0
+        xvfb_cmd="xvfb-run --auto-servernum"
+    pmd_ci_log_group_end
+    fi
+
     if pmd_ci_utils_is_fork_or_pull_request; then
         pmd_ci_log_group_start "Build with mvnw"
-            xvfb-run --auto-servernum ./mvnw clean verify \
+            ${xvfb_cmd} ./mvnw clean verify \
                 --show-version --errors --batch-mode --no-transfer-progress \
                 --toolchains .ci/files/toolchains.xml
         pmd_ci_log_group_end
@@ -37,6 +41,17 @@ function build() {
     # stop early for invalid maven version and branch/tag combination
     pmd_ci_maven_verify_version || exit 0
 
+    if [ "$(pmd_ci_utils_get_os)" != "linux" ]; then
+        pmd_ci_log_group_start "Build with mvnw"
+            ${xvfb_cmd} ./mvnw clean verify \
+                --show-version --errors --batch-mode --no-transfer-progress \
+                --toolchains .ci/files/toolchains.xml
+        pmd_ci_log_group_end
+
+        pmd_ci_log_info "Stopping build here, because os is not linux"
+        exit 0
+    fi
+
     # only builds on pmd/pmd-eclipse-plugin continue here
     pmd_ci_log_group_start "Setup environment"
         pmd_ci_setup_secrets_private_env
@@ -60,12 +75,12 @@ function snapshot_build() {
         pmd_ci_log_info "This is a snapshot build on branch ${PMD_CI_BRANCH} (version: ${PMD_CI_MAVEN_PROJECT_VERSION})"
 
         # Build 1 - without signing but with tests
-        xvfb-run --auto-servernum ./mvnw clean verify \
+        ${xvfb_cmd} ./mvnw clean verify \
             --show-version --errors --batch-mode --no-transfer-progress \
             --toolchains .ci/files/toolchains.xml
 
         # Build 2 - with signing, but skipping tests, pmd, checkstyle
-        xvfb-run --auto-servernum ./mvnw clean verify \
+        ${xvfb_cmd} ./mvnw clean verify \
             --show-version --errors --batch-mode --no-transfer-progress \
             --toolchains .ci/files/toolchains.xml \
             --activate-profiles sign \
@@ -117,12 +132,12 @@ function release_build() {
         pmd_ci_log_info "This is a release build for tag ${PMD_CI_TAG} (version: ${PMD_CI_MAVEN_PROJECT_VERSION})"
 
         # Build 1 - without signing but with tests
-        xvfb-run --auto-servernum ./mvnw clean verify \
+        ${xvfb_cmd} ./mvnw clean verify \
             --show-version --errors --batch-mode --no-transfer-progress \
             --toolchains .ci/files/toolchains.xml
 
         # Build 2 - with signing, but skipping tests, pmd, checkstyle
-        xvfb-run --auto-servernum ./mvnw clean verify \
+        ${xvfb_cmd} ./mvnw clean verify \
             --show-version --errors --batch-mode --no-transfer-progress \
             --toolchains .ci/files/toolchains.xml \
             --activate-profiles sign \

.github/workflows/build.yml

@@ -15,8 +15,11 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     continue-on-error: false
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
     if: ${{ !contains(github.event.head_commit.message, '[skip ci]') }}
     steps:
     - uses: actions/checkout@v2

ReleaseNotes.md

@@ -15,6 +15,8 @@ This is a minor release.
 
 ### Fixed Issues
 
+*   [#159](https://github.com/pmd/pmd-eclipse-plugin/issues/159): Error executing command ReviewCode: java.util.regex.PatternSyntaxException: Illegal/unsupported escape sequence near index (part 2)
+
 ### API Changes
 
 ### External Contributions

net.sourceforge.pmd.eclipse.plugin.test/pom.xml

@@ -65,32 +65,24 @@
     </plugins>
   </build>
 
-<!--
   <profiles>
     <profile>
       <id>osx</id>
       <activation>
-        <property>
-          <name>java.vendor.url</name>
-          <value>http://www.apple.com/</value>
-        </property>
+        <os><family>mac</family></os>
       </activation>
       <build>
-        <pluginManagement>
-          <plugins>
-            <plugin>
-              <groupId>org.eclipse.tycho</groupId>
-              <artifactId>tycho-surefire-plugin</artifactId>
-              <version>${tycho.version}</version>
-              <configuration>
-                <argLine>-XstartOnFirstThread</argLine>
-              </configuration>
-            </plugin>
-          </plugins>
-        </pluginManagement>
+        <plugins>
+          <plugin>
+            <groupId>org.eclipse.tycho</groupId>
+            <artifactId>tycho-surefire-plugin</artifactId>
+            <configuration>
+              <argLine>-XstartOnFirstThread</argLine>
+            </configuration>
+          </plugin>
+        </plugins>
       </build>
     </profile>
   </profiles>
- -->
 
 </project>

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/EclipseUtils.java

@@ -14,7 +14,7 @@
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
-import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
 import java.util.regex.Pattern;
 
 import org.eclipse.core.resources.IContainer;
@@ -27,12 +27,14 @@
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IPath;
-import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.jdt.core.IClasspathEntry;
 import org.eclipse.jdt.core.IJavaProject;
 import org.eclipse.jdt.core.JavaCore;
 import org.eclipse.jdt.core.JavaModelException;
+import org.eclipse.jdt.launching.JavaRuntime;
+import org.junit.Assert;
 
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
@@ -45,21 +47,7 @@
  * @author Philippe Herlin
  * @author Brian Remedios
  */
-public class EclipseUtils {
-    static class OpenMonitor extends NullProgressMonitor {
-        private final CountDownLatch latch;
-
-        OpenMonitor(final CountDownLatch latch) {
-            this.latch = latch;
-        }
-
-        @Override
-        public void done() {
-            super.done();
-            latch.countDown();
-        }
-    }
-
+public final class EclipseUtils {
     /**
      * Because this class is a utility class, it cannot be instantiated
      */
@@ -230,7 +218,7 @@ public static void addJavaNature(final IProject project) throws CoreException {
             javaProject
                     .setRawClasspath(
                             new IClasspathEntry[] { JavaCore.newSourceEntry(sourceFolder.getFullPath()),
-                                JavaCore.newContainerEntry(new Path("org.eclipse.jdt.launching.JRE_CONTAINER")) },
+                                JavaRuntime.getDefaultJREContainerEntry() },
                             null);
 
             Hashtable<String, String> javaOptions = JavaCore.getOptions();
@@ -370,4 +358,17 @@ public static void createFolders(IProject testProject, String fullpath) throws C
             current = folder;
         }
     }
+
+    public static void waitForJobs() throws InterruptedException {
+        long start = System.currentTimeMillis();
+        Thread.sleep(500);
+
+        while (!Job.getJobManager().isIdle()) {
+            Thread.sleep(500);
+
+            if (System.currentTimeMillis() - start > TimeUnit.SECONDS.toMillis(30)) {
+                Assert.fail("Timeout while waiting for Jobs to finish");
+            }
+        }
+    }
 }

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/LoggingRule.java

@@ -0,0 +1,25 @@
+/*
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.eclipse;
+
+import org.junit.rules.TestWatcher;
+import org.junit.runner.Description;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LoggingRule extends TestWatcher {
+
+    @Override
+    protected void starting(Description description) {
+        final Logger LOG = LoggerFactory.getLogger(description.getClassName());
+        LOG.debug("\n*\n*\n* Starting test {}\n*\n*\n*", description.getMethodName());
+    }
+
+    @Override
+    protected void finished(Description description) {
+        final Logger LOG = LoggerFactory.getLogger(description.getClassName());
+        LOG.debug("\n*\n*\n* Finished test {}\n*\n*\n*", description.getMethodName());
+    }
+}

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/WaitingMonitor.java

@@ -0,0 +1,24 @@
+/*
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.eclipse;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+import org.eclipse.core.runtime.NullProgressMonitor;
+
+public class WaitingMonitor extends NullProgressMonitor {
+    private final CountDownLatch latch = new CountDownLatch(1);
+
+    @Override
+    public void done() {
+        super.done();
+        latch.countDown();
+    }
+
+    public void await() throws InterruptedException {
+        latch.await(30, TimeUnit.SECONDS);
+    }
+}

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/internal/TestActivator.java

@@ -4,11 +4,19 @@
 
 package net.sourceforge.pmd.eclipse.internal;
 
+import java.io.File;
+import java.io.IOException;
+
+import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
+import org.eclipse.jdt.launching.IVMInstall;
+import org.eclipse.jdt.launching.IVMInstallType;
+import org.eclipse.jdt.launching.JavaRuntime;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.slf4j.LoggerFactory;
 
+import net.sourceforge.pmd.eclipse.WaitingMonitor;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 
 import ch.qos.logback.classic.Level;
@@ -26,7 +34,37 @@ public TestActivator() {
         } else {
             mainPlugin.getLog().log(new Status(IStatus.WARNING, PMDPlugin.PLUGIN_ID, "Couldn't setup logging for tests."));
         }
-        
-    }
 
+        // Setup a default JVM. This is especially required for mac osx on github actions,
+        // as there is no default JVM detected automatically.
+        // This is not done via the following extension, in order to check for the existence of openjdk8Path:
+        /*
+   <extension
+         point="org.eclipse.jdt.launching.vmInstalls">
+      <vmInstall
+            home="${env_var:HOME}/openjdk8"
+            id="net.sourceforge.pmd.eclipse.plugin.test.openjdk8"
+            name="openjdk8"
+            vmInstallType="org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType">
+      </vmInstall>
+   </extension>
+         */
+        File openjdk8Path = new File(System.getProperty("user.home"), "openjdk8");
+        if (openjdk8Path.exists()) {
+            try {
+                openjdk8Path = openjdk8Path.getCanonicalFile();
+                IVMInstallType vmInstallType = JavaRuntime.getVMInstallType("org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType");
+                IVMInstall vm = vmInstallType.createVMInstall("net.sourceforge.pmd.eclipse.plugin.test.openjdk8");
+                vm.setInstallLocation(openjdk8Path);
+                vm.setName("openjdk8");
+                WaitingMonitor monitor = new WaitingMonitor();
+                JavaRuntime.setDefaultVMInstall(vm, monitor);
+                monitor.await();
+            } catch (IOException | CoreException | InterruptedException e) {
+                mainPlugin.getLog().log(new Status(IStatus.ERROR, PMDPlugin.PLUGIN_ID,
+                        "Error setting up default JVM " + openjdk8Path, e));
+                Thread.currentThread().interrupt();
+            }
+        }
+    }
 }

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/MultipleRulesetsTest.java

@@ -17,7 +17,6 @@
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.NullProgressMonitor;
 import org.eclipse.core.runtime.Path;
-import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.jdt.core.IClasspathEntry;
 import org.eclipse.jdt.core.IJavaProject;
 import org.eclipse.jdt.core.JavaCore;
@@ -119,7 +118,7 @@ public void done() {
             }
         });
         latch.await(30, TimeUnit.SECONDS);
-        waitForJobs();
+        EclipseUtils.waitForJobs();
 
         final ReviewCodeCmd cmd = new ReviewCodeCmd();
         cmd.addResource(this.testProject);
@@ -143,13 +142,6 @@ public void done() {
         assertHasRuleViolation(markersThird, "UseUtilityClass");
     }
 
-    private void waitForJobs() throws InterruptedException {
-        long start = System.currentTimeMillis();
-        while (!Job.getJobManager().isIdle() && System.currentTimeMillis() - start < TimeUnit.SECONDS.toMillis(30)) {
-            Thread.sleep(500);
-        }
-    }
-
     private void assertHasRuleViolation(IMarker[] markers, String rulename) throws CoreException {
         boolean found = false;
         for (IMarker marker : markers) {

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCmdTest.java

@@ -30,6 +30,8 @@
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.eclipse.EclipseUtils;
+import net.sourceforge.pmd.eclipse.LoggingRule;
+import net.sourceforge.pmd.eclipse.WaitingMonitor;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences;
@@ -45,6 +47,9 @@
 public class ReviewCmdTest {
     private IProject testProject;
 
+    @org.junit.Rule
+    public LoggingRule loggingRule = new LoggingRule();
+
     @Before
     public void setUp() throws Exception {
 
@@ -116,8 +121,16 @@ private IFile createMissingOverrideTestCase(IProject project) throws Exception {
               + "  void run() {\n" // line 2
               + "  }\n"
               + "}");
-        project.build(IncrementalProjectBuilder.FULL_BUILD, null);
-        project.refreshLocal(IResource.DEPTH_INFINITE, null);
+
+        WaitingMonitor monitor;
+        monitor = new WaitingMonitor();
+        project.refreshLocal(IResource.DEPTH_INFINITE, monitor);
+        monitor.await();
+
+        monitor = new WaitingMonitor();
+        project.build(IncrementalProjectBuilder.FULL_BUILD, monitor);
+        monitor.await();
+
         return sourceFile;
     }