capture logging in parser

Signed-off-by: shmck <shawn.j.mckay@gmail.com>

Author: ShMcK

src/services/testRunner/formatOutput.ts

@@ -4,7 +4,7 @@ import { ParserOutput, Fail } from './parser'
 // export const formatSuccessOutput = (tap: ParserOutput): string => {}
 
 export const formatFailOutput = (tap: ParserOutput): string => {
-  let output = `'TESTS FAILED\n`
+  let output = `TESTS\n`
   tap.failed.forEach((fail: Fail) => {
     const details = fail.details ? `\n${fail.details}\n\n` : ''
     output += `  ✘ ${fail.message}\n${details}`

src/services/testRunner/parser.test.ts

@@ -6,7 +6,7 @@ describe('parser', () => {
 1..1
 ok 1 - Should pass
 `
-    expect(parser(example)).toEqual({ ok: true, passed: [{ message: 'Should pass' }], failed: [] })
+    expect(parser(example)).toEqual({ ok: true, passed: [{ message: 'Should pass' }], failed: [], logs: [] })
   })
   test('should detect multiple successes', () => {
     const example = `
@@ -19,6 +19,7 @@ ok 2 - Should also pass
       ok: true,
       passed: [{ message: 'Should pass' }, { message: 'Should also pass' }],
       failed: [],
+      logs: [],
     })
   })
   test('should detect failure if no tests passed', () => {
@@ -141,4 +142,34 @@ at processImmediate (internal/timers.js:439:21)`)
     expect(result.failed[1].message).toBe('package.json should have a valid "description" key')
     expect(result.failed[1].details).toBe(`AssertionError [ERR_ASSERTION]: no "description" key provided`)
   })
+  test('should capture logs', () => {
+    const example = `
+1..2
+ok 1 package.json should have "express" installed
+log 1
+log 2
+not ok 2 server should log "Hello World"
+#  AssertionError [ERR_ASSERTION]: "Hello World was not logged
+#      at Context.<anonymous> (test/server.test.js:15:12)
+#      at processImmediate (internal/timers.js:439:21)
+# tests 2
+# pass 1
+# fail 1
+# skip 0
+`
+    expect(parser(example)).toEqual({
+      ok: false,
+      passed: [{ message: 'package.json should have "express" installed' }],
+      failed: [
+        {
+          message: 'server should log "Hello World"',
+          details: `AssertionError [ERR_ASSERTION]: \"Hello World was not logged
+at Context.<anonymous> (test/server.test.js:15:12)
+at processImmediate (internal/timers.js:439:21)`,
+          logs: ['log 1', 'log 2'],
+        },
+      ],
+      logs: ['log 1', 'log 2'],
+    })
+  })
 })

src/services/testRunner/parser.ts

@@ -1,33 +1,47 @@
 export interface Fail {
   message: string
   details?: string
+  logs?: string[]
+}
+
+export interface Pass {
+  message: string
+  logs?: string[]
 }
 
 export interface ParserOutput {
   ok: boolean
-  passed: Array<{ message: string }>
-  failed: Array<Fail>
+  passed: Pass[]
+  failed: Fail[]
+  logs: string[]
 }
 
 const r = {
+  start: /^1\.\.[0-9]+$/,
   fail: /^not ok \d+\s(\-\s)?(.+)+$/,
   pass: /^ok \d+\s(\-\s)?(.+)+$/,
   details: /^#\s{2}(.+)$/,
+  ignore: /^#\s+(tests|pass|fail|skip)\s+[0-9]+$/,
 }
 
 const detect = (type: 'fail' | 'pass' | 'details', text: string) => r[type].exec(text)
 
 const parser = (text: string): ParserOutput => {
-  const lines = text.split('\n')
+  const lineList = text.split('\n')
+  // start after 1..n output
+  const startingPoint = lineList.findIndex((t) => t.match(r.start))
+  const lines = lineList.slice(startingPoint + 1)
 
   const result: ParserOutput = {
     ok: true,
     passed: [],
     failed: [],
+    logs: [],
   }
 
   // temporary holder of error detail strings
   let currentDetails: string | null = null
+  let logs: string[] = []
 
   const addCurrentDetails = () => {
     const failLength: number = result.failed.length
@@ -44,7 +58,12 @@ const parser = (text: string): ParserOutput => {
     // be optimistic! check for success
     const isPass = detect('pass', line)
     if (!!isPass) {
-      result.passed.push({ message: isPass[2].trim() })
+      const pass: Pass = { message: isPass[2].trim() }
+      if (logs.length) {
+        pass.logs = logs
+        logs = []
+      }
+      result.passed.push(pass)
       addCurrentDetails()
       continue
     }
@@ -54,7 +73,12 @@ const parser = (text: string): ParserOutput => {
     if (!!isFail) {
       result.ok = false
       addCurrentDetails()
-      result.failed.push({ message: isFail[2].trim() })
+      const fail: Fail = { message: isFail[2].trim() }
+      if (logs.length) {
+        fail.logs = logs
+        logs = []
+      }
+      result.failed.push(fail)
       continue
     }
 
@@ -68,6 +92,13 @@ const parser = (text: string): ParserOutput => {
         // @ts-ignore ignore as it must be a string
         currentDetails += `\n${lineDetails}`
       }
+      continue
+    }
+
+    if (!r.ignore.exec(line)) {
+      // must be a log, associate with the next test
+      logs.push(line)
+      result.logs.push(line)
     }
   }
   addCurrentDetails()