feat: add group name

Author: bahmutov

README.md

@@ -82,6 +82,17 @@ 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)
 
+You can change the group name for the recorded run using `group` parameter
+
+```toml
+[[plugins]]
+# local Cypress plugin will test our site after it is built
+package = "netlify-plugin-cypress"
+  [plugins.inputs]
+  record = true
+  group = "built site"
+```
+
 ### spec
 
 Run only a single spec or specs matching a wildcard
@@ -123,7 +134,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`, `record`, `spec`.
+Parameters you can place into `preBuild` inputs: `start`, `wait-on`, `wait-on-timeout`, `spec`, `record`, and `group`.
 
 ## Debugging
 

manifest.yml

@@ -5,6 +5,7 @@ inputs:
   - name: record
     default: false
   - name: spec
+  - name: group
   # tells the plugin how to start the server using custom command
   # and waiting for an url
   - name: preBuild

src/index.js

@@ -62,19 +62,20 @@ async function waitOnMaybe (options = {}) {
   }
 }
 
-async function runCypressTests (baseUrl, record, spec) {
+async function runCypressTests (baseUrl, record, spec, group) {
   // we will use Cypress via its NPM module API
   // https://on.cypress.io/module-api
   const cypress = require('cypress')
 
-  debug('run cypress params %o', { baseUrl, record, spec })
+  debug('run cypress params %o', { baseUrl, record, spec, group })
 
   return await cypress.run({
     config: {
       baseUrl,
     },
     spec,
-    record
+    record,
+    group
   })
 }
 
@@ -113,14 +114,14 @@ const processCypressResults = (results, failBuild) => {
   }
 }
 
-async function postBuild({ fullPublishFolder, record, spec, failBuild }) {
+async function postBuild({ fullPublishFolder, record, spec, group, 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)
+  const results = await runCypressTests(baseUrl, record, spec, group)
 
   await new Promise((resolve, reject) => {
     server.close(err => {
@@ -160,7 +161,12 @@ module.exports = function cypressPlugin (pluginConfig) {
       const baseUrl = preBuildInputs['wait-on']
       const record = Boolean(preBuildInputs.record)
       const spec = preBuildInputs.spec
-      const results = await runCypressTests(baseUrl, record, spec)
+      let group
+      if (record) {
+        group = preBuildInputs.group || 'preBuild'
+      }
+
+      const results = await runCypressTests(baseUrl, record, spec, group)
 
       if (closeServer) {
         debug('closing server')
@@ -185,6 +191,10 @@ module.exports = function cypressPlugin (pluginConfig) {
       const record = hasRecordKey() && Boolean(pluginConfig.record)
 
       const spec = pluginConfig.spec
+      let group
+      if (record) {
+        group = pluginConfig.group || 'postBuild'
+      }
 
       const failBuild = arg.utils && arg.utils.build && arg.utils.build.failBuild
       la(is.fn(failBuild), 'expected failBuild function inside', arg.utils)
@@ -193,6 +203,7 @@ module.exports = function cypressPlugin (pluginConfig) {
         fullPublishFolder,
         record,
         spec,
+        group,
         failBuild
       })
     }