You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ss...@apache.org on 2023/08/15 08:56:12 UTC

[sling-org-apache-sling-testing-resourceresolver-mock] 01/01: SLING-12001 Store MockFindResourcesHandler/MockQueryResourceHandler in MockResourceResolverFactoryOptions so they are available to all resource resolvers

This is an automated email from the ASF dual-hosted git repository.

sseifert pushed a commit to branch feature/SLING-12001-mockfindqueryresource-rrfactory-options
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-resourceresolver-mock.git

commit a3e33024fb6043755254a45266023aad1608211f
Author: Stefan Seifert <st...@users.noreply.github.com>
AuthorDate: Tue Aug 15 10:52:57 2023 +0200

    SLING-12001 Store MockFindResourcesHandler/MockQueryResourceHandler in MockResourceResolverFactoryOptions so they are available to all resource resolvers
---
 .../resourceresolver/MockResourceResolver.java     | 11 ++--
 .../MockResourceResolverFactoryOptions.java        | 24 ++++++++-
 .../testing/resourceresolver/package-info.java     |  2 +-
 ...esourcesResourceResolverFactoryOptionsTest.java | 48 ++++++++++++++++++
 .../resourceresolver/FindQueryResourcesTest.java   | 58 +++++++++++++++-------
 5 files changed, 115 insertions(+), 28 deletions(-)

diff --git a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolver.java b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolver.java
index de7e4fa..570bc80 100644
--- a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolver.java
+++ b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolver.java
@@ -67,9 +67,6 @@ public class MockResourceResolver extends SlingAdaptable implements ResourceReso
 
     private Map<String,Object> propertyMap;
 
-    private final List<MockFindResourcesHandler> findResourcesHandlers = new ArrayList<>();
-    private final List<MockQueryResourceHandler> queryResourcesHandlers = new ArrayList<>();
-
     public MockResourceResolver(final MockResourceResolverFactoryOptions options,
             final MockResourceResolverFactory factory,
             final Map<String, Map<String, Object>> resources) {
@@ -480,7 +477,7 @@ public class MockResourceResolver extends SlingAdaptable implements ResourceReso
     @Override
     @SuppressWarnings("null")
     public @NotNull Iterator<Resource> findResources(final @NotNull String query, final String language) {
-        return findResourcesHandlers.stream()
+        return options.getFindResourcesHandlers().stream()
             .map(handler -> handler.findResources(query, language))
             .filter(Objects::nonNull)
             .findFirst()
@@ -501,13 +498,13 @@ public class MockResourceResolver extends SlingAdaptable implements ResourceReso
     }
 
     void addFindResourceHandlerInternal(@NotNull MockFindResourcesHandler handler) {
-        findResourcesHandlers.add(handler);
+        options.addFindResourceHandler(handler);
     }
 
     @Override
     @SuppressWarnings("null")
     public @NotNull Iterator<Map<String, Object>> queryResources(@NotNull String query, String language) {
-        return queryResourcesHandlers.stream()
+        return options.getQueryResourcesHandlers().stream()
                 .map(handler -> handler.queryResources(query, language))
                 .filter(Objects::nonNull)
                 .findFirst()
@@ -528,7 +525,7 @@ public class MockResourceResolver extends SlingAdaptable implements ResourceReso
     }
 
     void addQueryResourceHandlerInternal(@NotNull MockQueryResourceHandler handler) {
-        queryResourcesHandlers.add(handler);
+        options.addQueryResourceHandlerInternal(handler);
     }
 
     // Sling API 2.24.0
diff --git a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactoryOptions.java b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactoryOptions.java
index 64705e6..9b270c8 100644
--- a/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactoryOptions.java
+++ b/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactoryOptions.java
@@ -18,6 +18,9 @@
  */
 package org.apache.sling.testing.resourceresolver;
 
+import java.util.ArrayList;
+import java.util.List;
+
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.osgi.service.event.EventAdmin;
@@ -35,6 +38,9 @@ public class MockResourceResolverFactoryOptions {
 
     private boolean mangleNamespacePrefixes;
 
+    private final List<MockFindResourcesHandler> findResourcesHandlers = new ArrayList<>();
+    private final List<MockQueryResourceHandler> queryResourcesHandlers = new ArrayList<>();
+
     public @Nullable EventAdmin getEventAdmin() {
         return eventAdmin;
     }
@@ -71,10 +77,26 @@ public class MockResourceResolverFactoryOptions {
         }
         return mockResourceFactory;
     }
-    
+
     public @NotNull MockResourceResolverFactoryOptions setMockResourceFactory(MockResourceFactory factory) {
         this.mockResourceFactory = factory;
         return this;
     }
 
+    public void addFindResourceHandler(@NotNull MockFindResourcesHandler handler) {
+        findResourcesHandlers.add(handler);
+    }
+
+    public @NotNull List<MockFindResourcesHandler> getFindResourcesHandlers() {
+        return findResourcesHandlers;
+    }
+
+    public void addQueryResourceHandlerInternal(@NotNull MockQueryResourceHandler handler) {
+        queryResourcesHandlers.add(handler);
+    }
+
+    public @NotNull List<MockQueryResourceHandler> getQueryResourcesHandlers() {
+        return queryResourcesHandlers;
+    }
+
 }
