Merge pull request #160 from sdwvit/patch-1

feat: add report json to github action outputs

Author: Ma11hewThomas

__tests__/github/handler.test.ts

@@ -1,9 +1,11 @@
 import * as core from '@actions/core'
+import { context } from '@actions/github'
 import { createCheckRun } from '../../src/client/github/checks'
 import {
   createStatusCheck,
   findExistingMarkedComment,
-  handleComment
+  handleComment,
+  handleViewsAndComments
 } from '../../src/github/handler'
 import { CtrfReport, Inputs } from '../../src/types'
 import * as githubClient from '../../src/client/github'
@@ -647,3 +649,45 @@ describe('handleComment', () => {
     })
   })
 })
+
+describe('handleViewsAndComments', () => {
+  const mockCore = jest.mocked(core)
+  beforeEach(() => {
+    jest.clearAllMocks()
+    context.payload ||= {}
+    mockCore.summary.stringify.mockReturnValue('Test summary')
+    mockCore.summary.addRaw.mockImplementation(
+      jest
+        .requireActual<typeof core>('@actions/core')
+        .summary.addRaw.bind(core.summary)
+    )
+    mockCore.summary.addEOL.mockImplementation(
+      jest
+        .requireActual<typeof core>('@actions/core')
+        .summary.addEOL.bind(core.summary)
+    )
+  })
+
+  it('should create a check run with views and comments', async () => {
+    const inputs: Inputs = {
+      statusCheckName: 'Test Status',
+      statusCheck: true
+    } as Inputs
+
+    const report = {
+      results: {
+        summary: {
+          failed: 0
+        },
+        tests: []
+      }
+    } as unknown as CtrfReport
+    await handleViewsAndComments(inputs, report)
+
+    expect(mockCore.setOutput).toHaveBeenNthCalledWith(
+      2,
+      'report',
+      '{"results":{"summary":{"failed":0},"tests":[]}}'
+    )
+  })
+})

action.yml

@@ -228,6 +228,8 @@ inputs:
 outputs:
   summary:
     description: 'The markdown summary generated'
+  report:
+    description: 'The report json'
 
 runs:
   using: 'node20'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-actions-ctrf",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "description": "View test results directly within your GitHub workflow summary and Pull Requests",
   "main": "index.js",
   "scripts": {

src/github/handler.ts

@@ -36,6 +36,7 @@ export async function handleViewsAndComments(
   generateViews(inputs, report)
 
   core.setOutput('summary', core.summary.stringify())
+  core.setOutput('report', JSON.stringify(report))
 
   if (shouldAddCommentToPullRequest(inputs, report)) {
     await postOrUpdatePRComment(inputs, INVISIBLE_MARKER)