Migrate tests to JUnit5 (test / jenkins / 3) (jenkinsci#10581)

* Migrate tests to JUnit5 (test / jenkins / 3)

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

* Stabilize SetupWizardTest

---------

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

Author: 3 people

test/src/test/java/jenkins/ClassPathTest.java

@@ -33,16 +33,15 @@
 import java.util.TreeMap;
 import java.util.jar.JarEntry;
 import java.util.jar.JarFile;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.ErrorCollector;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
 import org.jvnet.hudson.test.Issue;
 import org.jvnet.hudson.test.WarExploder;
+import org.opentest4j.MultipleFailuresError;
 
-public class ClassPathTest {
+class ClassPathTest {
 
-    @Rule
-    public ErrorCollector errors = new ErrorCollector();
+    private final List<Throwable> errors = new ArrayList<>();
 
     private static final Set<String> KNOWN_VIOLATIONS = Set.of(
             // TODO duplicated in [jline-2.14.6.jar, jansi-1.11.jar]
@@ -75,9 +74,16 @@ public class ClassPathTest {
             "org/fusesource/jansi/internal/WindowsSupport.class",
             "org/fusesource/jansi/WindowsAnsiOutputStream.class");
 
+    @AfterEach
+    void tearDown() {
+        if (!errors.isEmpty()) {
+            throw new MultipleFailuresError(null, errors);
+        }
+    }
+
     @Issue("JENKINS-46754")
     @Test
-    public void uniqueness() throws Exception {
+    void uniqueness() throws Exception {
         Map<String, List<String>> entries = new TreeMap<>();
         for (File jar : new File(WarExploder.getExplodedDir(), "WEB-INF/lib").listFiles((dir, name) -> name.endsWith(".jar"))) {
             String jarname = jar.getName();
@@ -93,7 +99,7 @@ public void uniqueness() throws Exception {
         }
         entries.forEach((name, jarnames) -> {
             if (jarnames.size() > 1 && !KNOWN_VIOLATIONS.contains(name)) { // Matchers.hasSize unfortunately does not display the collection
-                errors.addError(new AssertionError(name + " duplicated in " + jarnames));
+                errors.add(new AssertionError(name + " duplicated in " + jarnames));
             }
         });
     }

test/src/test/java/jenkins/CoreAutomaticTestBuilder.java

@@ -2,27 +2,33 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.hasSize;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import hudson.ExtensionComponent;
 import hudson.console.ConsoleAnnotatorFactory;
 import hudson.model.PageDecorator;
 import jenkins.install.SetupWizard;
-import org.junit.Rule;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.jvnet.hudson.test.JenkinsRule;
 import org.jvnet.hudson.test.TestExtension;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
 
 /**
  * @author Kohsuke Kawaguchi
  */
-public class ExtensionFilterTest {
+@WithJenkins
+class ExtensionFilterTest {
 
-    @Rule
-    public JenkinsRule j = new JenkinsRule();
+    private JenkinsRule j;
+
+    @BeforeEach
+    void setUp(JenkinsRule rule) {
+        j = rule;
+    }
 
     @Test
-    public void filter() {
+    void filter() {
         assertThat(PageDecorator.all(), hasSize(1));
         assertTrue(ConsoleAnnotatorFactory.all().isEmpty());
     }

test/src/test/java/jenkins/ExtensionFilterTest.java

@@ -26,88 +26,97 @@
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.startsWith;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.io.IOException;
 import net.sf.json.JSONObject;
-import org.junit.Assert;
-import org.junit.Rule;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.jvnet.hudson.test.Issue;
 import org.jvnet.hudson.test.JenkinsRule;
-import org.xml.sax.SAXException;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
 
 /**
  * @author <a href="mailto:tom.fennelly@gmail.com">tom.fennelly@gmail.com</a>
  */
-public class I18nTest {
+@WithJenkins
+class I18nTest {
 
-    @Rule
-    public JenkinsRule jenkinsRule = new JenkinsRule();
+    private JenkinsRule jenkinsRule;
+
+    @BeforeEach
+    void setUp(JenkinsRule rule) {
+        jenkinsRule = rule;
+    }
 
     @Test
-    public void test_baseName_unspecified() throws IOException, SAXException {
+    void test_baseName_unspecified() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle").getJSONObject();
-        Assert.assertEquals("error", response.getString("status"));
-        Assert.assertEquals("Mandatory parameter 'baseName' not specified.", response.getString("message"));
+        assertEquals("error", response.getString("status"));
+        assertEquals("Mandatory parameter 'baseName' not specified.", response.getString("message"));
     }
 
     @Test
-    public void test_baseName_unknown() throws IOException, SAXException {
+    void test_baseName_unknown() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=com.acme.XyzWhatever").getJSONObject();
-        Assert.assertEquals("error", response.getString("status"));
+        assertEquals("error", response.getString("status"));
         assertThat(response.getString("message"), startsWith("Can't find bundle for base name com.acme.XyzWhatever"));
     }
 
     @Issue("JENKINS-35270")
     @Test
-    public void test_baseName_plugin() throws Exception {
+    void test_baseName_plugin() throws Exception {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=org.jenkinsci.plugins.matrixauth.Messages").getJSONObject();
-        Assert.assertEquals(response.toString(), "ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"), response.toString());
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("Matrix-based security", data.getString("GlobalMatrixAuthorizationStrategy.DisplayName"));
+        assertEquals("Matrix-based security", data.getString("GlobalMatrixAuthorizationStrategy.DisplayName"));
     }
 
     @Test
-    public void test_valid() throws IOException, SAXException {
+    void test_valid() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=hudson.logging.Messages&language=de").getJSONObject();
-        Assert.assertEquals("ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"));
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("Initialisiere Log-Rekorder", data.getString("LogRecorderManager.init"));
+        assertEquals("Initialisiere Log-Rekorder", data.getString("LogRecorderManager.init"));
     }
 
+    // variant testing
     @Issue("JENKINS-39034")
-    @Test // variant testing
-    public void test_valid_region_variant() throws IOException, SAXException {
+    @Test
+    void test_valid_region_variant() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=jenkins.i18n.Messages&language=en_AU_variant").getJSONObject();
-        Assert.assertEquals("ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"));
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("value_au_variant", data.getString("Key"));
+        assertEquals("value_au_variant", data.getString("Key"));
     }
 
+    //country testing with delimiter '-' instead of '_'
     @Issue("JENKINS-39034")
-    @Test //country testing with delimiter '-' instead of '_'
-    public void test_valid_region() throws IOException, SAXException {
+    @Test
+    void test_valid_region() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=jenkins.i18n.Messages&language=en-AU").getJSONObject();
-        Assert.assertEquals("ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"));
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("value_au", data.getString("Key"));
+        assertEquals("value_au", data.getString("Key"));
     }
 
+    //fallthrough to default language if variant does not exit
     @Issue("JENKINS-39034")
-    @Test //fallthrough to default language if variant does not exit
-    public void test_valid_fallback() throws IOException, SAXException {
+    @Test
+    void test_valid_fallback() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=jenkins.i18n.Messages&language=en_NZ_variant").getJSONObject();
-        Assert.assertEquals("ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"));
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("value", data.getString("Key"));
+        assertEquals("value", data.getString("Key"));
     }
 
-    @Test // testing with unknown language falls through to default language
-    public void test_unsupported_language() throws IOException, SAXException {
+    // testing with unknown language falls through to default language
+    @Test
+    void test_unsupported_language() throws IOException {
         JSONObject response = jenkinsRule.getJSON("i18n/resourceBundle?baseName=jenkins.i18n.Messages&language=xyz").getJSONObject();
-        Assert.assertEquals("ok", response.getString("status"));
+        assertEquals("ok", response.getString("status"));
         JSONObject data = response.getJSONObject("data");
-        Assert.assertEquals("value", data.getString("Key"));
+        assertEquals("value", data.getString("Key"));
     }
 
 }

test/src/test/java/jenkins/I18nTest.java

@@ -14,14 +14,14 @@
 import java.util.List;
 import java.util.concurrent.Future;
 import java.util.stream.Collectors;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 import org.jvnet.hudson.test.Issue;
 
-public class BridgeMethodsTest {
+class BridgeMethodsTest {
 
     @Test
     @Issue("JENKINS-65605")
-    public void checkBridgeMethod() {
+    void checkBridgeMethod() {
         /*
          * we should have 2 methods getFuture() in hudson.model.Queue$WaitingItem but with different return types :
          * hudson.model.Queue$WaitingItem.getFuture()Ljava/util/concurrent/Future

test/src/test/java/jenkins/bugs/BridgeMethodsTest.java

@@ -1,50 +1,65 @@
 package jenkins.bugs;
 
 import hudson.model.FreeStyleProject;
+import java.util.ArrayList;
+import java.util.List;
 import org.htmlunit.cssparser.parser.CSSErrorHandler;
 import org.htmlunit.cssparser.parser.CSSException;
 import org.htmlunit.cssparser.parser.CSSParseException;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.ErrorCollector;
+import org.junit.jupiter.api.AfterEach;
+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 org.opentest4j.MultipleFailuresError;
 
-public class Jenkins14749Test {
+@WithJenkins
+class Jenkins14749Test {
 
-    @Rule
-    public JenkinsRule j = new JenkinsRule();
+    private JenkinsRule j;
 
-    @Rule
-    public ErrorCollector errors = new ErrorCollector();
+    private final List<Throwable> errors = new ArrayList<>();
+
+    @BeforeEach
+    void setUp(JenkinsRule rule) {
+        j = rule;
+    }
+
+    @AfterEach
+    void tearDown() {
+        if (!errors.isEmpty()) {
+            throw new MultipleFailuresError(null, errors);
+        }
+    }
 
     @Test
-    public void dashboard() throws Exception {
+    void dashboard() throws Exception {
         JenkinsRule.WebClient webClient = createErrorReportingWebClient();
         webClient.goTo("");
     }
 
     @Test
-    public void project() throws Exception {
+    void project() throws Exception {
         FreeStyleProject p = j.createFreeStyleProject();
         JenkinsRule.WebClient webClient = createErrorReportingWebClient();
         webClient.getPage(p);
     }
 
     @Test
-    public void configureProject() throws Exception {
+    void configureProject() throws Exception {
         FreeStyleProject p = j.createFreeStyleProject();
         JenkinsRule.WebClient webClient = createErrorReportingWebClient();
         webClient.getPage(p, "configure");
     }
 
     @Test
-    public void manage() throws Exception {
+    void manage() throws Exception {
         JenkinsRule.WebClient webClient = createErrorReportingWebClient();
         webClient.goTo("manage");
     }
 
     @Test
-    public void system() throws Exception {
+    void system() throws Exception {
         JenkinsRule.WebClient webClient = createErrorReportingWebClient();
         webClient.goTo("manage/configure");
     }
@@ -54,17 +69,17 @@ private JenkinsRule.WebClient createErrorReportingWebClient() {
         webClient.setCssErrorHandler(new CSSErrorHandler() {
             @Override
             public void warning(final CSSParseException exception) throws CSSException {
-                errors.addError(exception);
+                errors.add(exception);
             }
 
             @Override
             public void error(final CSSParseException exception) throws CSSException {
-                errors.addError(exception);
+                errors.add(exception);
             }
 
             @Override
             public void fatalError(final CSSParseException exception) throws CSSException {
-                errors.addError(exception);
+                errors.add(exception);
             }
         });
         return webClient;