Merge pull request #222 from kevbite/issue221

Add exitOnNoFiles argument to fail action when no test files are found

Author: Ma11hewThomas

README.md

@@ -151,6 +151,7 @@ For more advanced usage, there are several inputs available.
     title: '' # Set a custom title to display on the report.
     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
+    exitOnNoFiles: false # Exit the workflow with a failure status if no test files are found. 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

__tests__/ctrf/report-preparation.test.ts

@@ -501,6 +501,7 @@ function createSingleReportInputs(): Inputs {
     annotate: false,
     title: '',
     onFailOnly: false,
+    exitOnNoFiles: false,
     exitOnFail: false,
     exitOnEmpty: false,
     useSuiteName: false,

action.yml

@@ -145,6 +145,11 @@ inputs:
     description: 'Add a pull request comment only if tests fail.'
     required: false
     default: false
+  exit-on-no-files:
+    description:
+      'Exit the workflow with a failure status if no test files are found.'
+    required: false
+    default: false
   exit-on-fail:
     description: 'Exit the workflow with a failure status if any tests fail.'
     required: false

dist/index.js

@@ -42,6 +42,7 @@ export interface Arguments {
   alwaysLatestComment?: boolean
   commentTag?: string
   results?: number
+  exitOnNoFiles?: boolean
   exitOnFail?: boolean
   exitOnEmpty?: boolean
   fetchPreviousResults?: boolean
@@ -322,6 +323,11 @@ async function main(): Promise<void> {
       description: 'Use suite name in the test name',
       default: false
     })
+    .options('exit-on-no-files', {
+      type: 'boolean',
+      description: 'Fail action when if no test files are found',
+      default: false
+    })
     .options('exit-on-fail', {
       type: 'boolean',
       description: 'Fail action when if tests fail',

dist/index.js.map

@@ -44,6 +44,7 @@ export function getCliInputs(args: Arguments): Inputs {
     annotate: args.annotate !== false,
     title: args.title || '',
     onFailOnly: args.onFailOnly || false,
+    exitOnNoFiles: args.exitOnNoFiles || false,
     exitOnFail: args.exitOnFail || false,
     exitOnEmpty: args.exitOnEmpty || false,
     useSuiteName: args.useSuiteName || false,
@@ -131,6 +132,7 @@ export function getInputs(): Inputs {
     annotate: core.getInput('annotate').toLowerCase() === 'true',
     title: core.getInput('title') || '',
     onFailOnly: core.getInput('on-fail-only').toLowerCase() === 'true',
+    exitOnNoFiles: core.getInput('exit-on-no-files').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',

src/core/cli.ts

@@ -45,7 +45,7 @@ export async function prepareReport(
       throw new Error(`JUnit report not found at: ${inputs.ctrfPath}`)
     }
   } else {
-    report = readCtrfReports(inputs.ctrfPath)
+    report = readCtrfReports(inputs.ctrfPath, inputs.exitOnNoFiles)
   }
 
   report = stripAnsiFromErrors(report)

src/core/inputs.ts

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

src/ctrf/report-preparation.ts

@@ -33,14 +33,23 @@ export function readTemplate(filePath: string): string {
  * @returns A `Report` object containing the parsed report data.
  * @throws An error if the file does not exist, is not valid JSON, or does not contain CTRF results.
  */
-export function readCtrfReports(pattern: string): Report {
+export function readCtrfReports(
+  pattern: string,
+  exitOnNoFiles: boolean
+): Report {
   core.info(`Reading CTRF reports from ${pattern}`)
+
   try {
     const reports: Report[] = readReportsFromGlobPattern(pattern)
 
     if (reports.length === 0) {
+      if (exitOnNoFiles) {
+        core.setFailed(`No CTRF reports found at: ${pattern}. Exiting action.`)
+        process.exit(core.ExitCode.Failure)
+      }
+
       core.warning(`CTRF report not found at: ${pattern}. Exiting action.`)
-      process.exit(0)
+      process.exit(core.ExitCode.Success)
     }
 
     const report: Report =
@@ -49,8 +58,12 @@ export function readCtrfReports(pattern: string): Report {
     return report
   } catch (error: unknown) {
     const errorMessage = error instanceof Error ? error.message : String(error)
+    if (exitOnNoFiles) {
+      core.setFailed(`No CTRF reports found at: ${pattern}. Exiting action.`)
+      process.exit(core.ExitCode.Failure)
+    }
     core.warning(`${errorMessage}. Exiting action.`)
-    process.exit(0)
+    process.exit(core.ExitCode.Success)
   }
 }