feat: add start option to post build (#151) (#171)

Co-authored-by: Alex Foster <[email protected]>

Author: bahmutov

.gitignore

@@ -2,6 +2,7 @@ node_modules/
 **/cypress/screenshots
 **/cypress/videos
 build
+.DS_Store
 
 # Local Netlify folder
 .netlify

README.md

@@ -280,7 +280,7 @@ See [netlify-plugin-prebuild-example](https://github.com/cypress-io/netlify-plug
 
 ### testing the site after build
 
-By default this plugin tests static site _after deploy_. But maybe you want to run end-to-end tests locally after building the static site. Cypress includes a local static server for this case. Here is a sample config file
+By default this plugin tests static site _after deploy_. But maybe you want to run end-to-end tests locally after building the static site. Cypress includes a local static server for this case but you can specify your own command if needed by using the `start` argument. Here is a sample config file
 
 ```toml
 [[plugins]]
@@ -290,7 +290,7 @@ By default this plugin tests static site _after deploy_. But maybe you want to r
     enable = true
 ```
 
-Parameters you can place into `postBuild` inputs: `spec`, `record`, `group`, `tag`, and `spa`.
+Parameters you can place into `postBuild` inputs: `spec`, `record`, `group`, `tag`, `start` and `spa`.
 
 #### The SPA parameter
 
@@ -306,6 +306,7 @@ If your site requires all unknown URLs to redirect back to the index page, use t
     # so that client-side routing can correctly route them
     # can be set to true or "index.html" (or similar fallback filename in the built folder)
     spa = true
+    start = 'npm start'
 ```
 
 See [the routing example](./tests/routing/netlify.toml).

circle.yml

@@ -12,6 +12,9 @@ jobs:
       - node/with-cache:
           steps:
             - run: npm ci
+            - run:
+                name: show package contents 📦
+                command: npm pack --dry
 
   release:
     executor:
@@ -105,6 +108,19 @@ jobs:
           environment:
             DEBUG: netlify-plugin-cypress
 
+  'test-postbuild-start':
+    executor: cypress/base-12-14-0
+    steps:
+      # all dependencies were installed in previous job
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: Netlify Build 🏗
+          command: npm run netlify:build
+          working_directory: tests/test-postbuild-start
+          environment:
+            DEBUG: netlify-plugin-cypress
+
   'test-using-chromium':
     executor: cypress/base-12-14-0
     steps:
@@ -194,6 +210,9 @@ workflows:
       - 'test-prebuild-only':
           requires:
             - cypress/install
+      - 'test-postbuild-start':
+          requires:
+            - cypress/install
       - test-using-chromium:
           requires:
             - cypress/install
@@ -217,6 +236,7 @@ workflows:
             - 'recording test'
             - 'test-twice'
             - 'test-prebuild-only'
+            - 'test-postbuild-start'
             - test-using-chromium
             - test-netlify-dev
             - 'routing'

package.json

@@ -6,6 +6,7 @@
   "main": "src",
   "scripts": {
     "test": "cypress run",
+    "test:unit": "jest",
     "semantic-release": "semantic-release",
     "start": "serve public"
   },
@@ -16,7 +17,8 @@
   "author": "Gleb Bahmutov <[email protected]>",
   "files": [
     "manifest.yml",
-    "src"
+    "src",
+    "!src/**/*.test.js"
   ],
   "license": "ISC",
   "dependencies": {
@@ -41,6 +43,7 @@
     "node": ">=10.18.1"
   },
   "devDependencies": {
+    "jest": "^24.9.0",
     "cypress": "6.8.0",
     "netlify-cli": "3.13.7",
     "prettier": "2.2.1",
@@ -61,5 +64,8 @@
         "prerelease": true
       }
     ]
+  },
+  "jest": {
+    "rootDir": "./src"
   }
 }

src/constants.js

@@ -0,0 +1,4 @@
+module.exports = {
+  PLUGIN_NAME: 'netlify-plugin-cypress',
+  DEFAULT_BROWSER: 'chromium',
+}