diff --git a/src/main/java/org/apache/sling/testing/resourceresolver/package-info.java b/src/main/java/org/apache/sling/testing/resourceresolver/package-info.java
index 0a16cc8..cc055ba 100644
--- a/src/main/java/org/apache/sling/testing/resourceresolver/package-info.java
+++ b/src/main/java/org/apache/sling/testing/resourceresolver/package-info.java
@@ -19,5 +19,5 @@
 /**
  * Apache Sling Testing Resource Resolver Mock
  */
-@org.osgi.annotation.versioning.Version("2.3.0")
+@org.osgi.annotation.versioning.Version("2.4.0")
 package org.apache.sling.testing.resourceresolver;
diff --git a/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesResourceResolverFactoryOptionsTest.java b/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesResourceResolverFactoryOptionsTest.java
new file mode 100644
index 0000000..993b5c7
--- /dev/null
+++ b/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesResourceResolverFactoryOptionsTest.java
@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * 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.
+ */
+package org.apache.sling.testing.resourceresolver;
+
+import java.util.Arrays;
+
+import org.apache.sling.api.resource.LoginException;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.testing.mock.sling.ResourceResolverType;
+import org.apache.sling.testing.mock.sling.junit.SlingContext;
+import org.junit.Rule;
+
+public class FindQueryResourcesResourceResolverFactoryOptionsTest extends FindQueryResourcesTest {
+
+    @Rule
+    public SlingContext context = new SlingContext(ResourceResolverType.NONE);
+
+    @Override
+    protected ResourceResolver createResourceResolver_addFindResourceHandlers(MockFindResourcesHandler... handlers) throws LoginException {
+        // set handler on other resource resolver created in setUp
+        Arrays.stream(handlers).forEach(handler -> MockFindQueryResources.addFindResourceHandler(resourceResolver, handler));
+        return createResourceResolver();
+    }
+
+    @Override
+    protected ResourceResolver createResourceResolver_addQueryResourceHandlers(MockQueryResourceHandler... handlers) throws LoginException {
+        // set handler on other resource resolver created in setUp
+        Arrays.stream(handlers).forEach(handler -> MockFindQueryResources.addQueryResourceHandler(resourceResolver, handler));
+        return createResourceResolver();
+    }
+
+}
diff --git a/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesTest.java b/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesTest.java
index e06c0ad..2905c4c 100644
--- a/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesTest.java
+++ b/src/test/java/org/apache/sling/testing/resourceresolver/FindQueryResourcesTest.java
@@ -22,6 +22,7 @@ import static javax.jcr.query.Query.JCR_SQL2;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 
+import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -35,6 +36,7 @@ import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.resource.LoginException;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ResourceResolverFactory;
 import org.apache.sling.api.resource.ValueMap;
 import org.junit.Before;
 import org.junit.Test;
