Add [GithubCheckRuns] service

services/github/github-check-runs.service.js

@@ -0,0 +1,131 @@
+import Joi from 'joi'
+import countBy from 'lodash.countby'
+import { nonNegativeInteger } from '../validators.js'
+import { renderBuildStatusBadge } from '../build-status.js'
+import { GithubAuthV3Service } from './github-auth-service.js'
+import { documentation, errorMessagesFor } from './github-helpers.js'
+
+const schema = Joi.object({
+  total_count: nonNegativeInteger,
+  check_runs: Joi.array()
+    .items(
+      Joi.object({
+        status: Joi.equal('completed', 'in_progress', 'queued').required(),
+        conclusion: Joi.equal(
+          'action_required',
+          'cancelled',
+          'failure',
+          'neutral',
+          'skipped',
+          'success',
+          'timed_out',
+          null
+        ).required(),
+      })
+    )
+    .default([]),
+}).required()
+
+export default class GithubCheckRuns extends GithubAuthV3Service {
+  static category = 'build'
+  static route = {
+    base: 'github/checks-runs',
+    pattern: ':user/:repo/:ref+',
+  }
+
+  static examples = [
+    {
+      title: 'GitHub branch checks runs',
+      namedParams: {
+        user: 'badges',
+        repo: 'shields',
+        ref: 'master',
+      },
+      staticPreview: renderBuildStatusBadge({
+        status: 'success',
+      }),
+      keywords: ['status'],
+      documentation,
+    },
+    {
+      title: 'GitHub commit checks runs',
+      namedParams: {
+        user: 'badges',
+        repo: 'shields',
+        ref: '91b108d4b7359b2f8794a4614c11cb1157dc9fff',
+      },
+      staticPreview: renderBuildStatusBadge({
+        status: 'success',
+      }),
+      keywords: ['status'],
+      documentation,
+    },
+    {
+      title: 'GitHub tag checks runs',
+      namedParams: {
+        user: 'badges',
+        repo: 'shields',
+        ref: '3.3.0',
+      },
+      staticPreview: renderBuildStatusBadge({
+        status: 'success',
+      }),
+      keywords: ['status'],
+      documentation,
+    },
+  ]
+
+  static defaultBadgeData = { label: 'checks', namedLogo: 'github' }
+
+  static transform({ total_count, check_runs }) {
+    return {
+      total: total_count,
+      statusCounts: countBy(check_runs, 'status'),
+      conclusionCounts: countBy(check_runs, 'conclusion'),
+    }
+  }
+
+  static mapState({ total, statusCounts, conclusionCounts }) {
+    let state
+    if (total === 0) {
+      state = 'no check runs'
+    } else if (statusCounts.queued) {
+      state = 'queued'
+    } else if (statusCounts.in_progress) {
+      state = 'pending'
+    } else if (statusCounts.completed) {
+      // all check runs are completed, now evaluate conclusions
+      const orangeStates = ['action_required', 'stale']
+      const redStates = ['cancelled', 'failure', 'timed_out']
+
+      // assume "passing (green)"
+      state = 'passing'
+      for (const stateValue of Object.keys(conclusionCounts)) {
+        if (orangeStates.includes(stateValue)) {
+          // orange state renders "passing (orange)"
+          state = 'partially succeeded'
+        } else if (redStates.includes(stateValue)) {
+          // red state renders "failing (red)"
+          state = 'failing'
+          break
+        }
+      }
+    } else {
+      state = 'unknown status'
+    }
+    return state
+  }
+
+  async handle({ user, repo, ref }) {
+    // https://docs.github.com/en/rest/checks/runs#list-check-runs-for-a-git-reference
+    const json = await this._requestJson({
+      url: `/repos/${user}/${repo}/commits/${ref}/check-runs`,
+      errorMessages: errorMessagesFor('ref or repo not found'),
+      schema,
+    })
+
+    const state = this.constructor.mapState(this.constructor.transform(json))
+
+    return renderBuildStatusBadge({ status: state })
+  }
+}

services/github/github-check-runs.spec.js

@@ -0,0 +1,42 @@
+import { test, given } from 'sazerac'
+import GithubCheckRuns from './github-check-runs.service.js'
+
+describe('GithubCheckRuns', function () {
+  test(GithubCheckRuns.mapState, () => {
+    given({
+      total: 0,
+      statusCounts: null,
+      conclusionCounts: null,
+    }).expect('no check runs')
+    given({
+      total: 1,
+      statusCounts: { queued: 1 },
+      conclusionCounts: null,
+    }).expect('queued')
+    given({
+      total: 1,
+      statusCounts: { in_progress: 1 },
+      conclusionCounts: null,
+    }).expect('pending')
+    given({
+      total: 1,
+      statusCounts: { completed: 1 },
+      conclusionCounts: { success: 1 },
+    }).expect('passing')
+    given({
+      total: 2,
+      statusCounts: { completed: 2 },
+      conclusionCounts: { success: 1, stale: 1 },
+    }).expect('partially succeeded')
+    given({
+      total: 3,
+      statusCounts: { completed: 3 },
+      conclusionCounts: { success: 1, stale: 1, failure: 1 },
+    }).expect('failing')
+    given({
+      total: 1,
+      statusCounts: { somethingelse: 1 },
+      conclusionCounts: null,
+    }).expect('unknown status')
+  })
+})

services/github/github-check-runs.tester.js

@@ -0,0 +1,24 @@
+import { createServiceTester } from '../tester.js'
+import { isBuildStatus } from '../build-status.js'
+export const t = await createServiceTester()
+
+t.create('check runs - for branch')
+  .get('/badges/shields/master.json')
+  .expectBadge({
+    label: 'checks',
+    message: isBuildStatus,
+  })
+
+t.create('check runs - no tests')
+  .get('/badges/shields/5d4ab86b1b5ddfb3c4a70a70bd19932c52603b8c.json')
+  .expectBadge({
+    label: 'checks',
+    message: 'no check runs',
+  })
+
+t.create('check runs - nonexistent ref')
+  .get('/badges/shields/this-ref-does-not-exist.json')
+  .expectBadge({
+    label: 'checks',
+    message: 'ref or repo not found',
+  })