* Updated Mockito and Byte-Buddy for Java 21

* Updated mocking of client libs

Author: vladbailescu

bundles/core/src/test/java/com/adobe/cq/wcm/core/components/internal/models/v1/ClientLibrariesImplTest.java

@@ -17,17 +17,14 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.PrintWriter;
-import java.io.Writer;
-import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
 
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.resource.LoginException;
 import org.apache.sling.api.resource.Resource;
@@ -92,8 +89,6 @@ class ClientLibrariesImplTest {
 
     private final AemContext context = CoreComponentTestContext.newAemContext();
 
-    private Map<String,ClientLibrary> allLibraries; // a map of (path, library) of all the libraries
-    private Map<String,ClientLibrary> librariesMap; // a map of (category, library) of all the libraries
     private Map<String,String> jsIncludes; // expected js includes
     private Map<String,String> cssIncludes; // expected css includes
     private Map<String,String> jsIncludesWithAttributes; // expected js includes when injecting attributes
@@ -156,10 +151,11 @@ void setUp() {
         when(carouselClientLibrary.getCategories()).thenReturn(carouselCategories);
         when(carouselClientLibrary.getPath()).thenReturn(CAROUSEL_CLIENTLIB_PATH);
 
-        librariesMap = new HashMap<>();
-        librariesMap.put(TEASER_CATEGORY, teaserClientLibrary);
-        librariesMap.put(ACCORDION_CATEGORY, accordionClientLibrary);
-        librariesMap.put(CAROUSEL_CATEGORY, carouselClientLibrary);
+        // a map of (category, library) of all the libraries
+        Map<String, ClientLibrary> librariesByCategory = new HashMap<>();
+        librariesByCategory.put(TEASER_CATEGORY, teaserClientLibrary);
+        librariesByCategory.put(ACCORDION_CATEGORY, accordionClientLibrary);
+        librariesByCategory.put(CAROUSEL_CATEGORY, carouselClientLibrary);
 
         // Mock HtmlLibrary
         HtmlLibrary teaserJsHtmlLibrary = mock(HtmlLibrary.class);
@@ -186,99 +182,37 @@ void setUp() {
         } catch (IOException e) {
             fail(String.format("Unable to get input stream from the library: %s", e.getMessage()));
         }
-
-        // Mock htmlLibraryManager.getLibraries()
-        allLibraries = new HashMap<>();
-        allLibraries.put(TEASER_CLIENTLIB_PATH, teaserClientLibrary);
-        allLibraries.put(ACCORDION_CLIENTLIB_PATH, accordionClientLibrary);
-        allLibraries.put(CAROUSEL_CLIENTLIB_PATH, carouselClientLibrary);
-        HtmlLibraryManager htmlLibraryManager = context.registerInjectActivateService(mock(MockHtmlLibraryManager.class));
-        when(htmlLibraryManager.getLibraries()).thenReturn(allLibraries);
-
-        // Mock htmlLibraryManager.getLibraries(a, b, c, d)
-        doAnswer(invocation -> {
-            Object[] args = invocation.getArguments();
-            String[] categories = (String[]) args[0];
-            Collection<ClientLibrary> libraries = new ArrayList<>();
-            for (String category : categories) {
-                libraries.add(librariesMap.get(category));
-            }
-            return libraries;
-        }).when(htmlLibraryManager).getLibraries(any(String[].class), any(LibraryType.class), anyBoolean(), anyBoolean());
-
-        // Mock htmlLibraryManager.getLibrary(libraryType, clientlib.getPath())
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.JS), eq(TEASER_CLIENTLIB_PATH))).thenReturn(teaserJsHtmlLibrary);
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.JS), eq(ACCORDION_CLIENTLIB_PATH))).thenReturn(accordionJsHtmlLibrary);
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.JS), eq(CAROUSEL_CLIENTLIB_PATH))).thenReturn(carouselJsHtmlLibrary);
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.CSS), eq(TEASER_CLIENTLIB_PATH))).thenReturn(teaserCssHtmlLibrary);
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.CSS), eq(ACCORDION_CLIENTLIB_PATH))).thenReturn(accordionCssHtmlLibrary);
-        when(htmlLibraryManager.getLibrary(eq(LibraryType.CSS), eq(CAROUSEL_CLIENTLIB_PATH))).thenReturn(carouselCssHtmlLibrary);
-
-        // Mock htmlLibraryManager.writeJsInclude
-        try {
-            doAnswer(invocation -> {
-                Object[] args = invocation.getArguments();
-                StringBuilder scriptIncludes = new StringBuilder();
-                for (int i = 2; i < args.length; i++) {
-                    String category = (String) args[i];
-                    String script = jsIncludes.get(category);
-                    scriptIncludes.append(script);
-                }
-                ((PrintWriter)args[1]).write(scriptIncludes.toString());
-                return null;
-            }).when(htmlLibraryManager).writeJsInclude(any(SlingHttpServletRequest.class), any(Writer.class), any(String.class));
-        } catch (IOException e) {
-            fail(String.format("Unable to write JS include: %s", e.getMessage()));
-        }
-
-        // Mock htmlLibraryManager.writeCssInclude
-        try {
-            doAnswer(invocation -> {
-                Object[] args = invocation.getArguments();
-                StringBuilder linkIncludes = new StringBuilder();
-                for (int i = 2; i < args.length; i++) {
-                    String category = (String) args[i];
-                    String link = cssIncludes.get(category);
-                    linkIncludes.append(link);
-                }
-                ((PrintWriter)args[1]).write(linkIncludes.toString());
-                return null;
-            }).when(htmlLibraryManager).writeCssInclude(any(SlingHttpServletRequest.class), any(Writer.class), any(String.class));
-        } catch (IOException e) {
-            fail(String.format("Unable to write CSS include: %s", e.getMessage()));
-        }
-
-        // Mock htmlLibraryManager.writeIncludes
-        try {
-            doAnswer(invocation -> {
-                Object[] args = invocation.getArguments();
-                StringBuilder includes = new StringBuilder();
-                for (int i = 2; i < args.length; i++) {
-                    String category = (String) args[i];
-                    String script = jsIncludes.get(category);
-                    includes.append(script);
-                }
-                for (int i = 2; i < args.length; i++) {
-                    String category = (String) args[i];
-                    String link = cssIncludes.get(category);
-                    includes.append(link);
-                }
-                ((PrintWriter)args[1]).write(includes.toString());
-                return null;
-            }).when(htmlLibraryManager).writeIncludes(any(SlingHttpServletRequest.class), any(Writer.class), any(String.class));
-        } catch (IOException e) {
-            fail(String.format("Unable to write include: %s", e.getMessage()));
-        }
-
+        Map<Pair<String, LibraryType>, HtmlLibrary> htmlLibrariesByPathAndType = new HashMap<>();
+        htmlLibrariesByPathAndType.put(Pair.of(TEASER_CLIENTLIB_PATH, LibraryType.JS), teaserJsHtmlLibrary);
+        htmlLibrariesByPathAndType.put(Pair.of(ACCORDION_CLIENTLIB_PATH, LibraryType.JS), accordionJsHtmlLibrary);
+        htmlLibrariesByPathAndType.put(Pair.of(CAROUSEL_CLIENTLIB_PATH, LibraryType.JS), carouselJsHtmlLibrary);
+        htmlLibrariesByPathAndType.put(Pair.of(TEASER_CLIENTLIB_PATH, LibraryType.CSS), teaserCssHtmlLibrary);
+        htmlLibrariesByPathAndType.put(Pair.of(ACCORDION_CLIENTLIB_PATH, LibraryType.CSS), accordionCssHtmlLibrary);
+        htmlLibrariesByPathAndType.put(Pair.of(CAROUSEL_CLIENTLIB_PATH, LibraryType.CSS), carouselCssHtmlLibrary);
+
+        // a map of (path, library) of all the libraries
+        Map<String, ClientLibrary> librariesByPath = new HashMap<>();
+        librariesByPath.put(TEASER_CLIENTLIB_PATH, teaserClientLibrary);
+        librariesByPath.put(ACCORDION_CLIENTLIB_PATH, accordionClientLibrary);
+        librariesByPath.put(CAROUSEL_CLIENTLIB_PATH, carouselClientLibrary);
+
+        HtmlLibraryManager htmlLibraryManager = new MockHtmlLibraryManager(mock(ClientLibrary.class),
+                htmlLibrariesByPathAndType,
+                librariesByPath,
+                librariesByCategory,
+                jsIncludes,
+                cssIncludes);
+        context.registerInjectActivateService(htmlLibraryManager);
     }
 
     @Test
     void testGetCategories() {
         PageManager pageManager = context.pageManager();
         Page page = pageManager.getPage(ROOT_PAGE);
         Map<String, Object> attributes = new HashMap<>();
-        attributes.put(ClientLibraries.OPTION_RESOURCE_TYPES, Utils.getPageResourceTypes(page, context.request(), mock(ModelFactory.class)));
         ClientLibrariesImpl clientlibs = Objects.requireNonNull((ClientLibrariesImpl) getClientLibrariesUnderTest(ROOT_PAGE, attributes));
+        attributes.put(ClientLibraries.OPTION_RESOURCE_TYPES, Utils.getPageResourceTypes(page, context.request(), mock(ModelFactory.class)));
+        clientlibs = Objects.requireNonNull((ClientLibrariesImpl) getClientLibrariesUnderTest(ROOT_PAGE, attributes));
 
         Set<String> categories = new HashSet<>();
         categories.add(TEASER_CATEGORY);
@@ -520,7 +454,8 @@ private ClientLibraries getClientLibrariesUnderTest(String path, Map<String,Obje
                 }
             }
             context.request().setResource(resource);
