use relative paths in remotes and add remote origin to resources

Author: daniel-mohedano

dd-java-agent/agent-ci-visibility/src/test/groovy/datadog/trace/civisibility/git/tree/GitClientTest.groovy

@@ -9,6 +9,7 @@ import datadog.trace.civisibility.telemetry.CiVisibilityMetricCollectorImpl
 import java.nio.file.Files
 import java.nio.file.Path
 import java.nio.file.Paths
+import java.util.stream.Collectors
 import spock.lang.Specification
 import spock.lang.TempDir
 
@@ -469,19 +470,19 @@ class GitClientTest extends Specification {
   }
 
   def "test get base branch sha: #testcaseName"() {
-    givenGitRepo(repo)
-    def gitClient = givenGitClient()
+    givenGitRepos(["ci/git/impacted/repo_origin", "ci/git/impacted/$repoName"])
+    def gitClient = givenGitClient(repoName)
 
     expect:
     gitClient.getBaseCommitSha(baseBranch, null) == expected
 
     where:
-    testcaseName                                 | repo                                     | baseBranch | expected
-    "base branch provided"                       | "ci/git/impacted/source_repo/git"        | "master"   | "c0a09c420836a5d2c1ce4c74d9c4e732d4ccd065"
-    "base branch not provided"                   | "ci/git/impacted/source_repo/git"        | null       | "c0a09c420836a5d2c1ce4c74d9c4e732d4ccd065"
-    "fresh clone with remote cloned into master" | "ci/git/impacted/new_clone/git"          | null       | "c0a09c420836a5d2c1ce4c74d9c4e732d4ccd065"
-    "no remote clone"                            | "ci/git/impacted/no_remote/git"          | null       | null
-    "Github Actions style clone"                 | "ci/git/impacted/ghub_actions_clone/git" | null       | "c0a09c420836a5d2c1ce4c74d9c4e732d4ccd065"
+    testcaseName                                 | repoName             | baseBranch | expected
+    "base branch provided"                       | "source_repo"        | "master"   | "15567afb8426f72157c523d49dd49c24d6fe855e"
+    "base branch not provided"                   | "source_repo"        | null       | "15567afb8426f72157c523d49dd49c24d6fe855e"
+    "fresh clone with remote cloned into master" | "new_clone"          | null       | "15567afb8426f72157c523d49dd49c24d6fe855e"
+    "no remote clone"                            | "no_remote"          | null       | null
+    "Github Actions style clone"                 | "ghub_actions_clone" | null       | "15567afb8426f72157c523d49dd49c24d6fe855e"
   }
 
   private void givenGitRepo() {
@@ -491,12 +492,36 @@ class GitClientTest extends Specification {
   private void givenGitRepo(String resourceName) {
     def gitFolder = Paths.get(getClass().getClassLoader().getResource(resourceName).toURI())
     def tempGitFolder = tempDir.resolve(GIT_FOLDER)
-    Files.createDirectories(tempGitFolder)
-    IOUtils.copyFolder(gitFolder, tempGitFolder)
+    copyFolder(gitFolder, tempGitFolder)
   }
 
-  private givenGitClient() {
+  private void givenGitRepos(List<String> resourceDirs) {
+    def resources = resourceDirs.stream().map(dir -> Paths.get(getClass().getClassLoader().getResource(dir).toURI())).collect(Collectors.toList())
+    for (def resource : resources) {
+      def gitFolder = resource.resolve("git")
+      def destFolder = tempDir.resolve(resource.getFileName())
+      if (Files.isDirectory(gitFolder)) {
+        // repos with git/ folder
+        def tempGitFolder = destFolder.resolve(GIT_FOLDER)
+        copyFolder(gitFolder, tempGitFolder)
+      } else {
+        // dirs with no git/ folder, i.e. a remote
+        copyFolder(resource, destFolder)
+      }
+    }
+  }
+
+  private static void copyFolder(Path src, Path dest) {
+    Files.createDirectories(dest)
+    IOUtils.copyFolder(src, dest)
+  }
+
+  private givenGitClient(String tempRelPath) {
     def metricCollector = Stub(CiVisibilityMetricCollectorImpl)
-    new ShellGitClient(metricCollector, tempDir.toString(), "25 years ago", 10, GIT_COMMAND_TIMEOUT_MILLIS)
+    new ShellGitClient(metricCollector, tempDir.resolve(tempRelPath).toString(), "25 years ago", 10, GIT_COMMAND_TIMEOUT_MILLIS)
+  }
+
+  private givenGitClient() {
+    givenGitClient("")
   }
 }

dd-java-agent/agent-ci-visibility/src/test/resources/ci/git/impacted/build_script.txt

@@ -1,55 +1,65 @@
 #!/bin/bash
 
-origin_path="/tmp/impacted/repo_origin"
-source_path="/tmp/impacted/source_repo"
-new_clone_path="/tmp/impacted/new_clone"
-no_remote_path="/tmp/impacted/no_remote"
-ghub_actions_path="/tmp/impacted/ghub_actions_clone"
+# IMPORTANT: always use relative paths, as tests move the folders to temp dirs
+base_path="/tmp/impacted/"
+origin_path="repo_origin"
+source_path="source_repo"
+new_clone_path="new_clone"
+no_remote_path="no_remote"
+ghub_actions_path="ghub_actions_clone"
+
+base_branch="master"
+feature_branch="feature"
+
+mkdir -p $base_path
+cd $base_path
 
 # create origin
 mkdir -p $origin_path
-(cd $origin_path && git init --bare)
+cd $origin_path && git init --bare
+cd ..
 
 # create git repo
-mkdir -p $source_path
-(cd $source_path && git init && git remote add origin $origin_path)
-(cd $source_path && echo "Hello, world!" >>README.md && git add README.md && git commit -m "Initial commit")
-(cd $source_path && echo "Hello, world!" >>README.md && git add README.md && git commit -m "Update README")
-(cd $source_path && git push origin master)
-
-base_branch="master"
-feature_branch="feature"
-base_commit=$(cd $source_path && git rev-parse HEAD)
-
+mkdir -p $source_path && cd $source_path
+git init && git remote add origin "../$origin_path"
+echo "Hello, world!" >>README.md && git add README.md && git commit -m "Initial commit"
+echo "Hello, world!" >>README.md && git add README.md && git commit -m "Update README"
+git push origin master
+base_commit=$(git rev-parse HEAD)
 # create feature branch
-(cd $source_path && git checkout -b $feature_branch)
-(cd $source_path && echo "Feature branch change" >>README.md && git add README.md && git commit -m "Updated README")
-(cd $source_path && git push origin $feature_branch)
+git checkout -b $feature_branch
+echo "Feature branch change" >>README.md && git add README.md && git commit -m "Feature branch commit"
+git push origin $feature_branch
+cd ..
 
-# create new clone
-mkdir -p $new_clone_path
-(cd $new_clone_path && git init)
-(cd $new_clone_path && git remote add origin $origin_path)
-(cd $new_clone_path && git fetch origin $feature_branch)
-(cd $new_clone_path && git reset --hard "origin/$feature_branch")
+# clone with remote branch cloned into master branch of local repo
+mkdir -p $new_clone_path && cd $new_clone_path
+git init
+git remote add origin "../$origin_path"
+git fetch origin $feature_branch
+git reset --hard "origin/$feature_branch"
+cd ..
 
 # remote pointing to non existing repo
-mkdir -p $no_remote_path
-(cd $no_remote_path && git init)
-(cd $no_remote_path && echo "base branch file" >>README.md && git add README.md && git commit -m "first commit")
-(cd $no_remote_path && git remote add origin "git@git.com:datadog/non_existing_repo.git")
+mkdir -p $no_remote_path && cd $no_remote_path
+git init
+echo "base branch file" >>README.md && git add README.md && git commit -m "first commit"
+git remote add origin "git@git.com:datadog/non_existing_repo.git"
+cd ..
 
 # github actions style clone
-mkdir -p $ghub_actions_path
-(cd $ghub_actions_path && git init)
-(cd $ghub_actions_path && git remote add origin $origin_path)
-(cd $ghub_actions_path && git fetch --no-tags --prune --no-recurse-submodules origin $feature_branch)
-(cd $ghub_actions_path && git checkout --progress --force -B $feature_branch "refs/remotes/origin/$feature_branch")
+mkdir -p $ghub_actions_path && cd $ghub_actions_path
+git init
+git remote add origin "../$origin_path"
+git fetch --no-tags --prune --no-recurse-submodules origin $feature_branch
+git checkout --progress --force -B $feature_branch "refs/remotes/origin/$feature_branch"
+cd ..
 
 echo "BASE COMMIT: $base_commit"
 
 # cleanup
-(cd $source_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index && mv .git git)
-(cd $new_clone_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index && mv .git git)
-(cd $no_remote_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index && mv .git git)
-(cd $ghub_actions_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index && mv .git git)
+(cd $origin_path && rm -rf hooks info logs COMMIT_EDITMSG description index README.md)
+(cd $source_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index README.md && mv .git git)
+(cd $new_clone_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index README.md && mv .git git)
+(cd $no_remote_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index README.md && mv .git git)
+(cd $ghub_actions_path && rm -rf .git/hooks .git/info .git/logs .git/COMMIT_EDITMSG .git/description .git/index README.md && mv .git git)

dd-java-agent/agent-ci-visibility/src/test/resources/ci/git/impacted/ghub_actions_clone/README.md

@@ -1 +1 @@
-2fdf0c87f0a59400612ea7bff833507e8b4572eb		branch 'feature' of /tmp/impacted/repo_origin
+260c03f5848ec8054374407916e806a80bec3729		branch 'feature' of ../repo_origin

dd-java-agent/agent-ci-visibility/src/test/resources/ci/git/impacted/ghub_actions_clone/git/FETCH_HEAD

@@ -6,7 +6,7 @@
 	ignorecase = true
 	precomposeunicode = true
 [remote "origin"]
-	url = /tmp/impacted/repo_origin
+	url = ../repo_origin
 	fetch = +refs/heads/*:refs/remotes/origin/*
 [branch "feature"]
 	remote = origin