Overview

The Gradle integration prepares the code and runtime that Anvil runs. It resolves dependencies and registered artifacts, compiles scenario sources, and supplies tasks for automated tests and foreground environments. It also declares the runtime used by IDE integrations.

Choose the JUnit entry point when Gradle should run automated journeys. Inside that task's JVM, JUnit owns scenario selection, context injection, test execution, and cleanup. The foreground scenarios entry point can run without JUnit.

Configure and run the build

1. Plugins and dependencies: choose the entry point and install the runtime components.
2. Gradle DSL: configure shared settings and register your plugin artifacts.
3. Running tests: execute JUnit journeys and inspect Gradle reports.
4. Tasks and options: look up compilation, foreground, and preparation commands.
5. IDE project tooling: expose scenario definitions from the standard or an existing source set.

For a complete first project, follow Installation. For a manual environment, proceed from build configuration to the foreground runner.

Source-set conventions

The plugins create an anvil source set. Java sources belong in src/anvil/java, and resources belong in src/anvil/resources. Production code remains in src/main; ordinary tests remain in src/test. These paths are conventions of the consumer plugins, not requirements of Anvil's JUnit API. Project tooling also indexes scenario definitions compiled from the test source set.

The Anvil source set sees the main project's output and test dependencies. The foreground and tooling tasks also include compiled classes and resources from src/test, so a consumer can keep scenario definitions in its existing test source set. Use src/anvil when scenarios should remain separate from ordinary tests or when the JUnit integration needs its dedicated source set.