feat: add status check functionality

Author: Ma11hewThomas

CONTRIBUTING.md

@@ -23,6 +23,17 @@ project, do one of the following:
   your idea, open an issue to discuss it. This allows other contributors to
   point out any potential flaws or to help you flesh out your idea.
 
+```bash
+git clone https://github.com/ctrf-io/github-test-reporter.git
+cd github-test-reporter
+npm install
+# Add your changes
+npm run all:action
+```
+
+The `all:action` script builds and tests the action and stores the built action in the
+`dist` directory. GitHub Marketplace actions require build files to be present in the repository.
+
 ### Pull Requests
 
 1. Fork the repository and create your branch from `main`.

README.md

@@ -137,6 +137,8 @@ There are several inputs available
     summary: true # Post report to the job summary. Default is true
     pull-request: false # Comment on pull request with report. Default is false
     issue: '' # Issue number to comment on. Works with standard issues and pull-request. Default is no issue
+    status-check: false # Create a status check for the workflow. Default is false
+    status-check-name: 'Test Reporter Results' # Name of the status check. Default is GitHub Test Reporter Results 
     community-report-name: 'summary-short' # Name of the community report to use. Default is summary-short
     title: '' # Set a custom title to display on the report.
     annotate: true # Add failed test annotations. Default is true

__tests__/github/handler.test.ts

@@ -0,0 +1,119 @@
+import * as core from '@actions/core'
+import { createCheckRun } from '../../src/client/github/checks'
+import { createStatusCheck } from '../../src/github/handler'
+import { CtrfReport, Inputs } from '../../src/types'
+
+// Mock dependencies
+jest.mock('@actions/core')
+jest.mock('@actions/github', () => ({
+  context: {
+    repo: {
+      owner: 'test-owner',
+      repo: 'test-repo'
+    },
+    sha: 'test-sha'
+  }
+}))
+jest.mock('../../src/client/github/checks', () => ({
+  createCheckRun: jest.fn()
+}))
+
+describe('createStatusCheck', () => {
+  const mockCore = jest.mocked(core)
+  const mockCreateCheckRun = jest.mocked(createCheckRun)
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+    mockCore.summary.stringify.mockReturnValue('Test summary')
+  })
+
+  it('should create a successful check run when no tests failed', async () => {
+    const inputs: Inputs = {
+      statusCheckName: 'Test Status',
+      statusCheck: true
+    } as Inputs
+
+    const report: CtrfReport = {
+      results: {
+        summary: {
+          failed: 0
+        }
+      }
+    } as CtrfReport
+
+    await createStatusCheck(inputs, report)
+
+    expect(mockCreateCheckRun).toHaveBeenCalledWith(
+      'test-owner',
+      'test-repo',
+      'test-sha',
+      'Test Status',
+      'completed',
+      'success',
+      'Test Results',
+      'Test summary'
+    )
+  })
+
+  it('should create a failed check run when tests failed', async () => {
+    const inputs: Inputs = {
+      statusCheckName: 'Test Status',
+      statusCheck: true
+    } as Inputs
+
+    const report: CtrfReport = {
+      results: {
+        summary: {
+          failed: 1
+        }
+      }
+    } as CtrfReport
+
+    await createStatusCheck(inputs, report)
+
+    expect(mockCreateCheckRun).toHaveBeenCalledWith(
+      'test-owner',
+      'test-repo',
+      'test-sha',
+      'Test Status',
+      'completed',
+      'failure',
+      'Test Results',
+      'Test summary'
+    )
+  })
+
+  it('should truncate summary if it exceeds 65000 characters', async () => {
+    const longSummary = 'a'.repeat(65001)
+    mockCore.summary.stringify.mockReturnValue(longSummary)
+
+    const inputs: Inputs = {
+      statusCheckName: 'Test Status',
+      statusCheck: true
+    } as Inputs
+
+    const report: CtrfReport = {
+      results: {
+        summary: {
+          failed: 0
+        }
+      }
+    } as CtrfReport
+
+    await createStatusCheck(inputs, report)
+
+    expect(mockCore.warning).toHaveBeenCalledWith(
+      'Summary is too long to create a status check. Truncating...'
+    )
+    expect(mockCreateCheckRun).toHaveBeenCalledWith(
+      'test-owner',
+      'test-repo',
+      'test-sha',
+      'Test Status',
+      'completed',
+      'success',
+      'Test Results',
+      expect.stringMatching(/^a{65000}$/)
+    )
+  })
+})

action.yml

@@ -111,6 +111,14 @@ inputs:
     description: 'Add annotations to failed tests in the GitHub Actions UI.'
     required: false
     default: true
+  status-check:
+    description: 'Create a status check for the workflow.'
+    required: false
+    default: false
+  status-check-name:
+    description: 'Name of the status check.'
+    required: false
+    default: 'GitHub Test Reporter Results'
   community-report-name:
     description: 'Name of the community report to use.'
     required: false

badges/coverage.svg

@@ -0,0 +1,53 @@
+import { createGitHubClient } from '.'
+
+/**
+ * Creates a check run for a specific commit.
+ *
+ * @param owner - The owner of the repository (organization or user).
+ * @param repo - The name of the repository.
+ * @param sha - The SHA of the commit to update.
+ * @param name - The name of the check run.
+ * @param status - The current status ('queued' | 'in_progress' | 'completed').
+ * @param conclusion - The final conclusion ('success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required').
+ * @param title - The title of the check run.
+ * @param summary - A summary of the check run.
+ * @param detailsUrl - The URL of the integrator's site that has the full details of the check.
+ *
+ * @returns A promise that resolves to the response data from GitHub's API.
+ */
+export async function createCheckRun(
+  owner: string,
+  repo: string,
+  sha: string,
+  name: string,
+  status: 'queued' | 'in_progress' | 'completed',
+  conclusion?:
+    | 'success'
+    | 'failure'
+    | 'neutral'
+    | 'cancelled'
+    | 'skipped'
+    | 'timed_out'
+    | 'action_required',
+  title?: string,
+  summary?: string,
+  detailsUrl?: string
+): Promise<void> {
+  const octokit = await createGitHubClient()
+  await octokit.checks.create({
+    owner,
+    repo,
+    head_sha: sha,
+    name,
+    status,
+    conclusion,
+    output:
+      title && summary
+        ? {
+            title,
+            summary
+          }
+        : undefined,
+    details_url: detailsUrl
+  })
+}

dist/index.js

@@ -47,7 +47,9 @@ export function getCliInputs(args: Arguments): Inputs {
     uploadArtifact: false,
     integrationsConfig: {},
     groupBy: groupBy,
-    alwaysGroupBy: false
+    alwaysGroupBy: false,
+    statusCheck: false,
+    statusCheckName: 'GitHub Test Reporter Results'
   }
 }
 
@@ -113,6 +115,9 @@ export function getInputs(): Inputs {
     alwaysGroupBy: core.getInput('always-group-by').toLowerCase() === 'true',
     integrationsConfig: JSON.parse(
       core.getInput('integrations-config') || '{}'
-    ) as IntegrationsConfig
+    ) as IntegrationsConfig,
+    statusCheck: core.getInput('status-check').toLowerCase() === 'true',
+    statusCheckName:
+      core.getInput('status-check-name') || 'Test Reporter Results'
   }
 }