Add tags support (#100)

* Add basic tags support

* Add cucumber-tag-expressions package

* Remove unused code

* Add basic tests for tags implementation

* Refactor tags_implementation step

* Refactor TagsImplemetation.feature

* Lint

* Fix logic - enable running scenarios with no tags while the feature is tagged and there is a tagged scenario present
NEEDS REFACTORING

* Add tests to check whether appropriate tests are run with cypress env TAGS present

* Let tests pass when the env TAGS is not set

* Improve eslint commments, make error message more explicit

* Update package.lock using 6.4.1

* Handle eslint warnings

* Update README.ms with tags description

* Rename proceedCurrentStep to shouldProceedCurrentStep, fix tests

* Add simple test for using 'this' object in step definitions

* Install husky and lint-staged, set up pre-commit hook

* Fix lint-staged

* Requested tweaks

* 1.6.0 - added tagging tests

Author: sawasawasawa

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.6.0] - 2018-10-23
+### Added
+Finally! Tagging tests! (#100, #58, #46, #24 - Thanks @GlynnJKW @ChrisBAshton @jlin412  @sawasawasawa @lucetius for all the great work!)
+ 
 ## [1.5.1] - 2018-09-16
 
 ### Fixed

README.md

@@ -90,6 +90,15 @@ Feature: The Facebook
     Then I see "Facebook" in the title
 ```
 
+## Tagging tests
+You can use tags to select which test should run using [cucumber's tag expressions](https://github.com/cucumber/cucumber/tree/master/tag-expressions).
+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)'```
+
+
 ## Configuration
 Add it to your plugins:
 
@@ -201,8 +210,7 @@ const {given, when, then} = require('cypress-cucumber-preprocessor/resolveStepDe
 
 ## TODO
 
-Tags!
-(Maybe?) Option to customize mocha template ( #3 ) 
+(Maybe?) Option to customize mocha template ( #3 )
 
 ## Credit where it's due!
 

createTestsFromFeature.js

@@ -1,17 +1,47 @@
 const { createTestFromScenario } = require("./createTestFromScenario");
+const { shouldProceedCurrentStep, getEnvTags } = require("./tagsHelper");
 
 const createTestsFromFeature = parsedFeature => {
+  const featureTags = parsedFeature.feature.tags;
+  const hasEnvTags = !!getEnvTags();
+  const hasFeatureTags = featureTags && featureTags.length > 0;
+
+  let featureShouldRun = true;
+  if (hasEnvTags) {
+    if (hasFeatureTags) {
+      featureShouldRun = shouldProceedCurrentStep(featureTags);
+    } else {
+      featureShouldRun = false;
+    }
+  }
+
+  const taggedScenarioShouldRun = parsedFeature.feature.children.some(
+    section =>
+      section.tags &&
+      section.tags.length &&
+      shouldProceedCurrentStep(section.tags)
+  );
+
   // eslint-disable-next-line prefer-arrow-callback
   describe(parsedFeature.feature.name, function() {
-    const backgroundSection = parsedFeature.feature.children.find(
-      section => section.type === "Background"
-    );
-    const otherSections = parsedFeature.feature.children.filter(
-      section => section.type !== "Background"
-    );
-    otherSections.forEach(section => {
-      createTestFromScenario(section, backgroundSection);
-    });
+    if (featureShouldRun || taggedScenarioShouldRun) {
+      const backgroundSection = parsedFeature.feature.children.find(
+        section => section.type === "Background"
+      );
+      const otherSections = parsedFeature.feature.children.filter(
+        section => section.type !== "Background"
+      );
+      otherSections.forEach(section => {
+        const scenarioHasTags = section.tags.length > 0;
+        const shouldRun =
+          hasEnvTags && scenarioHasTags
+            ? shouldProceedCurrentStep(section.tags.concat(featureTags)) // concat handles inheritance of tags from feature
+            : featureShouldRun;
+        if (shouldRun) {
+          createTestFromScenario(section, backgroundSection);
+        }
+      });
+    }
   });
 };
 

cypress/integration/TagsImplementation.feature

@@ -0,0 +1,31 @@
+Feature: Tags Implementation
+
+  As a cucumber cypress plugin which handles Tags
+  I want to allow people to tag their scenarios with any tag
+  And then they can use those tags as per https://docs.cucumber.io/cucumber/api/#tags
+
+  Scenario: Pass no tags
+    Given my cypress environment variable TAGS is 'lots of random things'
+    Then the cypress runner should not break
+
+  Scenario: Pass a single tag
+    Given my cypress environment variable TAGS is '@smoke-tests'
+    Then tests tagged '@smoke-tests' should proceed
+    And tests tagged '@wrong-tag' should not proceed
+
+  Scenario: Pass a tag to ignore
+    Given my cypress environment variable TAGS is 'not @ignore'
+    Then tests tagged '@ignore' should not proceed
+    Then tests tagged '@do-not-ignore' should proceed
+
+  Scenario: Passing multiple tags joined by AND operator
+    Given my cypress environment variable TAGS is '@foo and @bar'
+    Then tests tagged '@foo @bar' should proceed
+    And tests tagged '@foo @ba' should not proceed
+
+  Scenario: Passing multiple tags joined by OR operator
+    Given my cypress environment variable TAGS is '@foo or @bar'
+    Then tests tagged '@foo' should proceed
+    And tests tagged '@bar' should proceed
+    And tests tagged '@foo @baz' should proceed
+    And tests tagged '@fo @ba' should not proceed

cypress/integration/TagsImplementationWithEnvSet.feature

@@ -0,0 +1,20 @@
+@test-tag
+Feature: Tags Implementation with environmental variables set
+
+  As a cucumber cypress plugin which handles Tags
+  I want to allow people set any tags via CLI
+  And run only tests selected by given tags
+
+  @ignore-tag
+  Scenario: This scenario should not run if @ignore-tag is present in env
+    Given 'not @ignore-tag' is in current TAGS environmental variable
+    Then this should not run
+
+  Scenario: This scenario should run
+    Given '@test-tag' is in current TAGS environmental variable
+    Then this should run
+
+  @this-tag-affects-nothing
+  Scenario: This scenario should also run
+    Given '@test-tag' is in current TAGS environmental variable
+    Then this should run

cypress/integration/TagsImplementationWithEnvSetScenarioLevel.feature

@@ -0,0 +1,14 @@
+Feature: Tags Implementation with environmental variables set only at scenario level
+
+  As a cucumber cypress plugin which handles Tags
+  I want to allow people set any tags via CLI
+  And run only tests selected even if they are tagged only at scenario level
+
+  Scenario: This scenario should not run if @test-tag is present in env
+    Given '@test-tag' is in current TAGS environmental variable
+    Then this should not run
+
+  @test-tag
+  Scenario: This scenario should run
+    Given '@test-tag' is in current TAGS environmental variable
+    Then this should run

cypress/integration/UsingThis.feature

@@ -0,0 +1,6 @@
+Feature: Test for using 'this' keyword in step definitions
+
+  Scenario: Keyword 'this' test with a classic function
+
+    When I assign a variable to 'this' object
+    Then 'this' object contains the given value

cypress/support/step_definitions/tags_implementation.js

@@ -0,0 +1,28 @@
+/* global given, then */
+
+const {
+  shouldProceedCurrentStep
+} = require("cypress-cucumber-preprocessor/tagsHelper"); // eslint-disable-line
+
+let parsedTags;
+
+given(/my cypress environment variable TAGS is '(.+)'/, envTagsString => {
+  parsedTags = envTagsString;
+});
+
+then(/the cypress runner should not break/, () => {
+  const shouldNeverThrow = () => {
+    shouldProceedCurrentStep([{ name: "@test-tag" }], parsedTags);
+  };
+  expect(shouldNeverThrow).to.not.throw();
+});
+
+then(
+  /tests tagged '(.+)' should (not )?proceed/,
+  (tags, shouldProceed = false) => {
+    const tagsArray = tags.split(" ").map(tag => ({ name: tag }));
+    expect(shouldProceedCurrentStep(tagsArray, parsedTags)).to.equal(
+      !shouldProceed
+    );
+  }
+);

cypress/support/step_definitions/tags_implementation_with_env_set.js

@@ -0,0 +1,14 @@
+/* global given, then */
+
+let isPresentInTagsEnv;
+const cypressEnvTags = Cypress.env("TAGS");
+
+given(/'(.+)' is in current TAGS environmental variable/, envTagsString => {
+  isPresentInTagsEnv = RegExp(envTagsString).test(cypressEnvTags);
+});
+
+then(/this should (not )?run/, shouldNotRun => {
+  if (typeof cypressEnvTags !== "undefined") {
+    expect(!shouldNotRun).to.equal(isPresentInTagsEnv);
+  }
+});

cypress/support/step_definitions/usingThis.js

@@ -0,0 +1,10 @@
+/* global then, when */
+/* eslint-env mocha */
+
+when("I assign a variable to 'this' object", function() {
+  this.testVariable = "testValue";
+});
+
+then("'this' object contains the given value", function() {
+  expect(this.testVariable).to.equal("testValue");
+});