Technical/issue 56 organize tests (#74)

* WIP tests

* all happy paths for config

* WIP refactoring setup to use cwd context

* WIP refactoring

* more cases working

* cleanup

* formatting

* new nested case

* more cases

* page template case

* clean up tests

* config workspace case

* smoke testing and creating test bed

* using more smoke testing

* added testing for deeper 404 and index testing

* remove eslint

* watch mode

* code coverage and reporting

* reuse test bed

* playing around with smoke tests

* cleanup

* delete fixtures

* remove commented out code

* increase test timeout

* one minute?

* build config error handling

* relax smoke test content testing

* fix spec using hash

* better test and build output cleanup

* Technical/issue 56 organize tests smoke test refactor (#75)

* integrating smoke tests

* full smoke test integration

* cleanup

* fix linting

* improve error message

* Fix test async and teardown (#77)

* fix: removed smoke test promises, implemented shared context using this

* fix: remove TODO

Author: thescientist13

.github/CONTRIBUTING.md

@@ -22,12 +22,35 @@ To develop for the project, you'll want to follow these steps:
 1. Run `yarn install`
 
 
-## Unit Testing
-Unit tests have been written that can be run using
+## Testing
+Greenwood follows [BDD style testing](https://en.wikipedia.org/wiki/Behavior-driven_development) through "cases".  Cases are used to capture the capabilities and features of Greenwood when running its various commands in a way that is close to how the user would actually expect the tool to work and so generally revolves around testing the build output of running `greenwood build`.  
+
+### Guidelines
+Cases follow a convention starting with the command (e.g. `build`) and and the capability and features being tested, like configuration with a particular option (e.g. `publicPath`):
+```shell
+<command>.<capability>.<feature>.spec.js
+```
+
+Examples:
+- _build.default.spec.js_ - Would test `greenwood build` with no config and no workspace.
+- _build.config.workspace-custom.spec.js_ - Would test `greenwood build` with a config that had a custom `workspace`
+- _build.config.workspace-public-path.spec.js_ - Would test `greenwood build` with a config that had a custom `workspace` and `publicPath` set.
+
+### Running Tests
+To run tests in watch mode, use:
+```shell
+$ yarn test:tdd
+```
+
+To verify compliance with coverage and watermark thresholds (what CI server runs), use:
 ```shell
 $ yarn test
 ```
 
-Note, you can use the following to adjust how many mocha tests get run:
-- `describe.only` / `it.only`: only run this block
-- `xdescribe` / `xit`: dont run this block
+Below are some tips to help with running / debugging tests
+- `describe.only` / `it.only`: only runs this block
+- `xdescribe` / `xit`: dont run this block
+- uncomment `setup.teardownTestBed()` in a case to see the build output without it getting cleaned
+- use `new TestBed(true)` get debug output from Greenwood when running tests
+
+> **PLEASE DO NOT COMMIT ANY OF THESE ABOVE CHANGES THOUGH**

.gitignore

@@ -1,4 +1,6 @@
 *.log
 .greenwood/
+.nyc_output/
+coverage/
 node_modules/
 public/

nyc.config.js

@@ -0,0 +1,30 @@
+module.exports = {
+  
+  all: true,
+  
+  include: [
+    'packages/cli/lib/**/*.js',
+    'packages/cli/tasks/*.js'
+  ],
+
+  reporter: [
+    'cobertura',
+    'html',
+    'text',
+    'text-summary'
+  ],
+
+  checkCoverage: true,
+
+  statements: 85,
+  branches: 65,
+  functions: 90,
+  lines: 85,
+
+  watermarks: {
+    statements: [75, 85],
+    branches: [75, 85],
+    functions: [75, 85],
+    lines: [75, 85]
+  }
+};

package.json

@@ -7,48 +7,42 @@
   "author": "Owen Buckley <[email protected]>",
   "license": "MIT",
   "scripts": {
-    "clean": "rimraf ./.greenwood && rimraf ./public",
+    "clean": "rimraf ./**/.greenwood/** && rimraf ./**/public/** && rimraf ./coverage",
     "lint": "eslint \"./packages/**/**/*.js\" \"./test/**/**/*.js\"",
     "build": "node ./packages/cli/index.js build",
     "serve": "yarn clean && yarn build && cd ./public && ws",
     "develop": "yarn clean && node ./packages/cli/index.js develop",
-    "test": "yarn clean && mocha --timeout 15000"
+    "test": "yarn clean && nyc mocha ./test/**/**/**/*.spec.js --timeout 30000",
+    "test:tdd": "yarn clean && mocha --watch ./test/**/**/**/*.spec.js --timeout 15000"
   },
   "dependencies": {
     "@babel/core": "^7.4.0",
     "@babel/preset-env": "^7.4.1",
     "babel-loader": "^8.0.5",
     "babel-plugin-transform-builtin-classes": "^0.6.1",
-    "chai": "^4.2.0",
-    "chai-as-promised": "^7.1.1",
     "chalk": "^2.4.2",
     "colors": "^1.3.3",
     "commander": "^2.20.0",
-    "concurrently": "^4.1.0",
     "css-loader": "^2.1.1",
     "css-to-string-loader": "^0.1.3",
     "cssnano": "^4.1.10",
     "eslint": "^5.15.3",
-    "eslint-loader": "^2.1.2",
     "file-loader": "^3.0.1",
     "filewatcher-webpack-plugin": "^1.2.0",
     "front-matter": "^3.0.1",
-    "fs-extra": "^7.0.1",
     "glob": "^7.1.3",
     "glob-promise": "^3.4.0",
     "html-webpack-plugin": "^3.2.0",
     "jsdom": "^14.0.0",
     "lit-element": "^2.0.1",
     "lit-redux-router": "^0.8.5",
     "local-web-server": "^2.6.1",
-    "mocha": "^6.0.2",
     "postcss-cssnext": "^3.1.0",
     "postcss-loader": "^3.0.0",
     "puppeteer": "^1.13.0",
     "pwa-helpers": "^0.9.1",
     "redux": "^4.0.1",
     "redux-thunk": "^2.3.0",
-    "rimraf": "^2.6.3",
     "wc-markdown-loader": "^0.1.0",
     "webpack": "^4.29.6",
     "webpack-cli": "^3.3.0",
@@ -57,6 +51,10 @@
     "webpack-merge": "^4.2.1"
   },
   "devDependencies": {
-    "http-server": "^0.11.1"
+    "chai": "^4.2.0",
+    "http-server": "^0.11.1",
+    "mocha": "^6.1.4",
+    "nyc": "^14.0.0",
+    "rimraf": "^2.6.3"
   }
 }

packages/cli/config/.eslintrc

@@ -44,13 +44,6 @@ module.exports = (config, context) => {
 
     module: {
       rules: [{
-        test: /\.js$/,
-        enforce: 'pre',
-        loader: 'eslint-loader',
-        options: {
-          configFile: path.join(__dirname, './.eslintrc')
-        }
-      }, {
         test: /\.js$/,
         loader: 'babel-loader',
         options: {

packages/cli/config/webpack.config.common.js

@@ -39,7 +39,6 @@ if (program.parse.length === 0) {
 }
 
 const run = async() => {
-  process.env.NODE_ENV = MODE === 'develop' ? 'development' : 'production';
 
   try {
     const compilation = await generateCompilation();