Pillar AEM project template

This is a project build using the Maven AEM Archetype and updated to include a set of common modules.

Modules

The main parts of the template are:

• common: Java bundle containing common core functionality like OSGi services, listeners or schedulers, as well as component-related Java code such as servlets or request filters.
• common.apps: contains the common /apps (and /etc) parts of the project
• common.content: contains common elements needed inside /conf
• common.config: contains common runmode specific OSGi configs
• core: Java bundle containing all core functionality for the site
• it.tests: Java based integration tests
• ui.apps: contains the /apps (and /etc) parts of the project, ie JS&CSS clientlibs, components, and templates
• ui.content: contains sample content using the components from the ui.apps
• ui.config: contains runmode specific OSGi configs for the project
• ui.frontend: an optional dedicated front-end build mechanism (Angular, React or general Webpack project)
• ui.tests: Cypress based UI tests (for other frameworks check aem-test-samples repository
• all: a single content package that embeds all of the compiled modules (bundles and content packages) including any vendor dependencies
• analyse: this module runs analysis on the project which provides additional validation for deploying into AEMaaCS

How to build

To build all the modules run in the project root directory the following command with Maven 3:

mvn clean install

To build all the modules and deploy the all package to a local instance of AEM, run in the project root directory the following command:

mvn clean install -PautoInstallSinglePackage

Or to deploy it to a publish instance, run

mvn clean install -PautoInstallSinglePackagePublish

Or alternatively

mvn clean install -PautoInstallSinglePackage -Daem.port=4503

Or to deploy only the bundle to the author, run

mvn clean install -PautoInstallBundle

Or to deploy only a single content package, run in the sub-module directory (i.e ui.apps)

mvn clean install -PautoInstallPackage

Local AEM install

Install AEM for author

java -Xmx2048M -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=30303 -jar aem-author-p4502.jar -gui -r"author,local"

Update start script

Update CQ_RUNMODE

 runmode(s)
# will not be used if repository is already present
if [ -z "$CQ_RUNMODE" ]; then
        CQ_RUNMODE='authoa,local'
fi

Update CQ_JVM_OPTS

# default JVM options
if [ -z "$CQ_JVM_OPTS" ]; then
        CQ_JVM_OPTS='-server -Xmx4g -Djava.awt.headless=true -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005'
        # add the required JPMS modules, if needed
        java --add-modules java.se.ee -version >/dev/null 2>&1
        if [ $? -eq 0 ]; then
               CQ_JVM_OPTS="${CQ_JVM_OPTS} --add-modules java.se.ee"
        fi
fi

Install AEM for publisher

java -Xmx2048M -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=30303 -jar aem-publish-p4503.jar -gui -r"publish,local"

Update CQ_PORT

# TCP port used for stop and status scripts
if [ -z "$CQ_PORT" ]; then
        CQ_PORT=4503
fi

Update CQ_RUNMODE

# runmode(s)
# will not be used if repository is already present
if [ -z "$CQ_RUNMODE" ]; then
        CQ_RUNMODE='publish,local'
fi

Update CQ_JVM_OPTS

# default JVM options
if [ -z "$CQ_JVM_OPTS" ]; then
        CQ_JVM_OPTS='-server -Xmx2g -Djava.awt.headless=true'
        # add the required JPMS modules, if needed
        java --add-modules java.se.ee -version >/dev/null 2>&1
        if [ $? -eq 0 ]; then
               CQ_JVM_OPTS="${CQ_JVM_OPTS} --add-modules java.se.ee"
        fi
fi

Documentation

The build process also generates documentation in the form of README.md files in each module directory for easy reference. Depending on the options you select at build time, the content may be customized to your project.

Testing

There are three levels of testing contained in the project:

Unit tests

This show-cases classic unit testing of the code contained in the bundle. To test, execute:

mvn clean test

Integration tests

This allows running integration tests that exercise the capabilities of AEM via HTTP calls to its API. To run the integration tests, run:

mvn clean verify -Plocal

Test classes must be saved in the src/main/java directory (or any of its subdirectories), and must be contained in files matching the pattern *IT.java.

The configuration provides sensible defaults for a typical local installation of AEM. If you want to point the integration tests to different AEM author and publish instances, you can use the following system properties via Maven's -D flag.

Property	Description	Default value
it.author.url	URL of the author instance	http://localhost:4502
it.author.user	Admin user for the author instance	admin
it.author.password	Password of the admin user for the author instance	admin
it.publish.url	URL of the publish instance	http://localhost:4503
it.publish.user	Admin user for the publish instance	admin
it.publish.password	Password of the admin user for the publish instance	admin

The integration tests in this archetype use the AEM Testing Clients and showcase some recommended best practices to be put in use when writing integration tests for AEM.

Static Analysis

The analyse module performs static analysis on the project for deploying into AEMaaCS. It is automatically run when executing

mvn clean install

from the project root directory. Additional information about this analysis and how to further configure it can be found here https://github.com/adobe/aemanalyser-maven-plugin

UI tests

They will test the UI layer of your AEM application using Cypress framework.

Check README file in ui.tests module for more details.

Examples of UI tests in different frameworks can be found here: https://github.com/adobe/aem-test-samples

ClientLibs

The frontend module is made available using an AEM ClientLib. When executing the NPM build script, the app is built and the aem-clientlib-generator package takes the resulting build output and transforms it into such a ClientLib.

A ClientLib will consist of the following files and directories:

• css/: CSS files which can be requested in the HTML
• css.txt (tells AEM the order and names of files in css/ so they can be merged)
• js/: JavaScript files which can be requested in the HTML
• js.txt (tells AEM the order and names of files in js/ so they can be merged
• resources/: Source maps, non-entrypoint code chunks (resulting from code splitting), static assets (e.g. icons), etc.

Maven settings

The project comes with the auto-public repository configured. To setup the repository in your Maven settings, refer to:

http://helpx.adobe.com/experience-manager/kb/SetUpTheAdobeMavenRepository.html