Support for server url (#77)

* feat: detect github server url (#76) * feat: autodetect github server url * test: add check for private github server url * fix: use serverUrl from octokit * chore: add debug output for github url * chore: update dist with latest changes * add script for `bump-version` * 1.0.24 * changelog 1.0.24 * remove unused workflow --------- Co-authored-by: David K <[email protected]>
MishaKav · Nov 23, 2023 · f2e8b56 · f2e8b56
1 parent b326885
commit f2e8b56
Show file tree

Hide file tree

Showing 15 changed files with 97 additions and 81 deletions.
diff --git a/.github/workflows/contrast_security_app.yaml b/.github/workflows/contrast_security_app.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog of the Jest Coverage Comment
 
+## [Jest Coverage Comment 1.0.24](https://github.com/MishaKav/jest-coverage-comment/tree/v1.0.24)
+
+**Release Date:** 2023-11-23
+
+#### Changes
+
+- Take right `serverUrl` in non github.com environments like selfhosted github, e.g. link to lines uses then the correct link, thanks to [@c0un7-z3r0](https://github.com/c0un7-z3r0) for contribution
+
 ## [Jest Coverage Comment 1.0.23](https://github.com/MishaKav/jest-coverage-comment/tree/v1.0.23)
 
 **Release Date:** 2023-03-13

diff --git a/__tests__/coverage.test.ts b/__tests__/coverage.test.ts
@@ -7,6 +7,7 @@ describe('get coverage report', () => {
   const options: Options = {
     token: 'token_123',
     repository: 'MishaKav/jest-coverage-comment',
+    serverUrl: 'https://github.com',
     commit: '05953710b21d222efa4f4535424a7af367be5a57',
     watermark: '<!-- Jest Coverage Comment: 1 -->\n',
     summaryTitle: '',
@@ -40,6 +41,31 @@ describe('get coverage report', () => {
       `"<details><summary>Coverage Report (<b>71%</b>)</summary><table><tr><th>File</th><th>% Stmts</th><th>% Branch</th><th>% Funcs</th><th>% Lines</th><th>Uncovered Line #s</th></tr><tbody><tr><td><b>All files</b></td><td><b>70.21</b></td><td><b>100</b></td><td><b>28.57</b></td><td><b>71.73</b></td><td>&nbsp;</td></tr><tr><td>src</td><td>68.29</td><td>100</td><td>33.33</td><td>68.29</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js">controller.js</a></td><td>46.66</td><td>100</td><td>33.33</td><td>46.66</td><td><a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js#L5-L9">5&ndash;9</a>, <a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js#L23-L27">23&ndash;27</a></td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/index.js">index.js</a></td><td>85.71</td><td>100</td><td>0</td><td>85.71</td><td><a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/index.js#L9">9</a></td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/router.js">router.js</a></td><td>100</td><td>100</td><td>100</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/service.js">service.js</a></td><td>69.23</td><td>100</td><td>50</td><td>69.23</td><td><a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/service.js#L16-L20">16&ndash;20</a></td></tr><tr><td>src/utils</td><td>83.33</td><td>100</td><td>0</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/utils/config.js">config.js</a></td><td>100</td><td>100</td><td>100</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/utils/utils.js">utils.js</a></td><td>75</td><td>100</td><td>0</td><td>100</td><td>&nbsp;</td></tr></tbody></table></details>"`
     )
   })
+  test('should return coverage report with custom github server url', () => {
+    const {
+      coverageHtml,
+      coverage,
+      color,
+      branches,
+      functions,
+      lines,
+      statements,
+    } = getCoverageReport({
+      ...options,
+      serverUrl: 'https://private.azure.github.com',
+    })
+
+    expect(lines).toBe(coverage)
+    expect(coverage).toBe(71)
+    expect(color).toBe('yellow')
+    expect(branches).toBe(100)
+    expect(functions).toBe(28)
+    expect(lines).toBe(71)
+    expect(statements).toBe(70)
+    expect(coverageHtml).toMatchInlineSnapshot(
+      `"<details><summary>Coverage Report (<b>71%</b>)</summary><table><tr><th>File</th><th>% Stmts</th><th>% Branch</th><th>% Funcs</th><th>% Lines</th><th>Uncovered Line #s</th></tr><tbody><tr><td><b>All files</b></td><td><b>70.21</b></td><td><b>100</b></td><td><b>28.57</b></td><td><b>71.73</b></td><td>&nbsp;</td></tr><tr><td>src</td><td>68.29</td><td>100</td><td>33.33</td><td>68.29</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js">controller.js</a></td><td>46.66</td><td>100</td><td>33.33</td><td>46.66</td><td><a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js#L5-L9">5&ndash;9</a>, <a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/controller.js#L23-L27">23&ndash;27</a></td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/index.js">index.js</a></td><td>85.71</td><td>100</td><td>0</td><td>85.71</td><td><a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/index.js#L9">9</a></td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/router.js">router.js</a></td><td>100</td><td>100</td><td>100</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/service.js">service.js</a></td><td>69.23</td><td>100</td><td>50</td><td>69.23</td><td><a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/service.js#L16-L20">16&ndash;20</a></td></tr><tr><td>src/utils</td><td>83.33</td><td>100</td><td>0</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/utils/config.js">config.js</a></td><td>100</td><td>100</td><td>100</td><td>100</td><td>&nbsp;</td></tr><tr><td>&nbsp; &nbsp;<a href="https://private.azure.github.com/MishaKav/jest-coverage-comment/blob/05953710b21d222efa4f4535424a7af367be5a57/src/utils/utils.js">utils.js</a></td><td>75</td><td>100</td><td>0</td><td>100</td><td>&nbsp;</td></tr></tbody></table></details>"`
+    )
+  })
 
   test('should return coverage report without links to files', () => {
     const { coverageHtml } = getCoverageReport({

diff --git a/__tests__/junit.test.ts b/__tests__/junit.test.ts
@@ -57,6 +57,7 @@ describe('parse junit and check report output', () => {
   const options = {
     token: 'token_123',
     repository: 'MishaKav/jest-coverage-comment',
+    serverUrl: 'https://github.com',
     commit: '05953710b21d222efa4f4535424a7af367be5a57',
     watermark: '<!-- Jest Coverage Comment: 1 -->\n',
     summaryTitle: '',

diff --git a/__tests__/summary.test.ts b/__tests__/summary.test.ts
@@ -47,6 +47,7 @@ describe('summary to td', () => {
 describe('parse summary', () => {
   const options: Options = {
     token: 'token_123',
+    serverUrl: 'https://github.com',
     repository: 'MishaKav/jest-coverage-comment',
     commit: '05953710b21d222efa4f4535424a7af367be5a57',
     watermark: '<!-- Jest Coverage Comment: 1 -->\n',
@@ -106,7 +107,7 @@ describe('should parse summary', () => {
     expect(parsedSummary).toBeNull()
     expect(spyCore.error).toHaveBeenCalledTimes(1)
     expect(spyCore.error).toHaveBeenCalledWith(
-      'Parse summary report. Unexpected token b in JSON at position 0'
+      'Parse summary report. Unexpected token \'b\', "bad content" is not valid JSON'
     )
   })
 })
@@ -115,6 +116,7 @@ describe('summary to markdown', () => {
   const options: Options = {
     token: 'token_123',
     repository: 'MishaKav/jest-coverage-comment',
+    serverUrl: 'https://github.com',
     commit: '05953710b21d222efa4f4535424a7af367be5a57',
     watermark: '<!-- Jest Coverage Comment: 1 -->\n',
     summaryTitle: '',
@@ -150,6 +152,7 @@ describe('coverage when have default values', () => {
   const options: Options = {
     token: 'token_123',
     repository: 'MishaKav/jest-coverage-comment',
+    serverUrl: 'https://github.com',
     commit: '05953710b21d222efa4f4535424a7af367be5a57',
     watermark: '<!-- Jest Coverage Comment: 1 -->\n',
     summaryTitle: '',

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jest-coverage-comment",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "description": "Comments a pull request or commit with the jest code coverage badge, full report and tests summary",
   "author": "Misha Kav <[email protected]>",
   "license": "MIT",
@@ -23,6 +23,7 @@
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "lint": "eslint **/*.ts",
+    "bump-version": "npm version patch",
     "package": "ncc build --source-map --license licenses.txt",
     "test": "jest",
     "test:coverage": "npm test -- --coverage",

diff --git a/src/cli.ts b/src/cli.ts
@@ -55,6 +55,7 @@ async function main(): Promise<void> {
     const options: Options = {
       token: 'token_123',
       repository: 'MishaKav/jest-coverage-comment',
+      serverUrl: 'https://github.com',
       commit: '05953710b21d222efa4f4535424a7af367be5a57',
       watermark: '<!-- Jest Coverage Comment: 1 -->\n',
       title: 'Jest Coverage Comment',

diff --git a/src/coverage.ts b/src/coverage.ts
@@ -129,13 +129,21 @@ function toFileNameTd(
   indent = false,
   options: Options
 ): string {
-  const relative = line.file.replace(options.prefix, '')
-  const href = `https://github.com/${options.repository}/blob/${options.commit}/${options.coveragePathPrefix}${relative}`
+  const {
+    serverUrl = 'https://github.com',
+    repository,
+    prefix,
+    commit,
+    coveragePathPrefix,
+    removeLinksToFiles,
+  } = options
+  const relative = line.file.replace(prefix, '')
+  const href = `${serverUrl}/${repository}/blob/${commit}/${coveragePathPrefix}${relative}`
   const parts = relative.split('/')
   const last = parts[parts.length - 1]
   const space = indent ? '&nbsp; &nbsp;' : ''
 
-  return options.removeLinksToFiles
+  return removeLinksToFiles
     ? `${space}${last}`
     : `${space}<a href="${href}">${last}</a>`
 }
@@ -148,13 +156,20 @@ function toMissingTd(line: CoverageLine, options: Options): string {
 
   return line.uncoveredLines
     .map((range) => {
+      const {
+        serverUrl = 'https://github.com',
+        repository,
+        commit,
+        coveragePathPrefix,
+        removeLinksToLines,
+      } = options
       const [start, end = start] = range.split('-')
       const fragment = start === end ? `L${start}` : `L${start}-L${end}`
       const relative = line.file
-      const href = `https://github.com/${options.repository}/blob/${options.commit}/${options.coveragePathPrefix}${relative}#${fragment}`
+      const href = `${serverUrl}/${repository}/blob/${commit}/${coveragePathPrefix}${relative}#${fragment}`
       const text = start === end ? start : `${start}&ndash;${end}`
 
-      return options.removeLinksToLines ? text : `<a href="${href}">${text}</a>`
+      return removeLinksToLines ? text : `<a href="${href}">${text}</a>`
     })
     .join(', ')
 }

diff --git a/src/index.ts b/src/index.ts
@@ -12,6 +12,7 @@ import { getMultipleJunitReport } from './multi-junit-files'
 async function main(): Promise<void> {
   try {
     const token = core.getInput('github-token', { required: true })
+
     const title = core.getInput('title', { required: false })
     const badgeTitle = core.getInput('badge-title', { required: false })
     const hideSummary = core.getBooleanInput('hide-summary', {
@@ -59,6 +60,9 @@ async function main(): Promise<void> {
       required: false,
     })
 
+    const serverUrl = context.serverUrl || 'https://github.com'
+    core.info(`Uses Github URL: ${serverUrl}`)
+
     const { repo, owner } = context.repo
     const { eventName, payload } = context
     const watermarkUniqueId = uniqueIdForComment
@@ -70,6 +74,7 @@ async function main(): Promise<void> {
     const options: Options = {
       token,
       repository: `${owner}/${repo}`,
+      serverUrl,
       prefix: `${process.env.GITHUB_WORKSPACE}/`,
       commit: '',
       watermark,

diff --git a/src/summary.ts b/src/summary.ts
@@ -40,10 +40,16 @@ export function summaryToMarkdown(
   options: Options,
   withoutHeader = false
 ): string {
-  const { repository, commit, badgeTitle } = options
+  const {
+    repository,
+    commit,
+    badgeTitle,
+    serverUrl = 'https://github.com',
+    summaryTitle,
+  } = options
   const { statements, functions, branches } = summary
   const { color, coverage } = getCoverage(summary)
-  const readmeHref = `https://github.com/${repository}/blob/${commit}/README.md`
+  const readmeHref = `${serverUrl}/${repository}/blob/${commit}/README.md`
   const badge = `<a href="${readmeHref}"><img alt="${badgeTitle}: ${coverage}%" src="https://img.shields.io/badge/${badgeTitle}-${coverage}%25-${color}.svg" /></a><br/>`
 
   const tableHeader =
@@ -60,8 +66,8 @@ export function summaryToMarkdown(
     return tableBody
   }
 
-  if (options.summaryTitle) {
-    return `## ${options.summaryTitle}\n\n${table}`
+  if (summaryTitle) {
+    return `## ${summaryTitle}\n\n${table}`
   }
 
   return table

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -1,6 +1,7 @@
 export interface Options {
   token: string
   repository: string
+  serverUrl: string
   summaryFile: string
   summaryTitle?: string
   badgeTitle: string