Merge pull request #793 from cucumber/fake-cucumber-use-cucumber-expr…

…essions Use cucumber-expressions to generate the match in fake-cucumber
cucumber · Nov 22, 2019 · 503e7b3 · 503e7b3
2 parents 5f718e3 + 0f43b81
commit 503e7b3
Show file tree

Hide file tree

Showing 68 changed files with 1,272 additions and 607 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -699,6 +699,7 @@ workflows:
           requires:
             - cucumber-messages-javascript
             - gherkin-javascript
+            - cucumber-expressions-javascript-node-12
       - cucumber-react-javascript:
           requires:
             - cucumber-messages-javascript

diff --git a/.templates/javascript/default.mk b/.templates/javascript/default.mk
@@ -2,7 +2,7 @@ SHELL := /usr/bin/env bash
 TYPESCRIPT_SOURCE_FILES = $(shell find src test -type f -name "*.ts" -o -name "*.tsx")
 PRIVATE = $(shell node -e "console.log(require('./package.json').private)")
 
-default: .tested .built
+default: .linted .tested .built
 .PHONY: default
 
 .deps: package-lock.json
@@ -22,7 +22,7 @@ endif
 	TS_NODE_TRANSPILE_ONLY=1 npm run test
 	touch $@
 
-.linted: $(TYPESCRIPT_SOURCE_FILES)
+.linted: $(TYPESCRIPT_SOURCE_FILES) package-lock.json
 	npm run lint-fix
 	touch $@
 

diff --git a/Makefile b/Makefile
@@ -2,14 +2,14 @@ SHELL := /usr/bin/env bash
 MAKEFILES=c21e/Makefile \
 	cucumber-messages/Makefile \
 	gherkin/Makefile \
+	cucumber-expressions/Makefile \
 	fake-cucumber/Makefile \
 	cucumber-query/Makefile \
 	cucumber-react/Makefile \
 	html-formatter/Makefile \
 	json-formatter/Makefile \
 	datatable/Makefile \
 	config/Makefile \
-	cucumber-expressions/Makefile \
 	tag-expressions/Makefile \
 	cucumber-demo-formatter/Makefile
 

diff --git a/c21e/javascript/default.mk b/c21e/javascript/default.mk
@@ -2,7 +2,7 @@ SHELL := /usr/bin/env bash
 TYPESCRIPT_SOURCE_FILES = $(shell find src test -type f -name "*.ts" -o -name "*.tsx")
 PRIVATE = $(shell node -e "console.log(require('./package.json').private)")
 
-default: .tested .built
+default: .linted .tested .built
 .PHONY: default
 
 .deps: package-lock.json
@@ -22,7 +22,7 @@ endif
 	TS_NODE_TRANSPILE_ONLY=1 npm run test
 	touch $@
 
-.linted: $(TYPESCRIPT_SOURCE_FILES)
+.linted: $(TYPESCRIPT_SOURCE_FILES) package-lock.json
 	npm run lint-fix
 	touch $@
 

diff --git a/cucumber-expressions/CHANGELOG.md b/cucumber-expressions/CHANGELOG.md
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+* [JavaScript] export `Argument` and `Expression` types
+
 ### Changed
 
 ### Deprecated

diff --git a/cucumber-expressions/javascript/default.mk b/cucumber-expressions/javascript/default.mk
@@ -2,7 +2,7 @@ SHELL := /usr/bin/env bash
 TYPESCRIPT_SOURCE_FILES = $(shell find src test -type f -name "*.ts" -o -name "*.tsx")
 PRIVATE = $(shell node -e "console.log(require('./package.json').private)")
 
-default: .tested .built
+default: .linted .tested .built
 .PHONY: default
 
 .deps: package-lock.json
@@ -22,7 +22,7 @@ endif
 	TS_NODE_TRANSPILE_ONLY=1 npm run test
 	touch $@
 
-.linted: $(TYPESCRIPT_SOURCE_FILES)
+.linted: $(TYPESCRIPT_SOURCE_FILES) package-lock.json
 	npm run lint-fix
 	touch $@
 

