new parsing & name

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: 'Python Coverage Reporter Build'
+name: 'Get Cover Build'
 on: ['pull_request']
 
 jobs:

README.md

@@ -1,12 +1,14 @@
-# Python Cov: Python Coverage Reporter GitHub Action
+# Get Cover: The Esential Coverage Reporter GitHub Action
 
-> 🐍 parse and publish coverage xml to a PR, enforce coverage rate on new & modified files
+> ☂️ parse and publish coverage xml to a PR, enforce coverage rate on new & modified files
 
 ## Usage
 
 Create a new workflow `.yml` file in the `.github/workflows/` directory.
 
-You can create a coverage report using `$ pytest --cov-report xml:path/to/coverage.xml`
+You can create a coverage report using python:
+ - pytest `$ pytest --cov-report xml:path/to/coverage.xml`
+ - coverage `$ coverage xml path/to/coverage.xml`
 
 ### Minimal Configuration
 ```yml
@@ -20,7 +22,7 @@ jobs:
     coverage:
         runs-on: ubuntu-latest
         steps:
-          - name: Python Cov 
+          - name: Get Cover 
             uses: orgoro/coverage@v2
             with:
                 coverageFile: path/to/coverage.xml

action.yml

@@ -1,5 +1,5 @@
-name: 'Python Cov'
-description: 'Publish python 🐍 coverage report to a PR & enforce coverage on new & modified files'
+name: 'Get Cover'
+description: 'Publish coverage report to a PR & enforce coverage on new & modified files'
 author: 'orgoro'
 inputs:
   coverageFile: 

coverage-v2.xml

@@ -0,0 +1,9 @@
+<sources>
+	<source>src</source>
+</sources>
+<coverage version="6.0" timestamp="1633536330812" line-rate="0.94" lines-covered="940" lines-valid="1000" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
+   <class branch-rate="0" complexity="0" filename="client.ts" line-rate="0.9" name="client.ts">
+     <class branch-rate="0" complexity="0" filename="compareCommits.ts" line-rate="0.88" name="compareCommits.ts">  
+       <class branch-rate="0" complexity="0" filename="coverage.ts" line-rate="0.99" name="coverage.ts">  
+     <class name="main.ts" filename="main.ts" complexity="0" line-rate="0" branch-rate="0">  
+   <class branch-rate="0" complexity="0" filename="messagePr.ts" line-rate="0.88" name="messagePr.ts">  

src/coverage.test.ts

@@ -1,10 +1,25 @@
-import {parseFilesCoverage, parseSource} from './coverage'
+import {parseFilesCoverage, parseSource, parseAverageCoverage} from './coverage'
 import fs from 'fs'
 import {parse} from 'path/posix'
 
+const coverageFilePathV1 = './coverage.xml'
+const coverageFilePathV2 = './coverage-v2.xml'
+
 describe('tests', () => {
+  it.each([coverageFilePathV1, coverageFilePathV2])('parses average coverage', coverageFilePath => {
+    const report = fs.readFileSync(coverageFilePath, 'utf8')
+    const parsed = parseAverageCoverage(report, 0.8)
+    console.log(parsed)
+    expect(parsed).toBeDefined()
+    const {ratio, covered, total, pass, threshold} = parsed
+    expect(total).toBe(1000)
+    expect(covered).toBe(940)
+    expect(ratio).toBe(0.94)
+    expect(threshold).toBe(0.8)
+    expect(pass).toBeTruthy()
+  })
   it('parses coverage as expected when float', () => {
-    const report = fs.readFileSync('./coverage.xml', 'utf8')
+    const report = fs.readFileSync(coverageFilePathV1, 'utf8')
     const parsed = parseFilesCoverage(report, 'src', ['src/coverage.ts'], 0.8)
     expect(parsed).toBeDefined()
     expect(parsed![0]).toBeDefined()
@@ -13,7 +28,7 @@ describe('tests', () => {
   })
 
   it('parses coverage as expected when zero', () => {
-    const report = fs.readFileSync('./coverage.xml', 'utf8')
+    const report = fs.readFileSync(coverageFilePathV1, 'utf8')
     const parsed = parseFilesCoverage(report, 'src', ['src/main.ts'], 0.01)
     expect(parsed).toBeDefined()
     expect(parsed![0]).toBeDefined()
@@ -22,7 +37,7 @@ describe('tests', () => {
   })
 
   it('parses source', () => {
-    const report = fs.readFileSync('./coverage.xml', 'utf8')
+    const report = fs.readFileSync(coverageFilePathV1, 'utf8')
     const parsed = parseSource(report)
     expect(parsed).toBe('src')
   })

src/coverage.ts

@@ -64,20 +64,30 @@ export function parseSource(report: string): string {
     return 'unknown'
   }
 }
+function setFailed(): AverageCoverage {
+  core.setFailed('❌ could not parse total coverage - make sure xml report is valid')
+  return {ratio: -1, covered: -1, threshold: -1, total: -1, pass: false}
+}
 
-function parseAverageCoverage(report: string, threshold: number): AverageCoverage {
-  const regex = new RegExp(
-    `.*<coverage.*lines-valid="(?<total>[\\d\\.]+)".*lines-covered="(?<covered>[\\d\\.]+)".*line-rate="(?<ratio>[\\d\\.]+)"`
-  )
-  const match = report.match(regex)
+export function parseAverageCoverage(report: string, threshold: number): AverageCoverage {
+  const lineRegex = new RegExp(`.*<coverage.*>`)
+  const totalRegex = new RegExp(`.*lines-valid="(?<total>[\\d\\.]+)".*`)
+  const coveredRegex = new RegExp(`.*lines-covered="(?<covered>[\\d\\.]+)".*`)
+  const ratioRegex = new RegExp(`.*line-rate="(?<ratio>[\\d\\.]+).*"`)
 
-  if (match?.groups) {
-    const ratio = parseFloat(match.groups['ratio'])
-    const covered = parseFloat(match.groups['covered'])
-    const total = parseFloat(match.groups['total'])
-    return {ratio, covered, threshold, total, pass: ratio > threshold}
-  } else {
-    core.setFailed('❌ could not parse total coverage - make sure xml report is valid')
-    return {ratio: -1, covered: -1, threshold: -1, total: -1, pass: false}
+  const match = report.match(lineRegex)
+  let result = null
+  if (match?.length === 1) {
+    const totalMatch = match[0].match(totalRegex)
+    const coveredMatch = match[0].match(coveredRegex)
+    const ratioMatch = match[0].match(ratioRegex)
+
+    if (totalMatch?.groups && coveredMatch?.groups && ratioMatch?.groups) {
+      const total = parseFloat(totalMatch.groups['total'])
+      const covered = parseFloat(coveredMatch.groups['covered'])
+      const ratio = parseFloat(ratioMatch.groups['ratio'])
+      result = {ratio, covered, threshold, total, pass: ratio > threshold}
+    }
   }
+  return result ?? setFailed()
 }

src/scorePr.ts

@@ -107,8 +107,8 @@ export function scorePr(filesCover: FilesCoverage): boolean {
     core.info('No covered modified files in this PR ')
   }
   const sha = context.payload.pull_request?.head.sha.slice(0, 7)
-  const action = '[action](https://github.com/marketplace/actions/python-cov)'
-  message = message.concat(`\n\n\n> **updated for commit: \`${sha}\` by ${action}🐍**`)
+  const action = '[action](https://github.com/marketplace/actions/get-cover)'
+  message = message.concat(`\n\n\n> **updated for commit: \`${sha}\` by ${action}🛡**`)
   message = `\n> current status: ${passOverall ? '✅' : '❌'}`.concat(message)
   publishMessage(context.issue.number, message)
   core.endGroup()