solves #22: add's support for Experience Fragment classes (#23)

Co-authored-by: Roy Teeuwen <[email protected]> Co-authored-by: Stefan Seifert <[email protected]>
wcm-io · Oct 13, 2023 · 4119165 · 4119165
1 parent 14f8afd
commit 4119165
Show file tree

Hide file tree

Showing 8 changed files with 564 additions and 1 deletion.
diff --git a/changes.xml b/changes.xml
@@ -23,7 +23,10 @@
     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.2" date="not released">
+    <release version="5.4.0" date="not released">
+      <action type="add" dev="royteeuwen" issue="22">
+        Add mocks for ExperienceFragment and ExperienceFragmentVariation, adaptable from page objects.
+      </action>
       <action type="update" dev="sseifert">
         Update to latest Sling Mock.
       </action>

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
@@ -24,6 +24,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import io.wcm.testing.mock.aem.xf.MockExperienceFragmentAdapterFactory;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolverFactory;
@@ -76,6 +77,7 @@ protected void registerDefaultServices() {
     registerInjectActivateService(new MockAemAdapterFactory());
     registerInjectActivateService(new MockAemDamAdapterFactory());
     registerInjectActivateService(new MockLayerAdapterFactory());
+    registerInjectActivateService(new MockExperienceFragmentAdapterFactory());
 
     // other services
     registerInjectActivateService(new MockAssetHandler());

diff --git a/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragment.java b/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragment.java
@@ -0,0 +1,78 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2019 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.testing.mock.aem.xf;
+
+import static com.adobe.cq.xf.ExperienceFragmentsConstants.PN_XF_VARIANT_TYPE;
+import static com.adobe.cq.xf.ExperienceFragmentsConstants.RT_EXPERIENCE_FRAGMENT_PAGE;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.sling.api.resource.ValueMap;
+
+import com.adobe.cq.xf.ExperienceFragment;
+import com.adobe.cq.xf.ExperienceFragmentVariation;
+import com.day.cq.commons.Filter;
+import com.day.cq.wcm.api.Page;
+
+/**
+ * Mock implementation of {@link ExperienceFragment}.
+ */
+class MockExperienceFragment extends MockExperienceFragmentBase implements ExperienceFragment {
+
+  MockExperienceFragment(Page page) {
+    super(page);
+  }
+
+  @Override
+  public List<ExperienceFragmentVariation> getVariations() {
+    List<ExperienceFragmentVariation> variations = new ArrayList<>();
+    Iterator<Page> it = getPage().listChildren(element -> element.getContentResource().isResourceType(RT_EXPERIENCE_FRAGMENT_PAGE));
+    while (it.hasNext()) {
+      Page thePage = it.next();
+      variations.add(thePage.adaptTo(ExperienceFragmentVariation.class));
+    }
+    return variations;
+  }
+
+  @Override
+  public List<ExperienceFragmentVariation> getVariations(String... type) {
+    final Set<String> typeValues = new HashSet<>(List.of(type));
+    Filter<Page> typeFilter = element -> {
+      ValueMap properties = element.getProperties();
+      String variantType = properties.get(PN_XF_VARIANT_TYPE, "");
+      if (StringUtils.isEmpty(variantType)) {
+        return false;
+      }
+      return typeValues.contains(variantType);
+    };
+    List<ExperienceFragmentVariation> variations = new ArrayList<>();
+    for (Iterator<Page> it = getPage().listChildren(typeFilter); it.hasNext();) {
+      Page page = it.next();
+      variations.add(page.adaptTo(ExperienceFragmentVariation.class));
+    }
+    return variations;
+  }
+
+}
diff --git a/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentAdapterFactory.java b/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentAdapterFactory.java
@@ -0,0 +1,62 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2019 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.testing.mock.aem.xf;
+
+import org.apache.sling.api.adapter.AdapterFactory;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.osgi.annotation.versioning.ProviderType;
+import org.osgi.service.component.annotations.Component;
+
+import com.adobe.cq.xf.ExperienceFragment;
+import com.adobe.cq.xf.ExperienceFragmentVariation;
+import com.adobe.cq.xf.ExperienceFragmentsConstants;
+import com.day.cq.wcm.api.Page;
+
+/**
+ * Mock adapter factory for AEM Experience Fragment-related adaptions.
+ */
+@Component(service = AdapterFactory.class,
+    property = {
+        AdapterFactory.ADAPTABLE_CLASSES + "=com.day.cq.wcm.api.Page",
+        AdapterFactory.ADAPTER_CLASSES + "=com.adobe.cq.xf.ExperienceFragment",
+        AdapterFactory.ADAPTER_CLASSES + "=com.adobe.cq.xf.ExperienceFragmentVariation"
+    })
+@ProviderType
+public final class MockExperienceFragmentAdapterFactory implements AdapterFactory {
+
+  @SuppressWarnings("unchecked")
+  @Override
+  public @Nullable <AdapterType> AdapterType getAdapter(@NotNull Object object, @NotNull Class<AdapterType> type) {
+    if (object instanceof Page) {
+      Page page = (Page)object;
+      if (page.getContentResource().isResourceType(ExperienceFragmentsConstants.RT_EXPERIENCE_FRAGMENT_MASTER) && (type == ExperienceFragment.class)) {
+          return (AdapterType)new MockExperienceFragment(page);
+
+      }
+      if (page.getContentResource().isResourceType(ExperienceFragmentsConstants.RT_EXPERIENCE_FRAGMENT_PAGE) && (type == ExperienceFragmentVariation.class)) {
+          return (AdapterType)new MockExperienceFragmentVariation(page);
+
+      }
+    }
+    return null;
+  }
+
+}
diff --git a/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentBase.java b/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentBase.java
@@ -0,0 +1,75 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2019 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.testing.mock.aem.xf;
+
+import java.util.Arrays;
+import java.util.List;
+
+import org.apache.sling.api.adapter.SlingAdaptable;
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import com.day.cq.commons.inherit.HierarchyNodeInheritanceValueMap;
+import com.day.cq.commons.inherit.InheritanceValueMap;
+import com.day.cq.wcm.api.Page;
+
+class MockExperienceFragmentBase extends SlingAdaptable {
+
+  private final Page page;
+
+  protected MockExperienceFragmentBase(Page page) {
+    this.page = page;
+  }
+
+  public String getPath() {
+    return page.getPath();
+  }
+
+  public ValueMap getProperties() {
+    return page.getProperties();
+  }
+
+  public List<String> getCloudserviceConfigurationsPaths() {
+    return Arrays.asList(getInheritedProperties().getInherited("cq:cloudserviceconfigs", new String[0]));
+  }
+
+  protected InheritanceValueMap getInheritedProperties() {
+    return new HierarchyNodeInheritanceValueMap(page.getContentResource());
+  }
+
+  @Override
+  @SuppressWarnings({ "unchecked", "null" })
+  public @Nullable <AdapterType> AdapterType adaptTo(@NotNull Class<AdapterType> type) {
+    if (type == Resource.class) {
+      return (AdapterType)page.adaptTo(Resource.class);
+    }
+    if (type == Page.class) {
+      return (AdapterType)page;
+    }
+    return super.adaptTo(type);
+  }
+
+  protected Page getPage() {
+    return page;
+  }
+
+}
diff --git a/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentVariation.java b/core/src/main/java/io/wcm/testing/mock/aem/xf/MockExperienceFragmentVariation.java
@@ -0,0 +1,74 @@
+/*
+ * #%L
+ * wcm.io
+ * %%
+ * Copyright (C) 2019 wcm.io
+ * %%
+ * Licensed 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.
+ * #L%
+ */
+package io.wcm.testing.mock.aem.xf;
+
+import static com.adobe.cq.xf.ExperienceFragmentsConstants.CUSTOM_XF_VARIANT_TYPE;
+import static com.adobe.cq.xf.ExperienceFragmentsConstants.PN_XF_VARIANT_TYPE;
+
+import org.apache.sling.api.resource.ValueMap;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import com.adobe.cq.xf.ExperienceFragment;
+import com.adobe.cq.xf.ExperienceFragmentVariation;
+import com.day.cq.commons.inherit.InheritanceValueMap;
+import com.day.cq.wcm.api.Page;
+
+/**
+ * Mock implementation of {@link ExperienceFragmentVariation}.
+ */
+class MockExperienceFragmentVariation extends MockExperienceFragmentBase implements ExperienceFragmentVariation {
+
+  private ExperienceFragment parent;
+
+  MockExperienceFragmentVariation(Page page) {
+    super(page);
+  }
+
+  @Override
+  public ExperienceFragment getParent() {
+    if (this.parent == null) {
+      this.parent = new MockExperienceFragment(getPage().getParent());
+    }
+    return this.parent;
+  }
+
+  @Override
+  public String getType() {
+    ValueMap properties = getPage().getProperties();
+    String type = properties.get(PN_XF_VARIANT_TYPE, String.class);
+    return (type != null) ? type : CUSTOM_XF_VARIANT_TYPE;
+  }
+
+  @Override
+  @SuppressWarnings("unchecked")
+  public @Nullable <AdapterType> AdapterType adaptTo(@NotNull Class<AdapterType> type) {
+    if (type == Page.class) {
+      return (AdapterType)getPage();
+    }
+    return super.adaptTo(type);
+  }
+
+  @Override
+  public InheritanceValueMap getPropertiesTree() {
+    return getInheritedProperties();
+  }
+
+}