feat(jenkins): add metric parameter support for apiv4 coverage plugin

The apiv4 format now supports a 'metric' query parameter allowing users
to choose which coverage metric to display from the new Jenkins
coverage plugin (io.jenkins.plugins.coverage).

Supported metrics: line (default), branch, instruction, method, module, file

Also updated the description to mention the new Coverage Plugin.

Closes #11689

Author: ashif323

services/jenkins/jenkins-coverage.service.js

@@ -1,12 +1,16 @@
 import Joi from 'joi'
 import { pathParam, queryParam } from '../index.js'
 import { coveragePercentage } from '../color-formatters.js'
+import { optionalUrl } from '../validators.js'
 import JenkinsBase from './jenkins-base.js'
-import {
-  buildTreeParamQueryString,
-  buildUrl,
-  queryParamSchema,
-} from './jenkins-common.js'
+import { buildTreeParamQueryString, buildUrl } from './jenkins-common.js'
+
+const queryParamSchema = Joi.object({
+  jobUrl: optionalUrl,
+  metric: Joi.string()
+    .valid('line', 'branch', 'instruction', 'method', 'module', 'file')
+    .default('line'),
+}).required()
 
 const formatMap = {
   jacoco: {
@@ -72,17 +76,30 @@ const formatMap = {
       projectStatistics: Joi.object({
         line: Joi.string()
           .pattern(/\d+\.\d+%/)
-          .required(),
+          .optional(),
+        branch: Joi.string()
+          .pattern(/\d+\.\d+%/)
+          .optional(),
+        instruction: Joi.string()
+          .pattern(/\d+\.\d+%/)
+          .optional(),
+        method: Joi.string()
+          .pattern(/\d+\.\d+%/)
+          .optional(),
+        module: Joi.string()
+          .pattern(/\d+\.\d+%/)
+          .optional(),
+        file: Joi.string()
+          .pattern(/\d+\.\d+%/)
+          .optional(),
       }).required(),
     }).required(),
-    treeQueryParam: 'projectStatistics[line]',
-    transform: json => {
-      const lineCoverageStr = json.projectStatistics.line
-      const lineCoverage = lineCoverageStr.substring(
-        0,
-        lineCoverageStr.length - 1,
-      )
-      return { coverage: Number.parseFloat(lineCoverage) }
+    treeQueryParam:
+      'projectStatistics[line,branch,instruction,method,module,file]',
+    transform: (json, metric) => {
+      const raw = json.projectStatistics[metric]
+      if (!raw) throw new Error(`metric '${metric}' not found`)
+      return { coverage: Number.parseFloat(raw) }
     },
     pluginSpecificPath: 'coverage',
   },
@@ -95,6 +112,7 @@ We support coverage metrics from a variety of Jenkins plugins:
   <li><a href="https://plugins.jenkins.io/jacoco">JaCoCo</a></li>
   <li><a href="https://plugins.jenkins.io/cobertura">Cobertura</a></li>
   <li>Any plugin which integrates with version 1 or 4+ of the <a href="https://plugins.jenkins.io/code-coverage-api">Code Coverage API</a> (e.g. llvm-cov, Cobertura 1.13+, etc.)</li>
+  <li>The new <a href="https://plugins.jenkins.io/coverage">Coverage Plugin</a> (use format <code>apiv4</code> with optional <code>metric</code> parameter)</li>
 </ul>
 `
 
@@ -124,6 +142,23 @@ export default class JenkinsCoverage extends JenkinsBase {
               'https://jenkins-2.sse.uni-hildesheim.de/job/Teaching_SubmissionCheck',
             required: true,
           }),
+          queryParam({
+            name: 'metric',
+            example: 'line',
+            description:
+              'Coverage metric to display (only for apiv4 format). One of: line, branch, instruction, method, module, file. Defaults to line.',
+            schema: {
+              type: 'string',
+              enum: [
+                'line',
+                'branch',
+                'instruction',
+                'method',
+                'module',
+                'file',
+              ],
+            },
+          }),
         ],
       },
     },
@@ -138,7 +173,7 @@ export default class JenkinsCoverage extends JenkinsBase {
     }
   }
 
-  async handle({ format }, { jobUrl }) {
+  async handle({ format }, { jobUrl, metric = 'line' }) {
     const { schema, transform, treeQueryParam, pluginSpecificPath } =
       formatMap[format]
     const json = await this.fetch({
@@ -149,7 +184,7 @@ export default class JenkinsCoverage extends JenkinsBase {
         404: 'job or coverage not found',
       },
     })
-    const { coverage } = transform(json)
+    const { coverage } = transform(json, metric)
     return this.constructor.render({ coverage })
   }
 }

services/jenkins/jenkins-coverage.tester.js

@@ -103,3 +103,37 @@ t.create('code coverage API v4+: job found')
 t.create('code coverage API v4+: job not found')
   .get('/apiv4.json?jobUrl=https://jenkins.mm12.xyz/jenkins/job/does-not-exist')
   .expectBadge({ label: 'coverage', message: 'job or coverage not found' })
+
+const coverageApiV4Response = {
+  _class: 'io.jenkins.plugins.coverage.metrics.restapi.CoverageApi',
+  projectStatistics: {
+    branch: '31.39%',
+    file: '53.27%',
+    instruction: '70.69%',
+    line: '70.69%',
+    method: '65.36%',
+    module: '100.00%',
+  },
+}
+
+t.create('code coverage API v4+: line coverage (default metric)')
+  .get('/apiv4.json?jobUrl=https://jenkins.example.com/job/myproject')
+  .intercept(nock =>
+    nock('https://jenkins.example.com/job/myproject/lastCompletedBuild')
+      .get('/coverage/api/json')
+      .query(true)
+      .reply(200, coverageApiV4Response),
+  )
+  .expectBadge({ label: 'coverage', message: '71%' })
+
+t.create('code coverage API v4+: branch coverage metric')
+  .get(
+    '/apiv4.json?jobUrl=https://jenkins.example.com/job/myproject&metric=branch',
+  )
+  .intercept(nock =>
+    nock('https://jenkins.example.com/job/myproject/lastCompletedBuild')
+      .get('/coverage/api/json')
+      .query(true)
+      .reply(200, coverageApiV4Response),
+  )
+  .expectBadge({ label: 'coverage', message: '31%' })