Merge branch 'update-cck'

Author: badeball

CHANGELOG.md

@@ -24,6 +24,8 @@ Other changes:
 
   - This is similar to how steps themselves can also return the above mentioned literals. This is in line with how cucumber-js behaves.
 
+- Attachments (using log(), link() or attach()) can be added in test run hooks (BeforeAll/AfterAll). This is in line with how cucumber-js behaves.
+
 - Remove use of patch-package in development mode, which was causing some issues, closes [#1255](https://github.com/badeball/cypress-cucumber-preprocessor/pull/1255).
 
 ## v23.2.1

compatibility/cck_spec.ts

@@ -38,12 +38,15 @@ const ignorableKeys = [
   "testCaseStartedId",
   "testStepId",
   "testRunStartedId",
+  "testRunHookStartedId",
   // time
   "nanos",
   "seconds",
   // errors
   "message",
   "stackTrace",
+  // suggestions
+  "snippets",
 ];
 
 function isObject(object: any): object is object {
@@ -90,15 +93,19 @@ describe("Cucumber Compatibility Kit", () => {
     const suiteName = path.basename(path.dirname(ndjsonFile));
 
     /**
-     * Unknown parameter type will generate an exception outside of a Cypress test and halt all
-     * execution. Thus, cucumber-js' behavior is tricky to mirror.
-     *
-     * Markdown is unsupported.
+     * cucumber-js' behavior is tricky to mirror in a variety of cases.
      */
     switch (suiteName) {
-      case "unknown-parameter-type":
-      case "markdown":
-      case "hooks-conditional":
+      case "unknown-parameter-type": // Unknown parameter type will generate an exception outside of a Cypress test and halt all execution
+      case "markdown": // Markdown is unsupported
+      case "hooks-conditional": // Expections during hooks are difficult to mimick due to no try-catch
+      case "global-hooks-beforeall-error": // See above
+      case "global-hooks-afterall-error": // See above
+      case "hooks-undefined": // See above
+      case "hooks-skipped": // See above
+      case "multiple-features": // The "correct" message order is difficult to mimick
+      case "multiple-features-reversed": // Cypress has no `reversed` option
+      case "test-run-exception": // Difficult to reproduce such scenario
         it.skip(`passes the cck suite for '${suiteName}'`);
         continue;
     }
@@ -183,11 +190,17 @@ describe("Cucumber Compatibility Kit", () => {
 
       await fs.mkdir(path.join(tmpDir, "cypress", "e2e"), { recursive: true });
 
-      await fs.copyFile(
-        path.join(CCK_FEATURES_PATH, suiteName, `${suiteName}.feature`),
-        path.join(tmpDir, "cypress", "e2e", `${suiteName}.feature`),
+      const features = glob.sync(
+        path.join(CCK_FEATURES_PATH, suiteName, "*.feature"),
       );
 
+      for (const feature of features) {
+        await fs.copyFile(
+          path.join(feature),
+          path.join(tmpDir, "cypress", "e2e", path.basename(feature)),
+        );
+      }
+
       if (suiteName === "hooks-attachment") {
         await fs.copyFile(
           path.join(CCK_FEATURES_PATH, suiteName, "cucumber.svg"),
@@ -270,7 +283,7 @@ describe("Cucumber Compatibility Kit", () => {
         (await fs.readFile(ndjsonFile)).toString(),
       ).map(normalizeMessage);
 
-      if (suiteName === "pending") {
+      if (suiteName === "pending" || suiteName === "retry-pending") {
         /**
          * We can't control Cypress exit code without failing a test, thus is cucumber-js behavior
          * difficult to mimic.
@@ -294,6 +307,14 @@ describe("Cucumber Compatibility Kit", () => {
               messages.TestStepResultStatus.PASSED;
           }
         });
+      } else if (suiteName === "global-hooks") {
+        // Move testCase after testRunHookStarted & testRunHookFinished. This is a bit difficult to
+        // account for in the preprocessor, but since it doesn't matter  we just modify the
+        // expectation.
+        expectedMessages.splice(12, 0, ...expectedMessages.splice(16, 2));
+      } else if (suiteName === "global-hooks-attachments") {
+        // Same as above.
+        expectedMessages.splice(8, 0, ...expectedMessages.splice(11, 1));
       }
 
       assert.deepEqual(actualMessages, expectedMessages);

compatibility/step_definitions/ambiguous.ts

@@ -0,0 +1,9 @@
+import { Given } from "@badeball/cypress-cucumber-preprocessor";
+
+Given(/^a (.*?) with (.*?)$/, function () {
+  // first one
+});
+
+Given(/^a step with (.*)$/, function () {
+  // second one
+});

compatibility/step_definitions/attachments.ts

@@ -38,18 +38,6 @@ When(
   },
 );
 
-When("a JPEG image is attached", function () {
-  cy.readFile("cucumber.jpeg", "base64").then((file) =>
-    attach(file, "base64:image/jpeg"),
-  );
-});
-
-When("a PNG image is attached", function () {
-  cy.readFile("cucumber.png", "base64").then((file) =>
-    attach(file, "base64:image/png"),
-  );
-});
-
 When("a PDF document is attached and renamed", function () {
   cy.readFile("document.pdf", "base64").then((file) =>
     attach(file, {

compatibility/step_definitions/backgrounds.ts

@@ -0,0 +1,13 @@
+import { Given, Then, When } from "@badeball/cypress-cucumber-preprocessor";
+
+Given("an order for {string}", () => {
+  // no-op
+});
+
+When("an action", () => {
+  // no-op
+});
+
+Then("an outcome", () => {
+  // no-op
+});

compatibility/step_definitions/doc-strings.ts

@@ -0,0 +1,6 @@
+import { Given } from "@badeball/cypress-cucumber-preprocessor";
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+Given("a doc string:", (docString: string) => {
+  // no-op
+});

compatibility/step_definitions/examples-tables-undefined.ts

@@ -0,0 +1,13 @@
+import { Given, Then, When } from "@badeball/cypress-cucumber-preprocessor";
+
+Given("there are {int} cucumbers", function (initialCount) {
+  this.count = initialCount;
+});
+
+When("I eat {int} cucumbers", function (eatCount: number) {
+  this.count -= eatCount;
+});
+
+Then("I should have {int} cucumbers", function (expectedCount: number) {
+  expect(this.count).to.equal(expectedCount);
+});

compatibility/step_definitions/global-hooks-attachments.ts

@@ -0,0 +1,18 @@
+import {
+  AfterAll,
+  attach,
+  BeforeAll,
+  When,
+} from "@badeball/cypress-cucumber-preprocessor";
+
+BeforeAll({}, function () {
+  attach("Attachment from BeforeAll hook", "text/plain");
+});
+
+When("a step passes", function () {
+  // no-op
+});
+
+AfterAll({}, function () {
+  attach("Attachment from AfterAll hook", "text/plain");
+});

compatibility/step_definitions/global-hooks.ts

@@ -0,0 +1,29 @@
+import {
+  AfterAll,
+  BeforeAll,
+  When,
+} from "@badeball/cypress-cucumber-preprocessor";
+
+BeforeAll({}, function () {
+  // no-op
+});
+
+BeforeAll({}, function () {
+  // no-op
+});
+
+When("a step passes", function () {
+  // no-op
+});
+
+When("a step fails", function () {
+  throw new Error("Exception in step");
+});
+
+AfterAll({}, function () {
+  // no-op
+});
+
+AfterAll({}, function () {
+  // no-op
+});

compatibility/step_definitions/multiple-features.ts

@@ -0,0 +1,5 @@
+import { Given } from "@badeball/cypress-cucumber-preprocessor";
+
+Given("an order for {string}", () => {
+  // no-op
+});