This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourceresolver.git
The following commit(s) were added to refs/heads/master by this push:
new 2a7960a SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator (#120)
2a7960a is described below
commit 2a7960a1134feeaa12db76d2229dfcfcc245dd3a
Author: Julian Reschke <[email protected]>
AuthorDate: Mon Jul 22 09:28:49 2024 +0200
SLING-12387: ResourceResolver: improve test coverage for PagedQueryIterator
(#120)
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: empty search result
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: broken query
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: simple query
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: paged query skipping resource with empty key
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: broken paging
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: detect broken sort order
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: sonar mangling
* SLING-12387: ResourceResolver: improve test coverage for
PagedQueryIterator: align test with SLING-12384
* SLING-12387: fix line ends
---
.../resourceresolver/impl/mapping/MapEntries.java | 2 +-
.../impl/mapping/PagedQueryIteratorTest.java | 177 +++++++++++++++++++++
2 files changed, 178 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
index def8167..f9fa751 100644
---
a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
+++
b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
@@ -1310,7 +1310,7 @@ public class MapEntries implements
/**
* Utility class for running paged queries.
*/
- private class PagedQueryIterator implements Iterator<Resource> {
+ protected class PagedQueryIterator implements Iterator<Resource> {
private ResourceResolver resolver;
private String subject;
diff --git
a/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
b/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
new file mode 100644
index 0000000..4bd41d0
--- /dev/null
+++
b/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
@@ -0,0 +1,177 @@
+/*
+ * 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.resourceresolver.impl.mapping;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Optional;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+import org.apache.sling.api.resource.QuerySyntaxException;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.api.resource.path.Path;
+import org.apache.sling.resourceresolver.impl.ResourceResolverMetrics;
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.Test;
+import org.mockito.MockitoAnnotations;
+
+public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
+
+ private MapEntries mapEntries;
+
+ private static String PROPNAME = "prop";
+
+ @SuppressWarnings("unchecked")
+ @Override
+ @Before
+ public void setup() throws Exception {
+ MockitoAnnotations.openMocks(this).close();
+
+ when(bundle.getSymbolicName()).thenReturn("TESTBUNDLE");
+ when(bundleContext.getBundle()).thenReturn(bundle);
+
when(resourceResolverFactory.getServiceResourceResolver(any(Map.class))).thenReturn(resourceResolver);
+ when(resourceResolverFactory.getObservationPaths()).thenReturn(new
Path[] { new Path("/") });
+
when(resourceResolverFactory.getMapRoot()).thenReturn(MapEntries.DEFAULT_MAP_ROOT);
+
+ Optional<ResourceResolverMetrics> metrics = Optional.empty();
+
+ mapEntries = new MapEntries(resourceResolverFactory, bundleContext,
eventAdmin, stringInterpolationProvider, metrics);
+ }
+
+ @Test
+ public void testEmptyQuery() {
+ when(resourceResolver.findResources(eq("empty"),
eq("JCR-SQL2"))).thenReturn(Collections.<Resource> emptySet().iterator());
+ Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias",
PROPNAME, resourceResolver, "empty", 2000);
+ assertFalse(it.hasNext());
+ }
+
+ @Test(expected = QuerySyntaxException.class)
+ public void testMalformedQuery() {
+ when(resourceResolver.findResources(eq("malformed"),
eq("JCR-SQL2"))).thenThrow(new QuerySyntaxException("x", "y", "z"));
+ mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver,
"malformed", 2000);
+ }
+
+ @Test
+ public void testSimple() {
+ String[] expected = new String[] { "a", "b", "c" };
+ Collection<Resource> expectedResources = toResourceList(expected);
+ when(resourceResolver.findResources(eq("simple"),
eq("JCR-SQL2"))).thenReturn(expectedResources.iterator());
+ Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias",
PROPNAME, resourceResolver, "simple", 2000);
+ for (String key : expected) {
+ assertEquals(key, getFirstValueOf(it.next(), PROPNAME));
+ }
+ assertFalse(it.hasNext());
+ }
+
+ @Ignore("SLING-12384: detection of incorrect sort order fails")
+ @Test(expected = RuntimeException.class)
+ public void testSimpleWrongOrder() {
+ String[] expected = new String[] { "a", "b", "d", "c" };
+ Collection<Resource> expectedResources = toResourceList(expected);
+ when(resourceResolver.findResources(eq("testSimpleWrongOrder"),
eq("JCR-SQL2"))).thenReturn(expectedResources.iterator());
+ Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias",
PROPNAME, resourceResolver, "testSimpleWrongOrder",
+ 2000);
+ while (it.hasNext()) {
+ it.next();
+ }
+ }
+
+ @Ignore("SLING-12384: resources with empty keys lost")
+ @Test
+ public void testPagedWithEmpty() {
+ String[] expected = new String[] { "", "a", "b", "c", "d" };
+ Collection<Resource> expectedResources = toResourceList(expected);
+ Collection<Resource> expectedFilteredResources = filter("",
expectedResources);
+ when(resourceResolver.findResources(eq("testPagedWithEmpty ''"),
eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResources.iterator());
+ Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias",
PROPNAME, resourceResolver, "testPagedWithEmpty '%s'",
+ 2000);
+ for (String key : expected) {
+ assertEquals(key, getFirstValueOf(it.next(), PROPNAME));
+ }
+ assertFalse(it.hasNext());
+ }
+
+ @Ignore("SLING-12384: broken paging")
+ @Test
+ public void testPagedResourcesOnPageBoundaryLost() {
+ String[] expected = new String[] { "a", "a", "a", "a", "a", "a", "b",
"c", "d" };
+ Collection<Resource> expectedResources = toResourceList(expected);
+ Collection<Resource> expectedFilteredResources = filter("",
expectedResources);
+ Collection<Resource> expectedFilteredResourcesA = filter("a",
expectedResources);
+ Collection<Resource> expectedFilteredResourcesB = filter("b",
expectedResources);
+ Collection<Resource> expectedFilteredResourcesC = filter("c",
expectedResources);
+ Collection<Resource> expectedFilteredResourcesD = filter("d",
expectedResources);
+
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost
''"), eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResources.iterator());
+
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost
'a'"), eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResourcesA.iterator());
+
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost
'b'"), eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResourcesB.iterator());
+
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost
'c'"), eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResourcesC.iterator());
+
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost
'd'"), eq("JCR-SQL2")))
+ .thenReturn(expectedFilteredResourcesD.iterator());
+ Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias",
PROPNAME, resourceResolver,
+ "testPagedResourcesOnPageBoundaryLost '%s'", 5);
+ int pos = 0;
+ for (String key : expected) {
+ assertEquals("expects " + key + " at position " + pos, key,
getFirstValueOf(it.next(), PROPNAME));
+ pos += 1;
+ }
+ assertFalse(it.hasNext());
+ }
+
+ private static Collection<Resource> toResourceList(String... keys) {
+ Collection<Resource> result = new ArrayList<>();
+ for (String key : keys) {
+ ValueMap m = mock(ValueMap.class);
+ when(m.get(eq(PROPNAME), any(Object.class))).thenReturn(new
String[] { key });
+ Resource r = mock(Resource.class);
+ when(r.getValueMap()).thenReturn(m);
+ result.add(r);
+ }
+ return result;
+ }
+
+ private static Collection<Resource> filter(String key,
Collection<Resource> input) {
+ // this emulates the ">" condition used by PagedQueryIterator prior to
+ // resolution of SLING-12384
+ Predicate<Resource> filter = r -> getFirstValueOf(r,
PROPNAME).compareTo(key) > 0;
+ return input.stream().filter(filter).collect(Collectors.toList());
+ }
+
+ private static String getFirstValueOf(Resource r, String propname) {
+ return r.getValueMap().get(propname, new String[0])[0];
+ }
+}
