Export Cucumber functions through @wdio/cucumber-framework package (#…

…7398) * Export Cucumber functions through @wdio/cucumber-framework package * reduce treshold * fix smoke tests
webdriverio · Sep 7, 2021 · 072c3b3 · 072c3b3
1 parent 5c0579d
commit 072c3b3
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 7 deletions.
diff --git a/jest.config.js b/jest.config.js
@@ -26,7 +26,7 @@ module.exports = {
     coverageThreshold: {
         global: {
             branches: 90,
-            functions: 97,
+            functions: 96,
             lines: 97,
             statements: 97
         }

diff --git a/packages/wdio-cli/src/templates/exampleFiles/cucumber/step_definitions/steps.js.ejs b/packages/wdio-cli/src/templates/exampleFiles/cucumber/step_definitions/steps.js.ejs
@@ -1,6 +1,6 @@
 <%- isUsingTypeScript || isUsingBabel
-    ? "import { Given, When, Then } from '@cucumber/cucumber';"
-    : "const { Given, When, Then } = require('@cucumber/cucumber');" %>
+    ? "import { Given, When, Then } from '@wdio/cucumber-framework';"
+    : "const { Given, When, Then } = require('@wdio/cucumber-framework');" %>
 <%
 /**
  * step definition without page objects

diff --git a/packages/wdio-cucumber-framework/src/index.ts b/packages/wdio-cucumber-framework/src/index.ts
@@ -6,6 +6,22 @@ import isGlob from 'is-glob'
 import glob from 'glob'
 
 import * as Cucumber from '@cucumber/cucumber'
+import {
+    After,
+    AfterAll,
+    AfterStep,
+    Before,
+    BeforeAll,
+    BeforeStep,
+    defineParameterType,
+    defineStep,
+    Given,
+    setDefaultTimeout,
+    setDefinitionFunctionWrapper,
+    setWorldConstructor,
+    Then,
+    When
+} from '@cucumber/cucumber'
 import { GherkinStreams } from '@cucumber/gherkin-streams'
 import EventDataCollector from '@cucumber/cucumber/lib/formatter/helpers/event_data_collector'
 import { ITestCaseHookParameter } from '@cucumber/cucumber/lib/support_code_library_builder/types'
@@ -374,7 +390,24 @@ adapterFactory.init = async function (...args: any[]) {
 }
 
 export default adapterFactory
-export { CucumberAdapter, adapterFactory }
+export {
+    CucumberAdapter,
+    adapterFactory,
+    After,
+    AfterAll,
+    AfterStep,
+    Before,
+    BeforeAll,
+    BeforeStep,
+    defineParameterType,
+    defineStep,
+    Given,
+    setDefaultTimeout,
+    setDefinitionFunctionWrapper,
+    setWorldConstructor,
+    Then,
+    When
+}
 
 declare global {
     namespace WebdriverIO {

diff --git a/packages/wdio-cucumber-framework/tests/adapter.test.ts b/packages/wdio-cucumber-framework/tests/adapter.test.ts
@@ -5,6 +5,7 @@ import mockery from 'mockery'
 
 import CucumberAdapter from '../src'
 import { setUserHookNames } from '../src/utils'
+import * as packageExports from '../src'
 
 jest.mock('../src/reporter', () => class CucumberReporter {
     eventListener = {
@@ -45,6 +46,19 @@ describe('CucumberAdapter', () => {
         ;(Cucumber.AfterStep as jest.Mock).mockClear()
     })
 
+    it('exports Cucumber exports', () => {
+        expect(Object.keys(packageExports))
+            .toContain('Given')
+        expect(Object.keys(packageExports))
+            .toContain('When')
+        expect(Object.keys(packageExports))
+            .toContain('Then')
+        expect(Object.keys(packageExports))
+            .toContain('Before')
+        expect(Object.keys(packageExports))
+            .toContain('After')
+    })
+
     it('can be initiated with tests', async () => {
         const adapter = await CucumberAdapter.init('0-0', {
             waitforTimeout: 1,

diff --git a/tests/cucumber/reporter/reporter.given.js b/tests/cucumber/reporter/reporter.given.js
@@ -1,4 +1,4 @@
-import { Given, BeforeAll, Before, After, AfterAll } from '@cucumber/cucumber'
+import { Given, BeforeAll, Before, After, AfterAll } from '../../../packages/wdio-cucumber-framework'
 
 BeforeAll(() => {})
 Before(function () {})

diff --git a/tests/cucumber/step-definitions/given.js b/tests/cucumber/step-definitions/given.js
@@ -1,6 +1,6 @@
 // eslint-disable-next-line
 import assert from 'assert'
-import { Given, BeforeAll, Before, After, AfterAll } from '@cucumber/cucumber'
+import { Given, BeforeAll, Before, After, AfterAll } from '../../../packages/wdio-cucumber-framework'
 
 browser.addCommand('rootLevel', () => {
     return true

diff --git a/tests/cucumber/step-definitions/then.js b/tests/cucumber/step-definitions/then.js
@@ -1,6 +1,6 @@
 import assert from 'assert'
 
-import { Then } from '@cucumber/cucumber'
+import { Then } from '../../../packages/wdio-cucumber-framework'
 
 Then(/^the title of the page should be:$/, (expectedTitle) => {
     const actualTitle = browser.getTitle()

diff --git a/website/docs/Frameworks.md b/website/docs/Frameworks.md
@@ -401,3 +401,19 @@ Here you have some examples of this syntax:
 - `@skip(browserName="firefox";platformName="linux")`: will skip the test in firefox over linux executions.
 - `@skip(browserName=["chrome","firefox"])`: tagged items will be skipped for both chrome and firefox browsers.
 - `@skip(browserName=/i.*explorer/`: capabilities with browsers matching the regexp will be skipped (like `iexplorer`, `internet explorer`, `internet-explorer`, ...).
+
+### Import Step Definition Helper
+
+In order to use step definition helper like `Given`, `When` or `Then` or hooks, you are suppose to import then from `@cucumber/cucumber`, e.g. like this:
+
+```js
+import { Given, When, Then } from '@cucumber/cucumber'
+```
+
+Now, if you use Cucumber already for other types of tests unrelated to WebdriverIO for which you use a specific version you need to import these helpers in your e2e tests from the WebdriverIO Cucumber package, e.g.:
+
+```js
+import { Given, When, Then } from '@wdio/cucumber-framework'
+```
+
+This ensures that you use the right helpers within the WebdriverIO framework and allows you to use an independant Cucumber version for other types of testing.