-            return context.request().adaptTo(ClientLibraries.class);
+            ClientLibraries clientLibraries = context.request().adaptTo(ClientLibraries.class);
+            return clientLibraries;
         }
         return null;
     }

parent/pom.xml

@@ -61,7 +61,8 @@
         <frontend-maven-plugin.version>1.11.3</frontend-maven-plugin.version>
         <node.version>v16.13.1</node.version>
         <npm.version>8.3.0</npm.version>
-        <mockitio.version>4.8.1</mockitio.version>
+        <mockito.version>5.2.0</mockito.version>
+        <byte-buddy.version>1.14.11</byte-buddy.version>
         <maven.compiler.source>${aem.java.version}</maven.compiler.source>
         <maven.compiler.target>${aem.java.version}</maven.compiler.target>
         <aem.selenium.base.it.version>0.2.48</aem.selenium.base.it.version>
@@ -448,7 +449,7 @@
                 <plugin>
                     <groupId>com.github.spotbugs</groupId>
                     <artifactId>spotbugs-maven-plugin</artifactId>
-                    <version>4.7.2.1</version>
+                    <version>4.7.3.6</version>
                     <configuration>
                         <effort>Max</effort>
                         <xmlOutput>true</xmlOutput>
@@ -778,13 +779,25 @@
             <dependency>
                 <groupId>org.mockito</groupId>
                 <artifactId>mockito-core</artifactId>
