Merge branch 'develop'

wcm-io · Aug 21, 2023 · 9c685db · 9c685db
2 parents b4a6a28 + 0190741
commit 9c685db
Show file tree

Hide file tree

Showing 20 changed files with 302 additions and 147 deletions.
diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml
@@ -32,6 +32,6 @@ jobs:
           java-version: ${{ matrix.java }}
           maven-executable: ./mvnw
           sonar-run-on-os: ubuntu-latest
-          sonar-run-on-java-version: 11
+          sonar-run-on-java-version: 17
           sonar-token: ${{ secrets.SONAR_TOKEN }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/maven-deploy.yml b/.github/workflows/maven-deploy.yml
@@ -2,6 +2,8 @@
 
 name: Deploy
 
+concurrency: ${{ github.workflow }}
+
 on:
   push:
     branches:

diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar
diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties
@@ -5,14 +5,14 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
-# 
+#
 #   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.4/apache-maven-3.9.4-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
diff --git a/changes.xml b/changes.xml
@@ -23,6 +23,21 @@
     xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/plugins/maven-changes-plugin/xsd/changes-1.0.0.xsd">
   <body>
 
+    <release version="5.3.0" date="2023-08-21">
+      <action type="add" dev="catalinadumitruu" issue="19">
+        Implement MockTag.getLocalizedTitlePaths method.
+      </action>
+      <action type="add" dev="rubnig" issue="16">
+        Add mock implementation for JcrTagManagerFactory.
+      </action>
+      <action type="update" dev="sseifert">
+        Update to latest OSGI Mock, ResourceResolver Mock, Sling Mock.
+      </action>
+      <action type="fix" dev="sseifert">
+        Exclude transitive dependencies from com.day.commons:day-commons-gfx to avoid leaking in old dependencies in classpath.
+      </action>
+    </release>
+
     <release version="5.2.2" date="2023-05-19">
       <action type="update" dev="sseifert" issue="12">
         MockAemBindingsValuesProvider: Support LazyBindings.

diff --git a/core/pom.xml b/core/pom.xml
@@ -25,7 +25,7 @@
   <parent>
     <groupId>io.wcm</groupId>
     <artifactId>io.wcm.testing.aem-mock.parent</artifactId>
-    <version>5.2.2</version>
+    <version>5.3.0</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
@@ -240,6 +240,12 @@
       <artifactId>day-commons-gfx</artifactId>
       <version>2.1.28</version>
       <scope>compile</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>com.day.commons</groupId>
+          <artifactId>day-commons-any</artifactId>
+        </exclusion>
+      </exclusions>
     </dependency>
 
     <!-- Sling Hamcrest - include as compile dependency for convenience -->

diff --git a/core/src/main/java/io/wcm/testing/mock/aem/MockJcrTagManagerFactory.java b/core/src/main/java/io/wcm/testing/mock/aem/MockJcrTagManagerFactory.java
@@ -0,0 +1,35 @@
+package io.wcm.testing.mock.aem;
+
+import javax.jcr.Session;
+
+import org.apache.sling.api.resource.ResourceResolver;
+import org.osgi.annotation.versioning.ProviderType;
+import org.osgi.service.component.annotations.Component;
+
+import com.day.cq.tagging.JcrTagManagerFactory;
+import com.day.cq.tagging.TagManager;
+
+/**
+ * Mock implementation of {@link JcrTagManagerFactory}.
+ */
+@Component(service = JcrTagManagerFactory.class)
+@ProviderType
+public final class MockJcrTagManagerFactory implements JcrTagManagerFactory {
+
+  @Override
+  public TagManager getTagManager(final Session session) {
+    // Tried to implement this method by injecting the ResourceResolverFactory as an OSGi Service, but this is not possible, due to the fact that
+    // ResourceResolverType.NONE doesn't register the service on the BundleContext at construction of the AemContext.
+    // This method is deprecated and shouldn't be used anyway, so it shouldn't be a problem.
+    throw new UnsupportedOperationException();
+  }
+
+  @Override
+  public TagManager getTagManager(final ResourceResolver resourceResolver) {
+    if (resourceResolver == null) {
+      throw new IllegalArgumentException("ResourceResolver must not be null");
+    }
+    return new MockTagManager(resourceResolver);
+  }
+
+}
diff --git a/core/src/main/java/io/wcm/testing/mock/aem/MockTag.java b/core/src/main/java/io/wcm/testing/mock/aem/MockTag.java
@@ -372,15 +372,35 @@ public String getTitlePath(Locale locale) {
     return titlePath.toString();
   }
 
-  // --- unsupported operations ---
-
   @Override
-  public String getGQLSearchExpression(String arg0) {
-    throw new UnsupportedOperationException("Unsupported operation");
+  public Map<Locale, String> getLocalizedTitlePaths() {
+    Tag parent = this.getParent();
+    Map<Locale, String> map = parent != null ? parent.getLocalizedTitlePaths() : new HashMap<>();
+
+    for (Map.Entry<Locale, String> entry : map.entrySet()) {
+      if (parent.isNamespace()) {
+        entry.setValue(entry.getValue() + TITLEPATH_NS_DELIMITER + getTitle(entry.getKey()));
+      } else {
+        entry.setValue(entry.getValue() + TITLEPATH_DELIMITER + getTitle(entry.getKey()));
+      }
+    }
+
+    Map<Locale, String> localMap = getLocalizedTitles();
+    for (Map.Entry<Locale, String> entry : localMap.entrySet()) {
+      if (parent == null) {
+        map.put(entry.getKey(), entry.getValue());
+      } else if (!map.containsKey(entry.getKey())) {
+        map.put(entry.getKey(), parent.getTitlePath(entry.getKey()) + TITLEPATH_DELIMITER + entry.getValue());
+      }
+    }
+
+    return map;
   }
 
+  // --- unsupported operations ---
+
   @Override
-  public Map<Locale, String> getLocalizedTitlePaths() {
+  public String getGQLSearchExpression(String arg0) {
     throw new UnsupportedOperationException("Unsupported operation");
   }
 

diff --git a/core/src/main/java/io/wcm/testing/mock/aem/context/AemContextImpl.java b/core/src/main/java/io/wcm/testing/mock/aem/context/AemContextImpl.java
@@ -19,6 +19,7 @@
  */
 package io.wcm.testing.mock.aem.context;
 
+import io.wcm.testing.mock.aem.MockJcrTagManagerFactory;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
@@ -87,6 +88,7 @@ protected void registerDefaultServices() {
     registerInjectActivateService(new MockResourceCollectionManager());
     registerInjectActivateService(new MockSlingModelFilter());
     registerInjectActivateService(new MockExternalizer());
+    registerInjectActivateService(new MockJcrTagManagerFactory());
   }
 
   @Override

diff --git a/core/src/main/java/io/wcm/testing/mock/aem/package-info.java b/core/src/main/java/io/wcm/testing/mock/aem/package-info.java
@@ -20,5 +20,5 @@
 /**
  * Mock implementation of selected AEM APIs.
  */
-@org.osgi.annotation.versioning.Version("2.2.1")
+@org.osgi.annotation.versioning.Version("2.3.0")
 package io.wcm.testing.mock.aem;
diff --git a/core/src/test/java/io/wcm/testing/mock/aem/MockJcrTagManagerFactoryTest.java b/core/src/test/java/io/wcm/testing/mock/aem/MockJcrTagManagerFactoryTest.java
@@ -0,0 +1,52 @@
+package io.wcm.testing.mock.aem;
+
+import static org.junit.Assert.assertNotNull;
+
+import javax.jcr.Session;
+
+import org.apache.sling.api.resource.ResourceResolver;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+
+import com.day.cq.tagging.JcrTagManagerFactory;
+import com.day.cq.tagging.Tag;
+import com.day.cq.tagging.TagManager;
+
+import io.wcm.testing.mock.aem.context.TestAemContext;
+import io.wcm.testing.mock.aem.junit.AemContext;
+
+public class MockJcrTagManagerFactoryTest {
+
+  @Rule
+  public AemContext context = TestAemContext.newAemContext();
+
+  private JcrTagManagerFactory underTest;
+
+  @Before
+  public void setUp() {
+    context.create().tag("test:test-tag");
+    underTest = context.getService(JcrTagManagerFactory.class);
+  }
+
+  @Test
+  public void testGetTagManagerFromResourceResolver() {
+    TagManager tagManager = underTest.getTagManager(context.resourceResolver());
+    assertNotNull(tagManager);
+
+    Tag tag = tagManager.resolve("test:test-tag");
+    assertNotNull(tag);
+  }
+
+  @Test(expected = IllegalArgumentException.class)
+  public void testGetTagManagerFromResourceResolverWithNull() {
+    underTest.getTagManager((ResourceResolver)null);
+  }
+
+  @SuppressWarnings("deprecation")
+  @Test(expected = UnsupportedOperationException.class)
+  public void testGetTagManagerFromSession() {
+    underTest.getTagManager((Session)null);
+  }
+
+}
diff --git a/core/src/test/java/io/wcm/testing/mock/aem/MockTagTest.java b/core/src/test/java/io/wcm/testing/mock/aem/MockTagTest.java
@@ -295,6 +295,19 @@ public void testGetXPathSearchExpression_DefaultNamespace() throws Exception {
     assertTagExpression(tag, "tag3", "default/tag3");
   }
 
+  @Test
+  public void getLocalizedTitlePaths() {
+    Map<Locale,String> localizedTitlePaths = aemApi.getLocalizedTitlePaths();
+
+    assertNotNull(localizedTitlePaths);
+    assertEquals(6, localizedTitlePaths.size());
+    assertEquals("WCM IO Tag Namespace : AEM / English AEM API", localizedTitlePaths.get(Locale.ENGLISH));
+    assertEquals("WCM IO Tag Namespace : AEM / AEM API for US", localizedTitlePaths.get(Locale.US));
+    assertEquals("WCM IO Tag Namespace : AEM / German AEM API", localizedTitlePaths.get(Locale.GERMAN));
+    assertEquals("WCM IO Tag Namespace : AEM / AEM API for Germany", localizedTitlePaths.get(Locale.GERMANY));
+    assertEquals("WCM IO Tag Namespace : AEM / Portuguese (Brazil) AEM API/:with special chars", localizedTitlePaths.get(LOCALE_PT_BR));
+  }
+
   private void assertTagExpression(@NotNull final Tag tag,
                                    @NotNull final String tagId,
                                    @NotNull final String tagPath) {

diff --git a/core/src/test/java/io/wcm/testing/mock/aem/context/MockOverrideSlingPathRequestWrapper.java b/core/src/test/java/io/wcm/testing/mock/aem/context/MockOverrideSlingPathRequestWrapper.java
@@ -33,7 +33,7 @@ class MockOverrideSlingPathRequestWrapper extends SlingHttpServletRequestWrapper
     super(request);
     this.adapterManager = adapterManager;
     this.myBindings = new SlingBindings();
-    this.adaptersCache = new HashMap();
+    this.adaptersCache = new HashMap<>();
     SlingBindings slingBindings = (SlingBindings)this.getSlingRequest().getAttribute(ATTR_SLING_BINDINGS);
     this.resource = this.getSlingRequest().getResourceResolver().resolve(this.getSlingRequest(), path);
     if (slingBindings != null) {
@@ -84,6 +84,7 @@ public Resource getResource() {
    * Overriding `adaptTo` to avoid using the original request as the adaptable.
    */
   @Override
+  @SuppressWarnings({ "null", "unchecked" })
   public <AdapterType> AdapterType adaptTo(Class<AdapterType> type) {
     AdapterType result = null;
     synchronized (this) {

diff --git a/junit4/pom.xml b/junit4/pom.xml
@@ -25,7 +25,7 @@
   <parent>
     <groupId>io.wcm</groupId>
     <artifactId>io.wcm.testing.aem-mock.parent</artifactId>
-    <version>5.2.2</version>
+    <version>5.3.0</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
@@ -54,7 +54,7 @@
     <dependency>
       <groupId>io.wcm</groupId>
       <artifactId>io.wcm.testing.aem-mock.core</artifactId>
-      <version>5.2.2</version>
+      <version>5.3.0</version>
       <scope>compile</scope>
     </dependency>
 
@@ -87,7 +87,7 @@
     <dependency>
       <groupId>io.wcm</groupId>
       <artifactId>io.wcm.testing.aem-mock.core</artifactId>
-      <version>5.2.2</version>
+      <version>5.3.0</version>
       <classifier>tests</classifier>
       <scope>test</scope>
     </dependency>

diff --git a/junit5/pom.xml b/junit5/pom.xml
@@ -25,7 +25,7 @@
   <parent>
     <groupId>io.wcm</groupId>
     <artifactId>io.wcm.testing.aem-mock.parent</artifactId>
-    <version>5.2.2</version>
+    <version>5.3.0</version>
     <relativePath>../parent/pom.xml</relativePath>
   </parent>
 
@@ -54,14 +54,14 @@
     <dependency>
       <groupId>io.wcm</groupId>
       <artifactId>io.wcm.testing.aem-mock.core</artifactId>
-      <version>5.2.2</version>
+      <version>5.3.0</version>
       <scope>compile</scope>
     </dependency>
 
     <dependency>
       <groupId>io.wcm</groupId>
       <artifactId>io.wcm.testing.aem-mock.core</artifactId>
-      <version>5.2.2</version>
+      <version>5.3.0</version>
       <classifier>tests</classifier>
       <scope>test</scope>
     </dependency>