feat: support suite tags (#49)

* feat: working grep by suite tags

* add ci test

* update readme

Author: bahmutov

.github/workflows/ci.yml

@@ -139,7 +139,6 @@ jobs:
             --expect expects/describe-tags-invert-spec.json
 
       # enable suite of tests using a tag
-      # DOES NOT WORK YET
       - name: Enable suite of tests with a tag 🧪
         run: |
           npx cypress-expect \
@@ -148,6 +147,22 @@ jobs:
             --env grepTags=@smoke \
             --expect expects/describe-tags-spec.json
 
+      - name: Nested describes with grep 🧪
+        run: |
+          npx cypress-expect \
+            --spec cypress/integration/nested-describe-spec.js \
+            --config testFiles="nested-describe-spec.js" \
+            --env grepTags=@smoke \
+            --expect expects/nested-describe-spec.json
+
+      - name: Nested describes without grep 🧪
+        run: |
+          npx cypress-expect \
+            --spec cypress/integration/nested-describe-spec.js \
+            --config testFiles="nested-describe-spec.js" \
+            --env grepTags=@does-not-exist \
+            --pending 1
+
       # repeat the selected test 3 times
       - name: Burn grepped test 🧪
         run: |

README.md

@@ -193,16 +193,19 @@ This package comes with [src/index.d.ts](./src/index.d.ts) definition file that
 
 ## Test suites
 
-The tags are also applied to the "describe" blocks with some limitations:
-
-- you can only use the config object tags
+The tags are also applied to the "describe" blocks. In that case, the tests look up if any of their outer suites are enabled.
 
 ```js
 describe('block with config tag', { tags: '@smoke' }, () => {
 })
 ```
 
-- currently only the invert tag to skip the blog has meaningful effect. For example you can skip the above suite of tests by using `--env grepTags=-@smoke` value. Keep an eye on issue [#22](https://github.com/bahmutov/cypress-grep/issues/22) for the full support implementation.
+```
+# run any tests in the blocks having "@smoke" tag
+--env grepTags=@smoke
+# skip any blocks with "@smoke" tag
+--env grepTags=-@smoke
+```
 
 See the [cypress/integration/describe-tags-spec.js](./cypress/integration/describe-tags-spec.js) file.
 

cypress/integration/describe-tags-spec.js

@@ -8,10 +8,6 @@ describe('block with no tags', () => {
   it('inside describe 2', () => {})
 })
 
-// WORKING: ignore the entire suite using invert option
-//  --env grepTags=-@smoke
-// NOT WORKING: run all the tests in this suite only
-//  --env grepTags=@smoke
 describe('block with tag smoke', { tags: '@smoke' }, () => {
   it('inside describe 3', () => {})
 

cypress/integration/nested-describe-spec.js

@@ -0,0 +1,10 @@
+/// <reference path="../../src/index.d.ts" />
+
+// @ts-check
+describe('grand', () => {
+  describe('outer', { tags: '@smoke' }, () => {
+    describe('inner', () => {
+      it('runs', () => {})
+    })
+  })
+})

expects/describe-tags-spec.json

@@ -4,8 +4,8 @@
     "inside describe 2": "pending"
   },
   "block with tag smoke": {
-    "inside describe 3": "pending",
-    "inside describe 4": "pending"
+    "inside describe 3": "passed",
+    "inside describe 4": "passed"
   },
   "block without any tags": {
     "test with tag smoke": "passed"

expects/nested-describe-spec.json

@@ -0,0 +1,9 @@
+{
+  "grand": {
+    "outer": {
+      "inner": {
+        "runs": "passing"
+      }
+    }
+  }
+}

src/support.js

@@ -56,19 +56,25 @@ function cypressGrep() {
     if (typeof configTags === 'string') {
       configTags = [configTags]
     }
+
+    const shouldRunBecauseOfParentSuite = suiteStack.includes(true)
     const shouldRun = shouldTestRun(parsedGrep, name, configTags)
     if (configTags && configTags.length) {
       debug(
         'should test "%s" with tags %s run? %s',
         name,
         configTags.join(','),
-        shouldRun,
+        shouldRunBecauseOfParentSuite || shouldRun,
       )
     } else {
-      debug('should test "%s" run? %s', name, shouldRun)
+      debug(
+        'should test "%s" run? %s',
+        name,
+        shouldRunBecauseOfParentSuite || shouldRun,
+      )
     }
 
-    if (shouldRun) {
+    if (shouldRunBecauseOfParentSuite || shouldRun) {
       if (grepBurn > 1) {
         // repeat the same test to make sure it is solid
         return Cypress._.times(grepBurn, (k) => {
@@ -83,6 +89,12 @@ function cypressGrep() {
     return _it.skip(name, options, callback)
   }
 
+  // list of "describe" suites for the current test
+  // when we encounter a new suite, we push it to the stack
+  // when the "describe" function exits, we pop it
+  // Thus a test can look up the tags from its parent suites
+  const suiteStack = []
+
   describe = function describeGrep(name, options, callback) {
     if (typeof options === 'function') {
       // the block has format describe('...', cb)
@@ -113,12 +125,15 @@ function cypressGrep() {
     const shouldRun = shouldTestRun(parsedGrep, configTags)
 
     if (shouldRun) {
+      suiteStack.push(true)
       _describe(name, options, callback)
+      suiteStack.pop()
       return
     }
 
     // skip tests without grep string in their names
     _describe.skip(name, options, callback)
+
     return
   }