improve tests by using a dedicated 'git repo' for testing

Author: TheSnoozer

src/test/java/pl/project13/core/AvailableGitTestRepo.java

@@ -116,6 +116,15 @@ public enum AvailableGitTestRepo {
     * </pre>
     */
   WITH_THREE_COMMITS_AND_TWO_TAGS_CURRENTLY_ON_COMMIT_WITHOUT_TAG("src/test/resources/_git_three_commits_and_two_tags_currently_on_commit_without_tag"),
+  /**
+   * <pre>
+   * 4862e42508099d359d791269f3735baff36d9102 a change in the root pom  (HEAD, master)
+   * 2b91f8b730121f66a833f771cb7241919fed5917 a change in submodule-two
+   * 8e88956d45d57725463550f4406a54d12a46ae78 a change in submodule-one
+   * 9c5d2e13d042b0acb71c48232a9c408e42da87f7 new repo for testing (based on git-commit-id-maven-debugging)
+   * </pre>
+   */
+  WITH_SUBMODULES_AND_MULTIPLE_COMMITS("src/test/resources/_git_with_submodules_and_multiple_commits"),
   // TODO: Why do the tests get stuck when we use .git??
   MAVEN_GIT_COMMIT_ID_PLUGIN("src/test/resources/_git_one_commit_with_umlaut")
   ;

src/test/java/pl/project13/core/GitCommitIdPluginIntegrationTest.java

@@ -28,6 +28,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 import pl.project13.core.git.GitDescribeConfig;
 import pl.project13.core.util.GenericFileManager;
@@ -43,17 +44,16 @@
 import java.util.*;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
-import static java.util.Arrays.asList;
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class GitCommitIdPluginIntegrationTest {
-  public static Collection<?> useNativeGit() {
-    return asList(true, false);
-  }
-
-  public static Collection<?> useDirty() {
-    return asList(true, false);
+  public static Stream<Arguments> useNativeGit() {
+    return Stream.of(
+            Arguments.of(true),
+            Arguments.of(false)
+    );
   }
 
   private Path sandbox;
@@ -1743,38 +1743,48 @@ public void verifyAllowedCharactersForEvaluateOnCommit() {
     Assertions.assertFalse(p.matcher("&&cat /etc/passwd").matches());
   }
 
+  static Stream<Arguments> useNativeGitWithSubmoduleName() {
+    return useNativeGit().flatMap(arg ->
+      Stream.of(
+        "submodule-one",
+        "submodule-two"
+      ).map(str ->
+        Arguments.of(arg.get()[0], str)
+      )
+    );
+  }
+
   @ParameterizedTest
-  @MethodSource("useNativeGit")
-  public void shouldGiveCommitIdForEachFolderWhenPerModuleVersionsEnabled(boolean useNativeGit) throws Exception {
+  @MethodSource("useNativeGitWithSubmoduleName")
+  public void shouldGiveCommitIdForEachFolderWhenPerModuleVersionsEnabled(boolean useNativeGit, String submoduleName) throws Exception {
     // given
-    File dotGitDirectory = createTmpDotGitDirectory(AvailableGitTestRepo.GIT_COMMIT_ID);
+    File dotGitDirectory = createTmpDotGitDirectory(AvailableGitTestRepo.WITH_SUBMODULES_AND_MULTIPLE_COMMITS);
 
-    GitCommitIdPlugin.Callback cbSrc =
-            new GitCommitIdTestCallback()
-                    .setDotGitDirectory(dotGitDirectory)
-                    .setUseNativeGit(useNativeGit)
-                    .setPerModuleVersions(true)
-                    .setModuleBaseDir(dotGitDirectory.getParentFile().toPath().resolve("src").toFile())
-                    .build();
-    Properties propertiesSrcFolder = new Properties();
-
-    GitCommitIdPlugin.Callback cbSrcTest =
+    GitCommitIdPlugin.Callback cb =
             new GitCommitIdTestCallback()
                     .setDotGitDirectory(dotGitDirectory)
                     .setUseNativeGit(useNativeGit)
                     .setPerModuleVersions(true)
-                    .setModuleBaseDir(dotGitDirectory.getParentFile().toPath().resolve("src/test").toFile())
+                    .setModuleBaseDir(dotGitDirectory.getParentFile().toPath().resolve(submoduleName).toFile())
                     .build();
-    Properties propertiesSrcTestFolder = new Properties();
+    Properties properties = new Properties();
 
     // when
-    GitCommitIdPlugin.runPlugin(cbSrc, propertiesSrcFolder);
-    GitCommitIdPlugin.runPlugin(cbSrcTest, propertiesSrcTestFolder);
+    GitCommitIdPlugin.runPlugin(cb, properties);
 
     // then
-    assertThat(propertiesSrcFolder).containsKey("git.commit.id");
-    assertThat(propertiesSrcTestFolder).containsKey("git.commit.id");
-    assertThat(propertiesSrcFolder.getProperty("git.commit.id")).isNotEqualTo(propertiesSrcTestFolder.getProperty("git.commit.id"));
+    assertThat(properties).containsKey("git.commit.id");
+
+    String expectedGitCommitId = null;
+    if (submoduleName.equals("submodule-one")) {
+      expectedGitCommitId = "8e88956d45d57725463550f4406a54d12a46ae78";
+    } else if (submoduleName.equals("submodule-two")) {
+      expectedGitCommitId = "2b91f8b730121f66a833f771cb7241919fed5917";
+    }
+    assertThat(expectedGitCommitId).isNotNull();
+    assertThat(properties.getProperty("git.commit.id"))
+            .as("useNativeGit=%s", useNativeGit)
+            .isEqualTo(expectedGitCommitId);
   }
 
   private GitDescribeConfig createGitDescribeConfig(boolean forceLongFormat, int abbrev) {