This is an automated email from the ASF dual-hosted git repository.
sseifert pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-testing-sling-mock.git
The following commit(s) were added to refs/heads/master by this push:
new 0fb9723 SLING-12266 - Add support for repo snapshots (#39)
0fb9723 is described below
commit 0fb97232b98a91bdca3b5accaa3d499175e4685b
Author: Csaba Varga <csaba.va...@ni.com>
AuthorDate: Thu Apr 11 14:06:06 2024 +0200
SLING-12266 - Add support for repo snapshots (#39)
Allow resource resolver types to save the state of an already initialized
repository and restore it when creating future repositories. Only Oak can
meaningfully support this right now, as it's already built on immutable
node state objects.
---
.../apache/sling/testing/mock/sling/MockSling.java | 30 ++++++-
.../sling/spi/ResourceResolverTypeAdapter.java | 24 ++++++
.../sling/testing/mock/sling/spi/package-info.java | 2 +-
.../sling/testing/mock/sling/MockSlingTest.java | 93 ++++++++++++++++++++++
4 files changed, 146 insertions(+), 3 deletions(-)
diff --git
a/core/src/main/java/org/apache/sling/testing/mock/sling/MockSling.java
b/core/src/main/java/org/apache/sling/testing/mock/sling/MockSling.java
index 378e530..96580e5 100644
--- a/core/src/main/java/org/apache/sling/testing/mock/sling/MockSling.java
+++ b/core/src/main/java/org/apache/sling/testing/mock/sling/MockSling.java
@@ -20,6 +20,8 @@ package org.apache.sling.testing.mock.sling;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
@@ -50,6 +52,9 @@ public final class MockSling {
private static final ThreadsafeMockAdapterManagerWrapper ADAPTER_MANAGER =
new ThreadsafeMockAdapterManagerWrapper();
+ private static final ConcurrentMap<Class<? extends
ResourceResolverTypeAdapter>, Object> SNAPSHOTS =
+ new ConcurrentHashMap<>();
+
static {
// register mocked adapter manager
SlingAdaptable.setAdapterManager(ADAPTER_MANAGER);
@@ -89,14 +94,35 @@ public final class MockSling {
ResourceResolverTypeAdapter adapter =
getResourceResolverTypeAdapter(type, bundleContext);
ResourceResolverFactory factory = adapter.newResourceResolverFactory();
if (factory == null) {
- SlingRepository repository = adapter.newSlingRepository();
- factory = ResourceResolverFactoryInitializer.setUp(repository,
bundleContext, type.getNodeTypeMode());
+ factory = buildFactoryFromRepository(type.getNodeTypeMode(),
bundleContext, adapter);
} else {
bundleContext.registerService(ResourceResolverFactory.class.getName(), factory,
null);
}
return factory;
}
+ @NotNull
+ static ResourceResolverFactory buildFactoryFromRepository(
+ @NotNull NodeTypeMode mode, @NotNull BundleContext bundleContext,
ResourceResolverTypeAdapter adapter) {
+ ResourceResolverFactory factory;
+ Object existingSnapshot = SNAPSHOTS.get(adapter.getClass());
+ SlingRepository repository;
+ if (existingSnapshot == null) {
+ repository = adapter.newSlingRepository();
+ } else {
+ repository =
adapter.newSlingRepositoryFromSnapshot(existingSnapshot);
+ }
+ factory = ResourceResolverFactoryInitializer.setUp(
+ repository, bundleContext, existingSnapshot == null ? mode :
NodeTypeMode.NOT_SUPPORTED);
+ if (existingSnapshot == null) {
+ Object newSnapshot = adapter.snapshot(repository);
+ if (newSnapshot != null) {
+ SNAPSHOTS.putIfAbsent(adapter.getClass(), newSnapshot);
+ }
+ }
+ return factory;
+ }
+
@SuppressWarnings("unchecked")
private static ResourceResolverTypeAdapter getResourceResolverTypeAdapter(
final ResourceResolverType type, @NotNull final BundleContext
bundleContext) {
diff --git
a/core/src/main/java/org/apache/sling/testing/mock/sling/spi/ResourceResolverTypeAdapter.java
b/core/src/main/java/org/apache/sling/testing/mock/sling/spi/ResourceResolverTypeAdapter.java
index e8ed7f9..583e647 100644
---
a/core/src/main/java/org/apache/sling/testing/mock/sling/spi/ResourceResolverTypeAdapter.java
+++
b/core/src/main/java/org/apache/sling/testing/mock/sling/spi/ResourceResolverTypeAdapter.java
@@ -50,4 +50,28 @@ public interface ResourceResolverTypeAdapter {
*/
@Nullable
SlingRepository newSlingRepository();
+
+ /**
+ * Make a snapshot of the current state of the given repository, or return
+ * null if snapshots are not supported.
+ * Returning non-null implies that calling {@link
#newSlingRepositoryFromSnapshot(Object)}
+ * with the same object will succeed when called on objects of the same
implementation type.
+ * The returned object must capture the whole state of the repository, and
must not reflect
+ * any future changes made to the repository after this method returns.
+ * @param repository The repository to snapshot.
+ * @return A snapshot object.
+ */
+ @Nullable
+ default Object snapshot(SlingRepository repository) {
+ return null;
+ }
+
+ /**
+ * Get a SlingRepository instance based on a snapshot taken from another
repository.
+ * @param snapshot A snapshot object, returned by an earlier call to
{@link #snapshot(SlingRepository)}.
+ * @return A Sling repository instance.
+ */
+ default SlingRepository newSlingRepositoryFromSnapshot(Object snapshot) {
+ throw new UnsupportedOperationException("Snapshots not supported");
+ }
}
diff --git
a/core/src/main/java/org/apache/sling/testing/mock/sling/spi/package-info.java
b/core/src/main/java/org/apache/sling/testing/mock/sling/spi/package-info.java
index 0e84e95..2ce75f8 100644
---
a/core/src/main/java/org/apache/sling/testing/mock/sling/spi/package-info.java
+++
b/core/src/main/java/org/apache/sling/testing/mock/sling/spi/package-info.java
@@ -19,5 +19,5 @@
/**
* SPI for hooking in alternative resource type adapter implementations.
*/
-@org.osgi.annotation.versioning.Version("1.0.1")
+@org.osgi.annotation.versioning.Version("1.1.0")
package org.apache.sling.testing.mock.sling.spi;
diff --git
a/core/src/test/java/org/apache/sling/testing/mock/sling/MockSlingTest.java
b/core/src/test/java/org/apache/sling/testing/mock/sling/MockSlingTest.java
new file mode 100644
index 0000000..2552139
--- /dev/null
+++ b/core/src/test/java/org/apache/sling/testing/mock/sling/MockSlingTest.java
@@ -0,0 +1,93 @@
+/*
+ * 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.mock.sling;
+
+import org.apache.sling.api.resource.ResourceResolverFactory;
+import org.apache.sling.jcr.api.SlingRepository;
+import org.apache.sling.testing.mock.osgi.MockOsgi;
+import org.apache.sling.testing.mock.sling.spi.ResourceResolverTypeAdapter;
+import org.jetbrains.annotations.Nullable;
+import org.junit.Test;
+import org.osgi.framework.BundleContext;
+
+import static org.junit.Assert.*;
+
+public class MockSlingTest {
+
+ private SlingRepository buildRepo(ResourceResolverTypeAdapter adapter) {
+ BundleContext context = MockOsgi.newBundleContext();
+ MockSling.buildFactoryFromRepository(NodeTypeMode.NOT_SUPPORTED,
context, adapter);
+ return
context.getService(context.getServiceReference(SlingRepository.class));
+ }
+
+ @Test
+ public void testAdapterDoesNotSupportSnapshots() {
+ ResourceResolverTypeAdapter snapshotUnawareAdapter = new
ResourceResolverTypeAdapter() {
+ @Override
+ public @Nullable ResourceResolverFactory
newResourceResolverFactory() {
+ return null;
+ }
+
+ @Override
+ public SlingRepository newSlingRepository() {
+ return new MockJcrSlingRepository();
+ }
+ };
+
+ SlingRepository repo1 = buildRepo(snapshotUnawareAdapter);
+ SlingRepository repo2 = buildRepo(snapshotUnawareAdapter);
+
+ assertNotNull(repo1);
+ assertNotNull(repo2);
+ assertNotSame(repo2, repo1);
+ }
+
+ @Test
+ public void testAdapterSupportsSnapshots() {
+ SlingRepository freshRepo = new MockJcrSlingRepository();
+ SlingRepository snapshotRepo = new MockJcrSlingRepository();
+ ResourceResolverTypeAdapter snapshotAwareAdapter = new
ResourceResolverTypeAdapter() {
+ @Override
+ public @Nullable ResourceResolverFactory
newResourceResolverFactory() {
+ return null;
+ }
+
+ @Override
+ public SlingRepository newSlingRepository() {
+ return freshRepo;
+ }
+
+ @Override
+ public Object snapshot(SlingRepository repository) {
+ return "dummy";
+ }
+
+ @Override
+ public SlingRepository newSlingRepositoryFromSnapshot(Object
snapshot) {
+ return snapshotRepo;
+ }
+ };
+
+ SlingRepository repo1 = buildRepo(snapshotAwareAdapter);
+ SlingRepository repo2 = buildRepo(snapshotAwareAdapter);
+
+ assertSame(freshRepo, repo1);
+ assertSame(snapshotRepo, repo2);
+ }
+}
