.github/workflows/build.yml

@@ -9,7 +9,7 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - id: set-matrix
         name: Prepare
         run: echo "matrix=$(node -p "JSON.stringify(require('./package.json').peerDependencies['cypress'].split(' || '))")" >> $GITHUB_OUTPUT
@@ -25,14 +25,14 @@ jobs:
         cypress-version: ${{fromJson(needs.prepare-versions.outputs.matrix)}}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cache NPM modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: npm-linux@${{ matrix.cypress-version }}
       - name: Cache Cypress binaries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/Cypress
           key: cypress-linux@${{ matrix.cypress-version }}
@@ -59,14 +59,14 @@ jobs:
       CYPRESS_CACHE_FOLDER: ${{ github.workspace }}/.cypress
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cache NPM modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .npm
           key: npm-windows
       - name: Cache Cypress binaries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .cypress
           key: cypress-windows

.github/workflows/examples-branch.yml

@@ -16,7 +16,7 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - id: set-matrix
         name: Prepare
         run: echo "matrix=$(node -p "JSON.stringify(fs.readdirSync('examples').filter(f => f !== 'readme.md'))")" >> $GITHUB_OUTPUT
@@ -28,14 +28,14 @@ jobs:
       image: cypress/base:20.5.0
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cache NPM modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: npm-linux@latest
       - name: Cache Cypress binaries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/Cypress
           key: cypress-linux@latest
@@ -70,14 +70,14 @@ jobs:
       NPM_CONFIG_PACKAGE_LOCK: "false"
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cache NPM modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: npm@${{ matrix.example }}
       - name: Cache Cypress binaries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/Cypress
           key: cypress-examples

.github/workflows/examples-master.yml

@@ -16,7 +16,7 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - id: set-matrix
         name: Prepare
         run: echo "matrix=$(node -p "JSON.stringify(fs.readdirSync('examples').filter(f => f !== 'readme.md'))")" >> $GITHUB_OUTPUT
