Migrate tests to JUnit Jupiter (#363)

* Migrate annotations and imports
* Migrate assertions
* Remove public visibility for test classes and methods
* Minor code cleanup
* Ban JUnit4 imports

Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>

Author: strangelookingnerd

pom.xml

@@ -63,6 +63,7 @@ THE SOFTWARE.
     <jenkins.version>${jenkins.baseline}.3</jenkins.version>
     <no-test-jar>false</no-test-jar>
     <spotbugs.threshold>High</spotbugs.threshold> <!-- TODO some violations remaining -->
+    <ban-junit4-imports.skip>false</ban-junit4-imports.skip>
     <svnkit.version>1.10.11</svnkit.version>
   </properties>
 

src/test/java/hudson/scm/AbstractSubversionTest.java

@@ -5,55 +5,61 @@
 import hudson.Launcher.LocalLauncher;
 import hudson.Proc;
 import hudson.util.StreamTaskListener;
-
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.when;
 import net.sf.json.JSONObject;
-
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.junit.jupiter.api.io.TempDir;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.BuildWatcherExtension;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
 import org.kohsuke.stapler.StaplerRequest2;
+import org.opentest4j.TestAbortedException;
 
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.ServerSocket;
 import java.net.Socket;
 import java.net.URL;
-import org.junit.AssumptionViolatedException;
-import org.junit.ClassRule;
-import org.junit.Rule;
-import org.junit.rules.TemporaryFolder;
-import org.jvnet.hudson.test.BuildWatcher;
-import org.jvnet.hudson.test.JenkinsRule;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 /**
  * Base class for Subversion related tests.
  *
  * @author Kohsuke Kawaguchi
  */
 // TODO perhaps merge into SubversionSampleRepoRule
+@WithJenkins
 public abstract class AbstractSubversionTest {
 
-    @ClassRule
-    public static BuildWatcher buildWatcher = new BuildWatcher();
+    @SuppressWarnings("unused")
+    @RegisterExtension
+    private static final BuildWatcherExtension BUILD_WATCHER = new BuildWatcherExtension();
+
+    protected JenkinsRule r;
 
-    @Rule
-    public JenkinsRule r = new JenkinsRule();
+    @TempDir
+    protected File tmp;
 
-    @Rule
-    public TemporaryFolder tmp = new TemporaryFolder();
+    @BeforeEach
+    protected void beforeEach(JenkinsRule rule) throws Exception {
+        r = rule;
+    }
 
     /**
      * Configure the SVN workspace format - i.e. the format of the local workspace copy.
-     * 
+     *
      * @param format one of the WC constants form SVNAdminAreaFactory or SubversionWorkspaceSelector.WC_FORMAT_17
      */
     protected void configureSvnWorkspaceFormat(int format) throws Exception {
-    	StaplerRequest2 req = mock(StaplerRequest2.class);
-    	when(req.getParameter("svn.workspaceFormat")).thenReturn(""+format);
-    	
-    	JSONObject formData = new JSONObject();
-    	
-    	r.jenkins.getDescriptorByType(SubversionSCM.DescriptorImpl.class).configure(req, formData);
+        StaplerRequest2 req = mock(StaplerRequest2.class);
+        when(req.getParameter("svn.workspaceFormat")).thenReturn("" + format);
+
+        JSONObject formData = new JSONObject();
+
+        r.jenkins.getDescriptorByType(SubversionSCM.DescriptorImpl.class).configure(req, formData);
     }
 
     protected void configureSvnWorkspaceFormat2(int format) throws Exception {
@@ -69,19 +75,19 @@ protected void configureSvnWorkspaceFormat2(int format) throws Exception {
     public static void checkForSvnServe() throws InterruptedException {
         LocalLauncher launcher = new LocalLauncher(StreamTaskListener.fromStdout());
         try {
-            launcher.launch().cmds("svnserve","--help").start().join();
+            launcher.launch().cmds("svnserve", "--help").start().join();
         } catch (IOException e) {
             // TODO better to add a docker-fixtures test dep so CI builds can run these tests
-            throw new AssumptionViolatedException("svnserve apparently not installed", e);
+            throw new TestAbortedException("svnserve apparently not installed", e);
         }
     }
 
     public Proc runSvnServe(URL zip) throws Exception {
         return runSvnServe(tmp, zip);
     }
 
-    public static Proc runSvnServe(TemporaryFolder tmp, URL zip) throws Exception {
-        File target = tmp.newFolder();
+    public static Proc runSvnServe(File tmp, URL zip) throws Exception {
+        File target = newFolder(tmp, "junit-" + System.currentTimeMillis());
         try (InputStream is = zip.openStream()) {
             new FilePath(target).unzipFrom(is);
         }
@@ -126,7 +132,7 @@ public static Proc runSvnServe(File repo) throws Exception {
     private static void waitForSvnServer(int port) throws InterruptedException {
         boolean serverReady = false;
         int retries = 0;
-        while(serverReady == false && retries < 6){
+        while (!serverReady && retries < 6) {
             try (Socket s = new Socket("localhost", port)) {
                 // Server is up
                 serverReady = true;
@@ -138,4 +144,13 @@ private static void waitForSvnServer(int port) throws InterruptedException {
             }
         }
     }
+
+    private static File newFolder(File root, String... subDirs) throws IOException {
+        String subFolder = String.join("/", subDirs);
+        File result = new File(root, subFolder);
+        if (!result.mkdirs()) {
+            throw new IOException("Couldn't create folders " + root);
+        }
+        return result;
+    }
 }

src/test/java/hudson/scm/CompareAgainstBaselineCallableTest.java

@@ -1,48 +1,53 @@
 package hudson.scm;
 
-import static java.util.regex.Pattern.compile;
 import hudson.scm.SubversionSCM.SVNLogHandler;
 import hudson.util.StreamTaskListener;
+import org.apache.commons.io.output.NullOutputStream;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
 
 import java.io.IOException;
 import java.io.ObjectOutputStream;
 import java.util.Collections;
 import java.util.regex.Pattern;
 
-import org.junit.Rule;
-import org.junit.Test;
-import org.jvnet.hudson.test.JenkinsRule;
+import static java.util.regex.Pattern.compile;
 
-import org.apache.commons.io.output.NullOutputStream;
+@WithJenkins
+class CompareAgainstBaselineCallableTest {
 
-public class CompareAgainstBaselineCallableTest {
+    private JenkinsRule r;
 
-    @Rule
-    public JenkinsRule r = new JenkinsRule();
-    
     private CompareAgainstBaselineCallable callable;
 
+    @BeforeEach
+    void beforeEach(JenkinsRule rule) {
+        r = rule;
+    }
+
     @Test
-    public void callableShouldBeRemotable() throws IOException {
+    void callableShouldBeRemotable() throws IOException {
         givenACallable();
-        
+
         // WHEN callable is serialized
-        ObjectOutputStream oos = new ObjectOutputStream(new NullOutputStream());
+        ObjectOutputStream oos = new ObjectOutputStream(NullOutputStream.INSTANCE);
         oos.writeObject(callable);
         // THEN no NotSerializableException should have been thrown
         oos.close();
     }
 
     private void givenACallable() {
         @SuppressWarnings("unchecked")
-        SVNLogFilter filter = new DefaultSVNLogFilter(new Pattern[] {compile("excludes")}, new Pattern[] {compile("includes")},
+        SVNLogFilter filter = new DefaultSVNLogFilter(new Pattern[]{compile("excludes")}, new Pattern[]{compile("includes")},
                 Collections.EMPTY_SET, "", new Pattern[0], false);
-        
+
         StreamTaskListener taskListener = null; // this fails with NPE because of static Channel current(): StreamTaskListener.fromStdout();
         this.callable = new CompareAgainstBaselineCallable(
                 new SVNRevisionState(null),
-                new SVNLogHandler( filter, taskListener),
-                        "projectName", taskListener, null, Collections.emptyMap(), "nodeName");
+                new SVNLogHandler(filter, taskListener),
+                "projectName", taskListener, null, Collections.emptyMap(), "nodeName");
     }
 
 }

src/test/java/hudson/scm/CredentialsExternalsTest.java

@@ -29,49 +29,64 @@
 import com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl;
 import hudson.model.FreeStyleBuild;
 import hudson.model.FreeStyleProject;
+import jenkins.scm.impl.subversion.SubversionSampleRepoExtension;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.jvnet.hudson.test.Issue;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.BuildWatcherExtension;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
 import java.net.ServerSocket;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Set;
 import java.util.TreeSet;
-import jenkins.scm.impl.subversion.SubversionSampleRepoRule;
-import org.junit.ClassRule;
-import org.junit.Test;
-import static org.junit.Assert.*;
-import org.junit.Rule;
-import org.jvnet.hudson.test.BuildWatcher;
-import org.jvnet.hudson.test.Issue;
-import org.jvnet.hudson.test.JenkinsRule;
 
-public class CredentialsExternalsTest {
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+@WithJenkins
+class CredentialsExternalsTest {
 
-    @ClassRule
-    public static BuildWatcher buildWatcher = new BuildWatcher();
+    @SuppressWarnings("unused")
+    @RegisterExtension
+    private static final BuildWatcherExtension BUILD_WATCHER = new BuildWatcherExtension();
 
-    @Rule
-    public JenkinsRule r = new JenkinsRule();
+    private JenkinsRule r;
 
-    @Rule
-    public SubversionSampleRepoRule main = new SubversionSampleRepoRule();
+    @RegisterExtension
+    private final SubversionSampleRepoExtension main = new SubversionSampleRepoExtension();
 
-    @Rule
-    public SubversionSampleRepoRule ext = new SubversionSampleRepoRule();
+    @RegisterExtension
+    private final SubversionSampleRepoExtension ext = new SubversionSampleRepoExtension();
+
+    @BeforeEach
+    void beforeEach(JenkinsRule rule) {
+        r = rule;
+    }
 
     @Issue("JENKINS-32167")
     @Test
-    public void smokes() throws Exception {
+    void smokes() throws Exception {
         main.init();
         main.writeConf("svnserve.conf",
-            "[general]\n" +
-            "password-db = passwd\n" +
-            "authz-db = authz\n" +
-            "anon-access = none\n"); // https://bugzilla.redhat.com/show_bug.cgi?id=556712
+                """
+                        [general]
+                        password-db = passwd
+                        authz-db = authz
+                        anon-access = none
+                        """); // https://bugzilla.redhat.com/show_bug.cgi?id=556712
         main.writeConf("passwd",
-            "[users]\n" +
-            "alice = alice\n");
+                """
+                        [users]
+                        alice = alice
+                        """);
         main.writeConf("authz",
-            "[/]\n" +
-            "alice = rw\n");
+                """
+                        [/]
+                        alice = rw
+                        """);
         // Adapted from AbstractSubversionTest.runSvnServe:
         int mainPort;
         ServerSocket serverSocket = new ServerSocket(0);
@@ -86,16 +101,22 @@ public void smokes() throws Exception {
             System.err.println("Running svnserve on <svn://localhost:" + mainPort + "> " + main.uuid());
             ext.init();
             ext.writeConf("svnserve.conf",
-                "[general]\n" +
-                "password-db = passwd\n" +
-                "authz-db = authz\n" +
-                "anon-access = none\n");
+                    """
+                            [general]
+                            password-db = passwd
+                            authz-db = authz
+                            anon-access = none
+                            """);
             ext.writeConf("passwd",
-                "[users]\n" +
-                "bob = bob\n");
+                    """
+                            [users]
+                            bob = bob
+                            """);
             ext.writeConf("authz",
-                "[/]\n" +
-                "bob = rw\n");
+                    """
+                            [/]
+                            bob = rw
+                            """);
             int extPort;
             serverSocket = new ServerSocket(0);
             try {
@@ -111,12 +132,12 @@ public void smokes() throws Exception {
                 main.svnkit("commit", "--message=externals", main.wc());
                 FreeStyleProject p = r.createFreeStyleProject("p");
                 SystemCredentialsProvider.getInstance().setDomainCredentialsMap(Collections.singletonMap(Domain.global(), Arrays.asList(
-                    new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, "main-creds", null, "alice", "alice"),
-                    new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, "ext-creds", null, "bob", "bob"))));
+                        new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, "main-creds", null, "alice", "alice"),
+                        new UsernamePasswordCredentialsImpl(CredentialsScope.GLOBAL, "ext-creds", null, "bob", "bob"))));
                 p.setScm(new SubversionSCM(
-                    Collections.singletonList(new SubversionSCM.ModuleLocation("svn://localhost:" + mainPort + "/prj/trunk", "main-creds", ".", "", false)),
-                    null, null, null, null, null, null, null, false, false, // WTF was all that?
-                    Collections.singletonList(new SubversionSCM.AdditionalCredentials("<svn://localhost:" + extPort + "> " + ext.uuid(), "ext-creds"))));
+                        Collections.singletonList(new SubversionSCM.ModuleLocation("svn://localhost:" + mainPort + "/prj/trunk", "main-creds", ".", "", false)),
+                        null, null, null, null, null, null, null, false, false, // WTF was all that?
+                        Collections.singletonList(new SubversionSCM.AdditionalCredentials("<svn://localhost:" + extPort + "> " + ext.uuid(), "ext-creds"))));
                 FreeStyleBuild b = r.buildAndAssertSuccess(p);
                 assertEquals("", b.getWorkspace().child("file").readToString());
                 assertEquals("", b.getWorkspace().child("ext/file").readToString());