fix(formatter): Enable calling parseTestCaseAttempt on test cases that haven't completed (#1531)

* fix(formatter): Enable calling parseTestCaseAttempt on test cases that haven't completed yet

* Instanciate a proper TestStepResult when parsing TestCaseAttempt

* Add unit tests

* Refactor testCaseAttemptParser unit tests

Co-authored-by: Aurélien Reeves <[email protected]>
Co-authored-by: Aslak Hellesøy <[email protected]>

Author: 3 people

src/formatter/helpers/test_case_attempt_parser.ts

@@ -11,6 +11,7 @@ import { ISupportCodeLibrary } from '../../support_code_library_builder/types'
 import { doesHaveValue, valueOrDefault } from '../../value_checker'
 import TestCaseHookDefinition from '../../models/test_case_hook_definition'
 import { ILineAndUri } from '../../types'
+import { TestStepResult } from '@cucumber/messages'
 
 export interface IParsedTestStep {
   actionLocation?: ILineAndUri
@@ -150,9 +151,13 @@ export function parseTestCaseAttempt({
   const parsedTestSteps: IParsedTestStep[] = []
   let isBeforeHook = true
   let previousKeywordType = KeywordType.Precondition
+
   testCase.testSteps.forEach((testStep) => {
-    const testStepResult = testCaseAttempt.stepResults[testStep.id]
+    const testStepResult =
+      testCaseAttempt.stepResults[testStep.id] || new TestStepResult()
+
     isBeforeHook = isBeforeHook && doesHaveValue(testStep.hookId)
+
     let keyword, keywordType, pickleStep
     if (doesHaveValue(testStep.pickleStepId)) {
       pickleStep = pickleStepMap[testStep.pickleStepId]

src/formatter/helpers/test_case_attempt_parser_spec.ts

@@ -0,0 +1,81 @@
+import { describe, it } from 'mocha'
+import { expect } from 'chai'
+import * as messages from '@cucumber/messages'
+import { parseTestCaseAttempt } from '.'
+import { getBaseSupportCodeLibrary } from '../../../test/fixtures/steps'
+import StepDefinitionSnippetBuilder from '../step_definition_snippet_builder'
+import { ParameterTypeRegistry } from '@cucumber/cucumber-expressions'
+import { reindent } from 'reindent-template-literals'
+import { getTestCaseAttempts } from '../../../test/formatter_helpers'
+
+describe('TestCaseAttemptParser', () => {
+  describe('parseTestCaseAttempt', () => {
+    const cwd = ''
+    const supportCodeLibrary = getBaseSupportCodeLibrary()
+    const snippetSyntax = {
+      build: () => 'snippet',
+    }
+
+    const snippetBuilder = new StepDefinitionSnippetBuilder({
+      snippetSyntax,
+      parameterTypeRegistry: new ParameterTypeRegistry(),
+    })
+
+    const source = {
+      data: reindent(`
+        Feature: my feature
+          Scenario: my scenario
+            Given a passing step
+      `),
+      uri: 'a.feature',
+    }
+
+    describe('with no test step result', () => {
+      it('initialize step result with status UNKNOWN', async () => {
+        // Arrange
+        const [testCaseAttempt] = await getTestCaseAttempts({
+          sources: [source],
+          supportCodeLibrary,
+        })
+
+        testCaseAttempt.stepResults = {}
+
+        // Act
+        const output = parseTestCaseAttempt({
+          cwd,
+          testCaseAttempt,
+          snippetBuilder,
+          supportCodeLibrary,
+        })
+
+        // Assert
+        expect(output.testSteps[0].result.status).to.eq(
+          messages.TestStepResultStatus.UNKNOWN
+        )
+      })
+    })
+
+    describe('with test step result', () => {
+      it('uses the parsed step result', async () => {
+        // Arrange
+        const [testCaseAttempt] = await getTestCaseAttempts({
+          sources: [source],
+          supportCodeLibrary,
+        })
+
+        // Act
+        const output = parseTestCaseAttempt({
+          cwd,
+          testCaseAttempt,
+          snippetBuilder,
+          supportCodeLibrary,
+        })
+
+        // Assert
+        expect(output.testSteps[0].result.status).to.eq(
+          messages.TestStepResultStatus.PASSED
+        )
+      })
+    })
+  })
+})