Add tests (#14)

* Add tests * Refine test class * Add comments in the test class
jenkins-infra · Jul 20, 2022 · 4891407 · 4891407
1 parent c6b6265
commit 4891407
Show file tree

Hide file tree

Showing 59 changed files with 413 additions and 205 deletions.
diff --git a/pom.xml b/pom.xml
@@ -43,6 +43,11 @@
       <artifactId>mockito-core</artifactId>
       <version>4.6.1</version>
     </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-inline</artifactId>
+      <version>4.6.1</version>
+  </dependency>
     <dependency>
       <groupId>org.jenkins-ci.plugins</groupId>
       <artifactId>structs</artifactId>

diff --git a/src/main/java/hudson/MockExtensionLists.java b/src/main/java/hudson/MockExtensionLists.java
@@ -19,7 +19,8 @@
 import jenkins.model.Jenkins;
 
 /**
- * A mocked way to get at {@link ExtensionList}s. In {@code hudson} package due to protected access in {@link ExtensionList}.
+ * A mocked way to get at {@link ExtensionList}s. In {@code hudson} package due
+ * to protected access in {@link ExtensionList}.
  */
 
 public class MockExtensionLists {
@@ -31,7 +32,7 @@ public ExtensionList<?> getMockExtensionList(HyperLocalPluginManager hlpm, Jenki
             doReturn(Collections.emptyIterator()).when(ret).iterator();
             return ret;
         }
-        if(extensionLists.get(type.getName()) != null) {
+        if (extensionLists.get(type.getName()) != null) {
             return extensionLists.get(type.getName());
         } else {
             MockExtensionList<?> mockList = new MockExtensionList<>(hlpm, hudson, type);
@@ -54,12 +55,12 @@ public MockExtensionList(HyperLocalPluginManager hlpm, Jenkins hudson, Class<T>
         private Answer<List<ExtensionComponent<T>>> mockLoad(HyperLocalPluginManager hlpm) {
             return new Answer<List<ExtensionComponent<T>>>() {
                 public List<ExtensionComponent<T>> answer(InvocationOnMock invocation) throws Throwable {
-                    return hlpm.getPluginStrategy().findComponents(mockExtensionList.extensionType, (Hudson)null);
+                    return hlpm.getPluginStrategy().findComponents(mockExtensionList.extensionType, (Hudson) null);
                 }
             };
         }
 
-        public ExtensionList<T> getMockExtensionList(){
+        public ExtensionList<T> getMockExtensionList() {
             return mockExtensionList;
         }
     }

diff --git a/src/main/java/hudson/MockJenkins.java b/src/main/java/hudson/MockJenkins.java
@@ -35,62 +35,65 @@
 import jenkins.model.Jenkins;
 
 public class MockJenkins {
-     private MockExtensionLists mockLookup = new MockExtensionLists();
+    private MockExtensionLists mockLookup = new MockExtensionLists();
 
     /**
-     * There are a few methods that need to be mocked in order for setup to work properly:
-     *     * getPluginManager -&gt; must return HyperLocalPluginManager
-     *     * getInitLevel     -&gt; COMPLETED; Jenkins is "setup" as soon as the pm is populated
-     *     * getExtensionList -&gt; use the MockExtensionLists
-     *     * getPlugin        -&gt; get the Plugin information from HyperLocalPluginManager
+     * There are a few methods that need to be mocked in order for setup to work
+     * properly:
+     * * getPluginManager -&gt; must return HyperLocalPluginManager
+     * * getInitLevel -&gt; COMPLETED; Jenkins is "setup" as soon as the pm is
+     * populated
+     * * getExtensionList -&gt; use the MockExtensionLists
+     * * getPlugin -&gt; get the Plugin information from HyperLocalPluginManager
      */
-     @SuppressWarnings({"unchecked", "rawtypes"})
-     public Jenkins getMockJenkins(HyperLocalPluginManager pm) {
-         Jenkins mockJenkins = mock(Hudson.class); //required by ExtensionList
-         when(mockJenkins.getPluginManager()).thenReturn(pm);
-         when(mockJenkins.getInitLevel()).thenReturn(InitMilestone.COMPLETED);
-         when(mockJenkins.getInstallState()).thenReturn(InstallState.TEST);
-         when(mockJenkins.getComputers()).thenReturn(new Computer[0]);
-         when(mockJenkins.getRootDir()).thenReturn(new File(System.getProperty("java.io.tmpdir")));
-         try {
-             Field lookup = mockJenkins.getClass().getField("lookup");
-             lookup.setAccessible(true);
-             lookup.set(mockJenkins, new Lookup());
-             Field servletContext = mockJenkins.getClass().getField("servletContext");
-             servletContext.setAccessible(true);
-             servletContext.set(mockJenkins, mock(ServletContext.class));
-         } catch (NoSuchFieldException | IllegalAccessException e) {
-             e.printStackTrace();
-         }
-         doAnswer(new Answer<ExtensionList>() {
+    @SuppressWarnings({ "unchecked", "rawtypes" })
+    public Jenkins getMockJenkins(HyperLocalPluginManager pm) {
+        Jenkins mockJenkins = mock(Hudson.class); // required by ExtensionList
+        when(mockJenkins.getPluginManager()).thenReturn(pm);
+        when(mockJenkins.getInitLevel()).thenReturn(InitMilestone.COMPLETED);
+        when(mockJenkins.getInstallState()).thenReturn(InstallState.TEST);
+        when(mockJenkins.getComputers()).thenReturn(new Computer[0]);
+        when(mockJenkins.getRootDir()).thenReturn(new File(System.getProperty("java.io.tmpdir")));
+        try {
+            Field lookup = mockJenkins.getClass().getField("lookup");
+            lookup.setAccessible(true);
+            lookup.set(mockJenkins, new Lookup());
+            Field servletContext = mockJenkins.getClass().getField("servletContext");
+            servletContext.setAccessible(true);
+            servletContext.set(mockJenkins, mock(ServletContext.class));
+        } catch (NoSuchFieldException | IllegalAccessException e) {
+            e.printStackTrace();
+        }
+        doAnswer(new Answer<ExtensionList>() {
             @Override
             public ExtensionList answer(InvocationOnMock invocation) throws Throwable {
                 Object[] args = invocation.getArguments();
                 return mockLookup.getMockExtensionList(pm, mockJenkins, (Class) args[0]);
             }
-         }).when(mockJenkins).getExtensionList(any(Class.class));
+        }).when(mockJenkins).getExtensionList(any(Class.class));
 
-         doAnswer(invocation -> {
-             Object[] args = invocation.getArguments();
-             for (Object _d : mockLookup.getMockExtensionList(pm, mockJenkins, Descriptor.class)) {
-                 Descriptor d = (Descriptor) _d;
-                 if (d.clazz == args[0]) {
-                     return d;
-                 }
-             }
-             return null;
-         }).when(mockJenkins).getDescriptor(any(Class.class));
+        doAnswer(invocation -> {
+            Object[] args = invocation.getArguments();
+            for (Object _d : mockLookup.getMockExtensionList(pm, mockJenkins, Descriptor.class)) {
+                Descriptor d = (Descriptor) _d;
+                if (d.clazz == args[0]) {
+                    return d;
+                }
+            }
+            return null;
+        }).when(mockJenkins).getDescriptor(any(Class.class));
 
-                  doAnswer(new Answer<Plugin>() {
-             @Override
-             public Plugin answer(InvocationOnMock invocation) throws Throwable {
-                 Object[] args = invocation.getArguments();
-                 PluginWrapper p = pm.getPlugin((Class) args[0]);
-                 if(p==null)     return null; //not actually loaded; might need an override
-                 return p.getPlugin();
-             }
-         }).when(mockJenkins).getPlugin(any(Class.class));
+        doAnswer(new Answer<Plugin>() {
+            @Override
+            public Plugin answer(InvocationOnMock invocation) throws Throwable {
+                Object[] args = invocation.getArguments();
+                PluginWrapper p = pm.getPlugin((Class) args[0]);
+                if (p == null)
+                    return null; // not actually loaded; might need an override
+                return p.getPlugin();
+            }
+        }).when(mockJenkins).getPlugin(any(Class.class));
 
-         return mockJenkins;
-     }
- }
+        return mockJenkins;
+    }
+}