-                <version>${mockitio.version}</version>
+                <version>${mockito.version}</version>
                 <scope>test</scope>
             </dependency>
             <dependency>
                 <groupId>org.mockito</groupId>
                 <artifactId>mockito-junit-jupiter</artifactId>
-                <version>${mockitio.version}</version>
+                <version>${mockito.version}</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>net.bytebuddy</groupId>
+                <artifactId>byte-buddy</artifactId>
+                <version>${byte-buddy.version}</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>net.bytebuddy</groupId>
+                <artifactId>byte-buddy-agent</artifactId>
+                <version>${byte-buddy.version}</version>
                 <scope>test</scope>
             </dependency>
             <dependency>

testing/junit/core/src/main/java/com/adobe/cq/wcm/core/components/testing/MockHtmlLibraryManager.java

@@ -17,13 +17,15 @@
 
 import java.io.IOException;
 import java.io.Writer;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
 
 import javax.jcr.RepositoryException;
 
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.osgi.service.component.annotations.Component;
 
@@ -37,20 +39,46 @@
 )
 public class MockHtmlLibraryManager implements HtmlLibraryManager {
 
+    private Map<Pair<String, LibraryType>, HtmlLibrary> htmlLibrariesByPathAndType;
     private Collection<ClientLibrary> clientLibraries;
+    private Map<String,ClientLibrary> librariesByPath; // a map of (path, library) of all the libraries
+    private Map<String,ClientLibrary> librariesByCategory; // a map of (category, library) of all the libraries
+    private Map<String,String> jsIncludes; // expected js includes
+    private Map<String,String> cssIncludes; // expected css includes
+
+    public MockHtmlLibraryManager(ClientLibrary mockClientLibrary,
+                                  Map<Pair<String, LibraryType>, HtmlLibrary> htmlLibrariesByPathAndType,
+                                  Map<String,ClientLibrary> librariesByPath,
+                                  Map<String,ClientLibrary> librariesByCategory,
+                                  Map<String,String> jsIncludes,
+                                  Map<String,String> cssIncludes) {
+        clientLibraries = Arrays.asList(mockClientLibrary);
+        this.htmlLibrariesByPathAndType = htmlLibrariesByPathAndType;
+        this.librariesByPath = librariesByPath;
+        this.librariesByCategory = librariesByCategory;
+        this.jsIncludes = jsIncludes;
+        this.cssIncludes = cssIncludes;
+    }
 
     public MockHtmlLibraryManager(ClientLibrary mockClientLibrary) {
         clientLibraries = Arrays.asList(mockClientLibrary);
     }
 
     @Override
     public Map<String, ClientLibrary> getLibraries() {
-        return null;
+        return librariesByPath;
     }
 
     @Override
     public void writeJsInclude(SlingHttpServletRequest slingHttpServletRequest, Writer writer, String... strings) throws IOException {
-
+        if (jsIncludes != null) {
+            StringBuilder scriptIncludes = new StringBuilder();
+            for (String category : strings) {
+                String script = jsIncludes.get(category);
+                scriptIncludes.append(script);
+            }
+            writer.write(scriptIncludes.toString());
+        }
     }
 
     @Override
@@ -61,13 +89,19 @@ public void writeJsInclude(SlingHttpServletRequest slingHttpServletRequest, Writ
 
     @Override
     public void writeCssInclude(SlingHttpServletRequest slingHttpServletRequest, Writer writer, String... strings) throws IOException {
-
+        if (cssIncludes != null) {
+            StringBuilder linkIncludes = new StringBuilder();
+            for (String category : strings) {
+                String link = cssIncludes.get(category);
+                linkIncludes.append(link);
+            }
+            writer.write(linkIncludes.toString());
+        }
     }
 
     @Override
     public void writeCssInclude(SlingHttpServletRequest slingHttpServletRequest, Writer writer, boolean b, String... strings)
             throws IOException {
-
     }
 
     @Override
@@ -77,11 +111,25 @@ public void writeThemeInclude(SlingHttpServletRequest slingHttpServletRequest, W
 
     @Override
     public void writeIncludes(SlingHttpServletRequest slingHttpServletRequest, Writer writer, String... strings) throws IOException {
-
+        if (jsIncludes != null && cssIncludes != null) {
+            StringBuilder includes = new StringBuilder();
+            for (String category : strings) {
+                String script = jsIncludes.get(category);
+                includes.append(script);
+            }
+            for (String category : strings) {
+                String link = cssIncludes.get(category);
+                includes.append(link);
+            }
+            writer.write(includes.toString());
+        }
     }
 
     @Override
     public HtmlLibrary getLibrary(LibraryType libraryType, String s) {
+        if (htmlLibrariesByPathAndType != null) {
+            return htmlLibrariesByPathAndType.get(Pair.of(s, libraryType));
+        }
         return null;
     }
 
@@ -107,6 +155,13 @@ public boolean isGzipEnabled() {
 
     @Override
     public Collection<ClientLibrary> getLibraries(String[] strings, LibraryType libraryType, boolean b, boolean b1) {
+        if (librariesByCategory != null) {
+            Collection<ClientLibrary> libraries = new ArrayList<>();
+            for (String category : strings) {
+                libraries.add(librariesByCategory.get(category));
+            }
+            return libraries;
+        }
         return Collections.unmodifiableCollection(clientLibraries);
     }
 

testing/junit/core/src/main/java/com/adobe/cq/wcm/core/components/testing/package-info.java

@@ -14,7 +14,7 @@
  ~ limitations under the License.
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 
-@Version("2.3.1")
+@Version("2.4.0")
 package com.adobe.cq.wcm.core.components.testing;
 
 import org.osgi.annotation.versioning.Version;