Skip to content

Latest commit

 

History

History
147 lines (95 loc) · 6.93 KB

README.md

File metadata and controls

147 lines (95 loc) · 6.93 KB
Raw

WTT logo

GitHub tag (latest SemVer) GitHub All Releases Check Apache License, Version 2.0, January 2004

AEM Stubs

Tool for providing sample data for AEM applications in a simple and flexible way.

Simply install ready-to-use CRX package on AEM instance and start stubbing!

AEM Stubs Screenshot

AdaptTo 2020 Live Demo - https://adapt.to/2020/en/schedule/lightning-talks/aem-stubs.html

Main concepts of AEM Stubs tool are:

  • Simplicity
    • Creating stubs should be as much simple as it is possible,
  • Reactivity
    • Trivial tool deployment - installable on AEM via all-in-one CRX package in the time when stubs are actually needed,
    • Trivial stubs deployment - reloading stubs tied to regular AEM application deployment.

Installation

The ready-to-install AEM packages are available on GitHub releases.

There are two ways to install AEM Stubs on your AEM instances:

  1. Using the 'all' package:
    • Recommended for fresh AEM instances.
    • This package will also install AEM Groovy Console and AEM Stubs examples.
  2. Using the 'minimal' package:
    • Recommended for AEM instances that already contain some dependencies shared with other tools.
    • This package does not include Groovy bundles, which can be provided by other tools like AEM Easy Content Upgrade (AECU) or AEM Groovy Console.

Post installation steps

Remember that using AEM Stubs on AEM Publish instances through AEM Dispatcher may require an additional configuration.

Simply ensure that AEM Stubs Filter prefix /stubs (configured in AEM Stubs HTTP Filter is not filtered by AEM Dispatcher configuration. Alternatively, by creating OSGi configuration, update that path prefix (or regex pattern) to the something which is already accessible.

Compatibility

AEM Stubs AEM Java Groovy
1.0.0, 1.0.1 6.4, 6.5 8 2.x
>= 1.0.2 6.3, 6.4, 6.5 8 2.x
2.0.0 6.3, 6.4, 6.5 11 2.x
2.0.1 6.3, 6.4, 6.5 8, 11 2.x
3.0.0 6.3, 6.4, 6.5 8, 11 4.x
4.0.0 6.5, cloud 11 4.x

Note that AEM Stubs is using Groovy scripts concept. However it is not using AEM Groovy Console. It is done intentionally, because Groovy Console has close dependencies to concrete AEM version. AEM Stubs tool is implemented in a AEM version agnostic way, to make it more universal and more fault-tolerant when AEM version is changing. It is compatible with AEM Groovy Console - simply install one of AEM Stubs distributions without Groovy console OSGi bundle included as it is usually provided by Groovy Console AEM package.

From AEM Stubs 3.x onwards, Groovy has been upgraded to version 4.x. Groovy has stopped providing a groovy-all 'uber' bundle. In this package, only the groovy 'core' bundle is included. It is possible to add extra Groovy modules in your own project. A list of groovy subprojects can be found here at the Groovy GitHub Project

Documentation

Basics

Stubs could be provided by:

  • Groovy Scripts (*.stub.groovy) so called stub scripts e.g file named my-feature.stub.groovy.

For example, when decided to choose WireMock framework, then these files should be put into AEM under path /conf/stubs/wiremock/* via CRX package with corresponding Vault workspace filter:

<?xml version="1.0" encoding="UTF-8"?>
<workspaceFilter version="1.0">
    <filter root="/apps/mysite"/>
    <filter root="/conf/stubs/mysite"/>
</workspaceFilter>

OSGi configuration

AEM Stubs HTTP Filter AEM Stubs Repository

Stub script API

Pre-defined variables:

  • resourceResolver - for accessing AEM repository,
  • log - SLF4j logger connected to script being run.
  • template - Template engine-based rendering
  • repository - Easy access to AEM repository
  • faker - Data Faker library for generating random data

Other tools

There are no other dedicated tools for stubbing data available for AEM and it was main purpose to create AEM Stubs tool.

Authors

Contributing

Issues reported or pull requests created will be very appreciated.

  1. Fork plugin source code using a dedicated GitHub button.
  2. Do code changes on a feature branch created from main branch.
  3. Create a pull request with a base of main branch.

Building

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

License

AEM Stubs is licensed under the Apache License, Version 2.0 (the "License")