Merge pull request #45 from cicirello/custom-labels

Added option to specify custom left-side badge labels

Author: cicirello

.github/workflows/build.yml

@@ -89,6 +89,27 @@ jobs:
         echo "coverage = ${{ steps.integration4.outputs.coverage }}"
         echo "branch coverage = ${{ steps.integration4.outputs.branches }}"
 
+    - name: Integration test with custom labels
+      id: integration5
+      uses: ./
+      with:
+        jacoco-csv-file: tests/jacoco.csv
+        badges-directory: tests/badges
+        generate-branches-badge: true
+        generate-coverage-endpoint: true
+        generate-branches-endpoint: true
+        coverage-badge-filename: customCoverage.svg
+        branches-badge-filename: customBranches.svg
+        coverage-endpoint-filename: customCoverage.json
+        branches-endpoint-filename: customBranches.json
+        coverage-label: custom coverage label one
+        branches-label: custom coverage label two
+
+    - name: Log integration test outputs with a single jacoco.csv
+      run: |
+        echo "coverage = ${{ steps.integration5.outputs.coverage }}"
+        echo "branch coverage = ${{ steps.integration5.outputs.branches }}"
+
     - name: Verify integration test results
       run: python3 -u -m unittest tests/integration.py
 

CHANGELOG.md

@@ -9,11 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 ### Changed
-* Left-side text width and position calculated rather than hard-coded to
-  width of "coverage" and "branches".
-* Changed Dockerfile to pull base image from GitHub Container Registry, assuming
-  within GitHub Actions likely faster to pull from GitHub rather than Docker Hub.
-* Repository reorganized to move Python source code to a new src directory.
 
 ### Deprecated
 
@@ -24,6 +19,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### CI/CD
 
 
+## [2.6.0] - 2022-02-17
+
+### Added
+* Option to specify custom labels for the left side of the badges controlled
+  by the new inputs `coverage-label` and `branches-label`.
+
+### Changed
+* Left-side text width and position calculated rather than hard-coded to
+  width of "coverage" and "branches".
+* Changed Dockerfile to pull base image from GitHub Container Registry, assuming
+  within GitHub Actions likely faster to pull from GitHub rather than Docker Hub.
+* Repository reorganized to move Python source code to a new src directory.
+
+
 ## [2.5.0] - 2021-11-11
 
 ### Added

README.md

@@ -351,6 +351,16 @@ created within the `badges-directory`
 directory. __The action doesn't commit the JSON file. You will 
 need to have additional steps in your workflow to do that.__
 
+### `coverage-label`
+
+This input is the text for the label on the left side of the coverage badge, which
+defaults to `coverage`.
+
+### `branches-label`
+
+This input is the text for the label on the left side of the branches coverage badge, which
+defaults to `branches`.
+
 ### `colors`
 
 This input can be used to change the colors used for the badges.
@@ -649,6 +659,8 @@ what these inputs do.
         branches-endpoint-filename: branches.json
         generate-summary: false
         summary-filename: coverage-summary.json
+        coverage-label: coverage
+        branches-label: branches
         colors: '#4c1 #97ca00 #a4a61d #dfb317 #fe7d37 #e05d44'
         intervals: 100 90 80 70 60 0
         on-missing-report: fail

action.yml

@@ -56,6 +56,14 @@ inputs:
     description: 'Controls whether or not to generate the branches coverage badge.'
     required: false
     default: false
+  coverage-label:
+    description: 'Text for the left-side of the coverage badge.'
+    required: false
+    default: coverage
+  branches-label:
+    description: 'Text for the left-side of the branches coverage badge.'
+    required: false
+    default: branches
   on-missing-report:
     description: 'Controls what happens if one or more jacoco.csv files do not exist.'
     required: false
@@ -136,3 +144,5 @@ runs:
     - ${{ inputs.branches-endpoint-filename }}
     - ${{ inputs.generate-summary }}
     - ${{ inputs.summary-filename }}
+    - ${{ inputs.coverage-label }}
+    - ${{ inputs.branches-label }}

src/JacocoBadgeGenerator.py

