@cucumber/query 5.0.0 → 7.0.1

package/test/QueryTest.ts

@@ -1,15 +1,16 @@
 import 'source-map-support/register'
-import { GherkinStreams, Query as GherkinQuery } from '@cucumber/gherkin'
+import { GherkinStreams } from '@cucumber/gherkin'
+import { Query as GherkinQuery } from '@cucumber/gherkin-utils'
 import { IdGenerator, messages } from '@cucumber/messages'
 import { pipeline, Readable, Writable } from 'stream'
 import assert from 'assert'
-import SupportCode from '@cucumber/fake-cucumber/dist/src/SupportCode'
-import { withFullStackTrace } from '@cucumber/fake-cucumber/dist/src/ErrorMessageGenerator'
+import { SupportCode, withFullStackTrace } from '@cucumber/fake-cucumber'
 
 import { promisify } from 'util'
 import IncrementClock from '@cucumber/fake-cucumber/dist/src/IncrementClock'
 import Query from '../src/Query'
-import makeTestPlan from '@cucumber/fake-cucumber/dist/src/makeTestPlan'
+import { makeTestPlan, makeTestCase } from '@cucumber/fake-cucumber'
+import IncrementStopwatch from '@cucumber/fake-cucumber/dist/src/IncrementStopwatch'
 
 const pipelinePromise = promisify(pipeline)
 
