[test optimization] Configuration parameter to disable git unshallow (#…

…5291)
DataDog · Feb 20, 2025 · 23abc09 · 23abc09
1 parent 4733649
commit 23abc09
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/packages/dd-trace/src/ci-visibility/exporters/git/git_metadata.js b/packages/dd-trace/src/ci-visibility/exporters/git/git_metadata.js
@@ -5,6 +5,7 @@ const FormData = require('../../../exporters/common/form-data')
 const request = require('../../../exporters/common/request')
 
 const log = require('../../../log')
+const { isFalse } = require('../../../util')
 const {
   getLatestCommits,
   getRepositoryUrl,
@@ -284,7 +285,9 @@ function sendGitMetadata (url, { isEvpProxy, evpProxyPrefix }, configRepositoryU
     }
     // Otherwise we unshallow and get commits to upload again
     log.debug('It is shallow clone, unshallowing...')
-    unshallowRepository()
+    if (!isFalse(process.env.DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED)) {
+      unshallowRepository()
+    }
 
     // The latest commits change after unshallowing
     latestCommits = getLatestCommits()

diff --git a/packages/dd-trace/test/ci-visibility/exporters/git/git_metadata.spec.js b/packages/dd-trace/test/ci-visibility/exporters/git/git_metadata.spec.js
@@ -36,6 +36,7 @@ describe('git_metadata', () => {
 
   after(() => {
     delete process.env.DD_API_KEY
+    delete process.env.DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED
     fs.unlinkSync(temporaryPackFile)
     fs.unlinkSync(secondTemporaryPackFile)
   })
@@ -97,6 +98,25 @@ describe('git_metadata', () => {
     })
   })
 
+  it('should not unshallow if the parameter to enable unshallow is false', (done) => {
+    process.env.DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED = false
+    const scope = nock('https://api.test.com')
+      .post('/api/v2/git/repository/search_commits')
+      .reply(200, JSON.stringify({ data: [] }))
+      .post('/api/v2/git/repository/search_commits') // calls a second time after unshallowing
+      .reply(200, JSON.stringify({ data: [] }))
+      .post('/api/v2/git/repository/packfile')
+      .reply(204)
+
+    isShallowRepositoryStub.returns(true)
+    gitMetadata.sendGitMetadata(new URL('https://api.test.com'), { isEvpProxy: false }, '', (err) => {
+      expect(unshallowRepositoryStub).not.to.have.been.called
+      expect(err).to.be.null
+      expect(scope.isDone()).to.be.true
+      done()
+    })
+  })
+
   it('should request to /api/v2/git/repository/search_commits and /api/v2/git/repository/packfile', (done) => {
     const scope = nock('https://api.test.com')
       .post('/api/v2/git/repository/search_commits')