add tag support

Author: bahmutov

README.md

@@ -82,6 +82,8 @@ package = "netlify-plugin-cypress"
 
 See [cypress-example-kitchensink](https://github.com/cypress-io/cypress-example-kitchensink) and recorded results at [![Cypress Dashboard](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://dashboard.cypress.io/#/projects/4b7344/runs)
 
+#### group
+
 You can change the group name for the recorded run using `group` parameter
 
 ```toml
@@ -93,6 +95,20 @@ package = "netlify-plugin-cypress"
   group = "built site"
 ```
 
+#### tag
+
+You can give recorded run [tags](https://on.cypress.io/module-api#cypress-run) using a comma-separated string
+
+```toml
+[[plugins]]
+# local Cypress plugin will test our site after it is built
+package = "netlify-plugin-cypress"
+  [plugins.inputs]
+  record = true
+  group = "built site"
+  tag = "nightly,production"
+```
+
 ### spec
 
 Run only a single spec or specs matching a wildcard
@@ -134,7 +150,7 @@ By default this plugin tests static site _after build_. But maybe you want to ru
     wait-on-timeout = '30' # seconds
 ```
 
-Parameters you can place into `preBuild` inputs: `start`, `wait-on`, `wait-on-timeout`, `spec`, `record`, and `group`.
+Parameters you can place into `preBuild` inputs: `start`, `wait-on`, `wait-on-timeout`, `spec`, `record`, `group`, and `tag`.
 
 ## Debugging
 

src/index.js

@@ -62,7 +62,7 @@ async function waitOnMaybe (options = {}) {
   }
 }
 
-async function runCypressTests (baseUrl, record, spec, group) {
+async function runCypressTests (baseUrl, record, spec, group, tag) {
   // we will use Cypress via its NPM module API
   // https://on.cypress.io/module-api
   const cypress = require('cypress')
@@ -74,7 +74,7 @@ async function runCypressTests (baseUrl, record, spec, group) {
     ciBuildId = process.env.BUILD_ID
   }
 
-  debug('run cypress params %o', { baseUrl, record, spec, group, ciBuildId })
+  debug('run cypress params %o', { baseUrl, record, spec, group, tag, ciBuildId })
 
   return await cypress.run({
     config: {
@@ -83,6 +83,10 @@ async function runCypressTests (baseUrl, record, spec, group) {
     spec,
     record,
     group,
+    // ignoring the TS error for now
+    // https://github.com/cypress-io/cypress/pull/6796
+    // @ts-ignore
+    tag,
     ciBuildId
   })
 }
@@ -122,14 +126,14 @@ const processCypressResults = (results, failBuild) => {
   }
 }
 
-async function postBuild({ fullPublishFolder, record, spec, group, failBuild }) {
+async function postBuild({ fullPublishFolder, record, spec, group, tag, failBuild }) {
   const port = 8080
   const server = serveFolder(fullPublishFolder, port)
   debug('local server listening on port %d', port)
 
   const baseUrl = `http://localhost:${port}`
 
-  const results = await runCypressTests(baseUrl, record, spec, group)
+  const results = await runCypressTests(baseUrl, record, spec, group, tag)
 
   await new Promise((resolve, reject) => {
     server.close(err => {
@@ -170,11 +174,15 @@ module.exports = function cypressPlugin (pluginConfig) {
       const record = Boolean(preBuildInputs.record)
       const spec = preBuildInputs.spec
       let group
+      let tag
       if (record) {
         group = preBuildInputs.group || 'preBuild'
+        if (preBuildInputs.tag) {
+          tag = preBuildInputs.tag
+        }
       }
 
-      const results = await runCypressTests(baseUrl, record, spec, group)
+      const results = await runCypressTests(baseUrl, record, spec, group, tag)
 
       if (closeServer) {
         debug('closing server')
@@ -200,8 +208,12 @@ module.exports = function cypressPlugin (pluginConfig) {
 
       const spec = pluginConfig.spec
       let group
+      let tag
       if (record) {
         group = pluginConfig.group || 'postBuild'
+        if (pluginConfig.tag) {
+          tag = pluginConfig.tag
+        }
       }
 
       const failBuild = arg.utils && arg.utils.build && arg.utils.build.failBuild
@@ -212,6 +224,7 @@ module.exports = function cypressPlugin (pluginConfig) {
         record,
         spec,
         group,
+        tag,
         failBuild
       })
     }