Merge pull request #48 from ctrf-io/feat/test-list

Feat/test list

.github/workflows/detailed.yaml

@@ -20,8 +20,8 @@ jobs:
         run: npx tsc
       - name: Test detailed with title
         run: node dist/index.js tests ctrf-reports/ctrf-report.json --title "Detailed With Title"
-      - name: Test default no title
-        run: node dist/index.js ctrf-reports/ctrf-report.json --annotate false
+      - name: Test list
+        run: node dist/index.js test-list ctrf-reports/ctrf-report.json --annotate false --title "List With Title"
       - name: Upload test results
         uses: actions/upload-artifact@v4
         with:

README.md

@@ -115,6 +115,16 @@ For a test details table, add the `tests` command to your workflow yaml:
   if: always()
 ```
 
+### Generating Test list
+
+For a simple list of tests, add the `test-list` command to your workflow yaml:
+
+```yaml
+- name: Publish CTRF test list
+  run: npx github-actions-ctrf test-list path-to-your-ctrf-report.json
+  if: always()
+```
+
 ### Generating Failed Test Details Table
 
 For a failed test details table, add the `failed` command to your workflow yaml:
@@ -522,6 +532,10 @@ npm run report
 
 ![Tests](images/tests.png)
 
+### Test list
+
+![Tests](images/test-list.png)
+
 ### Failed details
 
 ![Failed](images/failed.png)

package.json

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

src/index.ts

@@ -23,6 +23,7 @@ import { generateSkippedTestsDetailsTable } from './views/skipped'
 import { generateFailedFoldedTable } from './views/failed-folded'
 import { generateTestSuiteFoldedTable } from './views/suite-folded'
 import { generateSuiteListView } from './views/suite-list'
+import { generateTestListView } from './views/test-list'
 
 interface Arguments {
   _: Array<string | number>
@@ -75,6 +76,16 @@ const argv: Arguments = yargs(hideBin(process.argv))
       })
     }
   )
+  .command(
+    'test-list <file>',
+    'Generate test list from a CTRF report',
+    (yargs) => {
+      return yargs.positional('file', {
+        describe: 'Path to the CTRF file',
+        type: 'string',
+      })
+    }
+  )
   .command(
     'failed <file>',
     'Generate fail test report from a CTRF report',
@@ -391,6 +402,29 @@ if ((commandUsed === 'all' || commandUsed === '') && argv.file) {
   } catch (error) {
     console.error('Failed to read file:', error)
   }
+} else if (argv._.includes('test-list') && argv.file) {
+  try {
+    let report = validateCtrfFile(argv.file)
+    report = stripAnsiFromErrors(report)
+    if (report !== null) {
+      if (argv.title) {
+        addHeading(title)
+      }
+      generateTestListView(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') && argv.file) {
   try {
     let report = validateCtrfFile(argv.file)

src/views/flaky-rate.ts

@@ -157,4 +157,4 @@ ${totalRunsMessage}
 [Github Test Reporter CTRF](https://github.com/ctrf-io/github-test-reporter-ctrf)
 `
   core.summary.addRaw(summaryTable)
-}
+}

src/views/suite-list.ts

@@ -1,5 +1,7 @@
 import * as core from '@actions/core'
 import { CtrfTest } from '../../types/ctrf'
+import { getEmojiForStatus } from './common'
+import { stripAnsi } from '../common'
 
 export function generateSuiteListView(tests: CtrfTest[], useSuite: boolean): void {
   try {
@@ -11,8 +13,8 @@ export function generateSuiteListView(tests: CtrfTest[], useSuite: boolean): voi
 
     tests.forEach((test) => {
       const groupKey = useSuite
-        ? test.suite || 'Unknown Suite'
-        : (test.filePath || 'Unknown File').replace(workspacePath, '').replace(/^\//, '')
+        ? test.suite || 'No suite provided'
+        : (test.filePath || 'No file path provided').replace(workspacePath, '').replace(/^\//, '')
 
       if (!testResultsByGroup[groupKey]) {
         testResultsByGroup[groupKey] = { tests: [], statusEmoji: '✅' }
@@ -33,18 +35,15 @@ export function generateSuiteListView(tests: CtrfTest[], useSuite: boolean): voi
       markdown += `## ${groupData.statusEmoji} ${escapeMarkdown(groupKey)}\n\n`
 
       groupData.tests.forEach((test) => {
-        const statusEmoji =
-          test.status === 'passed' ? '✅' :
-            test.status === 'failed' ? '❌' :
-              test.status === 'skipped' ? '⏭️' :
-                test.status === 'pending' ? '⏳' : '❓'
+        const statusEmoji = getEmojiForStatus(test.status)
 
-        const testName = escapeMarkdown(test.name || 'Unnamed Test')
+        const testName = escapeMarkdown(test.name)
 
         markdown += `      **${statusEmoji} ${testName}**\n`
 
         if (test.status === 'failed' && test.message) {
-          const message = test.message.replace(/\n{2,}/g, '\n').trim()
+          let message = stripAnsi(test.message || "No failure message")
+          message = message.replace(/\n{2,}/g, '\n').trim()
 
           const escapedMessage = escapeMarkdown(message)
 

src/views/test-list.ts

@@ -0,0 +1,48 @@
+import * as core from '@actions/core'
+import { CtrfTest } from '../../types/ctrf'
+import { getTestName, stripAnsi } from '../common'
+import { getEmojiForStatus } from './common'
+
+export function generateTestListView(tests: CtrfTest[], useSuiteName: boolean): void {
+    try {
+        let markdown = `\n`
+
+        function escapeMarkdown(text: string): string {
+            return text.replace(/([\\*_{}[\]()#+\-.!])/g, '\\$1')
+        }
+
+        tests.forEach((test) => {
+            const statusEmoji = getEmojiForStatus(test.status)
+
+            const testName = escapeMarkdown(getTestName(test, useSuiteName))
+
+            markdown += `**${statusEmoji} ${testName}**\n`
+
+            if (test.status === 'failed') {
+                let message = stripAnsi(test.message || "No failure message")
+                message = message.replace(/\n{2,}/g, '\n').trim()
+
+                const escapedMessage = escapeMarkdown(message)
+
+                const indentedMessage = escapedMessage
+                    .split('\n')
+                    .filter(line => line.trim() !== '')
+                    .map(line => `      ${line}`)
+                    .join('\n')
+
+                markdown += `${indentedMessage}\n`
+            }
+        })
+
+        markdown += `\n[Github Test Reporter](https://github.com/ctrf-io/github-test-reporter)`
+
+        core.summary.addRaw(markdown)
+
+    } catch (error) {
+        if (error instanceof Error) {
+            core.setFailed(`Failed to display test list: ${error.message}`)
+        } else {
+            core.setFailed('An unknown error occurred')
+        }
+    }
+}