@@ -325,7 +325,7 @@ def getPriorCoverage(badgeFilename, whichBadge) :
 
     Keyword arguments:
     badgeFilename - the filename with path
-    whichBadge - this input should be one of 'coverage' or 'branches'
+    whichBadge - the badge label such as 'coverage' or 'branches' or some custom label
     """
     if not os.path.isfile(badgeFilename) :
         return -1
@@ -347,7 +347,7 @@ def getPriorCoverageFromEndpoint(jsonFilename, whichBadge) :
 
     Keyword arguments:
     jsonFilename - the filename with path
-    whichBadge - this input should be one of 'coverage' or 'branches'
+    whichBadge - the badge label such as 'coverage' or 'branches' or some custom label
     """
     if not os.path.isfile(jsonFilename) :
         return -1
@@ -371,7 +371,7 @@ def coverageDecreased(coverage, badgeFilename, whichBadge) :
     Keyword arguments:
     coverage - The coverage in interval 0.0 to 1.0
     badgeFilename - the filename with path
-    whichBadge - this input should be one of 'coverage' or 'branches'
+    whichBadge - the badge label
     """
     previous = getPriorCoverage(badgeFilename, whichBadge)
     # Badge only records 1 decimal place, and thus need
@@ -384,8 +384,7 @@ def coverageDecreased(coverage, badgeFilename, whichBadge) :
     # from coverage data at this point.
     new = coverage * 1000
     if new < old :
-        s = "Branches coverage" if whichBadge == "branches" else "Coverage"
-        print(s, "decreased from", coverageTruncatedToString(previous)[0], "to", coverageTruncatedToString(coverage)[0])
+        print(whichBadge, "decreased from", coverageTruncatedToString(previous)[0], "to", coverageTruncatedToString(coverage)[0])
         return True
     return False
 
@@ -396,7 +395,7 @@ def coverageDecreasedEndpoint(coverage, jsonFilename, whichBadge) :
     Keyword arguments:
     coverage - The coverage in interval 0.0 to 1.0
     jsonFilename - the filename with path
-    whichBadge - this input should be one of 'coverage' or 'branches'
+    whichBadge - the badge label
     """
     previous = getPriorCoverageFromEndpoint(jsonFilename, whichBadge)
     # Badge only records 1 decimal place, and thus need
@@ -409,8 +408,7 @@ def coverageDecreasedEndpoint(coverage, jsonFilename, whichBadge) :
     # from coverage data at this point.
     new = coverage * 1000
     if new < old :
-        s = "Branches coverage" if whichBadge == "branches" else "Coverage"
-        print(s, "decreased from", coverageTruncatedToString(previous)[0], "to", coverageTruncatedToString(coverage)[0])
+        print(whichBadge, "decreased from", coverageTruncatedToString(previous)[0], "to", coverageTruncatedToString(coverage)[0])
         return True
     return False
 
@@ -482,6 +480,8 @@ def coverageDictionary(cov, branches) :
     branchesJSON = sys.argv[17]
     generateSummary = sys.argv[18].lower() == "true"
     summaryFilename = sys.argv[19]
+    coverageLabel = sys.argv[20]
+    branchesLabel = sys.argv[21]
 
     if onMissingReport not in {"fail", "quiet", "badges"} :
         print("ERROR: Invalid value for on-missing-report.")
@@ -520,16 +520,16 @@ def coverageDictionary(cov, branches) :
                 print("Failing the workflow run.")
                 sys.exit(1)
         else : # Otherwise use the prior coverages as stored in badges / JSON.
-            if failOnCoverageDecrease and generateCoverageBadge and coverageDecreased(cov, coverageBadgeWithPath, "coverage") :
+            if failOnCoverageDecrease and generateCoverageBadge and coverageDecreased(cov, coverageBadgeWithPath, coverageLabel) :
                 print("Failing the workflow run.")
                 sys.exit(1)
-            if failOnBranchesDecrease and generateBranchesBadge and coverageDecreased(branches, branchesBadgeWithPath, "branches") :
+            if failOnBranchesDecrease and generateBranchesBadge and coverageDecreased(branches, branchesBadgeWithPath, branchesLabel) :
                 print("Failing the workflow run.")
                 sys.exit(1)
