Merge branch 'dev'

* dev: (60 commits)
  Test cleanups incl. proper naming
  Clean up the custom test runner
  Complete app.js tests
  Minor simplification of eslint config
  WIP: Reorganise app.js to make it easier to maintain and easier to test
  Clean up and complete all currently remaining tests
  WIP: A bunch of Slack message tests
  Minor tweaks
  Improve test runner to handle user IDs + only make a DB connection if required
  devDeps: Add jest-chain for cleaner tests
  Minor: make tests more maintainable by just checking that assertions exist
  Make eslint output a little cleaner
  More Travis tweakin
  Try upgrading Travis Slack integration for .com endpoint
  Further Travis postgres tweaks
  It usually helps to use the correct filename
  Docs & CI: mention min. Postgres version & upgrade in Travis
  Restructure some tests, adding e2e tests + implementing some Slack test TODOs
  Construct test runner for end-to-end tests
  Complete Postgres tests
  ...

Author: tdmalone

.eslintrc.js

@@ -1,31 +1,68 @@
+/**
+ * Custom ESLint configuration.
+ *
+ * @see https://eslint.org/docs/user-guide/configuring
+ * @see https://eslint.org/docs/rules/
+ */
 
 'use strict';
 
 module.exports = {
 
   env: {
     browser: false,
-    node:    true
+    node: true
   },
 
-  extends: [ 'tdmalone' ],
+  extends: [
+    'tdmalone' // @see https://github.com/tdmalone/eslint-config-tdmalone/blob/master/index.js
+  ],
 
   parserOptions: {
-    ecmaVersion: 8
+    ecmaVersion: 9 // Aka ES2018. @see https://node.green/#ES2018
   },
 
   rules: {
-    'max-statements':   [ 'error', { max: 75 } ],
-    'no-magic-numbers': [ 'error', {
-      ignore: [
-        -1,
-        0,
-        1
-      ],
-      ignoreArrayIndexes: true,
-      enforceConst:       true
-    } ],
-    'no-multi-str': [ 'off' ]
-  }
-
-};
+
+    'array-bracket-newline': [ 'error', 'consistent' ],
+    'array-element-newline': [ 'error', 'consistent' ],
+
+    'object-curly-newline': [
+      'error',
+      {
+        minProperties: 3,
+        multiline: true,
+        consistent: true
+      }
+    ],
+
+    'key-spacing': [
+      'warn',
+      {
+        beforeColon: false,
+        afterColon: true,
+        mode: 'strict'
+      }
+    ],
+
+    'max-statements': [ 'error', { max: 20 } ],
+
+    'no-magic-numbers': [
+      'error',
+      {
+        ignore: [
+          -1,
+          0,
+          1
+        ],
+        ignoreArrayIndexes: true,
+        enforceConst: true
+      }
+    ],
+
+    'no-multi-str': [ 'off' ],
+    'no-var': [ 'error' ],
+    'prefer-const': [ 'error' ]
+
+  } // Rules.
+}; // Module.exports.

.travis-postgres10.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+#
+# Installs PostgreSQL 10 on Travis CI, as the default build images don't support it yet.
+#
+# @see https://github.com/travis-ci/travis-ci/issues/8537#issuecomment-354020356
+
+set -euxo pipefail
+
+echo "Installing Postgres 10..."
+sudo service postgresql stop
+sudo apt-get remove --quiet 'postgresql-*'
+sudo apt-get update --quiet
+sudo apt-get install --quiet postgresql-10 postgresql-client-10
+sudo cp /etc/postgresql/{9.6,10}/main/pg_hba.conf
+
+echo "Restarting Postgres 10..."
+sudo service postgresql restart
+
+echo "Adding Travis role..."
+sudo psql --command="CREATE ROLE travis SUPERUSER LOGIN CREATEDB;" --username="postgres"

.travis.yml

@@ -1,17 +1,42 @@
+
+# Travis CI configuration for Working PlusPlus++
+#
+# @see https://docs.travis-ci.com/user/languages/javascript-with-nodejs/
+# @see https://docs.travis-ci.com/user/database-setup/#postgresql
+# @author Tim Malone <[email protected]>
+
 language: node_js
 node_js: 10.8.0
 
