fix(cypress): Merge all steps of a scenario into a single test. (#44)

* fix(cypress): Fix state clearing between each state

BREAKING CHANGE: each scenario is implemented as a single test now. We lose the ability to know exactly which step fails within a scenario

* test: Fix lint errors and tests

* fix(cypress): Transform background sections into beforeEach blocks

* fix(cypress): Add an index to tests with examples

* chore(package): Remove mocha-steps

It has become useless since we don't execute steps as individual tests anymore. It will become useful again when cypress allows to control state clearing and we can get steps as tests again.

createTestFromScenario.js

@@ -1,33 +1,30 @@
 /* eslint-disable prefer-template */
-/* global step */
-
-require("mocha-steps");
 const { resolveAndRunStepDefinition } = require("./resolveStepDefinition");
 
-const stepTest = stepDetails =>
-  step(`${stepDetails.keyword} ${stepDetails.text}`, () => {
-    resolveAndRunStepDefinition(stepDetails);
-  });
+const stepTest = stepDetails => {
+  cy.log(`${stepDetails.keyword} ${stepDetails.text}`);
+  resolveAndRunStepDefinition(stepDetails);
+};
 
-const createTestFromScenario = scenario => {
-  describe(scenario.name, () => {
-    if (scenario.examples) {
-      scenario.examples.forEach(example => {
-        const exampleValues = [];
+const createTestFromScenario = (scenario, backgroundSection) => {
+  if (scenario.examples) {
+    scenario.examples.forEach(example => {
+      const exampleValues = [];
 
-        example.tableBody.forEach((row, rowIndex) => {
-          example.tableHeader.cells.forEach((header, headerIndex) => {
-            exampleValues[rowIndex] = Object.assign(
-              {},
-              exampleValues[rowIndex],
-              {
-                [header.value]: row.cells[headerIndex].value
-              }
-            );
+      example.tableBody.forEach((row, rowIndex) => {
+        example.tableHeader.cells.forEach((header, headerIndex) => {
+          exampleValues[rowIndex] = Object.assign({}, exampleValues[rowIndex], {
+            [header.value]: row.cells[headerIndex].value
           });
         });
+      });
+
+      exampleValues.forEach((_, index) => {
+        it(`${scenario.name} (example #${index + 1})`, () => {
+          if (backgroundSection) {
+            backgroundSection.steps.forEach(stepTest);
+          }
 
-        exampleValues.forEach((_, index) => {
           scenario.steps.forEach(step => {
             const newStep = Object.assign({}, step);
             Object.entries(exampleValues[index]).forEach(column => {
@@ -43,10 +40,15 @@ const createTestFromScenario = scenario => {
           });
         });
       });
-    } else {
+    });
+  } else {
+    it(scenario.name, () => {
+      if (backgroundSection) {
+        backgroundSection.steps.forEach(stepTest);
+      }
       scenario.steps.forEach(step => stepTest(step));
-    }
-  });
+    });
+  }
 };
 
 module.exports = {

createTestsFromFeature.js

@@ -1,6 +1,6 @@
 const { createTestFromScenario } = require("./createTestFromScenario");
 
-const createTestsFromFeature = parsedFeature =>
+const createTestsFromFeature = parsedFeature => {
   describe(parsedFeature.feature.name, () => {
     const backgroundSection = parsedFeature.feature.children.find(
       section => section.type === "Background"
@@ -9,12 +9,10 @@ const createTestsFromFeature = parsedFeature =>
       section => section.type !== "Background"
     );
     otherSections.forEach(section => {
-      if (backgroundSection) {
-        createTestFromScenario(backgroundSection);
-      }
-      createTestFromScenario(section);
+      createTestFromScenario(section, backgroundSection);
     });
   });
+};
 
 module.exports = {
   createTestsFromFeature

package.json

@@ -32,7 +32,6 @@
     "debug": "^3.0.1",
     "gherkin": "^5.0.0",
     "glob": "^7.1.2",
-    "mocha-steps": "^1.1.0",
     "through": "^2.3.8"
   },
   "devDependencies": {

resolveStepDefinition.test.js

@@ -1,4 +1,5 @@
 /* eslint-disable global-require */
+/* global jest */
 const fs = require("fs");
 const { Parser } = require("gherkin");
 const { createTestsFromFeature } = require("./createTestsFromFeature");
@@ -7,6 +8,9 @@ const { when, then, given } = require("./resolveStepDefinition");
 window.when = when;
 window.then = then;
 window.given = given;
+window.cy = {
+  log: jest.fn()
+};
 
 const readAndParseFeatureFile = featureFilePath => {
   const spec = fs.readFileSync(featureFilePath);