Merge pull request github#7872 from bmuskalla/fixCoverageCollection

Collect framework coverage on demand

Author: Benjamin Muskalla

.github/workflows/csv-coverage-metrics.yml

@@ -0,0 +1,43 @@
+name: "Publish framework coverage as metrics"
+
+on:
+  schedule:
+    - cron: '5 0 * * *'
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/csv-coverage-metrics.yml"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Setup CodeQL
+        uses: ./.github/actions/fetch-codeql
+      - name: Create empty database
+        run: |
+          DATABASE="${{ runner.temp }}/java-database"
+          PROJECT="${{ runner.temp }}/java-project"
+          mkdir -p "$PROJECT/src/tmp/empty"
+          echo "class Empty {}" >> "$PROJECT/src/tmp/empty/Empty.java"
+          codeql database create "$DATABASE" --language=java --source-root="$PROJECT" --command 'javac src/tmp/empty/Empty.java'
+      - name: Capture coverage information
+        run: |
+          DATABASE="${{ runner.temp }}/java-database"
+          codeql database analyze --format=sarif-latest --output=metrics.sarif -- "$DATABASE" ./java/ql/src/Metrics/Summaries/FrameworkCoverage.ql
+      - uses: actions/upload-artifact@v2
+        with:
+          name: metrics.sarif
+          path: metrics.sarif
+          retention-days: 20
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: metrics.sarif

java/ql/src/Diagnostics/CoverageDiagnostics.ql renamed to java/ql/src/Metrics/Summaries/FrameworkCoverage.ql

@@ -1,8 +1,9 @@
 /**
- * @name Diagnostics for framework coverage
- * @description Expose diagnostics for the number of API endpoints covered by CSV models.
- * @kind diagnostic
- * @id java/diagnostics/framework-coverage
+ * @id java/summary/framework-coverage
+ * @name Metrics of framework coverage
+ * @description Expose metrics for the number of API endpoints covered by CSV models.
+ * @kind metric
+ * @tags summary
  */
 
 import java

misc/suite-helpers/code-scanning-selectors.yml

@@ -24,4 +24,6 @@
 - exclude:
     deprecated: //
 - exclude:
-    query path: /^experimental\/.*/
+    query path:
+      - /^experimental\/.*/
+      - Metrics/Summaries/FrameworkCoverage.ql

misc/suite-helpers/lgtm-selectors.yml

@@ -22,4 +22,6 @@
 - exclude:
     deprecated: //
 - exclude:
-    query path: /^experimental\/.*/
+    query path:
+      - /^experimental\/.*/
+      - Metrics/Summaries/FrameworkCoverage.ql

misc/suite-helpers/security-and-quality-selectors.yml

@@ -25,5 +25,7 @@
 - exclude:
     deprecated: //
 - exclude:
-    query path: /^experimental\/.*/
+    query path:
+      - /^experimental\/.*/
+      - Metrics/Summaries/FrameworkCoverage.ql
 

misc/suite-helpers/security-extended-selectors.yml

@@ -30,5 +30,6 @@
 - exclude:
     deprecated: //
 - exclude:
-    query path: /^experimental\/.*/
-
+    query path:
+      - /^experimental\/.*/
+      - Metrics/Summaries/FrameworkCoverage.ql