MSFT-AEM-Project/ui.tests

UI Testing module (Cypress) for your AEM application

Sample structure for Cypress UI test module which conforms to AEM Cloud Manager quality gate UI test conventions.

AEM provides an integrated suite of Cloud Manager quality gates to ensure smooth updates to custom applications, UI tests are executed as part of a specific quality gate for each Cloud Manager pipeline with a dedicated Custom UI Testing step.

The Cloud Manager UI test module convention defines the expected structure of the test module as well as the environment variables which will be passed at runtime. This is explained in detail in the Building UI Tests section of the documentation.

• /test-module The test project (add your tests there)

Do not modify following files

• Dockerfile commands to assemble the image
• pom.xml defines project dependencies and build configuration which will be used by Cloud Manager to build the test module image
• assembly-ui-test-docker-context.xml Packages test project for AEMaaCS

Sample dockerfile is based on the cypress/included image, which provides all the dependencies and the binaries to run cypress tests.

When running several Cypress instances in parallel, the spawning of multiple X11 servers at once can cause problems for some of them. In this case, you can separately start a single X11 server and pass the server's address to each Cypress instance using DISPLAY variable.

The setup described in the documentation is implemented in run.sh as is used as entrypoint to the container.

Refer to test-module/README.md.

The image built from the Dockerfile can be used to execute tests locally against an AEM environment. The ui-tests-docker-execution maven profile will start the docker-compose setup starting Cypress and the test module, executing the tests against the AEM instance defined via environment variables. The test results will be stored in the ./target/reports directory.

The following environment variables (AEM UI test convention) can be passed

envvar	default
AEM_AUTHOR_URL	http://localhost:4502
AEM_AUTHOR_USERNAME	admin
AEM_AUTHOR_PASSWORD	admin
AEM_PUBLISH_URL	http://localhost:4503
AEM_PUBLISH_USERNAME	admin
AEM_PUBLISH_PASSWORD	admin
REPORTS_PATH	cypress/results

1. Build the Docker UI test image with below command

   mvn clean package -Pui-tests-docker-build
   

2. Run the test

   mvn verify -Pui-tests-docker-execution -DAEM_AUTHOR_URL=https://author.my-deployment.com -DAEM_AUTHOR_USERNAME=<PASS> -DAEM_AUTHOR_PASSWORD=<PASS>