-            if failOnCoverageDecrease and generateCoverageJSON and coverageDecreasedEndpoint(cov, coverageJSONWithPath, "coverage") :
+            if failOnCoverageDecrease and generateCoverageJSON and coverageDecreasedEndpoint(cov, coverageJSONWithPath, coverageLabel) :
                 print("Failing the workflow run.")
                 sys.exit(1)
-            if failOnBranchesDecrease and generateBranchesJSON and coverageDecreasedEndpoint(branches, branchesJSONWithPath, "branches") :
+            if failOnBranchesDecrease and generateBranchesJSON and coverageDecreasedEndpoint(branches, branchesJSONWithPath, branchesLabel) :
                 print("Failing the workflow run.")
                 sys.exit(1)
 
@@ -540,19 +540,19 @@ def coverageDictionary(cov, branches) :
             covStr, color = badgeCoverageStringColorPair(cov, colorCutoffs, colors)
             if generateCoverageBadge :
                 with open(coverageBadgeWithPath, "w") as badge :
-                    badge.write(generateBadge(covStr, color))
+                    badge.write(generateBadge(covStr, color, coverageLabel))
             if generateCoverageJSON :
                 with open(coverageJSONWithPath, "w") as endpoint :
-                    json.dump(generateDictionaryForEndpoint(covStr, color, "coverage"), endpoint, sort_keys=True)
+                    json.dump(generateDictionaryForEndpoint(covStr, color, coverageLabel), endpoint, sort_keys=True)
 
         if generateBranchesBadge or generateBranchesJSON :
             covStr, color = badgeCoverageStringColorPair(branches, colorCutoffs, colors)
             if generateBranchesBadge :
                 with open(branchesBadgeWithPath, "w") as badge :
-                    badge.write(generateBadge(covStr, color, "branches"))
+                    badge.write(generateBadge(covStr, color, branchesLabel))
             if generateBranchesJSON :
                 with open(branchesJSONWithPath, "w") as endpoint :
-                    json.dump(generateDictionaryForEndpoint(covStr, color, "branches"), endpoint, sort_keys=True)
+                    json.dump(generateDictionaryForEndpoint(covStr, color, branchesLabel), endpoint, sort_keys=True)
 
         if generateSummary :
             with open(summaryFilenameWithPath, "w") as summaryFile :

tests/custom1.json

@@ -0,0 +1 @@
+{"color": "#4c1", "label": "custom coverage label one", "message": "100%", "schemaVersion": 1}

tests/custom1.svg

@@ -0,0 +1 @@
+{"color": "#97ca00", "label": "custom coverage label two", "message": "90%", "schemaVersion": 1}

tests/custom2.json

@@ -34,6 +34,26 @@
 
 class IntegrationTest(unittest.TestCase) :
 
+    def testIntegrationCustomCoverageLabel(self) :
+        with open("tests/custom1.svg","r") as expected :
+            with open("tests/badges/customCoverage.svg","r") as generated :
+                self.assertEqual(expected.read(), generated.read())
+
+    def testIntegrationCustomBranchesLabel(self) :
+        with open("tests/custom2.svg","r") as expected :
+            with open("tests/badges/customBranches.svg","r") as generated :
+                self.assertEqual(expected.read(), generated.read())
+
+    def testIntegrationCustomCoverageLabelJSON(self) :
+        with open("tests/custom1.json","r") as expected :
+            with open("tests/badges/customCoverage.json","r") as generated :
+                self.assertEqual(expected.read(), generated.read())
+
+    def testIntegrationCustomBranchesLabelJSON(self) :
+        with open("tests/custom2.json","r") as expected :
+            with open("tests/badges/customBranches.json","r") as generated :
+                self.assertEqual(expected.read(), generated.read())
+                
     def testIntegrationInstructionsBadge(self) :
         with open("tests/100.svg","r") as expected :
             with open("tests/badges/jacoco.svg","r") as generated :