diff --git a/cucumber-expressions/javascript/src/index.ts b/cucumber-expressions/javascript/src/index.ts
@@ -1,10 +1,14 @@
+import Argument from './Argument'
+import Expression from './Expression'
 import CucumberExpression from './CucumberExpression'
 import RegularExpression from './RegularExpression'
 import CucumberExpressionGenerator from './CucumberExpressionGenerator'
 import ParameterTypeRegistry from './ParameterTypeRegistry'
 import ParameterType from './ParameterType'
 
-export = {
+export {
+  Argument,
+  Expression,
   CucumberExpression,
   RegularExpression,
   CucumberExpressionGenerator,

diff --git a/cucumber-expressions/javascript/src/web.ts b/cucumber-expressions/javascript/src/web.ts
@@ -1,4 +1,4 @@
-import CucumberExpressions from './index'
+import * as CucumberExpressions from './index'
 
 // @ts-ignore
 window.CucumberExpressions = CucumberExpressions
diff --git a/cucumber-messages/dotnet/messages.proto b/cucumber-messages/dotnet/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-messages/go/messages.pb.go b/cucumber-messages/go/messages.pb.go
diff --git a/cucumber-messages/go/messages.proto b/cucumber-messages/go/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-messages/java/messages.proto b/cucumber-messages/java/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-messages/javascript/default.mk b/cucumber-messages/javascript/default.mk
@@ -2,7 +2,7 @@ SHELL := /usr/bin/env bash
 TYPESCRIPT_SOURCE_FILES = $(shell find src test -type f -name "*.ts" -o -name "*.tsx")
 PRIVATE = $(shell node -e "console.log(require('./package.json').private)")
 
-default: .tested .built
+default: .linted .tested .built
 .PHONY: default
 
 .deps: package-lock.json
@@ -22,7 +22,7 @@ endif
 	TS_NODE_TRANSPILE_ONLY=1 npm run test
 	touch $@
 
-.linted: $(TYPESCRIPT_SOURCE_FILES)
+.linted: $(TYPESCRIPT_SOURCE_FILES) package-lock.json
 	npm run lint-fix
 	touch $@
 

diff --git a/cucumber-messages/javascript/messages.proto b/cucumber-messages/javascript/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-messages/javascript/test/ProtobufNdjsonStreamTest.ts b/cucumber-messages/javascript/test/ProtobufNdjsonStreamTest.ts
@@ -22,7 +22,7 @@ describe('ProtobufNdjsonStream', () => {
             status: messages.TestResult.Status.UNKNOWN,
           }),
         }),
-      }),
+      })
     )
   })
 
@@ -38,7 +38,7 @@ describe('ProtobufNdjsonStream', () => {
         testCase: messages.TestCase.create({
           pickleId: '123',
         }),
-      }),
+      })
     )
   })
 
@@ -52,7 +52,7 @@ describe('ProtobufNdjsonStream', () => {
     stream.write(
       messages.Envelope.create({
         testCase: messages.TestCase.create({ pickleId: '' }),
-      }),
+      })
     )
   })
 
@@ -80,7 +80,7 @@ describe('ProtobufNdjsonStream', () => {
             }),
           }),
         }),
-      }),
+      })
     )
   })
 })
