Merge pull request #43 from ctrf-io/feat/failed-folded

feat: add failed with folded details

.github/workflows/failed.yaml

@@ -22,6 +22,8 @@ jobs:
         run: node dist/index.js failed ctrf-reports/ctrf-report.json --title "Failed With Title"
       - name: Test failed no title
         run: node dist/index.js failed ctrf-reports/ctrf-report.json
+      - name: Test failed folded
+        run: node dist/index.js failed-folded ctrf-reports/ctrf-report.json --title "Failed Folded"
       - name: Test failed rate
         run: node dist/index.js failed-rate ctrf-reports/ctrf-report.json --title "Failed Rate"
         env:

README.md

@@ -123,6 +123,16 @@ For a failed test details table, add the `failed` command to your workflow yaml:
   if: always()
 ```
 
+### Generating Failed Folded Test Details Table
+
+For a failed test table with details folded, add the `failed-folded` command to your workflow yaml:
+
+```yaml
+- name: Publish CTRF Failed Test Summary Results
+  run: npx github-actions-ctrf failed-folded path-to-your-ctrf-report.json
+  if: always()
+```
+
 ### Generating Failed Rate Test Details Table
 
 To see the failed test rate over time, add the `failed-rate` command to your workflow yaml:
@@ -490,9 +500,13 @@ npm run report
 
 ![Failed](images/failed.png)
 
+### Failed Folded details
+
+![Failed Folded](images/failed-folded.png)
+
 ### Failed rate
 
-![Failed](images/failed-rate.png)
+![Failed Rate](images/failed-rate.png)
 
 ### AI summary
 

package.json

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

src/index.ts

@@ -20,6 +20,7 @@ import { generateTestDetailsTable } from './views/detailed'
 import { generateFailedTestsDetailsTable } from './views/failed'
 import { generateFlakyTestsDetailsTable } from './views/flaky'
 import { generateSkippedTestsDetailsTable } from './views/skipped'
+import { generateFailedFoldedTable } from './views/failed-folded'
 
 interface Arguments {
   _: Array<string | number>
@@ -81,6 +82,16 @@ const argv: Arguments = yargs(hideBin(process.argv))
       })
     }
   )
+  .command(
+    'failed-folded <file>',
+    'Generate fail folded test report from a CTRF report',
+    (yargs) => {
+      return yargs.positional('file', {
+        describe: 'Path to the CTRF file',
+        type: 'string',
+      })
+    }
+  )
   .command(
     'failed-rate <file>',
     'Generate a fail rate statistics test report from a CTRF report',
@@ -371,7 +382,31 @@ if ((commandUsed === 'all' || commandUsed === '') && argv.file) {
   } catch (error) {
     console.error('Failed to read file:', error)
   }
-} else if (argv._.includes('failed-rate') && argv.file) {
+} else if (argv._.includes('failed-folded') && argv.file) {
+  try {
+    let report = validateCtrfFile(argv.file)
+    report = stripAnsiFromErrors(report)
+    if (report !== null) {
+      if (argv.title) {
+        addHeading(title)
+      }
+      generateFailedFoldedTable(report.results.tests, useSuiteName)
+      write()
+      if (argv.prComment) {
+        postPullRequestComment(report, apiUrl, baseUrl, onFailOnly, title, useSuiteName, prCommentMessage)
+      }
+      if (pullRequest) {
+        postPullRequestComment(report, apiUrl, baseUrl, onFailOnly, title, useSuiteName, core.summary.stringify())
+      }
+      if (exitOnFail) {
+        exitActionOnFail(report)
+      }
+    }
+  } catch (error) {
+    console.error('Failed to read file:', error)
+  }
+}
+else if (argv._.includes('failed-rate') && argv.file) {
   try {
     let report = validateCtrfFile(argv.file)
     report = stripAnsiFromErrors(report)

src/views/failed-folded.ts

@@ -0,0 +1,58 @@
+import * as core from '@actions/core'
+import { getTestName } from "../common"
+import Convert from 'ansi-to-html'
+import { CtrfTest } from '../../types/ctrf'
+
+export function generateFailedFoldedTable(tests: CtrfTest[], useSuiteName: boolean): void {
+  try {
+    core.summary.addHeading(`Failed Tests`, 3)
+    const convert = new Convert()
+
+    const failedTests = tests.filter((test) => test.status === 'failed')
+
+    if (failedTests.length > 0) {
+      let tableHtml = `
+  <table>
+    <thead>
+      <tr>
+        <th>Failed Tests</th>
+      </tr>
+    </thead>
+    <tbody>`
+      failedTests.forEach((test) => {
+        const testName = getTestName(test, useSuiteName)
+        const messageHtml = convert.toHtml(test.message || 'No message available')
+        const traceHtml = convert.toHtml(test.trace || 'No trace available')
+
+        tableHtml += `
+      <tr>
+        <td>
+          <details>
+            <summary>❌ ${testName}</summary>
+            <p><strong>Message:</strong></p>
+            <pre><code>${messageHtml}</code></pre>
+            <p><strong>Trace:</strong></p>
+            <pre><code>${traceHtml}</code></pre>
+          </details>
+        </td>
+      </tr>`
+      })
+      tableHtml += `</tbody>
+  </table>`
+
+      core.summary.addRaw(tableHtml)
+      core.summary.addLink(
+        'Github Test Reporter',
+        'https://github.com/ctrf-io/github-test-reporter'
+      )
+    } else {
+      core.summary.addRaw('<p>No failed tests ✨</p>')
+    }
+  } catch (error) {
+    if (error instanceof Error) {
+      core.setFailed(`Failed to display failed test details: ${error.message}`)
+    } else {
+      core.setFailed('An unknown error occurred')
+    }
+  }
+}