Finished CircleCI setup, tests, coverage & lint #9

 - Added required dependencies
 - Added database setup through environment variables for CI and through
hidden.js for local environment
 - Added extra rules for linting
 - Added test setup and coverage reports

npm run migrate parses hidden.js to extract the password as an
environment variable. This is a quick hack to factor out the password
from database.json

Author: Lercerss

.circleci/config.yaml

@@ -8,13 +8,15 @@ jobs:
     docker:
       # specify the version you desire here
       - image: circleci/node:10-browsers
-      
+        environment:
+          - MYSQL_PASSWORD: very-secret
+        
       - image: circleci/mysql:5.7.23
         environment:
           - MYSQL_USER: dbuser
           - MYSQL_PASSWORD: very-secret
 
-    working_directory: ~/repo
+    working_directory: ~/SOEN343
 
     steps:
       - checkout
@@ -24,6 +26,7 @@ jobs:
           keys:
           - v1-dependencies-{{ checksum "package.json" }}
           # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
 
       - run: npm install
 
@@ -34,25 +37,17 @@ jobs:
 
       - run:
         name: setup database
-        command: npm run migrate db:create anansi_db && npm run migrate up
+        # Create db and run all migrations
+        command: node_modules/db-migrate/bin/db-migrate db:create anansi_db && node_modules/db-migrate/bin/db-migrate up
 
       - run: 
         name: test
         command: npm test
 
-      - run:
-        name: coverage
-        command: npm run coverage
-      
       - run:
         name: lint
         command: npm run lint
 
       - store_artifacts: # TODO
-          path: test-results.xml
-          prefix: tests
-      - store_artifacts: # TODO
-          path: coverage
+          path: test-report.html
           prefix: coverage
-      - store_test_results: # TODO
-          path: test-results.xml

.eslintrc.json

@@ -2,6 +2,9 @@
     "extends": "standard",
     "rules": {
         "semi": [2, "always"],
-        "indent": ["error", 4]
+        "indent": ["error", 4],
+        "no-unused-vars": "warn",
+        "comma-dangle": "off",
+        "camelcase": "error"
     }
 }

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 hidden.js
+coverage/

config.js

@@ -1,8 +1,13 @@
+var hidden = {};
+try {
+    hidden = require('hidden');
+} catch (ex) {}
+
 var config = {
     db: {
-        host: '127.0.0.1',
+        host: '127.0.0.1', // localhost
         user: 'dbuser',
-        password: 'very-secret',
+        password: hidden.password || process.env.MYSQL_PASSWORD,
         db: 'anansi_db'
     }
 };

database.json

@@ -4,14 +4,7 @@
         "driver": "mysql",
         "host": "localhost",
         "user": "dbuser",
-        "password": "very-secret",
-        "database": "anansi_db"
-    },
-    "test": {
-        "driver": "mysql",
-        "host": "localhost",
-        "user": "root",
-        "password": "",
+        "password": {"ENV": "MYSQL_PASSWORD"},
         "database": "anansi_db"
     }
 }

jest.config.js

@@ -0,0 +1,185 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
+
+    // Stop running tests after the first failure
+    // bail: false,
+
+    // Respect "browser" field in package.json when resolving modules
+    // browser: false,
+
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "/tmp/jest_rs",
+
+    // Automatically clear mock calls and instances between every test
+    clearMocks: true,
+
+    // Indicates whether the coverage information should be collected while executing the test
+    // collectCoverage: false,
+
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: null,
+
+    // The directory where Jest should output its coverage files
+    coverageDirectory: 'coverage',
+
+    // An array of regexp pattern strings used to skip coverage collection
+    // coveragePathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // A list of reporter names that Jest uses when writing coverage reports
+    coverageReporters: [
+        'json',
+        'text',
+        //   "lcov",
+        //   "clover"
+    ],
+
+    // An object that configures minimum threshold enforcement for coverage results
+    // coverageThreshold: null,
+
+    // Make calling deprecated APIs throw helpful error messages
+    // errorOnDeprecated: false,
+
+    // Force coverage collection from ignored files usin a array of glob patterns
+    // forceCoverageMatch: [],
+
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: null,
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: null,
+
+    // A set of global variables that need to be available in all test environments
+    // globals: {},
+
+    // An array of directory names to be searched recursively up from the requiring module's location
+    // moduleDirectories: [
+    //   "node_modules"
+    // ],
+
+    // An array of file extensions your modules use
+    // moduleFileExtensions: [
+    //   "js",
+    //   "json",
+    //   "jsx",
+    //   "node"
+    // ],
+
+    // A map from regular expressions to module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
+
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
+
+    // Activates notifications for test results
+    // notify: false,
+
+    // An enum that specifies notification mode. Requires { notify: true }
+    // notifyMode: "always",
+
+    // A preset that is used as a base for Jest's configuration
+    // preset: null,
+
+    // Run tests from one or more projects
+    // projects: null,
+
+    // Use this configuration option to add custom reporters to Jest
+    reporters: [
+        'default',
+        ['./node_modules/jest-html-reporter', {
+            pageTitle: 'Test Report'
+        }]
+    ],
+
+    // Automatically reset mock state between every test
+    // resetMocks: false,
+
+    // Reset the module registry before running each individual test
+    // resetModules: false,
+
+    // A path to a custom resolver
+    // resolver: null,
+
+    // Automatically restore mock state between every test
+    // restoreMocks: false,
+
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: null,
+
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
+
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
+
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
+
+    // The path to a module that runs some code to configure or set up the testing framework before each test
+    // setupTestFrameworkScriptFile: null,
+
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
+
+    // The test environment that will be used for testing
+    testEnvironment: 'node',
+
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
+
+    // Adds a location field to test results
+    // testLocationInResults: false,
+
+    // The glob patterns Jest uses to detect test files
+    // testMatch: [
+    //   "**/__tests__/**/*.js?(x)",
+    //   "**/?(*.)+(spec|test).js?(x)"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    // testPathIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // The regexp pattern Jest uses to detect test files
+    // testRegex: "",
+
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: null,
+
+    // This option allows use of a custom test runner
+    // testRunner: "jasmine2",
+
+    // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+    // testURL: "http://localhost",
+
+    // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+    // timers: "real",
+
+    // A map from regular expressions to paths to transformers
+    // transform: null,
+
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
+
+    // Indicates whether each individual test should be reported during the run
+    // verbose: null,
+
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
+
+    // Whether to use watchman for file crawling
+    // watchman: true,
+};