Dedicated example

README.md

@@ -250,7 +250,7 @@ Because of this we should wait for a busy state after increasing the engine time
 
 ## Examples
 
-For example tests the best place to look right now is the tests in the QA module.
+[Examples](examples/README.md)
 
 ## Engine lifecycle
 

examples/README.md

@@ -0,0 +1,34 @@
+# Examples
+
+This module contains examples on how to use the assertions to test processes.
+
+## Example: _Pull Request Process_
+
+This example demonstrates how to ...
+* Annotate a unit tests
+* Deploy processes to the test engine
+* Control process execution
+* Protect tests from flakiness caused by asynchronous processing in the engine
+* Manipulate the time of the engine to trigger timer events
+* Assert that deployment was successful
+* Assert a certain path was taken / not taken
+* Assert state of process instance variables
+* Navigate from the main process to spawned child process
+
+**Processes**
+
+The example is based on the following process:
+![Pull Request Created Process](assets/pr-created.png)
+
+[Source](src/test/resources/pr-created.bpmn)
+
+Which calls a subprocess _Automated tests_:
+
+![Automated Tests Process](assets/automated-tests.png)
+
+[Source](src/test/resources/automated-tests.bpmn)
+
+**Tests**
+
+[Source](src/test/java/io/camunda/zeebe/process/test/examples/PullRequestProcessTest.java)
+

examples/pom.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright © 2021 camunda services GmbH (info@camunda.com)
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>io.camunda</groupId>
+    <artifactId>zeebe-process-test-root</artifactId>
+    <version>8.1.0-alpha3-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>zeebe-process-test-examples</artifactId>
+
+  <name>Zeebe Process Test Examples</name>
+
+  <properties>
+    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.target>17</maven.compiler.target>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-process-test-assertions</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-process-test-extension</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-client-java</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-process-test-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-dependency-plugin</artifactId>
+        <configuration>
+          <failOnWarning>true</failOnWarning>
+          <ignoredUnusedDeclaredDependencies>
+            <!-- used in tests to provide an slf4j implementation-->
+            <ignoredUnusedDeclaredDependency>org.slf4j:slf4j-simple</ignoredUnusedDeclaredDependency>
+          </ignoredUnusedDeclaredDependencies>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>