improve debug output

SAP · Mar 15, 2024 · 12e2006 · 12e2006
1 parent e3fee3b
commit 12e2006
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 13 deletions.
diff --git a/src/github.ts b/src/github.ts
@@ -30,13 +30,15 @@ export async function downloadPiperBinary (
   const headers: any = {}
   const piperBinaryName = await getPiperBinaryNameFromInputs(isEnterprise, version)
   if (token !== '') {
+    debug('Fetching binary from GitHub API')
     headers.Accept = 'application/octet-stream'
     headers.Authorization = `token ${token}`
 
     const [binaryAssetURL, tag] = await getReleaseAssetUrl(piperBinaryName, version, apiURL, token, owner, repo)
     binaryURL = binaryAssetURL
     version = tag
   } else {
+    debug('Fetching binary from URL')
     binaryURL = await getPiperDownloadURL(piperBinaryName, version)
     version = binaryURL.split('/').slice(-2)[0]
   }
@@ -87,7 +89,7 @@ async function getPiperReleases (version: string, api: string, token: string, ow
   }
 
   const octokit = new Octokit(options)
-  info(`Getting releases from ${api}/repos/${owner}/${repository}/releases/${tag}`)
+  debug(`Fetching release info from ${api}/repos/${owner}/${repository}/releases/${tag}`)
   const response = await octokit.request(`GET /repos/${owner}/${repository}/releases/${tag}`)
   if (response.status !== 200) {
     throw new Error(`can't get release by tag ${tag}: ${response.status}`)

diff --git a/test/github.test.ts b/test/github.test.ts
@@ -59,7 +59,10 @@ describe('GitHub package tests', () => {
     })
 
     await downloadPiperBinary(osStep, 'latest', githubApiURL, '', owner, repo)
+    expect(core.debug).toHaveBeenNthCalledWith(1, 'Fetching binary from URL')
+    expect(core.debug).toHaveBeenCalledTimes(1)
     expect(core.info).toHaveBeenCalledWith(`Downloading 'https://github.com/SAP/jenkins-library/releases/download/v1.1.1/piper' as '${process.cwd()}/${version.replace(/\./g, '_')}/piper'`)
+    expect(core.info).toHaveBeenCalledTimes(1)
   })
 
   test('downloadPiperBinary - SAP step latest', async () => {
@@ -79,10 +82,12 @@ describe('GitHub package tests', () => {
     })
 
     await downloadPiperBinary(sapStep, 'latest', githubApiURL, token, owner, repo)
-    expect(core.debug).toHaveBeenCalledWith(`Found asset URL: ${assetUrl} and tag: ${version}`)
-    expect(core.info).toHaveBeenNthCalledWith(1, `Getting releases from ${githubApiURL}/repos/${owner}/${repo}/releases/latest`)
-    expect(core.info).toHaveBeenNthCalledWith(2, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/sap-piper'`))
-    expect(core.info).toHaveBeenCalledTimes(2)
+    expect(core.debug).toHaveBeenNthCalledWith(1, 'Fetching binary from GitHub API')
+    expect(core.debug).toHaveBeenNthCalledWith(2, `Fetching release info from ${githubApiURL}/repos/${owner}/${repo}/releases/latest`)
+    expect(core.debug).toHaveBeenNthCalledWith(5, `Found asset URL: ${assetUrl} and tag: ${version}`)
+    expect(core.debug).toHaveBeenCalledTimes(5)
+    expect(core.info).toHaveBeenNthCalledWith(1, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/sap-piper'`))
+    expect(core.info).toHaveBeenCalledTimes(1)
   })
 
   test('downloadPiperBinary - OS step, master', async () => {
@@ -102,10 +107,12 @@ describe('GitHub package tests', () => {
     })
 
     await downloadPiperBinary(osStep, 'master', githubApiURL, token, owner, repo)
-    expect(core.debug).toHaveBeenCalledWith(`Found asset URL: ${assetUrl} and tag: ${version}`)
-    expect(core.info).toHaveBeenNthCalledWith(1, `Getting releases from ${githubApiURL}/repos/${owner}/${repo}/releases/latest`)
-    expect(core.info).toHaveBeenNthCalledWith(2, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/piper_master'`))
-    expect(core.info).toHaveBeenCalledTimes(2)
+    expect(core.debug).toHaveBeenNthCalledWith(1, 'Fetching binary from GitHub API')
+    expect(core.debug).toHaveBeenNthCalledWith(2, `Fetching release info from ${githubApiURL}/repos/${owner}/${repo}/releases/latest`)
+    expect(core.debug).toHaveBeenNthCalledWith(5, `Found asset URL: ${assetUrl} and tag: ${version}`)
+    expect(core.debug).toHaveBeenCalledTimes(5)
+    expect(core.info).toHaveBeenNthCalledWith(1, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/piper_master'`))
+    expect(core.info).toHaveBeenCalledTimes(1)
   })
 
   test('downloadPiperBinary - OS step, exact version', async () => {
@@ -125,10 +132,12 @@ describe('GitHub package tests', () => {
     })
 
     await downloadPiperBinary(osStep, version, githubApiURL, token, owner, repo)
-    expect(core.debug).toHaveBeenCalledWith(`Found asset URL: ${assetUrl} and tag: ${version}`)
-    expect(core.info).toHaveBeenNthCalledWith(1, `Getting releases from ${githubApiURL}/repos/${owner}/${repo}/releases/tags/${version}`)
-    expect(core.info).toHaveBeenNthCalledWith(2, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/piper'`))
-    expect(core.info).toHaveBeenCalledTimes(2)
+    expect(core.debug).toHaveBeenNthCalledWith(1, 'Fetching binary from GitHub API')
+    expect(core.debug).toHaveBeenNthCalledWith(2, `Fetching release info from ${githubApiURL}/repos/${owner}/${repo}/releases/tags/${version}`)
+    expect(core.debug).toHaveBeenNthCalledWith(5, `Found asset URL: ${assetUrl} and tag: ${version}`)
+    expect(core.debug).toHaveBeenCalledTimes(5)
+    expect(core.info).toHaveBeenNthCalledWith(1, expect.stringContaining(`Downloading '${assetUrl}' as '${process.cwd()}/${version.replace(/\./g, '_')}/piper'`))
+    expect(core.info).toHaveBeenCalledTimes(1)
   })
 
   test('Get dev Piper', async () => {