Sling Single-Project Example

Description

This project could be used to start developing application/library based on Sling Framework.

Documentation for Sling plugin is available in project Gradle Sling Plugin.

Table of Contents

• Quickstart
• Environment
• Building
• Tips & tricks
• Running tests
• Attaching debugger
• Extending build

Quickstart

ℹ️ Shorthand for running Sling without forking: git clone git@github.com:wttech/gradle-sling-single.git && cd gradle-sling-single && sh gradlew props -Pfork.verbose && sh gradlew setup

1. Fork project using command:

   git clone https://github.com/wttech/gradle-sling-single.git && cd gradle-sling-single && sh gradlew fork

   and specify properties:

   

   and wait until project is forked then enter configured target directory.

2. Setup user specific project configuration using command:

   sh gradlew props

   and specify properties:

   

3. Setup local Sling instance(s) and dependencies then build application using command:

   sh gradlew setup

   and wait till complete Sling environment will be ready to use.

4. Develop continuously application using command:

   sh gradlew

Environment

Tested on:

• Java 1.8
• Gradle 6.3
• Sling Starter 11

Building

1. Use command gradlew so that Gradle in version according to project will be downloaded automatically.
2. Deploy application: sh gradlew <=> sh gradlew :packageDeploy

Tooling

1. Monitoring errors in logs: sh gradlew :instanceTail,
2. Synchronizing JCR content from AEM to local file system: sh gradlew :sync,
3. Copying JCR content between AEM instances: sh gradlew :rcp -Prcp.source=http://user:pass@x.x.x.x:8080 -Prcp.target=master -Prcp.paths=[/content/example]

Tips & tricks

• According to recommendations, Gradle daemon should be:
  • enabled on development environments,
  • disabled on continuous integration environments.
• To see more descriptive errors or want to skip some tasks, see command line documentation.

Running tests

IntelliJ

Certain unit tests may depend on the results of running gradle tasks. One such example is the testing of OSGi Services using OSGi Mocks where in order to run a test, the SCR metadata must be available for a class. Running a test like this in IntelliJ results in errors because the IDE is not aware of the Bundle plugin.

This can be worked around by configuring IntelliJ to delegate test execution to Gradle. In order to set this up, go to Settings > Build, Execution, Deployment > Gradle > Runner and set your IDE to delegate IDE build/run actions to Gradle. Alternatively, you can use a dropdown menu to use a specific runner or to decide on a test-by-test basis.

Attaching debugger

1. Execute build with options -Dorg.gradle.debug=true --no-daemon, it will suspend,
2. Attach debugger on port 5005,
3. Suspension will be released and build should stop at breakpoint.

Extending build

For defining new tasks directly in build see:

• Build Script Basics
• More about Tasks

The easiest way to implement custom plugins and use them in project is a technique related with buildSrc/ directory. For more details please read documentation.