Remove test duplication #255
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
remcowesterhoud
force-pushed
the
195_test_duplication
branch
2 times, most recently
from
6fc196f to
dad372a
Compare
Abstract test classes should contain all the test implementations. The other classes that extend this only need to provide the extension. This way we don't have to duplicate all of our test implementations. One thing to note is that injection of the ZeebeClient, ZeebeTestEngine and RecordStream. These fields get injected in what jUnit defines as the test class: final Class<?> requiredTestClass = extensionContext.getRequiredTestClass(); We are dealing with 2 different scenarios. We have the assertion tests. Here the abstract classes contain 2 nested classes, HappyPathTests and UnhappyPathTests. In this scenario the nested class is the test class. These fields get injected just fine. In other tests we do not have any nested classes. Here the class that extends the abstract class will be the test class (e.g. the WorkterTest class). For these classes the fields must be declared on the extending class. We can access these in the abstract class by adding abstract getters.
All unit tests will now extends from an abstract class. This class provides the test implementation. The extending class only needs to have the relevant annotation and in some cases needs to define ZeebeClient, ZeebeTestEngine and RecordStream fields.
The java version in the root pom was 11. This is not accurate as by default we use java 17, unless otherwise specified.
Adds a unit test which will make sure that all the abstract test classes are implemented in the regular and in the testcontainer package, as well as annotated with the correct extension.
In our documentation we talk about the embedded engine. It makes sense to name our packages in a similar way.
Automatically adding the copyright headers included a new line. The maven license plugin does not want this new line, so I have removed this from the configuration.
remcowesterhoud
force-pushed
the
195_test_duplication
branch
from
dad372a to
6287137
Compare
pihme
approved these changes
Mar 14, 2022
qa/src/test/java/io/camunda/zeebe/process/test/qa/ExtendAbstractsTest.java
Outdated
Show resolved
Hide resolved
|
@pihme I've changed the test to use |
remcowesterhoud
force-pushed
the
195_test_duplication
branch
from
199e1ba to
26ce3f7
Compare
|
|
pihme
approved these changes
Mar 15, 2022
qa/src/test/java/io/camunda/zeebe/process/test/qa/ExtendAbstractsTest.java
Outdated
Show resolved
Hide resolved
qa/src/test/java/io/camunda/zeebe/process/test/qa/ExtendAbstractsTest.java
Show resolved
Hide resolved
qa/src/test/java/io/camunda/zeebe/process/test/qa/ExtendAbstractsTest.java
Outdated
Show resolved
Hide resolved
Replace custom implementation with classgraph. This solution is easier to understand.
remcowesterhoud
force-pushed
the
195_test_duplication
branch
from
26ce3f7 to
632b64e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces abstract test classes. Abstract test classes should contain all the test implementations. The other classes that extend this only need to provide the extension. This way we don't have to duplicate all of our test implementations.
One thing to note is that injection of the
ZeebeClient,ZeebeTestEngineandRecordStream. These fields get injected in what jUnit defines as the test class:final Class<?> requiredTestClass = extensionContext.getRequiredTestClass();We are dealing with 2 different scenarios:
HappyPathTestsandUnhappyPathTests. In this scenario the nested class is the test class. These fields get injected just fine.WorkterTestclass). For these classes the fields must be declared on the extending class. We can access these in the abstract class by adding abstract getters.Related issues
closes #195
Definition of Done
Not all items need to be done depending on the issue and the pull request.
Code changes:
Testing:
Documentation: