-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ADR von JUnit vs. AssertJ (#6335)
- Loading branch information
Showing
2 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# Use Plain JUnit5 for advanced test assertions | ||
|
||
## Context and Problem Statement | ||
|
||
How to write readable test assertions? | ||
How to write readable test assertions for advanced tests? | ||
|
||
## Considered Options | ||
|
||
* Plain JUnit5 | ||
* Hamcrest | ||
* AssertJ | ||
|
||
## Decision Outcome | ||
|
||
Chosen option: "Plain JUnit5", because comes out best \(see below\). | ||
|
||
### Positive Consequences | ||
|
||
* Tests are more readable | ||
* More easy to write tests | ||
* More readable assertions | ||
|
||
### Negative Consequences | ||
|
||
* More complicated testing leads to more complicated assertions | ||
|
||
## Pros and Cons of the Options | ||
|
||
### Plain JUnit5 | ||
|
||
Homepage: <https://junit.org/junit5/docs/current/user-guide/> | ||
JabRef testing guidelines: <https://devdocs.jabref.org/getting-into-the-code/code-howtos#test-cases> | ||
|
||
Example: | ||
|
||
```java | ||
String actual = markdownFormatter.format(source); | ||
assertTrue(actual.contains("Markup<br />")); | ||
assertTrue(actual.contains("<li>list item one</li>")); | ||
assertTrue(actual.contains("<li>list item 2</li>")); | ||
assertTrue(actual.contains("> rest")); | ||
assertFalse(actual.contains("\n")); | ||
``` | ||
|
||
* Good, because Junit5 is "common Java knowledge" | ||
* Bad, because complex assertions tend to get hard to read | ||
* Bad, because no fluent API | ||
|
||
### Hamcrest | ||
|
||
Homepage: <http://hamcrest.org/JavaHamcrest/> | ||
|
||
* Good, because offers advanced matchers (such as `contains`) | ||
* Bad, because not full fluent API | ||
* Bad, because entry barrier is increased | ||
|
||
### AssertJ | ||
|
||
Homepage: <https://joel-costigliola.github.io/assertj/> | ||
|
||
Example: | ||
|
||
```java | ||
assertThat(markdownFormatter.format(source)) | ||
.contains("Markup<br />") | ||
.contains("<li>list item one</li>") | ||
.contains("<li>list item 2</li>") | ||
.contains("> rest") | ||
.doesNotContain("\n"); | ||
``` | ||
|
||
* Good, because offers fluent assertions | ||
* Good, because allows partial string testing to focus on important parts | ||
* Good, because assertions are more readable | ||
* Bad, because not commonly used | ||
* Bad, because newcomers have to learn an additional language to express test cases | ||
* Bad, because entry barrier is increased | ||
* Bad, because expressions of test cases vary from unit test to unit test | ||
|
||
## Links | ||
|
||
* German comparison between Hamcrest and AssertJ: <https://www.sigs-datacom.de/uploads/tx_dmjournals/philipp_JS_06_15_gRfN.pdf> |
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