@@ -34,14 +34,14 @@ jobs:
       NPM_CONFIG_PACKAGE_LOCK: "false"
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Cache NPM modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: npm@${{ matrix.example }}
       - name: Cache Cypress binaries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/Cypress
           key: cypress-examples

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## v20.0.2
+
+- Add support for skipped / pending scenario hooks, fixes [#1159](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1159).
+
+- Add support for suite-level test configuration, fixes [#1158](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1158).
+
 ## v20.0.1
 
 - Handle more corner cases related to reload-behavior, fixes [#1142](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1142).

docs/cucumber-basics.md

@@ -12,6 +12,7 @@
 - [Hooks](#hooks)
   - [Run hooks](#run-hooks)
   - [Scenario hooks](#scenario-hooks)
+    - [Pending / skipped scenario hooks](#pending--skipped-scenario-hooks)
   - [Step hooks](#step-hooks)
   - [Hook ordering](#hook-ordering)
   - [Named hooks](#named-hooks)
@@ -188,6 +189,10 @@ Before(function ({ pickle, gherkinDocument, testCaseStartedId }) {
 });
 ```
 
+### Pending / skipped scenario hooks
+
+Scenario hooks can be made pending or skipped similarly to steps, as explained above, by returning `"pending"` or `"skipped"`, respectively. Both will halt the execution and Cypress will report the test as "skipped".
+
 ## Step hooks
 
 `BeforeStep()` and `AfterStep()` are hooks invoked before and after each step, respectively. These too can be selected to conditionally run based on the tags of each scenario, as shown below.

features/pending_scenario_hooks.feature

@@ -0,0 +1,39 @@
+Feature: pending scenario hooks
+
+  Scenario: pending Before() hook
+    Given a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { Before, Given } = require("@badeball/cypress-cucumber-preprocessor")
+      Before(() => {
+        return "pending"
+      })
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes
+    And it should appear to have skipped the scenario "a scenario"
+
+  Scenario: pending After() hook
+    Given a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { After, Given } = require("@badeball/cypress-cucumber-preprocessor")
+      After(() => {
+        return "pending"
+      })
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes
+    And it should appear to have skipped the scenario "a scenario"

features/setup.feature

@@ -30,5 +30,5 @@ Feature: setup
     Then it fails
     And the output should contain
       """
-      Missing preprocessor event handlers (this usally means you've not invoked `addCucumberPreprocessorPlugin()` or not returned the config object in `setupNodeEvents()`)
+      Missing preprocessor event handlers (this usually means you've not invoked `addCucumberPreprocessorPlugin()` or not returned the config object in `setupNodeEvents()`)
       """

features/skipped_scenario_hooks.feature

@@ -0,0 +1,39 @@
+Feature: skipped scenario hooks
+
+  Scenario: skipped Before() hook
+    Given a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { Before, Given } = require("@badeball/cypress-cucumber-preprocessor")
+      Before(() => {
+        return "skipped"
+      })
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes
+    And it should appear to have skipped the scenario "a scenario"
+
+  Scenario: skipped After() hook
+    Given a file named "cypress/e2e/a.feature" with:
+      """
+      Feature: a feature
+        Scenario: a scenario
+          Given a step
+      """
+    And a file named "cypress/support/step_definitions/steps.js" with:
+      """
+      const { After, Given } = require("@badeball/cypress-cucumber-preprocessor")
+      After(() => {
+        return "skipped"
+      })
+      Given("a step", function() {})
+      """
+    When I run cypress
+    Then it passes
+    And it should appear to have skipped the scenario "a scenario"

features/suite_only_options.feature

@@ -0,0 +1,135 @@
+@cypress>=12
+Feature: suite only options
+
+  Background:
+    Given additional Cypress configuration
+      """
+      {
+        "e2e": {
+          "testIsolation": true
+        }
+      }
+      """
+
+  Rule: testIsolation is only applicable for Feature / Rule
+
+    Scenario: Configuring testIsolation on a Feature
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        @testIsolation(false)
+        Feature: a feature
+          Scenario: a scenario
+            Given a step
+          Scenario: another scenario
+            Then another step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given, Then } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a step", () => {
+          cy.get("body").invoke('html', 'Hello world')
+        });
+        Given("another step", () => {
+          cy.contains("Hello world").should("exist");
+        });
+        """
+      When I run cypress
+      Then it passes
+
+    Scenario: Configuring testIsolation on a Rule
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          @testIsolation(false)
+          Rule: a rule
+            Scenario: a scenario
+              Given a step
+            Scenario: another scenario
+              Then another step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given, Then } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a step", () => {
+          cy.get("body").invoke('html', 'Hello world')
+        });
+        Given("another step", () => {
+          cy.contains("Hello world").should("exist");
+        });
+        """
+      When I run cypress
+      Then it passes
+
+    Scenario: Configuring testIsolation on a Scenario
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          @testIsolation(false)
+          Scenario: a scenario
+            Given a step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given, Then } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a step", () => {
+          cy.get("body").invoke('html', 'Hello world')
+        });
+        """
+      When I run cypress
+      Then it fails
+      And the output should contain
+        """
+        The `testIsolation` configuration can only be overridden from a suite-level override (in Cucumber-terms this means on a Feature or Rule).
+        """
+
+    Scenario: Configuring testIsolation on a Scenario Outline
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          @testIsolation(false)
+          Scenario Outline: a scenario
+            Given a step
+
+            Examples:
+              | foo |
+              | bar |
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given, Then } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a step", () => {
+          cy.get("body").invoke('html', 'Hello world')
+        });
+        """
+      When I run cypress
+      Then it fails
+      And the output should contain
+        """
+        The `testIsolation` configuration can only be overridden from a suite-level override (in Cucumber-terms this means on a Feature or Rule).
+        """
+
+    Scenario: Configuring testIsolation on Examples
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          Scenario Outline: a scenario
+            Given a step
+
+            @testIsolation(false)
+            Examples:
+              | foo |
+              | bar |
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given, Then } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a step", () => {
+          cy.get("body").invoke('html', 'Hello world')
+        });
+        """
+      When I run cypress
+      Then it fails
+      And the output should contain
+        """
+        The `testIsolation` configuration can only be overridden from a suite-level override (in Cucumber-terms this means on a Feature or Rule).
+        """

features/support/helpers.ts

@@ -1,6 +1,7 @@
-import path from "path";
-import { promises as fs } from "fs";
 import assert from "assert";
+import { version as cypressVersion } from "cypress/package.json";
+import { promises as fs } from "fs";
+import path from "path";
 
 export async function writeFile(filePath: string, fileContent: string) {
   await fs.mkdir(path.dirname(filePath), { recursive: true });
@@ -106,3 +107,11 @@ export function stringToNdJson(content: string) {
 export function ndJsonToString(ndjson: any) {
   return ndjson.map((o: any) => JSON.stringify(o)).join("\n") + "\n";
 }
+
+export function isPost12() {
+  return parseInt(cypressVersion.split(".")[0], 10) >= 12;
+}
+
+export function isPre12() {
+  return !isPost12();
+}