UI tests

.github/dependabot.yml

@@ -1,11 +1,19 @@
 version: 2
 updates:
   - package-ecosystem: "maven"
-    directory: "/" # Location of package manifests
+    directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     ignore:
       - dependency-name: "io.wcm.maven:io.wcm.maven.aem-dependencies"
         versions: [ "[6.5.17,)" ]
       - dependency-name: "biz.aQute.bnd:bnd-maven-plugin"
         update-types: [ "version-update:semver-major" ]
+  - package-ecosystem: "npm"
+    directory: "/ui.tests"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -3,7 +3,46 @@ name: Build
 on: [ push, pull_request ]
 
 jobs:
-  call-workflow:
+  aem-maven-build:
+    name: Call workflow
     uses: orbinson/workflows/.github/workflows/aem-maven-build.yml@main
     with:
-      java-version: 11
+      java-version: 11
+
+  ui-tests:
+    name: Run UI tests
+    runs-on: ubuntu-latest
+    needs: aem-maven-build
+    services:
+      aem-author:
+        image: ghcr.io/orbinson/aem-sdk:author-2024.10.18459.20241031T210302Z-241000
+        ports:
+          - 4502:4502
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 11
+          cache: maven
+      - name: Get Playwright version from package-lock.json
+        run: echo "PLAYWRIGHT_VERSION=$(jq -r '.packages["node_modules/playwright-core"].version' ui.tests/package-lock.json)" >> $GITHUB_ENV
+      - name: Cache Playwright binaries
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/ms-playwright
+          key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
+      - name: Install all package
+        run: mvn install -B -U -PautoInstallSinglePackage
+      - name: Install it.content package
+        run: mvn install -B -U -PautoInstallPackage -pl it.content
+      - name: Run ui.tests
+        run: mvn test -B -pl ui.tests -DskipTests=false
+      - name: Upload Playwright Report
+        uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: ui.tests/playwright-report

.run/[author] aemsync it.content.run.xml

@@ -0,0 +1,34 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="[author] aemsync it.content" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="cmdOptions" />
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+            </list>
+          </option>
+          <option name="multimoduleDir" />
+          <option name="pomFileName" value="pom.xml" />
+          <option name="profilesMap">
+            <map>
+              <entry key="aemsync" value="true" />
+            </map>
+          </option>
+          <option name="projectsCmdOptionValues">
+            <list />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$/it.content" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>

.run/[author] aemsync ui.apps.run.xml

@@ -0,0 +1,34 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="[author] aemsync ui.apps" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="cmdOptions" />
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="verify" />
+            </list>
+          </option>
+          <option name="multimoduleDir" />
+          <option name="pomFileName" value="pom.xml" />
+          <option name="profilesMap">
+            <map>
+              <entry key="aemsync" value="true" />
+            </map>
+          </option>
+          <option name="projectsCmdOptionValues">
+            <list />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$/ui.apps" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>

.run/[author] install it.content.run.xml

@@ -0,0 +1,35 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="[author] install it.content" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="cmdOptions" />
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="clean" />
+              <option value="install" />
+            </list>
+          </option>
+          <option name="multimoduleDir" />
+          <option name="pomFileName" value="pom.xml" />
+          <option name="profilesMap">
+            <map>
+              <entry key="autoInstallPackage" value="true" />
+            </map>
+          </option>
+          <option name="projectsCmdOptionValues">
+            <list />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$/it.content" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>

.run/[author] run ui.tests.run.xml

@@ -0,0 +1,34 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="[author] run ui.tests" type="MavenRunConfiguration" factoryName="Maven">
+    <MavenSettings>
+      <option name="myGeneralSettings" />
+      <option name="myRunnerSettings" />
+      <option name="myRunnerParameters">
+        <MavenRunnerParameters>
+          <option name="cmdOptions" />
+          <option name="profiles">
+            <set />
+          </option>
+          <option name="goals">
+            <list>
+              <option value="clean" />
+              <option value="test" />
+              <option value="-DskipTests=false" />
+            </list>
+          </option>
+          <option name="multimoduleDir" />
+          <option name="pomFileName" value="pom.xml" />
+          <option name="profilesMap">
+            <map />
+          </option>
+          <option name="projectsCmdOptionValues">
+            <list />
+          </option>
+          <option name="resolveToWorkspace" value="false" />
+          <option name="workingDirPath" value="$PROJECT_DIR$/ui.tests" />
+        </MavenRunnerParameters>
+      </option>
+    </MavenSettings>
+    <method v="2" />
+  </configuration>
+</component>

README.md

