Initial tests (#17)

* Add ALL the testing tools!

* Integrate a couple more eslint plugins

* First test! Yay!

* First pass testing most of the checkers

* Set up an action for running tests

* "actioino" != "action"

* Fix more typos. Because spelling is important.

* Apply suggestions from code review

Co-authored-by: msluther <[email protected]>

* Remove explicit linting since it's in posttest now

* Add some documentation on writing/running tests

Co-authored-by: msluther <[email protected]>

Author: tarkatronic

.eslintrc

@@ -1,4 +1,14 @@
 {
   "root": true,
-  "extends": "godaddy"
+  "extends": [
+    "godaddy",
+    "plugin:mocha/recommended"
+  ],
+  "plugins": [
+    "eslint-plugin-mocha",
+    "eslint-plugin-node"
+  ],
+  "env": {
+    "node": true
+  }
 }

.github/workflows/node.js.yml

@@ -0,0 +1,36 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 15.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install, build, and run tests
+      run: |
+        npm ci
+        npm run build --if-present
+        npm test
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        file: coverage/cobertura-coverage.xml

README.md

@@ -117,6 +117,20 @@ does have the side effect that, if an internal username is connected to multiple
 GitHub usernames, as demonstrated above, all of those GitHub usernames will be
 made admins of the org.
 
+## Development
+
+### Running Tests
+
+This project uses [mocha], [assume], and [sinon] for its tests. It also uses
+[eslint] for ensuring code styling. Luckily, the execution of these tools is
+nicely automated for you. To run all of them, all you need to do is:
+
+```console
+$ npm test
+```
+
+This will run all of the tests for you, followed by the linter.
+
 ## Credits
 
 Originally developed internally for making easier work of the management of
@@ -125,8 +139,11 @@ Originally developed internally for making easier work of the management of
 * [Joey Wilhelm]
 * [Rick Markins]
 
-[TOML]: https://toml.io/
 [array of tables]: https://toml.io/en/v1.0.0#array-of-tables
+[assume]: http://assume.fail/
 [GoDaddy]: https://www.godaddy.com/
 [Joey Wilhelm]: https://github.com/tarkatronic/
+[mocha]: https://mochajs.org/
 [Rick Markins]: https://github.com/rxmarbles/
+[sinon]: https://sinonjs.org/
+[TOML]: https://toml.io/