Merge pull request #220 from kevbite/main

Allow tests to fail based on a `exitOnEmpty` flag being set.

Author: Ma11hewThomas

README.md

@@ -152,6 +152,7 @@ For more advanced usage, there are several inputs available.
     annotate: true # Add failed test annotations. Default is true
     on-fail-only: false # Add a pull request comment only if tests fail. Default is false
     exit-on-fail: false # Exit the workflow with a failure status if any tests fail. Default is false
+    exit-on-empty: false # Exit the workflow with a failure status if no tests are found. Default is false
     use-suite-name: false # Prefix test names with the suite name for better grouping. Default is false
     collapse-large-reports: false # Collapse large reports (test-table and test-list) for better readability. Default is false
     update-comment: false # Update existing Pull Request comment. Default is false

__tests__/ctrf/report-preparation.test.ts

@@ -502,6 +502,7 @@ function createSingleReportInputs(): Inputs {
     title: '',
     onFailOnly: false,
     exitOnFail: false,
+    exitOnEmpty: false,
     useSuiteName: false,
     previousResultsMax: 0,
     metricsReportsMax: 0,

action.yml

@@ -149,6 +149,11 @@ inputs:
     description: 'Exit the workflow with a failure status if any tests fail.'
     required: false
     default: false
+  exit-on-empty:
+    description:
+      'Exit the workflow with a failure status if no tests are found.'
+    required: false
+    default: false
   use-suite-name:
     description: 'Prefix test names with the suite name for better grouping.'
     required: false

dist/index.js

@@ -1,6 +1,11 @@
 process.env.RUN_MODE = 'action'
 
-import { exitActionOnFail, getAllGitHubContext, handleError } from '../github'
+import {
+  exitActionOnFail,
+  exitActionOnEmpty,
+  getAllGitHubContext,
+  handleError
+} from '../github'
 import { getInputs } from './inputs'
 import { prepareReport } from '../ctrf'
 import { handleViewsAndComments, handleAnnotations } from '../github/handler'
@@ -17,6 +22,9 @@ export async function runAction(): Promise<void> {
     await handleViewsAndComments(inputs, report)
     handleAnnotations(inputs, report)
 
+    if (inputs.exitOnEmpty) {
+      exitActionOnEmpty(report)
+    }
     if (inputs.exitOnFail) {
       exitActionOnFail(report)
     }

dist/index.js.map

@@ -3,7 +3,12 @@ process.env.RUN_MODE = 'cli'
 
 import yargs from 'yargs/yargs'
 import { hideBin } from 'yargs/helpers'
-import { exitActionOnFail, getAllGitHubContext, handleError } from '../github'
+import {
+  exitActionOnFail,
+  exitActionOnEmpty,
+  getAllGitHubContext,
+  handleError
+} from '../github'
 import { prepareReport } from '../ctrf'
 import { handleViewsAndComments, handleAnnotations } from '../github/handler'
 import { getCliInputs } from '../core/inputs'
@@ -38,6 +43,7 @@ export interface Arguments {
   commentTag?: string
   results?: number
   exitOnFail?: boolean
+  exitOnEmpty?: boolean
   fetchPreviousResults?: boolean
   reportOrder?: string
   maxWorkflowRunsToCheck?: number
@@ -321,6 +327,11 @@ async function main(): Promise<void> {
       description: 'Fail action when if tests fail',
       default: false
     })
+    .options('exit-on-empty', {
+      type: 'boolean',
+      description: 'Fail action when if no tests are found',
+      default: false
+    })
     .options('update-comment', {
       type: 'boolean',
       description: 'Updates existing Pull Request comment',
@@ -379,6 +390,9 @@ async function main(): Promise<void> {
 
     await processPrComment(argv, report, inputs)
 
+    if (inputs.exitOnEmpty) {
+      exitActionOnEmpty(report)
+    }
     if (inputs.exitOnFail) {
       exitActionOnFail(report)
     }

src/core/action-handler.ts

@@ -45,6 +45,7 @@ export function getCliInputs(args: Arguments): Inputs {
     title: args.title || '',
     onFailOnly: args.onFailOnly || false,
     exitOnFail: args.exitOnFail || false,
+    exitOnEmpty: args.exitOnEmpty || false,
     useSuiteName: args.useSuiteName || false,
     previousResultsMax: args.rows || 10,
     metricsReportsMax: args.results || 100,
@@ -131,6 +132,7 @@ export function getInputs(): Inputs {
     title: core.getInput('title') || '',
     onFailOnly: core.getInput('on-fail-only').toLowerCase() === 'true',
     exitOnFail: core.getInput('exit-on-fail').toLowerCase() === 'true',
+    exitOnEmpty: core.getInput('exit-on-empty').toLowerCase() === 'true',
     useSuiteName: core.getInput('use-suite-name').toLowerCase() === 'true',
     previousResultsMax: parseInt(
       core.getInput('previous-results-max') || '10',

src/core/cli.ts

@@ -396,6 +396,19 @@ export function exitActionOnFail(report: Report): void {
   }
 }
 
+/**
+ * Exits the GitHub Action with a failure status if the CTRF report does not contains any tests.
+ *
+ * @param report - The CTRF report containing the summary of test results.
+ */
+export function exitActionOnEmpty(report: Report): void {
+  if (report.results.summary.tests === 0) {
+    core.setFailed(
+      `Github Test Reporter: ${report.results.summary.tests} tests found in the report, exiting as per configuration`
+    )
+  }
+}
+
 /**
  * Handles errors that occur during the action, setting the GitHub Action status to failed.
  *

src/core/inputs.ts

@@ -33,6 +33,7 @@ export interface Inputs {
   annotate: boolean
   title: string
   onFailOnly: boolean
+  exitOnEmpty: boolean
   exitOnFail: boolean
   useSuiteName: boolean
   previousResultsMax: number