diff --git a/cucumber-messages/messages.proto b/cucumber-messages/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-messages/ruby/messages.proto b/cucumber-messages/ruby/messages.proto
@@ -417,6 +417,7 @@ message TestCase {
     // Pointer to the PickleStep (if derived from a PickleStep)
     string pickleStepId = 2;
     // Pointer to all the matching StepDefinitions (if derived from a PickleStep)
+    // TODO: Should be renamed stepDefinitionIds
     repeated string stepDefinitionId = 3;
     // All the arguments from the match (if derived from a PickleStep and there was exactly 1 StepDefinition)
     repeated StepMatchArgument stepMatchArguments = 4;

diff --git a/cucumber-query/README.md b/cucumber-query/README.md
@@ -13,4 +13,14 @@ For example, [cucumber-react]() needs to know the status of a [Step](../cucumber
 is rendering the [GherkinDocument](../cucumber-messages/messages.md#io.cucumber.messages.GherkinDocument)
 
 The `cucumber-query` library makes this easy by providing a function to look up the
-status of a step, a scenario or an entire file.
+status of a step, a scenario or an entire file.
+
+## API
+
+| Query function                                                                          | .NET | Go | Java | Ruby | TypeScript |  
+| --------------------------------------------------------------------------------------- | ---- | -- | ---- | ---- | ---------- |
+| `getStepResults(uri: string, lineNumber: number): messages.ITestResult[]`               |      |    |      |      | ✓          |
+| `getScenarioResults(uri: string, lineNumber: number): messages.ITestResult[]`           |      |    |      |      | ✓          |
+| `getDocumentResults(uri: string): messages.ITestResult[]`                               |      |    |      |      | ✓          |
+| `getStepMatchArguments(uri: string, lineNumber: number): messages.IStepMatchArgument[]` |      |    |      |      | ✓          |
+| `getGherkinStep(gherkinStepId: string): messages.GherkinDocument.Feature.IStep`         |      |    |      |      | ✓          |
diff --git a/cucumber-query/javascript/default.mk b/cucumber-query/javascript/default.mk
@@ -2,7 +2,7 @@ SHELL := /usr/bin/env bash
 TYPESCRIPT_SOURCE_FILES = $(shell find src test -type f -name "*.ts" -o -name "*.tsx")
 PRIVATE = $(shell node -e "console.log(require('./package.json').private)")
 
-default: .tested .built
+default: .linted .tested .built
 .PHONY: default
 
 .deps: package-lock.json
@@ -22,7 +22,7 @@ endif
 	TS_NODE_TRANSPILE_ONLY=1 npm run test
 	touch $@
 
-.linted: $(TYPESCRIPT_SOURCE_FILES)
+.linted: $(TYPESCRIPT_SOURCE_FILES) package-lock.json
 	npm run lint-fix
 	touch $@
 

diff --git a/cucumber-query/javascript/src/CucumberQuery.ts b/cucumber-query/javascript/src/CucumberQuery.ts
@@ -3,6 +3,10 @@ import { messages } from 'cucumber-messages'
 export default class CucumberQuery {
   private readonly uriBySourceId = new Map<string, string>()
   private readonly locationBySourceId = new Map<string, messages.ILocation>()
+  private readonly gherkinStepById = new Map<
+    string,
+    messages.GherkinDocument.Feature.IStep
+  >()
 
   private readonly pickleById = new Map<string, messages.IPickle>()
   private readonly pickleStepById = new Map<
@@ -87,6 +91,15 @@ export default class CucumberQuery {
         this.testStepById.set(testStep.id, testStep)
 
         const pickleStep = this.pickleStepById.get(testStep.pickleStepId)
+        if (pickleStep === undefined) {
+          throw new Error(
+            `Did not find a PickleStep with id "${
+              testStep.pickleStepId
+            }". Known ids:\n${Array.from(this.pickleStepById.keys()).join(
+              '\n'
+            )}`
+          )
+        }
 
         for (const sourceId of pickleStep.sourceIds) {
           const uri = this.uriBySourceId.get(sourceId)
@@ -180,6 +193,7 @@ export default class CucumberQuery {
     for (const step of background.steps) {
       this.uriBySourceId.set(step.id, uri)
       this.locationBySourceId.set(step.id, step.location)
+      this.gherkinStepById.set(step.id, step)
     }
   }
 
@@ -192,6 +206,7 @@ export default class CucumberQuery {
     for (const step of scenario.steps) {
       this.uriBySourceId.set(step.id, uri)
       this.locationBySourceId.set(step.id, step.location)
+      this.gherkinStepById.set(step.id, step)
     }
 
     for (const examples of scenario.examples) {
@@ -229,4 +244,10 @@ export default class CucumberQuery {
       this.testStepMatchArgumentsByUriAndLine.get(`${uri}:${lineNumber}`) || []
     )
   }
+
+  public getGherkinStep(
+    gherkinStepId: string
+  ): messages.GherkinDocument.Feature.IStep {
+    return this.gherkinStepById.get(gherkinStepId)
+  }
 }