fix flaky test br.com.helpdev.quaklog.entity.GameTest#shouldBuildGameWithSuccess

[hofi1]

Problem

The test test br.com.helpdev.quaklog.entity.GameTest#shouldBuildGameWithSuccess asserts the players which are stored in the game. These are stored in a List. The list is generated by the builder using a map. But the order, in which the players are returned by the map, is not deterministic, but the test expects the values to be in certain order.
This leads to a flaky test.

br.com.helpdev.quaklog.entity.GameTest > shouldBuildGameWithSuccess() FAILED
    org.opentest4j.AssertionFailedError: expected: <Mock for PlayerInGame, hashCode: 461659368> but was: <Mock for PlayerInGame, hashCode: 1532150109>
        at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:56)
        at org.junit.jupiter.api.AssertEquals.failNotEqual(AssertEquals.java:197)
        at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:186)
        at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:181)
        at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:500)
        at br.com.helpdev.quaklog.entity.GameTest.shouldBuildGameWithSuccess(GameTest.java:39)

quaklog-api/core/src/test/java/br/com/helpdev/quaklog/entity/GameTest.java

Lines 38 to 39 in f651f2a

	final var game = gameBuilder.build();
	assertEquals(playerInGame, game.getPlayers().get(0));

quaklog-api/core/src/main/java/br/com/helpdev/quaklog/entity/Game.java

Line 27 in f651f2a

this.players = List.copyOf(builder.players.values());

This problem was found by the NonDex Engine.

Solution

Sort the stream of players in the map by their ID, to make sure, they are returned in predefined order.

quaklog-api/core/src/main/java/br/com/helpdev/quaklog/entity/Game.java

Lines 29 to 30 in b76c148

	this.players = List.copyOf(builder.players.values().stream().sorted(
	Comparator.comparing(PlayerInGame::getId)).collect(Collectors.toList()));

Reproduce

To reproduce, follow the steps:

1. ./gradlew build -x test
2. Add the following text to the top of the build.gradle file in $PROJ_DIR.

buildscript {
    repositories {
      maven {
        url = uri('https://plugins.gradle.org/m2/')
      }
    }
    dependencies {
      classpath('edu.illinois:plugin:2.1.1')
    }
}

3. Add the following line to the end of the build.gradle file in $PROJ_DIR.

apply plugin: 'edu.illinois.nondex'

4. Add the following line to the end of the build.gradle file in $PROJ_DIR.

subprojects {
  apply plugin: 'edu.illinois.nondex'
}

5. Change the following lines

test {
  useJUnitPlatform()
}
// Change above to below
tasks.withType(Test) {
  useJUnitPlatform()
}

4. Run

./gradlew --info nondexTest --tests=br.com.helpdev.quaklog.entity.GameTest.shouldBuildGameWithSuccess --nondexRuns=100 -p core