maven-plugin

Maven Plugin

The plugin's generator goal runs within Maven's default lifecycle in phase generate-test-sources (run mvn generate-test-sources to see the generator's log). It generates the test code under target/bpmndt and adds this directory as test source directory, which is automatically compiled during the test-compile phase. The compilation results (test cases and API classes) will be available in the test classpath afterwards.

⚠️ Within IntelliJ IDEA, add the additional test source directory manually. Right click on target/bpmndt > Mark Directory as > Test Sources Root

Usage

<plugin>
  <groupId>org.camunda.community</groupId>
  <artifactId>bpmn-driven-testing-maven-plugin</artifactId>
  <version>1.3.0</version>
  <executions>
    <execution>
      <goals>
        <goal>generator</goal>
      </goals>
    </execution>
  </executions>
</plugin>

Please see Maven Central to get a specific version.

Configuration

Available parameters for the plugin's generator goal:

Parameter	Type	Description	Default value
packageName	String	Package name, used for the generated test sources	generated
processEnginePlugins	List	List of process engine plugins to register at the process engine (not required for Spring Boot, since process engine plugins must be exposed as beans)	-
springEnabled	Boolean	Enables Spring based testing (not required for Spring Boot, since here only the BpmndtProcessEnginePlugin must be exposed as a bean)	false

Dependencies

Add dependencies, which are required to execute the generated test code:

<dependency>
  <groupId>org.camunda.bpm</groupId>
  <artifactId>camunda-engine</artifactId>
</dependency>

<!-- Test -->
<dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter-api</artifactId>
  <version>${junit.jupiter.version}</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <version>${h2.version}</version>
  <scope>test</scope>
</dependency>

<dependency>
  <groupId>org.camunda.bpm.assert</groupId>
  <artifactId>camunda-bpm-assert</artifactId>
  <version>${camunda.bpm.assert.version}</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.assertj</groupId>
  <artifactId>assertj-core</artifactId>
  <version>${assertj.version}</version>
  <scope>test</scope>
</dependency>

For Spring based testing, additional dependencies are required:

<dependency>
  <groupId>org.camunda.bpm</groupId>
  <artifactId>camunda-engine-spring</artifactId>
</dependency>

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-beans</artifactId>
  <version>${spring.version}</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-jdbc</artifactId>
  <version>${spring.version}</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context</artifactId>
  <version>${spring.version}</version>
</dependency>

<!-- Test -->
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-test</artifactId>
  <version>${spring.version}</version>
  <scope>test</scope>
</dependency>

For Spring Boot based testing, additional dependencies are required:

<dependency>
  <groupId>org.camunda.bpm.springboot</groupId>
  <artifactId>camunda-bpm-spring-boot-starter</artifactId>
</dependency>

<!-- Test -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
</dependency>

Recommended versions:

Dependency	Version
Camunda BPM	7.24.0
Camunda BPM Assert	15.0.0
JUnit 5 (Jupiter)	5.11.4
Assertj	3.27.3
Spring Framework	6.2.12
Spring Boot	3.5.7

Testing

⚠️ This section is only important for Maven plugin development!

Beside unit tests, a set of integration tests exist, which verify that the Maven plugin works correctly when executed within a Maven build. The integration tests are implemented using the Robot Framework (Java implementation).

To execute unit and integration tests, run:

mvn clean install -pl maven-plugin -am

The Robot test report is written to target/robot/report.html.