@@ -18,14 +18,14 @@ The [AEM Dictionary Translator](http://localhost:4502/tools/translation/dictiona
 
 ## Installation
 
-### System requirements
+### Compatibility matrix
 
-The minimal required AEM versions are:
+The minimal required AEM and AEM Dictionary Translator versions are:
 
-| type    | version                       |
-|---------|-------------------------------|
-| AEM 6.5 | 6.5.17                        |
-| AEMaaCS | 2023.1.10912.20230130T173736Z |
+| AEM Type | AEM version                     | AEM Dictionary Translator |
+|----------|---------------------------------|----------------------|
+| AEM 6.5  | `6.5.17`                        | `1.3.0`              |
+| AEMaaCS  | `2023.1.10912.20230130T173736Z` | `1.0.0`              |
 
 The minimal required Java version is `11`.
 
@@ -61,7 +61,7 @@ To deploy the AEM Dictionary Translator as an embedded package you need to updat
 To mitigate this, update the `org.apache.sling.i18n.impl.JcrResourceBundleProvider` OSGi config to allow dictionaries in
 other folders, for example by using `/content/dictionaries` for all your editable dictionaries.
 
-Example `org.apache.sling.i18n.impl.JcrResourceBundleProvider` OSGi config:
+Example `org.apache.sling.i18n.impl.JcrResourceBundleProvider` OSGi config
 
 ```json
 {
@@ -95,3 +95,17 @@ mvn clean install -PautoInstallSinglePackage
 
 This project follows the [AEM Archetype](https://github.com/adobe/aem-project-archetype) conventions so for further
 guidelines consult the available documentation.
+
+### UI Tests
+
+First install the `it.content` module to your local AEM instance
+
+```shell
+mvn clean install -pl it.content -PautoInstallPackage
+```
+
+Afterward run the UI tests with the following command
+
+```shell
+mvn clean test -pl ui.tests -DskipTests=false
+```

core/src/test/java/be/orbinson/aem/dictionarytranslator/models/impl/DictionaryImplTest.java

@@ -8,12 +8,9 @@
 import junit.framework.Assert;
 import org.apache.commons.lang3.time.DateUtils;
 import org.apache.sling.api.resource.Resource;
-import org.apache.sling.api.resource.ResourceResolver;
-import org.apache.sling.models.factory.ModelFactory;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
-import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.mockito.junit.jupiter.MockitoSettings;
 import org.mockito.quality.Strictness;

it.content/pom.xml

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>be.orbinson.aem</groupId>
+        <artifactId>aem-dictionary-translator</artifactId>
+        <version>1.3.0-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>aem-dictionary-translator.it.content</artifactId>
+    <packaging>content-package</packaging>
+    <name>IT Content</name>
+    <description>IT Content package for the Dictionary Translator</description>
+
+    <profiles>
+        <profile>
+            <id>autoInstallPackage</id>
+
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>io.wcm.maven.plugins</groupId>
+                        <artifactId>wcmio-content-package-maven-plugin</artifactId>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
+    <build>
+        <sourceDirectory>src/main/content/jcr_root</sourceDirectory>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.jackrabbit</groupId>
+                <artifactId>filevault-package-maven-plugin</artifactId>
+                <configuration>
+                    <properties>
+                        <cloudManagerTarget>none</cloudManagerTarget>
+                    </properties>
+                    <packageType>mixed</packageType>
+                    <showImportPackageReport>false</showImportPackageReport>
+                    <repositoryStructurePackages>
+                        <repositoryStructurePackage>
+                            <groupId>be.orbinson.aem</groupId>
+                            <artifactId>aem-dictionary-translator.ui.apps.structure</artifactId>
+                        </repositoryStructurePackage>
+                    </repositoryStructurePackages>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>be.orbinson.aem</groupId>
+            <artifactId>aem-dictionary-translator.ui.apps.structure</artifactId>
+            <version>${project.version}</version>
+            <type>zip</type>
+        </dependency>
+    </dependencies>
+</project>

it.content/src/main/content/META-INF/vault/filter.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<workspaceFilter version="1.0">
+    <filter root="/apps/aem-dictionary-translator/osgiconfig/config/org.apache.sling.jcr.repoinit.RepositoryInitializer~dictionary-translator-it-content.config"/>
+    <filter root="/apps/wcm/core/resources/languages"/>
+    <filter root="/content/dictionaries"/>
+    <filter root="/etc/replication/agents.author/publish"/>
+    <filter root="/etc/replication/agents.author/preview"/>
+</workspaceFilter>

it.content/src/main/content/jcr_root/apps/aem-dictionary-translator/osgiconfig/config/org.apache.sling.jcr.repoinit.RepositoryInitializer~dictionary-translator-it-content.config

@@ -0,0 +1,13 @@
+scripts=["
+    create group dictionary-user
+    add dictionary-user to group contributor
+
+    create user test-user-dictionary-user with password test-password-dictionary-user
+    add test-user-dictionary-user to group dictionary-user
+
+    set ACL for dictionary-user
+        allow jcr:read,jcr:nodeTypeManagement,jcr:write,crx:replicate on /content/dictionaries
+        allow jcr:read on /libs/cq/i18n/translator
+        allow jcr:read on /libs/cq/i18n/gui/translator
+    end
+"]

it.content/src/main/content/jcr_root/apps/wcm/core/resources/.content.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
+          xmlns:jcr="http://www.jcp.org/jcr/1.0"
+          jcr:primaryType="sling:Folder"/>