Update local testing setup

Add docker-compose.test.yml for a local test DB
Add mocharc with default files to test so they can be omitted from the test command
Update the knexfile to provide some defaults for dev/test envs
Add lint and test to the README
Disable lint/test in circleCI

Author: levinmr

.circleci/config.yml

@@ -34,34 +34,6 @@ install_cf_cli: &install_cf_cli
         sudo dpkg -i cf8-cli-installer_8.7.4_x86-64.deb
 
 jobs:
-  lint_js:
-    docker:
-      - image: cimg/node:20.11.0-browsers
-    steps:
-      - checkout
-      - *restore_npm_cache
-      - *install_npm_packages
-      - *save_npm_cache
-      - run:
-          name: lint javascript
-          command: npm run lint
-  test:
-    docker:
-      - image: cimg/node:20.11.0-browsers
-        environment:
-          POSTGRES_USER: postgres
-          NODE_ENV: test
-      - image: circleci/postgres:9.5-alpine
-        environment:
-          POSTGRES_DB: analytics-api-test
-    steps:
-      - checkout
-      - *restore_npm_cache
-      - *install_npm_packages
-      - *save_npm_cache
-      - run:
-          name: unit test javascript
-          command: npm test
   development_env_deploy:
     docker:
       - image: cimg/node:20.11.0-browsers

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
         with:
             path: ./node_modules
             key: v1-dependencies-${{ env.PACKAGE_CHECKSUM }}
-      - name: Lint JavaScript
+      - name: lint javascript
         run: npm run lint
   test:
     needs: lint
@@ -39,8 +39,8 @@ jobs:
         image: postgres:latest
         env:
           POSTGRES_DB: analytics_reporter_test
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: postgres
+          POSTGRES_USER: analytics
+          POSTGRES_PASSWORD: 123abc
         ports:
           - 5432:5432
         options:
@@ -71,10 +71,5 @@ jobs:
         with:
             path: ./node_modules
             key: v1-dependencies-${{ env.PACKAGE_CHECKSUM }}
-      - name: Run tests
-        env:
-            POSTGRES_USER: postgres
-            POSTGRES_PASSWORD: postgres
-            POSTGRES_DB: analytics_reporter_test
-            POSTGRES_PORT: ${{ job.services.postgres.ports[5432] }}
+      - name: run tests
         run: npm test

.mocharc.yml

@@ -0,0 +1,11 @@
+diff: true
+extension: ['js']
+package: './package.json'
+slow: '75'
+spec:
+  - 'test/**/*.js'
+timeout: '2000'
+ui: 'bdd'
+watch-files:
+  - 'src/**/*.js'
+  - 'test/**/*.js'

README.md

@@ -149,21 +149,41 @@ An enum which describes the session. Possible values:
 'Direct', 'Organic Search', 'Paid Social', 'Organic Social', 'Email',
 'Affiliates', 'Referral', 'Paid Search', 'Video', and 'Display'
 
-# Running the Tests
+# Linting
 
-The Analytics API application is backed by a test suite that uses
-[Mocha](https://mochajs.org/) to run tests.
+This repo uses Eslint and Prettier for code static analysis and formatting. Run
+the linter with:
 
-Before running the test suite, a database for the tests will need to be created.
+```shell
+npm run lint
+```
+
+Automatically fix lint issues with:
 
 ```shell
-createdb analytics-api-test
+npm run lint:fix
 ```
 
-Then the tests can be invoked via NPM. The test script has a pretest hook that
-migrates the database.
+# Running the unit tests
+
+The unit tests for this repo require a local PostgreSQL database. You can run a
+local DB server or create a docker container using the provided test compose
+file. (Requires docker and docker-compose to be installed)
+
+Starting a docker test DB:
 
+```shell
+docker-compose -f docker-compose.test.yml up
 ```
+
+Once you have a PostgreSQL DB running locally, you can run the tests. The test
+DB connection in knexfile.js has some default connection config which can be
+overridden with environment variables.  If using the provided docker-compose DB
+then you can avoid setting the connection details.
+
+Run the tests (pre-test hook runs DB migrations):
+
+```shell
 npm test
 ```
 

docker-compose.test.yml

@@ -0,0 +1,10 @@
+version: "3.0"
+services:
+  db:
+    image: postgres:16
+    environment:
+      - POSTGRES_DB=analytics_reporter_test
+      - POSTGRES_USER=analytics
+      - POSTGRES_PASSWORD=123abc
+    ports:
+      - "5432:5432"

knexfile.js

@@ -26,8 +26,10 @@ module.exports = {
   test: {
     client: "postgresql",
     connection: {
-      user: process.env.CIRCLECI ? "postgres" : undefined,
-      database: "analytics-api-test",
+      host: process.env.POSTGRES_HOST || "localhost",
+      user: process.env.POSTGRES_USER || "analytics",
+      password: process.env.POSTGRES_PASSWORD || "123abc",
+      database: process.env.POSTGRES_DATABASE || "analytics_reporter_test",
     },
     migrations: {
       tableName: "knex_migrations",

package.json

@@ -8,7 +8,7 @@
     "dev": "nodemon src/index.js",
     "postinstall": "",
     "pretest": "NODE_ENV=test npm run migrate",
-    "test": "NODE_ENV=test `npm bin`/mocha test/**/*.test.js --exit",
+    "test": "NODE_ENV=test mocha",
     "migrate": "knex migrate:latest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"

src/db.js

@@ -125,4 +125,4 @@ const query = ({
   );
 };
 
-module.exports = { query, queryDomain, buildTimeQuery };
+module.exports = { query, queryDomain, buildTimeQuery, dbClient: db };