java-test-code-conventions.md

Favor adding @DisplayName to each test case #5525

Favor hamcrest assertThat for new tests #5526

Use hamcrest matchers and assertThat syntax.

• Keep existing tests consistent
• New tests should use 'hamcrest'

Example

Instead of:

assertEquals(6, mfb.getAttackingUnits().size());

Use:

assertThat(mfb.getAttackingUnits(), hasSize(6);

Testing, favor using helper functions for "given, when, then" like structures to tests #5489

IE: we want to try and have tests that are as much as possible like:

void test() {
  givenConditionsReturningValue("value");
  String result = someObject.doSomething();
  assertThat(result, is("value"));
}

Use 'assertThat' string parameter to describe why we assert a condition #5527

Unless completely and absolutely trivial, favor the majority of the time to use the string parameter of 'assertThat' methods to describe why we expect an asserted condition to be true.

Example, instead of:

assertThat(collection, hasSize(2));

Prefer:

assertThat("3 units added, one unit filtered, we expect to have 2", collection, hasSize(2));