Migrate tests to JUnit5 (#120)

* Migrate annotations and imports
* Migrate assertions
* Remove public visibility for test classes and methods
* Minor clean up

Co-authored-by: strangelookingnerd <strangelookingnerd@users.noreply.github.com>

Author: strangelookingnerd

src/main/groovy/org/jenkinsci/plugins/sshsteps/util/Common.groovy

@@ -31,7 +31,7 @@ class Common {
      */
     void validateRemote(remote) {
         assert remote, getPrefix() + "remote is null or empty"
-        assert remote.name, getPrefix() + " a remote (or a gateway) is missing the required field 'name'"
+        assert remote.name, getPrefix() + "a remote (or a gateway) is missing the required field 'name'"
         if (remote.retryCount)
             assert remote.retryCount >= 0, getPrefix() + "retryCount must be zero or positive ($remote.name)"
         if (remote.retryWaitSec)

src/test/java/org/jenkinsci/plugins/sshsteps/SSHServiceTest.java

@@ -4,17 +4,17 @@
 
 import java.util.HashMap;
 import java.util.Map;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 /**
  * Test cases for SSHService.
  *
  * @author Naresh Rayapati.
  */
-public class SSHServiceTest {
+class SSHServiceTest {
 
   @Test
-  public void testWithEmptyRemoteThrowsAssertionError() {
+  void testWithEmptyRemoteThrowsAssertionError() {
     Map<String, String> remote = new HashMap<>();
 
     assertThatExceptionOfType(AssertionError.class)
@@ -25,20 +25,20 @@ public void testWithEmptyRemoteThrowsAssertionError() {
   }
 
   @Test
-  public void testRemoteWithEmptyNameThrowsAssertionError() {
+  void testRemoteWithEmptyNameThrowsAssertionError() {
     Map<String, String> remote = new HashMap<>();
     remote.put("name", "");
 
     assertThatExceptionOfType(AssertionError.class)
         .isThrownBy(() -> SSHService.create(remote, false, false, null))
         .withMessage(
-            "SSH Steps:  a remote (or a gateway) is missing the required field 'name'. Expression: remote.name")
+            "SSH Steps: a remote (or a gateway) is missing the required field 'name'. Expression: remote.name")
         .withStackTraceContaining("AssertionError")
         .withNoCause();
   }
 
   @Test
-  public void testRemoteWithEmptyUserThrowsAssertionError() {
+  void testRemoteWithEmptyUserThrowsAssertionError() {
     Map<String, String> remote = new HashMap<>();
     remote.put("name", "dummy");
 
@@ -50,7 +50,7 @@ public void testRemoteWithEmptyUserThrowsAssertionError() {
   }
 
   @Test
-  public void testRemoteWithOutKnownHostsAndAllowAnyHostsThrowsIllegalArgumentException() {
+  void testRemoteWithOutKnownHostsAndAllowAnyHostsThrowsIllegalArgumentException() {
     Map<String, String> remote = new HashMap<>();
     remote.put("name", "dummy");
     remote.put("user", "dummy");
@@ -63,7 +63,7 @@ public void testRemoteWithOutKnownHostsAndAllowAnyHostsThrowsIllegalArgumentExce
   }
 
   @Test
-  public void testRemoteWithMinimumRequiredParams() {
+  void testRemoteWithMinimumRequiredParams() {
     Map<String, Object> remote = new HashMap<>();
     remote.put("name", "dummy");
     remote.put("user", "dummy");

src/test/java/org/jenkinsci/plugins/sshsteps/steps/BaseTest.java

@@ -1,32 +1,33 @@
 package org.jenkinsci.plugins.sshsteps.steps;
 
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.anyBoolean;
-import static org.mockito.Mockito.doNothing;
-import static org.mockito.Mockito.when;
-
 import hudson.EnvVars;
 import hudson.Launcher;
 import hudson.model.Run;
 import hudson.model.TaskListener;
-import java.io.IOException;
-import java.io.PrintStream;
 import org.jenkinsci.plugins.sshsteps.SSHService;
 import org.jenkinsci.plugins.sshsteps.util.TestVirtualChannel;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.junit.After;
-import org.junit.Before;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.mockito.Mock;
 import org.mockito.MockedStatic;
 import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;
 
+import java.io.IOException;
+import java.io.PrintStream;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyBoolean;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.when;
+
 /**
  * Base Test Class.
  *
  * @author Naresh Rayapati
  */
-public class BaseTest {
+class BaseTest {
 
   @Mock
   TaskListener taskListenerMock;
@@ -46,8 +47,8 @@ public class BaseTest {
   private AutoCloseable closeable;
   private MockedStatic<SSHService> sshService;
 
-  @Before
-  public void setUpBase() throws IOException, InterruptedException {
+  @BeforeEach
+  void setUpBase() throws IOException, InterruptedException {
 
     closeable = MockitoAnnotations.openMocks(this);
 
@@ -65,8 +66,8 @@ public void setUpBase() throws IOException, InterruptedException {
     when(contextMock.get(Launcher.class)).thenReturn(launcherMock);
   }
 
-  @After
-  public void tearUpBase() throws Exception {
+  @AfterEach
+  void tearUpBase() throws Exception {
     sshService.close();
     closeable.close();
   }

src/test/java/org/jenkinsci/plugins/sshsteps/steps/CommandStepTest.java

@@ -1,38 +1,22 @@
 package org.jenkinsci.plugins.sshsteps.steps;
 
+import org.junit.jupiter.api.Test;
+
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
-import static org.mockito.Mockito.any;
-import static org.mockito.Mockito.anyBoolean;
-import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
-
-import hudson.EnvVars;
-import hudson.Launcher;
-import hudson.model.Run;
-import hudson.model.TaskListener;
-import java.io.IOException;
-import java.io.PrintStream;
-import org.jenkinsci.plugins.sshsteps.SSHService;
-import org.jenkinsci.plugins.sshsteps.util.TestVirtualChannel;
-import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.Mock;
 
 /**
  * Unit test cases for CommandStep class.
  *
  * @author Naresh Rayapati
  */
-public class CommandStepTest extends BaseTest {
+class CommandStepTest extends BaseTest {
 
   CommandStep.Execution stepExecution;
 
   @Test
-  public void testWithEmptyCommandThrowsIllegalArgumentException() throws Exception {
+  void testWithEmptyCommandThrowsIllegalArgumentException() throws Exception {
     final CommandStep step = new CommandStep("");
     stepExecution = new CommandStep.Execution(step, contextMock);
 
@@ -45,7 +29,7 @@ public void testWithEmptyCommandThrowsIllegalArgumentException() throws Exceptio
   }
 
   @Test
-  public void testSuccessfulExecuteCommand() throws Exception {
+  void testSuccessfulExecuteCommand() throws Exception {
     final CommandStep step = new CommandStep("ls -lrt");
 
     // Since SSHService is a mock, it is not validating remote.

src/test/java/org/jenkinsci/plugins/sshsteps/steps/GetStepTest.java

@@ -1,34 +1,24 @@
 package org.jenkinsci.plugins.sshsteps.steps;
 
+import hudson.FilePath;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mock;
+
+import java.io.IOException;
+
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.Mockito.any;
-import static org.mockito.Mockito.anyBoolean;
-import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import hudson.EnvVars;
-import hudson.FilePath;
-import hudson.Launcher;
-import hudson.model.Run;
-import hudson.model.TaskListener;
-import java.io.IOException;
-import java.io.PrintStream;
-import org.jenkinsci.plugins.sshsteps.SSHService;
-import org.jenkinsci.plugins.sshsteps.util.TestVirtualChannel;
-import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.Mock;
-
 /**
  * Unit test cases for GetStep class.
  *
  * @author Naresh Rayapati
  */
-public class GetStepTest extends BaseTest {
+class GetStepTest extends BaseTest {
 
   final String path = "test.sh";
   final String filterBy = "name";
@@ -39,8 +29,8 @@ public class GetStepTest extends BaseTest {
 
   GetStep.Execution stepExecution;
 
-  @Before
-  public void setup() throws IOException, InterruptedException {
+  @BeforeEach
+  void setup() throws IOException, InterruptedException {
 
     when(filePathMock.child(any())).thenReturn(filePathMock);
     when(filePathMock.exists()).thenReturn(true);
@@ -52,7 +42,7 @@ public void setup() throws IOException, InterruptedException {
   }
 
   @Test
-  public void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
+  void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
     final GetStep step = new GetStep("", path);
     stepExecution = new GetStep.Execution(step, contextMock);
 
@@ -65,7 +55,7 @@ public void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
   }
 
   @Test
-  public void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
+  void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
     final GetStep step = new GetStep(path, "");
     step.setOverride(true);
     stepExecution = new GetStep.Execution(step, contextMock);
@@ -79,7 +69,7 @@ public void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
   }
 
   @Test
-  public void testSuccessfulExecuteScript() throws Exception {
+  void testSuccessfulExecuteScript() throws Exception {
     final GetStep step = new GetStep(path, path);
     step.setOverride(true);
 

src/test/java/org/jenkinsci/plugins/sshsteps/steps/PutStepTest.java

@@ -1,34 +1,24 @@
 package org.jenkinsci.plugins.sshsteps.steps;
 
+import hudson.FilePath;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mock;
+
+import java.io.IOException;
+
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.Mockito.any;
-import static org.mockito.Mockito.anyBoolean;
-import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import hudson.EnvVars;
-import hudson.FilePath;
-import hudson.Launcher;
-import hudson.model.Run;
-import hudson.model.TaskListener;
-import java.io.IOException;
-import java.io.PrintStream;
-import org.jenkinsci.plugins.sshsteps.SSHService;
-import org.jenkinsci.plugins.sshsteps.util.TestVirtualChannel;
-import org.jenkinsci.plugins.workflow.steps.StepContext;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.Mock;
-
 /**
  * Unit test cases for PutStep class.
  *
  * @author Naresh Rayapati
  */
-public class PutStepTest extends BaseTest {
+class PutStepTest extends BaseTest {
 
   final String path = "test.sh";
   final String filterBy = "name";
@@ -39,8 +29,8 @@ public class PutStepTest extends BaseTest {
 
   PutStep.Execution stepExecution;
 
-  @Before
-  public void setup() throws IOException, InterruptedException {
+  @BeforeEach
+  void setup() throws IOException, InterruptedException {
 
     when(filePathMock.child(any())).thenReturn(filePathMock);
     when(filePathMock.exists()).thenReturn(true);
@@ -52,7 +42,7 @@ public void setup() throws IOException, InterruptedException {
   }
 
   @Test
-  public void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
+  void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
     final PutStep step = new PutStep("", path);
     stepExecution = new PutStep.Execution(step, contextMock);
 
@@ -65,7 +55,7 @@ public void testWithEmptyFromThrowsIllegalArgumentException() throws Exception {
   }
 
   @Test
-  public void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
+  void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
     final PutStep step = new PutStep(path, "");
     stepExecution = new PutStep.Execution(step, contextMock);
 
@@ -78,7 +68,7 @@ public void testWithEmptyIntoThrowsIllegalArgumentException() throws Exception {
   }
 
   @Test
-  public void testSuccessfulPut() throws Exception {
+  void testSuccessfulPut() throws Exception {
     final PutStep step = new PutStep(path, path);
 
     // Since SSHService is a mock, it is not validating remote.