@@ -24,17 +25,20 @@ describe('Query', () => {
   describe('#getWorstTestStepResult(testStepResults)', () => {
     it('returns a FAILED result for PASSED,FAILED,PASSED', () => {
       const result = cucumberQuery.getWorstTestStepResult([
-        new messages.TestStepResult({
-          status: messages.TestStepResult.Status.PASSED,
+        new messages.TestStepFinished.TestStepResult({
+          status: messages.TestStepFinished.TestStepResult.Status.PASSED,
         }),
-        new messages.TestStepResult({
-          status: messages.TestStepResult.Status.FAILED,
+        new messages.TestStepFinished.TestStepResult({
+          status: messages.TestStepFinished.TestStepResult.Status.FAILED,
         }),
-        new messages.TestStepResult({
-          status: messages.TestStepResult.Status.PASSED,
+        new messages.TestStepFinished.TestStepResult({
+          status: messages.TestStepFinished.TestStepResult.Status.PASSED,
         }),
       ])
-      assert.strictEqual(result.status, messages.TestStepResult.Status.FAILED)
+      assert.strictEqual(
+        result.status,
+        messages.TestStepFinished.TestStepResult.Status.FAILED
+      )
     })
   })
 
@@ -43,19 +47,24 @@ describe('Query', () => {
       const results = cucumberQuery.getPickleTestStepResults([])
       assert.deepStrictEqual(
         results.map((r) => r.status),
-        [messages.TestStepResult.Status.UNKNOWN]
+        [messages.TestStepFinished.TestStepResult.Status.UNKNOWN]
       )
     })
 
     it('looks up results for scenario steps', async () => {
+      const envelopes: messages.IEnvelope[] = []
+
       await execute(
         `Feature: hello
   Scenario: ok
     Given a passed step
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
 
-      const pickleStepIds = gherkinQuery.getPickleStepIds('test.feature', 3)
+      const scenario = findScenario(envelopes)
+
+      const pickleStepIds = gherkinQuery.getPickleStepIds(scenario.steps[0].id)
       assert.strictEqual(pickleStepIds.length, 1)
 
       const testStepResults = cucumberQuery.getPickleStepTestStepResults(
@@ -65,11 +74,13 @@ describe('Query', () => {
 
       assert.strictEqual(
         testStepResults[0].status,
-        messages.TestStepResult.Status.PASSED
+        messages.TestStepFinished.TestStepResult.Status.PASSED
       )
     })
 
     it('looks up results for background steps', async () => {
+      const envelopes: messages.IEnvelope[] = []
+
       await execute(
         `Feature: hello
   Background:
@@ -80,10 +91,14 @@ describe('Query', () => {
 
   Scenario: ko
     Given a failed step
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
 
-      const pickleStepIds = gherkinQuery.getPickleStepIds('test.feature', 3)
+      const background = findBackground(envelopes)
+      const pickleStepIds = gherkinQuery.getPickleStepIds(
+        background.steps[0].id
+      )
       assert.strictEqual(pickleStepIds.length, 2)
 
       const testStepResults = cucumberQuery.getPickleStepTestStepResults(
@@ -93,25 +108,31 @@ describe('Query', () => {
       assert.deepStrictEqual(
         testStepResults.map((r) => r.status),
         [
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
         ]
       )
     })
 
     it('looks up results for background steps when scenarios are empty', async () => {
+      const envelopes: messages.IEnvelope[] = []
+
       await execute(
         `Feature: hello
   Background:
-    Given a passed step
+  Given a passed step
 
   Scenario: ok
 
   Scenario: ok too
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
 
-      const pickleStepIds = gherkinQuery.getPickleStepIds('test.feature', 3)
+      const background = findBackground(envelopes)
+      const pickleStepIds = gherkinQuery.getPickleStepIds(
+        background.steps[0].id
+      )
       assert.strictEqual(pickleStepIds.length, 0)
 
       const testStepResults = cucumberQuery.getPickleStepTestStepResults(
@@ -121,22 +142,25 @@ describe('Query', () => {
 
       assert.strictEqual(
         testStepResults[0].status,
-        messages.TestStepResult.Status.UNKNOWN
+        messages.TestStepFinished.TestStepResult.Status.UNKNOWN
       )
     })
   })
 
   describe('#getPickleTestStepResults(pickleIds)', () => {
     it('looks up results for scenarios', async () => {
+      const envelopes: messages.IEnvelope[] = []
       await execute(
         `Feature: hello
   Scenario: ko
     Given a passed step
     Given a failed step
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
 
-      const pickleIds = gherkinQuery.getPickleIds('test.feature', 2)
+      const scenario = findScenario(envelopes)
+      const pickleIds = gherkinQuery.getPickleIds('test.feature', scenario.id)
       assert.strictEqual(pickleIds.length, 1)
 
       const testStepResults = cucumberQuery.getPickleTestStepResults(pickleIds)
@@ -144,13 +168,14 @@ describe('Query', () => {
       assert.deepStrictEqual(
         testStepResults.map((r) => r.status),
         [
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.FAILED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.FAILED,
         ]
       )
     })
 
     it('looks up results for scenario outlines', async () => {
+      const envelopes: messages.IEnvelope[] = []
       await execute(
         `Feature: hello
   Scenario: hi <status1> and <status2>
@@ -161,23 +186,28 @@ describe('Query', () => {
       | status1    | status2 |
       | passed     | passed  |
       | passed     | failed  |
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
-      const pickleIds = gherkinQuery.getPickleIds('test.feature', 2)
+
+      const scenario = findScenario(envelopes)
+      const pickleIds = gherkinQuery.getPickleIds('test.feature', scenario.id)
       assert.strictEqual(pickleIds.length, 2)
 
       assert.deepStrictEqual(
         cucumberQuery.getPickleTestStepResults(pickleIds).map((r) => r.status),
         [
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.FAILED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.FAILED,
         ]
       )
     })
 
     it('looks up results for examples rows outlines', async () => {
+      const envelopes: messages.IEnvelope[] = []
+
       await execute(
         `Feature: hello
   Scenario: hi <status1> and <status2>
@@ -188,30 +218,34 @@ describe('Query', () => {
       | status1    | status2 |
       | passed     | passed  |
       | passed     | failed  |
-`
+`,
+        (envelope) => envelopes.push(envelope)
       )
 
+      const scenario = findScenario(envelopes)
+      const exampleIds = scenario.examples[0].tableBody.map((row) => row.id)
+
       assert.deepStrictEqual(
         cucumberQuery
           .getPickleTestStepResults(
-            gherkinQuery.getPickleIds('test.feature', 8)
+            gherkinQuery.getPickleIds('test.feature', exampleIds[0])
           )
           .map((r) => r.status),
         [
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
         ]
       )
 
       assert.deepStrictEqual(
         cucumberQuery
           .getPickleTestStepResults(
-            gherkinQuery.getPickleIds('test.feature', 9)
+            gherkinQuery.getPickleIds('test.feature', exampleIds[1])
           )
           .map((r) => r.status),
         [
-          messages.TestStepResult.Status.PASSED,
-          messages.TestStepResult.Status.FAILED,
+          messages.TestStepFinished.TestStepResult.Status.PASSED,
+          messages.TestStepFinished.TestStepResult.Status.FAILED,
         ]
       )
     })
@@ -219,14 +253,17 @@ describe('Query', () => {
 
   describe('#getPickleStepAttachments(pickleIds)', () => {
     it('looks up attachments', async () => {
+      const envelopes: messages.IEnvelope[] = []
       await execute(
         `Feature: hello
   Scenario: ok
     Given a passed step with attachment
-`
+    `,
+        (envelope) => envelopes.push(envelope)
       )
 
-      const pickleStepIds = gherkinQuery.getPickleStepIds('test.feature', 3)
+      const scenario = findScenario(envelopes)
+      const pickleStepIds = gherkinQuery.getPickleStepIds(scenario.steps[0].id)
       assert.strictEqual(pickleStepIds.length, 1)
 
       const attachments = cucumberQuery.getPickleStepAttachments(pickleStepIds)
@@ -238,18 +275,22 @@ describe('Query', () => {
 
   describe('#getStepMatchArguments(uri, lineNumber)', () => {
     it("looks up result for step's uri and line", async () => {
+      const envelopes: messages.IEnvelope[] = []
       await execute(
         `Feature: hello
-  Scenario: hi
+  Scenario: ok
     Given a passed step
     And I have 567 cukes in my belly
-`
+    `,
+        (envelope) => envelopes.push(envelope)
       )
 
+      const scenario = findScenario(envelopes)
+
       assert.deepStrictEqual(
         cucumberQuery
           .getStepMatchArgumentsLists(
-            gherkinQuery.getPickleStepIds('test.feature', 3)[0]
+            gherkinQuery.getPickleStepIds(scenario.steps[0].id)[0]
           )
           .map((sal) =>
             sal.stepMatchArguments.map((arg) => arg.parameterTypeName)
@@ -260,7 +301,7 @@ describe('Query', () => {
       assert.deepStrictEqual(
         cucumberQuery
           .getStepMatchArgumentsLists(
-            gherkinQuery.getPickleStepIds('test.feature', 4)[0]
+            gherkinQuery.getPickleStepIds(scenario.steps[1].id)[0]
           )
           .map((sal) =>
             sal.stepMatchArguments.map((arg) => arg.parameterTypeName)
@@ -268,13 +309,232 @@ describe('Query', () => {
         [['int', 'word']]
       )
     })
+
+    describe('#getBeforeHookSteps(pickleId: string)', () => {
+      it('returns an empty list when there is no hooks', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.deepStrictEqual(cucumberQuery.getBeforeHookSteps(pickleId), [])
+      })
+
+      it('returns one before hook step', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    @beforeHook
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.strictEqual(cucumberQuery.getBeforeHookSteps(pickleId).length, 1)
+      })
+
+      it('does not return after hook steps', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    @afterHook
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.deepStrictEqual(cucumberQuery.getBeforeHookSteps(pickleId), [])
+      })
+    })
+
+    describe('#getAfterHookSteps(pickleId: string)', () => {
+      it('returns an empty list when there is no hooks', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.deepStrictEqual(cucumberQuery.getAfterHookSteps(pickleId), [])
+      })
+
+      it('returns one after hook step', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    @afterHook
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.strictEqual(cucumberQuery.getAfterHookSteps(pickleId).length, 1)
+      })
+
+      it('does not return before hook steps', async () => {
+        const envelopes: messages.IEnvelope[] = []
+        await execute(
+          `Feature: hello
+    @beforeHook
+    Scenario: hi
+      Given a passed step
+  `,
+          (envelope) => envelopes.push(envelope)
+        )
+        const scenarioId = findScenario(envelopes).id
+        const pickleId = gherkinQuery.getPickleIds(
+          'test.feature',
+          scenarioId
+        )[0]
+
+        assert.deepStrictEqual(cucumberQuery.getAfterHookSteps(pickleId), [])
+      })
+    })
+
+    describe('#getTestStepResult', () => {
+      it('returns one test step result', async () => {
+        const emittedMessages: Array<messages.IEnvelope> = []
+        await execute(
+          `Feature: hello
+    Scenario: hi
+      Given a passed step
+  `,
+          (message) => emittedMessages.push(message)
+        )
+        const testCase = emittedMessages.find((child) => child.testCase)
+          .testCase
+        const testStep = testCase.testSteps[0]
+        const results = cucumberQuery.getTestStepResults(testStep.id)
+
+        assert.deepStrictEqual(results.length, 1)
+        assert.deepStrictEqual(
+          results[0].status,
+          messages.TestStepFinished.TestStepResult.Status.PASSED
+        )
+      })
+
+      it('returns a result for hook step', async () => {
+        const emittedMessages: Array<messages.IEnvelope> = []
+        await execute(
+          `Feature: hello
+    @beforeHook
+    Scenario: hi
+      Given a passed step
+  `,
+          (message) => emittedMessages.push(message)
+        )
+        const testCase = emittedMessages.find((child) => child.testCase)
+          .testCase
+        const testStep = testCase.testSteps[0]
+        const results = cucumberQuery.getTestStepResults(testStep.id)
+
+        assert.deepStrictEqual(results.length, 1)
+        assert.deepStrictEqual(
+          results[0].status,
+          messages.TestStepFinished.TestStepResult.Status.PASSED
+        )
+      })
+    })
+
+    describe('#getHook(HookId)', () => {
+      it('returns undefined if the id does not match any hook', () => {
+        assert.strictEqual(cucumberQuery.getHook('tralala'), undefined)
+      })
+
+      it('returns the matching hook', () => {
+        const hook = messages.Hook.create({
+          id: 'tralala',
+        })
+        const envelope = messages.Envelope.create({
+          hook,
+        })
+
+        cucumberQuery.update(envelope)
+
+        assert.deepStrictEqual(cucumberQuery.getHook('tralala'), hook)
+      })
+    })
+
+    describe('#getAttachmentByTestStepId', () => {
+      it('looks up attachments', async () => {
+        const testCases: messages.ITestCase[] = []
+        await execute(
+          `Feature: hello
+    Scenario: ok
+      Given a passed step with attachment
+  `,
+          (envelope) => {
+            if (envelope.testCase) {
+              testCases.push(envelope.testCase)
+            }
+          }
+        )
+
+        const attachments = cucumberQuery.getTestStepsAttachments([
+          testCases[0].testSteps[0].id,
+        ])
+        assert.strictEqual(attachments.length, 1)
+
+        assert.strictEqual(attachments[0].body, 'Hello')
+      })
+    })
   })
 
-  async function execute(gherkinSource: string): Promise<void> {
+  async function execute(
+    gherkinSource: string,
+    messagesHandler: (envelope: messages.IEnvelope) => void = () => null
+  ): Promise<void> {
     const newId = IdGenerator.incrementing()
     const clock = new IncrementClock()
+    const stopwatch = new IncrementStopwatch()
     const makeErrorMessage = withFullStackTrace()
-    const supportCode = new SupportCode(newId, clock, makeErrorMessage)
+    const supportCode = new SupportCode(
+      newId,
+      clock,
+      stopwatch,
+      makeErrorMessage
+    )
+    supportCode.defineBeforeHook(null, '@beforeHook', () => {
+      // no-op
+    })
+    supportCode.defineAfterHook(null, '@afterHook', () => {
+      // no-op
+    })
     supportCode.defineStepDefinition(null, 'a passed step', () => {
       // no-op
     })
@@ -304,6 +564,7 @@ describe('Query', () => {
         callback: (error?: Error | null) => void
       ): void {
         try {
+          messagesHandler(envelope)
           gherkinQuery.update(envelope)
           cucumberQuery.update(envelope)
           callback()
@@ -317,8 +578,11 @@ describe('Query', () => {
       queryUpdateStream
     )
 
-    const testPlan = makeTestPlan(gherkinQuery, supportCode)
-    await testPlan.execute((envelope) => cucumberQuery.update(envelope))
+    const testPlan = makeTestPlan(gherkinQuery, supportCode, makeTestCase)
+    await testPlan.execute((envelope: messages.IEnvelope) => {
+      messagesHandler(envelope)
+      cucumberQuery.update(envelope)
+    })
   }
 
   function gherkinMessages(
@@ -335,4 +599,24 @@ describe('Query', () => {
     })
     return GherkinStreams.fromSources([source], { newId })
   }
+
+  function findScenario(
+    envelopes: messages.IEnvelope[]
+  ): messages.GherkinDocument.Feature.IScenario {
+    const gherkinDocument = envelopes.find(
+      (envelope) => envelope.gherkinDocument
+    ).gherkinDocument
+    return gherkinDocument.feature.children.find((child) => child.scenario)
+      .scenario
+  }
+
+  function findBackground(
+    envelopes: messages.IEnvelope[]
+  ): messages.GherkinDocument.Feature.IBackground {
+    const gherkinDocument = envelopes.find(
+      (envelope) => envelope.gherkinDocument
+    ).gherkinDocument
+    return gherkinDocument.feature.children.find((child) => child.background)
+      .background
+  }
 })

package/tsconfig.json

@@ -3,11 +3,7 @@
     "declaration": true,
     "target": "es5",
     "lib": [
-      "es5",
-      "es6",
-      "es7",
-      "es2015",
-      "es2017",
+      "es2019",
       "dom"
     ],
     "sourceMap": true,

package/.idea/codeStyles/Project.xml

@@ -1,45 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <option name="AUTODETECT_INDENTS" value="false" />
-    <JSCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </JSCodeStyleSettings>
-    <JavaCodeStyleSettings>
-      <option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="500" />
-      <option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="300" />
-    </JavaCodeStyleSettings>
-    <TypeScriptCodeStyleSettings version="0">
-      <option name="USE_SEMICOLON_AFTER_STATEMENT" value="false" />
-      <option name="FORCE_SEMICOLON_STYLE" value="true" />
-      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
-      <option name="USE_DOUBLE_QUOTES" value="false" />
-      <option name="FORCE_QUOTE_STYlE" value="true" />
-      <option name="ENFORCE_TRAILING_COMMA" value="WhenMultiline" />
-      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
-      <option name="SPACES_WITHIN_IMPORTS" value="true" />
-    </TypeScriptCodeStyleSettings>
-    <codeStyleSettings language="JavaScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-    <codeStyleSettings language="TypeScript">
-      <option name="SOFT_MARGINS" value="80" />
-      <indentOptions>
-        <option name="INDENT_SIZE" value="2" />
-        <option name="CONTINUATION_INDENT_SIZE" value="2" />
-        <option name="TAB_SIZE" value="2" />
-      </indentOptions>
-    </codeStyleSettings>
-  </code_scheme>
-</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

package/.idea/compiler.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="TypeScriptCompiler">
-    <option name="showAllErrors" value="true" />
-  </component>
-</project>