Cypress tags wrapper (#166)

* fix: make sure that when using 'not @tag', we do run features that do not have any tags

* feat: a custom wrapper that respects tags

* docs: info about the new wrapper

Author: lgandecki

README.md

@@ -237,7 +237,11 @@ Keep in mind we are using newer syntax, eg. `'not @foo and (@bar or @zap)'`.
 In order to initialize tests using tags you will have to run cypress and pass TAGS environment variable.
 
 Example:
-  ```cypress run -e TAGS='not @foo and (@bar or @zap)'```
+  ```./node_modules/.bin/cypress-tags run -e TAGS='not @foo and (@bar or @zap)'```
+
+Please note - we use our own cypress-tags wrapper to speed things up.
+For more details and examples please take a look to the example repo:
+[cypress-cucumber-example](https://github.com/TheBrainFamily/cypress-cucumber-example)
 
 ### Smart tagging
 Start your tests without setting any tags. And then put a @focus on the scenario (or scenarios) you want to focus on while development or bug fixing.

cypress-tags.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+const { Parser } = require("gherkin");
+const glob = require("glob");
+const fs = require("fs");
+const { execFileSync } = require("child_process");
+
+const { shouldProceedCurrentStep } = require("./lib/tagsHelper");
+
+// TODO currently we only work with feature files in cypress/integration folder.
+// It should be easy to base this on the cypress.json configuration - we are happy to take a PR
+// here if you need this functionality!
+
+const paths = glob.sync("cypress/integration/**/*.feature");
+
+const featuresToRun = [];
+
+const debug = (message, ...rest) =>
+  process.env.DEBUG
+    ? console.log(`DEBUG: ${message}`, rest.length ? rest : "")
+    : null;
+
+const found = process.argv.slice(2).find(arg => arg.indexOf("TAGS=") === 0);
+
+const envTags = found.replace(/.*=/, "");
+debug("Found tag expression", envTags);
+
+paths.forEach(featurePath => {
+  const spec = `${fs.readFileSync(featurePath)}`;
+  const parsedFeature = new Parser().parse(spec);
+
+  const featureTags = parsedFeature.feature.tags;
+  const featureShouldRun = shouldProceedCurrentStep(featureTags, envTags);
+  const taggedScenarioShouldRun = parsedFeature.feature.children.some(
+    section =>
+      section.tags &&
+      section.tags.length &&
+      shouldProceedCurrentStep(section.tags.concat(featureTags), envTags)
+  );
+  debug(
+    `Feature: ${featurePath}, featureShouldRun: ${featureShouldRun}, taggedScenarioShouldRun: ${taggedScenarioShouldRun}`
+  );
+  if (featureShouldRun || taggedScenarioShouldRun) {
+    featuresToRun.push(featurePath);
+  }
+});
+
+try {
+  execFileSync(
+    `${__dirname}/node_modules/.bin/cypress`,
+    [...process.argv.slice(2), "--spec", featuresToRun.join(",")],
+    {
+      stdio: [process.stdin, process.stdout, process.stderr]
+    }
+  );
+} catch (e) {
+  debug("Error while running cypress (or just a test failure)", e);
+  process.exit(1);
+}

package-lock.json

@@ -9,6 +9,9 @@
     "fixStyle": "eslint . --fix",
     "semantic-release": "semantic-release"
   },
+  "bin": {
+    "cypress-tags": "cypress-tags.js"
+  },
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged && jest"