chore(ci): report coverage (#64)

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

.github/workflows/ruby.yml

@@ -14,6 +14,14 @@ on:
 # see https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
 permissions: {}
 
+concurrency:
+  group: '${{ github.workflow }}-${{ github.ref }}'
+  cancel-in-progress: true
+
+env:
+  COVERAGE_DIR: coverage
+  TESTS_COVERAGE_ARTIFACT: coverage
+
 jobs:
   test:
     name: Ruby ${{ matrix.ruby }}
@@ -39,3 +47,34 @@ jobs:
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake
+    - name: Artifact coverage
+      if: ${{ ! cancelled() }}
+      # see https://github.com/actions/upload-artifact
+      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+      with:
+        name: '${{ env.TESTS_COVERAGE_ARTIFACT }}_ruby${{ matrix.ruby }}'
+        path: ${{ env.COVERAGE_DIR }}
+        if-no-files-found: error
+        retention-days: 7
+  report-coverage:
+    name: Publish test coverage
+    needs: [ "test" ]
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: fetch test artifacts
+        # see https://github.com/actions/download-artifact
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          pattern: '${{ env.TESTS_COVERAGE_ARTIFACT }}_*'
+          merge-multiple: false
+      - name: Run codacy-coverage-reporter
+        env:
+          CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        ## see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-using-secrets
+        if: ${{ env.CODACY_PROJECT_TOKEN != '' }}
+        # see https://github.com/codacy/codacy-coverage-reporter-action
+        uses: codacy/codacy-coverage-reporter-action@89d6c85cfafaec52c72b6c5e8b2878d33104c699 # v1
+        with:
+          project-token: ${{ env.CODACY_PROJECT_TOKEN }}
+          coverage-reports: '${{ env.TESTS_COVERAGE_ARTIFACT }}_*/coverage.xml'

.simplecov

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+require 'simplecov-cobertura'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::CoberturaFormatter
+]
+
 # Copied from https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/.simplecov
 # Licensed under MIT - https://github.com/cucumber/aruba/blob/3b1a6cea6e3ba55370c3396eef0a955aeb40f287/LICENSE
 

README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://img.shields.io/gem/v/cyclonedx-ruby?logo=rubygems&logoColor=white)](https://rubygems.org/gems/cyclonedx-ruby)
 [![CT status](https://img.shields.io/github/actions/workflow/status/CycloneDX/cyclonedx-ruby-gem/ruby.yml?branch=master&logo=GitHub&logoColor=white)](https://github.com/CycloneDX/cyclonedx-ruby-gem/actions/workflows/ruby.yml?query=branch%3Amaster)
+[![shield_coverage]][link_codacy]
 [![License](https://img.shields.io/github/license/CycloneDX/cyclonedx-ruby-gem?logo=open%20source%20initiative&logoColor=white)][license_file]    
 [![Website](https://img.shields.io/badge/https://-cyclonedx.org-blue.svg)](https://cyclonedx.org/)
 [![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack&labelColor=393939)](https://cyclonedx.org/slack/invite)
@@ -64,3 +65,6 @@ CycloneDX Ruby Gem is Copyright (c) OWASP Foundation. All Rights Reserved.
 Permission to modify and redistribute is granted under the terms of the Apache 2.0 license. See the [LICENSE][license_file] file for the full license.
 
 [license_file]: https://github.com/CycloneDX/cyclonedx-ruby-gem/blob/master/LICENSE.txt
+
+[shield_coverage]: https://img.shields.io/codacy/coverage/de2bfb229a81439b8974b5e3d0af4e1a?logo=Codacy&logoColor=white "test coverage"
+[link_codacy]: https://app.codacy.com/gh/CycloneDX/cyclonedx-ruby-gem

cyclonedx-ruby.gemspec

@@ -64,6 +64,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'cucumber', '>= 9.2.0', '< 11'
   spec.add_development_dependency 'aruba', '~> 2.2'
   spec.add_development_dependency 'simplecov', '~> 0.22.0'
+  spec.add_development_dependency 'simplecov-cobertura'
   spec.add_development_dependency 'rubocop',  '~> 1.54'
   spec.add_development_dependency 'stone_checksums',  '~> 1.0', '>= 1.0.3'
 end

spec/spec_helper.rb

@@ -18,8 +18,8 @@
   require 'simplecov'
   SimpleCov.command_name 'RSpec'
 
-  # Run simplecov by default
-  SimpleCov.start unless ENV.key? 'ARUBA_NO_COVERAGE'
+  aruba_no_coverage = ENV.fetch('ARUBA_NO_COVERAGE', 'false')
+  SimpleCov.start unless aruba_no_coverage.casecmp?('true')
 end
 # End copied from Aruba