@@ -45,7 +47,8 @@ import org.junit.Test;
 @SuppressWarnings("null")
 public class FindQueryResourcesTest {
 
-    private ResourceResolver resourceResolver;
+    protected ResourceResolverFactory resourceResolverFactory = new MockResourceResolverFactory();
+    protected ResourceResolver resourceResolver;
     private Resource resource1;
     private Resource resource2;
 
@@ -59,63 +62,80 @@ public class FindQueryResourcesTest {
             .commit();
         resource1 = resourceResolver.getResource("/resource1");
         resource2 = resourceResolver.getResource("/resource2");
+        resourceResolver.commit();
     }
 
     protected ResourceResolver createResourceResolver() throws LoginException {
-        return new MockResourceResolverFactory().getResourceResolver(null);
+        return resourceResolverFactory.getResourceResolver(null);
+    }
+
+    protected ResourceResolver createResourceResolver_addFindResourceHandlers(MockFindResourcesHandler... handlers) throws LoginException {
+        // set handler directly on newly created resource resolver
+        ResourceResolver resourceResolver = createResourceResolver();
+        Arrays.stream(handlers).forEach(handler -> MockFindQueryResources.addFindResourceHandler(resourceResolver, handler));
+        return resourceResolver;
+    }
+
+    protected ResourceResolver createResourceResolver_addQueryResourceHandlers(MockQueryResourceHandler... handlers) throws LoginException {
+        // set handler directly on newly created resource resolver
+        ResourceResolver resourceResolver = createResourceResolver();
+        Arrays.stream(handlers).forEach(handler -> MockFindQueryResources.addQueryResourceHandler(resourceResolver, handler));
+        return resourceResolver;
     }
 
     @Test
-    public void testFindResourcesNoHandler() {
+    public void testFindResourcesNoHandler() throws Exception {
+        ResourceResolver resourceResolver = createResourceResolver_addFindResourceHandlers();
         Iterator<Resource> result = resourceResolver.findResources("any-query", JCR_SQL2);
         assertFalse(result.hasNext());
     }
 
     @Test
-    public void testFindResourcesSingleHandler() {
+    public void testFindResourcesSingleHandler() throws Exception {
         List<Resource> expected = List.of(resource1, resource2);
-        MockFindQueryResources.addFindResourceHandler(resourceResolver, (query, language) -> expected.iterator());
+        ResourceResolver resourceResolver = createResourceResolver_addFindResourceHandlers(
+                (query, language) -> expected.iterator());
 
         assertResources(expected, resourceResolver.findResources("any-query", JCR_SQL2));
     }
 
     @Test
-    public void testFindResourcesMultipleHandlers() {
+    public void testFindResourcesMultipleHandlers() throws Exception {
         List<Resource> expected1 = List.of(resource1);
-        MockFindQueryResources.addFindResourceHandler(resourceResolver, (query, language) ->
-            StringUtils.equals(query, "q1") ? expected1.iterator() : null);
-
         List<Resource> expected2 = List.of(resource2);
-        MockFindQueryResources.addFindResourceHandler(resourceResolver, (query, language) ->
-            StringUtils.equals(query, "q2") ? expected2.iterator() : null);
+
+        ResourceResolver resourceResolver = createResourceResolver_addFindResourceHandlers(
+                (query, language) -> StringUtils.equals(query, "q1") ? expected1.iterator() : null,
+                (query, language) -> StringUtils.equals(query, "q2") ? expected2.iterator() : null);
 
         assertResources(expected1, resourceResolver.findResources("q1", JCR_SQL2));
         assertResources(expected2, resourceResolver.findResources("q2", JCR_SQL2));
     }
 
     @Test
-    public void testQueryResourcesNoHandler() {
+    public void testQueryResourcesNoHandler() throws Exception {
+        ResourceResolver resourceResolver = createResourceResolver_addQueryResourceHandlers();
         Iterator<Map<String,Object>> result = resourceResolver.queryResources("any-query", JCR_SQL2);
         assertFalse(result.hasNext());
     }
 
     @Test
-    public void testQueryResourcesSingleHandler() {
+    public void testQueryResourcesSingleHandler() throws Exception {
         List<Map<String,Object>> expected = List.of(resource1.getValueMap(), resource2.getValueMap());
-        MockFindQueryResources.addQueryResourceHandler(resourceResolver, (query, language) -> expected.iterator());
+        ResourceResolver resourceResolver = createResourceResolver_addQueryResourceHandlers(
+                (query, language) -> expected.iterator());
 
         assertEquals(expected, IteratorUtils.toList(resourceResolver.queryResources("any-query", JCR_SQL2)));
     }
 
     @Test
-    public void testQueryResourcesMultipleHandlers() {
+    public void testQueryResourcesMultipleHandlers() throws Exception {
         List<Map<String,Object>> expected1 = List.of(resource1.getValueMap());
-        MockFindQueryResources.addQueryResourceHandler(resourceResolver, (query, language) ->
-            StringUtils.equals(query, "q1") ? expected1.iterator() : null);
 
         List<Map<String,Object>> expected2 = List.of(resource2.getValueMap());
-        MockFindQueryResources.addQueryResourceHandler(resourceResolver, (query, language) ->
-            StringUtils.equals(query, "q2") ? expected2.iterator() : null);
+        ResourceResolver resourceResolver = createResourceResolver_addQueryResourceHandlers(
+                (query, language) -> StringUtils.equals(query, "q1") ? expected1.iterator() : null,
+                (query, language) -> StringUtils.equals(query, "q2") ? expected2.iterator() : null);
 
         assertEquals(expected1, IteratorUtils.toList(resourceResolver.queryResources("q1", JCR_SQL2)));
         assertEquals(expected2, IteratorUtils.toList(resourceResolver.queryResources("q2", JCR_SQL2)));