Retry failing integration tests

This uses 'RetryingTest' from junit jupiter to retry integration tests that are known to fail from time to time. We explicitly mark single tests in contrast to set a global retry to be able to trace those, whenever this is intended.

To do so, we have to update to the latest version of JUnit. Unfortunately, this brought a new behaviour for the @TempDir annotation: In contrast to the former behaviour where for one test all annotated parameters got the same directory, in the new version the parameters get different directories assigned. This led to the need of some consolidation between @BeforeEach methods and the related tests.

Committed-by: Eduard Heimbuch <eduard.heimbuch@cloudogu.com>
Co-authored-by: René Pfeuffer <rene.pfeuffer@cloudogu.com>

scm-webapp/src/test/java/sonia/scm/update/repository/CopyMigrationStrategyTest.java

@@ -51,32 +51,34 @@ class CopyMigrationStrategyTest {
   SCMContextProvider contextProvider;
   @Mock
   RepositoryLocationResolver locationResolver;
+  @TempDir
+  private Path tempDir;
 
   @BeforeEach
-  void mockContextProvider(@TempDir Path tempDir) {
+  void mockContextProvider() {
     when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
   }
 
   @BeforeEach
-  void createV1Home(@TempDir Path tempDir) throws IOException {
+  void createV1Home() throws IOException {
     V1RepositoryFileSystem.createV1Home(tempDir);
   }
 
   @BeforeEach
-  void mockLocationResolver(@TempDir Path tempDir) {
+  void mockLocationResolver() {
     RepositoryLocationResolver.RepositoryLocationResolverInstance instanceMock = mock(RepositoryLocationResolver.RepositoryLocationResolverInstance.class);
     when(locationResolver.forClass(Path.class)).thenReturn(instanceMock);
     when(instanceMock.createLocation(anyString())).thenAnswer(invocation -> tempDir.resolve((String) invocation.getArgument(0)));
   }
 
   @Test
-  void shouldUseStandardDirectory(@TempDir Path tempDir) {
+  void shouldUseStandardDirectory() {
     Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
     assertThat(target).isEqualTo(tempDir.resolve("b4f-a9f0-49f7-ad1f-37d3aae1c55f"));
   }
 
   @Test
-  void shouldCopyDataDirectory(@TempDir Path tempDir) {
+  void shouldCopyDataDirectory() {
     Path target = new CopyMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
     assertThat(target.resolve("data")).exists();
     Path originalDataDir = tempDir

scm-webapp/src/test/java/sonia/scm/update/repository/InlineMigrationStrategyTest.java

@@ -50,27 +50,29 @@ class InlineMigrationStrategyTest {
   PathBasedRepositoryLocationResolver locationResolver;
   @Mock
   RepositoryLocationResolver.RepositoryLocationResolverInstance locationResolverInstance;
+  @TempDir
+  Path tempDir;
 
   @BeforeEach
-  void mockContextProvider(@TempDir Path tempDir) {
+  void mockContextProvider() {
     when(locationResolver.forClass(Path.class)).thenReturn(locationResolverInstance);
     when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
   }
 
   @BeforeEach
-  void createV1Home(@TempDir Path tempDir) throws IOException {
+  void createV1Home() throws IOException {
     V1RepositoryFileSystem.createV1Home(tempDir);
   }
 
   @Test
-  void shouldUseExistingDirectory(@TempDir Path tempDir) {
+  void shouldUseExistingDirectory() {
     Path target = new InlineMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
     assertThat(target).isEqualTo(resolveOldDirectory(tempDir));
     verify(locationResolverInstance).setLocation("b4f-a9f0-49f7-ad1f-37d3aae1c55f", target);
   }
 
   @Test
-  void shouldMoveDataDirectory(@TempDir Path tempDir) {
+  void shouldMoveDataDirectory() {
     new InlineMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git");
     assertThat(resolveOldDirectory(tempDir).resolve("data")).exists();
   }

scm-webapp/src/test/java/sonia/scm/update/repository/MigrateVerbsToPermissionRolesTest.java

@@ -63,8 +63,11 @@ class MigrateVerbsToPermissionRolesTest {
   @InjectMocks
   private MigrateVerbsToPermissionRoles migration;
 
+  @TempDir
+  private Path tempDir;
+
   @BeforeEach
-  void init(@TempDir Path tempDir) throws IOException {
+  void init() throws IOException {
     URL metadataUrl = Resources.getResource("sonia/scm/update/repository/metadataWithoutRoles.xml");
     Files.copy(metadataUrl.openStream(), tempDir.resolve("metadata.xml"));
     doAnswer(invocation -> {
@@ -75,7 +78,7 @@ class MigrateVerbsToPermissionRolesTest {
   }
 
   @Test
-  void shouldUpdateToRolesIfPossible(@TempDir Path tempDir) throws IOException {
+  void shouldUpdateToRolesIfPossible() throws IOException {
     migration.doUpdate();
 
     List<String> newMetadata = Files.readAllLines(tempDir.resolve("metadata.xml"));

scm-webapp/src/test/java/sonia/scm/update/repository/MoveMigrationStrategyTest.java

@@ -48,32 +48,34 @@ class MoveMigrationStrategyTest {
   SCMContextProvider contextProvider;
   @Mock
   RepositoryLocationResolver locationResolver;
+  @TempDir
+  Path tempDir;
 
   @BeforeEach
-  void mockContextProvider(@TempDir Path tempDir) {
+  void mockContextProvider() {
     when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
   }
 
   @BeforeEach
-  void createV1Home(@TempDir Path tempDir) throws IOException {
+  void createV1Home() throws IOException {
     V1RepositoryFileSystem.createV1Home(tempDir);
   }
 
   @BeforeEach
-  void mockLocationResolver(@TempDir Path tempDir) {
+  void mockLocationResolver() {
     RepositoryLocationResolver.RepositoryLocationResolverInstance instanceMock = mock(RepositoryLocationResolver.RepositoryLocationResolverInstance.class);
     when(locationResolver.forClass(Path.class)).thenReturn(instanceMock);
     when(instanceMock.createLocation(anyString())).thenAnswer(invocation -> tempDir.resolve((String) invocation.getArgument(0)));
   }
 
   @Test
-  void shouldUseStandardDirectory(@TempDir Path tempDir) {
+  void shouldUseStandardDirectory() {
     Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
     assertThat(target).isEqualTo(tempDir.resolve("b4f-a9f0-49f7-ad1f-37d3aae1c55f"));
   }
 
   @Test
-  void shouldMoveDataDirectory(@TempDir Path tempDir) {
+  void shouldMoveDataDirectory() {
     Path target = new MoveMigrationStrategy(contextProvider, locationResolver).migrate("b4f-a9f0-49f7-ad1f-37d3aae1c55f", "some/more/directories/than/one", "git").get();
     assertThat(target.resolve("data")).exists();
     Path originalDataDir = tempDir

scm-webapp/src/test/java/sonia/scm/update/repository/XmlRepositoryFileNameUpdateStepTest.java

@@ -47,13 +47,16 @@ class XmlRepositoryFileNameUpdateStepTest {
   SCMContextProvider contextProvider = mock(SCMContextProvider.class);
   XmlRepositoryDAO repositoryDAO = mock(XmlRepositoryDAO.class);
 
+  @TempDir
+  Path tempDir;
+
   @BeforeEach
-  void mockScmHome(@TempDir Path tempDir) {
+  void mockScmHome() {
     when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
   }
 
   @Test
-  void shouldCopyRepositoriesFileToRepositoryPathsFile(@TempDir Path tempDir) throws IOException {
+  void shouldCopyRepositoriesFileToRepositoryPathsFile() throws IOException {
     XmlRepositoryFileNameUpdateStep updateStep = new XmlRepositoryFileNameUpdateStep(contextProvider, repositoryDAO);
     URL url = Resources.getResource("sonia/scm/update/repository/formerV2RepositoryFile.xml");
     Path configDir = tempDir.resolve("config");

scm-webapp/src/test/java/sonia/scm/update/repository/XmlRepositoryV1UpdateStepTest.java

@@ -82,9 +82,11 @@ class XmlRepositoryV1UpdateStepTest {
   UpdateStepTestUtil testUtil;
 
   XmlRepositoryV1UpdateStep updateStep;
+  @TempDir
+  Path tempDir;
 
   @BeforeEach
-  void createUpdateStepFromMocks(@TempDir Path tempDir) {
+  void createUpdateStepFromMocks() {
     testUtil = new UpdateStepTestUtil(tempDir);
     updateStep = new XmlRepositoryV1UpdateStep(
       testUtil.getContextProvider(),
@@ -99,7 +101,7 @@ class XmlRepositoryV1UpdateStepTest {
   class WithExistingDatabase {
 
     @BeforeEach
-    void createV1Home(@TempDir Path tempDir) throws IOException {
+    void createV1Home() throws IOException {
       V1RepositoryFileSystem.createV1Home(tempDir);
     }
 
@@ -176,7 +178,7 @@ class XmlRepositoryV1UpdateStepTest {
     }
 
     @Test
-    void shouldUseDirectoryFromStrategy(@TempDir Path tempDir) throws JAXBException {
+    void shouldUseDirectoryFromStrategy() throws JAXBException {
       Path targetDir = tempDir.resolve("someDir");
       MigrationStrategy.Instance strategyMock = injectorMock.getInstance(MoveMigrationStrategy.class);
       when(strategyMock.migrate("454972da-faf9-4437-b682-dc4a4e0aa8eb", "simple", "git")).thenReturn(of(targetDir));
@@ -206,7 +208,7 @@ class XmlRepositoryV1UpdateStepTest {
     }
 
     @Test
-    void shouldBackupOldRepositoryDatabaseFile(@TempDir Path tempDir) throws JAXBException {
+    void shouldBackupOldRepositoryDatabaseFile() throws JAXBException {
       updateStep.doUpdate();
 
       assertThat(tempDir.resolve("config").resolve("repositories.xml")).doesNotExist();
@@ -220,15 +222,15 @@ class XmlRepositoryV1UpdateStepTest {
   }
 
   @Test
-  void shouldNotFailIfFormerV2DatabaseExists(@TempDir Path tempDir) throws JAXBException, IOException {
-    createFormerV2RepositoriesFile(tempDir);
+  void shouldNotFailIfFormerV2DatabaseExists() throws JAXBException, IOException {
+    createFormerV2RepositoriesFile();
 
     updateStep.doUpdate();
   }
 
   @Test
-  void shouldNotBackupFormerV2DatabaseFile(@TempDir Path tempDir) throws JAXBException, IOException {
-    createFormerV2RepositoriesFile(tempDir);
+  void shouldNotBackupFormerV2DatabaseFile() throws JAXBException, IOException {
+    createFormerV2RepositoriesFile();
 
     updateStep.doUpdate();
 
@@ -237,14 +239,14 @@ class XmlRepositoryV1UpdateStepTest {
   }
 
   @Test
-  void shouldGetNoMissingStrategiesWithFormerV2DatabaseFile(@TempDir Path tempDir) throws IOException {
-    createFormerV2RepositoriesFile(tempDir);
+  void shouldGetNoMissingStrategiesWithFormerV2DatabaseFile() throws IOException {
+    createFormerV2RepositoriesFile();
 
     assertThat(updateStep.getRepositoriesWithoutMigrationStrategies()).isEmpty();
   }
 
   @Test
-  void shouldFindMissingStrategies(@TempDir Path tempDir) throws IOException {
+  void shouldFindMissingStrategies() throws IOException {
     V1RepositoryFileSystem.createV1Home(tempDir);
 
     assertThat(updateStep.getRepositoriesWithoutMigrationStrategies())
@@ -255,7 +257,7 @@ class XmlRepositoryV1UpdateStepTest {
         "454972da-faf9-4437-b682-dc4a4e0aa8eb");
   }
 
-  private void createFormerV2RepositoriesFile(@TempDir Path tempDir) throws IOException {
+  private void createFormerV2RepositoriesFile() throws IOException {
     URL url = Resources.getResource("sonia/scm/update/repository/formerV2RepositoryFile.xml");
     Path configDir = tempDir.resolve("config");
     Files.createDirectories(configDir);

scm-webapp/src/test/java/sonia/scm/update/security/XmlSecurityV1UpdateStepTest.java

@@ -59,8 +59,11 @@ class XmlSecurityV1UpdateStepTest {
   XmlSecurityV1UpdateStep updateStep;
   ConfigurationEntryStore<AssignedPermission> assignedPermissionStore;
 
+  @TempDir
+  Path tempDir;
+
   @BeforeEach
-  void mockScmHome(@TempDir Path tempDir) {
+  void mockScmHome() {
     when(contextProvider.getBaseDirectory()).thenReturn(tempDir.toFile());
     InMemoryConfigurationEntryStoreFactory inMemoryConfigurationEntryStoreFactory = create();
     assignedPermissionStore = inMemoryConfigurationEntryStoreFactory.get("security");
@@ -71,7 +74,7 @@ class XmlSecurityV1UpdateStepTest {
   class WithExistingDatabase {
 
     @BeforeEach
-    void createConfigV1XML(@TempDir Path tempDir) throws IOException {
+    void createConfigV1XML() throws IOException {
       Path configDir = tempDir.resolve("config");
       Files.createDirectories(configDir);
       copyTestDatabaseFile(configDir, "config.xml");
@@ -111,7 +114,7 @@ class XmlSecurityV1UpdateStepTest {
     private Path configDir;
 
     @BeforeEach
-    void createSecurityV1XML(@TempDir Path tempDir) throws IOException {
+    void createSecurityV1XML() throws IOException {
       configDir = tempDir.resolve("config");
       Files.createDirectories(configDir);
     }