+services:
+  - postgresql
+
+# Support upgrading to PostgreSQL 10, as the default build images don't support it yet.
+# (We run the install script in before_install below)
+# @see https://github.com/travis-ci/travis-ci/issues/8537#issuecomment-354020356
+sudo: required
+addons:
+  postgresql: 9.6
+
 cache:
   yarn: true
   directories:
     - node_modules
 
-# Upgrade Yarn to the version specified in package.json.
 before_install:
+
+  # Upgrade Yarn to the version specified in package.json.
   - curl --location https://yarnpkg.com/install.sh | bash -s -- --version "$( node -e "console.log(require('./package.json').engines.yarn)" )"
   - export PATH="$HOME/.yarn/bin:$PATH"
 
-install: yarn
+  # Upgrade to PostgreSQL 10.
+  - ./.travis-postgres10.sh
+
+install:
+  - yarn --frozen-lockfile
+
+before_script:
+  - psql --command="CREATE DATABASE plusplus_tests;" --username="postgres"
 
 script:
   - yarn lint
@@ -24,4 +49,4 @@ notifications:
   slack:
     on_start: always
     rooms:
-      - secure: UbCK1YGnopRxELn0sxl1Ra7/c4GjAHYb77FRS3mzgOdIzg+C3VyAilIL1SpAS3ue7IGyG+DeTtVa1azC4Xwo9abpk5/wJQxYBFlBoYV2VO9JWgz74L4i/rW00cbFZDozCv1Df3mwq9OUe6S5eXDY4KSR36hod48aZ/PRwHL8uj/VyYku5JA1BI3nyIQx7N7Tn26jzQkC2M74aO4tN3FSwrYyV0805In43+rUKGnb65glJ+nxrW6A6lBsTH9MiIt2xk9FFBuF9ZQUjG0Fu4asOGROqJp4w5b1p7Hf2PVWB773oFQuNIi4H2jEiHO/QUAtmn8i5lCuzLpB1PuGmcQGIpw4GdZE5R0gZ7au0sgqmiNM20v+5L355M0+bK+BfyEKLz+rBIl0mmmWd1rXipErlhsmQRsp1bvMk7pjoeQGgJ4Qrt9NZYqkmBR/629fGsf68maSNR+AFbYzXeOcSq/6VK445QMdw8XygYiQVswS7Kyu3/s2VeaDJOPUORpJ2jehGsj5a1B0jTpPMYXGVMwYRfA5CqT8BqM0BvwvzHtyz/sGHodMr3UIodBWBIyDigP7Pk8gYN0hTsg6rVZ7SkjWgOKxcuwOnRwA36T9KfVfyEcDfbcyROl3fSTn5wNABBrUxaFU12paTlIQlZ4Gveh9W80xN5y9fHXWJb+B80bHbnA=
+      - secure: efl6ZdfE6OTOK5L2z5m993uultsT5WanZ5sn8EmHPa0ENd2+SKXIIigQ1EqbLm1zExWLMKA3Pq5pbHwndsnWywGkZDXWy2eHoSHk7IEVLLvAceyLUr5h2pBL8wztqWGZDMBo1tHGYddQsyBlCs52AQM04i+XBX4tYiUhub7AAbMQ9cqBIz09fRZ9JBNxM6HzMvj+PmeezXzFxvzgvmVQawGQUvJPaZuf9qcwJN1ZWw0FNkIwg3Aafe809mnQnzYIwmiC9kF+ZJ14BX4qqW7uzbo7Zsf647a8LSm9OI3fWzGdNnScWXv+hkWyfHAj8cz4yI2y5l+F3Muhwylp2wHGzjARJTLQq3HTFWaAnZtpyd82FB8v82qKPaPpKTeLcVkdib/E9XjYsdFdsC33jr5vc0j/oM/bLi9pA0faWwN4kq6Q9k3Ei2u+WnP4G7Fzb1WR7zZoLmT9k4BVOJFLYF++OirE9GPaKTvRMnOaR/RO/rQkOx2FlrtzfoG//NBULycMbEMmrv4/GJ64SHQ7YtnedaEb1NwXi/qTwdDtjXkmAeNRoNayHvLLZKG3GKsUze3VIrieN8qMCTRdXRttQd3hacPYNtoCqcB7ogIMN/Jg7v1g2l2szs/v2waNMJW18Hoj3PD8dDSrH/VXlDjaqCNFxo5/sBeHC6eJtW6EkCgzCY4=

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to Working PlusPlus++
+
+Contributions are welcome! [Create an issue](https://github.com/tdmalone/working-plusplus/issues/new) if there's something you'd like to see or [send a pull request](https://github.com/tdmalone/working-plusplus/compare) if you can implement it yourself.
+
+## Installing Locally
+
+To develop locally against a real, working instance, follow most of the *Installation* instructions in the [README](README.md), except **instead of step 5** (deploying to Heroku), clone this repo locally and then install dependencies:
+
+    $ git clone https://github.com/tdmalone/working-plusplus
+    $ cd working-plusplus
+    $ yarn
+
+You'll need [Node.js](https://nodejs.org/) already installed on your system. In addition, if you don't have [Yarn](https://yarnpkg.com/en/) and don't want it, you can use `npm install` instead of `yarn` above (but you might not get _exactly_ the same dependency versions).
+
+You'll also need a local installation of PostgreSQL (or a server you can utilise) and a clean database you can use. [Here's an easy-to-use Postgres app for Macs](https://postgresapp.com/). Working PlusPlus++ requires at least PostgreSQL 9.5, but 10+ is recommended.
+
+Make the following environment variables accessible to the app:
+
+- **`SLACK_BOT_USER_OAUTH_ACCESS_TOKEN`**: from step 4 of the [installation instructions](README.md)
+- **`SLACK_VERIFICATION_TOKEN`**: from step 4 of the [installation instructions](README.md)
+- **`DATABASE_URL`**: in the format `postgres://user@localhost:5432/databasename`
+
+Then, run the app:
+
+    $ node index.js
+
+Or if you have the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed:
+
+    $ heroku local
+
+ℹ️ _For more help on using `heroku local`, see the [Heroku Local Dev Center article](https://devcenter.heroku.com/articles/heroku-local)._
+
+If you make changes to the app, press Ctrl+C to exit, and then run it again.
+
+Finally, you'll need to be able to have Slack contact your development instance directly. If you don't have the ability to forward a port through to your machine, I recommend [ngrok](https://ngrok.com/). Download and extract, then in the directory you've extracted it in run:
+
+    ./ngrok http 80 # Or port 5000 if you're running with heroku local.
+
+ngrok will provide you with the public URL your app is accessible on. This is the URL you'll then need to use in **step 6** of the [installation instructions](README.md).
+
+Other than the modifications to steps 5 and 6, make sure you've followed all the rest of the installation instructions. You should then be set up and ready with a local development instance that you can interact with directly on Slack! If you run into any problems, feel free to [create an issue](https://github.com/tdmalone/working-plusplus/issues/new).
+
+## Linting and Running Tests
+
+This app has an extensive test suite, just because. Before submitting pull requests, please check that your changes pass linting and tests by running `yarn lint` and `yarn test`. These will also be run for you by Travis CI, but it's often quicker to debug and resolve the issues locally.
+
+⚠️ _You will need access to a PostgreSQL server to run the integration and end-to-end tests. If you don't, just run the unit tests (see below) and let Travis CI run the full test suite for you._
+
+ℹ️ _If you don't have Yarn, you can replace any mention of `yarn` in this section with `npm run`._
+
+You can run just a subset of tests:
+- Unit tests with `yarn unit-tests`
+- Integration tests with `yarn integration-tests`
+- End-to-end tests with `yarn e2e-tests`
+
+It is normal to see _some_ errors while running the integration and end-to-end tests, but keep an eye on the exit code of the process to determine if it is successful (run `echo $?` immediately after running `yarn test` - you're looking for an exit code of `0` for a pass).
+
+You can modify the default testing behaviour by adjusting the relevant `scripts` in [`package.json`](package.json) or in some cases by passing additional [Jest configuration parameters](https://jestjs.io/docs/en/configuration.html) at the end of the test commands above.
+
+If you come across annoying *stylistic* linting rules, feel free to [change them](https://eslint.org/docs/rules/) in [`.eslintrc.js`](.eslintrc.js) as part of your pull request, providing they don't cause an adverse effect on existing code.
+
+Many linting issues can be automatically fixed by running `yarn fix`.

README.md

@@ -76,45 +76,9 @@ Further instructions, such as hosting elsewhere, upgrading, etc. are coming soon
 
 ## Contributing
 
-Contributions are welcome! [Create an issue](https://github.com/tdmalone/working-plusplus/issues/new) if there's something you'd like to see or [send a pull request](https://github.com/tdmalone/working-plusplus/compare) if you can implement it yourself.
+Your contributions are welcome! [Create an issue](https://github.com/tdmalone/working-plusplus/issues/new) if there's something you'd like to see or [send a pull request](https://github.com/tdmalone/working-plusplus/compare) if you can implement it yourself.
 
-To develop locally, follow most of the *Installation* instructions above, except **instead of step 5** (deploying to Heroku), clone this repo locally and then install dependencies:
-
-    $ git clone https://github.com/tdmalone/working-plusplus
-    $ cd working-plusplus
-    $ yarn
-
-You'll need [Node.js](https://nodejs.org/) already installed on your system. In addition, if you don't have [Yarn](https://yarnpkg.com/en/) and don't want it, you can use `npm install` instead of `yarn` above (but you might not get _exactly_ the same dependency versions).
-
-After installing, to run the app:
-
-    $ node index.js
-
-Or if you have the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed:
-
-    $ heroku local
-
-_For more help on running `heroku local`, see the [Heroku Local Dev Center article](https://devcenter.heroku.com/articles/heroku-local)._
-
-If you make changes to the app, press Ctrl+C to exit, and then run it again.
-
-Finally, you'll need to be able to have Slack contact your development instance directly. If you don't have the ability to forward a port through to your machine, I recommend [ngrok](https://ngrok.com/). Download and extract, then in the directory you've extracted it in run:
-
-    ./ngrok http 80 # Or port 5000 if you're running with heroku local.
-
-ngrok will provide you with the public URL your app is accessible on. This is the URL you'll then need to use in **step 6** of the installation instructions above.
-
-Other than the modifications to steps 5 and 6, make sure you've followed all the rest of the installation instructions. You should then be set up and ready with a local development instance that you can interact with directly on Slack! If you run into any problems, feel free to [create an issue](https://github.com/tdmalone/working-plusplus/issues/new).
-
-### Linting and Running Tests
-
-Before submitting pull requests, please check that your changes pass linting and tests by running `yarn lint` and `yarn test`. These will also be run for you by Travis CI, but it's often quicker to debug and resolve the issues locally.
-
-You can run just the unit tests with `yarn unit-tests`, and just the integration tests with `yarn integration-tests`. It is normal to see errors while running the integration tests - some of the tests specifically check for these errors - but keep an eye on the exit code of the process to determine if it is successful (run `echo $?` immediately after running `yarn test` - you're looking for an exit code of `0` for a pass.)
-
-You can modify the default testing behaviour by adjusting the relevant `scripts` in [`package.json`](package.json) or in some cases by passing additional [Jest configuration parameters](https://jestjs.io/docs/en/configuration.html) on the command line.
-
-If you come across annoying *stylistic* linting rules, feel free to [change them](https://eslint.org/docs/rules/) in [`.eslintrc.js`](.eslintrc.js) as part of your pull request, providing they don't cause an adverse effect on existing code. Many linting issues can be automatically fixed by running `yarn fix`.
+For full details on contributing, including getting a local environment set up, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## TODO
 
@@ -133,6 +97,8 @@ Although it works, it's very basic. Potential enhancements include:
 * Option to deduct karma automatically for swearing (with customisable word list?)
 * Record and make accessible how many karma points someone has _given_
 * Enhance messages to support interpolation of variables such as score and name of user or thing **(in progress, see [#1](https://github.com/tdmalone/working-plusplus/pull/1))**
+* Set up a Dockerfile to make local development easier (i.e. to not require Node, Yarn or Postgres)
+* Improve error handling
 
 ## License
 

app.json

@@ -18,7 +18,7 @@
     },
     "YARN_PRODUCTION": {
       "description": "This configures Heroku to only install production dependencies. See https://devcenter.heroku.com/articles/nodejs-support#package-installation for more details.",
-      "value": true
+      "value": "true"
     }
   },
   "addons": [

index.js

@@ -10,19 +10,45 @@
 'use strict';
 
 const express = require( 'express' ),
+      slack = require( '@slack/client' ),
       bodyParser = require( 'body-parser' ),
       app = require( './src/app' );
 
-// Let Heroku set the port.
-const PORT = process.env.PORT || 80; // eslint-disable-line no-process-env, no-magic-numbers
+/* eslint-disable no-process-env, no-magic-numbers */
+const PORT = process.env.PORT || 80; // Let Heroku set the port.
+const SLACK_OAUTH_ACCESS_TOKEN = process.env.SLACK_BOT_USER_OAUTH_ACCESS_TOKEN;
+/* eslint-enable no-process-env, no-magic-numbers */
 
-const server = express();
+/**
+ * Starts the server and bootstraps the app.
+ *
+ * @param {object} options Optional. Allows passing in replacements for the default Express server
+ *                         module (`express` property) and Slack Web API client module (`slack`
+ *                         property).
+ * @returns {http.Server} A Node.js http.Server object as returned by Express' listen method. See
+ *                        https://expressjs.com/en/4x/api.html#app.listen and
+ *                        https://nodejs.org/api/http.html#http_class_http_server for details.
+ */
+const bootstrap = ( options = {}) => {
+
+  // Allow alternative implementations of both Express and Slack to be passed in.
+  const server = options.express || express();
+  app.setSlackClient( options.slack || new slack.WebClient( SLACK_OAUTH_ACCESS_TOKEN ) );
+
+  server.use( bodyParser.json() );
+  server.enable( 'trust proxy' );
+  server.get( '/', app.handleGet );
+  server.post( '/', app.handlePost );
+
+  return server.listen( PORT, () => {
+    console.log( 'Listening on port ' + PORT + '.' );
+  });
+
+};
 
-server.use( bodyParser.json() );
-server.enable( 'trust proxy' );
-server.get( '/', app.handleGet );
-server.post( '/', app.handlePost );
+// If module was called directly, bootstrap now.
+if ( require.main === module ) {
+  bootstrap();
+}
 
-server.listen( PORT, () => {
-  console.log( 'Listening on port ' + PORT + '.' );
-});
+module.exports = bootstrap;

jest.config.js

@@ -0,0 +1,46 @@
+/**
+ * Configuration for Jest.
+ *
+ * @see https://jestjs.io/docs/en/configuration.html
+ */
+
+'use strict';
+
+const config = {
+  collectCoverage: true,
+  setupTestFrameworkScriptFile: 'jest-chain',
+  testEnvironment: 'node',
+
+  testMatch: [
+    '**/tests/**/*.js'
+  ],
+
+  testPathIgnorePatterns: [
+    '/mocks/',
+    '/node_modules/',
+    '/_config.js',
+    '/_runner.js',
+    '/.eslintrc.js'
+  ],
+
+  verbose: true
+};
+
+/* eslint-disable no-process-env */
+
+if ( process.env.SKIP_INTEGRATION_TESTS ) {
+  config.testPathIgnorePatterns.push( 'integration-tests' );
+}
+
+if ( process.env.SKIP_E2E_TESTS ) {
+  config.testPathIgnorePatterns.push( 'e2e-tests' );
+}
+
+process.env.PORT = 5000;
+process.env.SLACK_VERIFICATION_TOKEN = 'abcdef123';
+process.env.DATABASE_URL = 'postgres://postgres@localhost:5432/plusplus_tests';
+process.env.DATABASE_USE_SSL = false;
+
+/* eslint-enable no-process-env */
+
+module.exports = config;