Merge pull request #5 from cypress-io/add-spec-parameter

feat: add spec parameter

Author: bahmutov

README.md

@@ -69,6 +69,31 @@ plugins:
       record: true
 ```
 
+### spec
+
+Run only a single spec or specs matching a wildcard
+
+```yaml
+# Netlify config file
+build:
+  command: "npm run build"
+  publish: "build"
+  environment:
+    # do not show Cypress installation progress messages
+    CI: 1
+    # cache Cypress binary in local "node_modules" folder
+    # so Netlify caches it
+    CYPRESS_CACHE_FOLDER: "./node_modules/CypressBinary"
+    # set TERM variable for terminal output
+    TERM: "xterm"
+
+plugins:
+  # local Cypress plugin will test our site after it is built
+  - package: netlify-plugin-cypress
+    config:
+      spec: 'cypress/integration/smoke*.js'
+```
+
 ## Debugging
 
 Set environment variable `DEBUG=netlify-plugin-cypress` to see the debug logs. To see even more information, set `DEBUG=netlify-plugin-cypress,netlify-plugin-cypress:verbose`

index.js

@@ -11,16 +11,18 @@ function serveFolder (folder, port) {
   return http.createServer(server).listen(port)
 }
 
-async function runCypressTests (baseUrl, record) {
+async function runCypressTests (baseUrl, record, spec) {
   // we will use Cypress via its NPM module API
   // https://on.cypress.io/module-api
   const cypress = require('cypress')
 
   console.log('running Cypress against url %s recording?', baseUrl, record)
+
   return await cypress.run({
     config: {
-      baseUrl
+      baseUrl,
     },
+    spec,
     record
   })
 }
@@ -46,7 +48,9 @@ module.exports = function cypressPlugin (pluginConfig) {
         typeof process.env.CYPRESS_RECORD_KEY === 'string' &&
         Boolean(pluginConfig.record)
       const baseUrl = `http://localhost:${port}`
-      const results = await runCypressTests(baseUrl, record)
+      const spec = pluginConfig.spec
+
+      const results = await runCypressTests(baseUrl, record, spec)
 
       await new Promise((resolve, reject) => {
         server.close(err => {