Merge pull request #1 from dadi/refactor/test-suite

Refactor for testability

Author: jimlambie

.gitignore

@@ -1 +1,7 @@
-config.*json
+.DS_Store
+config.*json
+log/*
+*.log
+node_modules/
+coverage/
+docs/

.travis.yml

@@ -0,0 +1,28 @@
+language: node_js
+cache:
+  directories:
+    - node_modules
+notifications:
+  email: false
+node_js:
+  - '6'
+  - '5'
+  - '4'
+before_script:
+  - npm prune
+after_success:
+  - npm run semantic-release
+branches:
+  except:
+    - /^v\d+\.\d+\.\d+$/
+env:
+  - CXX=g++-4.8
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
+services:
+  - redis-server
+before_install: if [[ `npm -v` != 3* ]]; then npm i -g npm@latest; fi

config.js

@@ -0,0 +1,118 @@
+const convict = require('convict')
+const fs = require('fs')
+const mkdirp = require('mkdirp')
+const path = require('path')
+
+const conf = convict({
+  env: {
+    doc: 'The applicaton environment',
+    format: ['production', 'development', 'test'],
+    default: 'development',
+    env: 'NODE_ENV'
+  },
+  queue: {
+    host: {
+      doc: 'The queue server host IP',
+      format: 'ipaddress',
+      default: '127.0.0.1'
+    },
+    port: {
+      doc: 'The queue server port number',
+      format: 'port',
+      default: 6379
+    }
+  },
+  broker: {
+    queue: {
+      doc: 'The queue name',
+      format: String,
+      default: '',
+      arg: 'queue'
+    },
+    interval: {
+      doc: 'The polling intervals, in seconds',
+      format: Array,
+      default: [ 0, 1, 5, 10 ]
+    },
+    retries: {
+      doc: 'The number of times a message will be retried after failing',
+      format: Number,
+      default: 10
+    },
+    timeout: {
+      doc: 'The number of seconds until a message is placed back on the queue',
+      format: Number,
+      default: 30
+    },
+    throttle: {
+      doc: 'The number of workers that should execute concurrently',
+      format: Number,
+      default: 5
+    }
+  },
+  workers: {
+    path: {
+      doc: 'The absolute or relative path to the directory for worker modules',
+      format: String,
+      default: './workers'
+    }
+  },
+  logging: {
+    enabled: {
+      doc: 'Enable or disable logging',
+      format: Boolean,
+      default: false
+    },
+    level: {
+      doc: 'The minimum error level to be logged',
+      format: String,
+      default: 'info'
+    },
+    path: {
+      doc: 'The absolute or relative path to the directory for log files',
+      format: String,
+      default: './log'
+    },
+    filename: {
+      doc: 'The name to use for the log file, without extension',
+      format: String,
+      default: 'error'
+    },
+    extension: {
+      doc: 'The extension to use for the log file',
+      format: String,
+      default: 'log'
+    },
+    accessLog: {
+      enabled: {
+        doc: 'Enable or disable access logging',
+        format: Boolean,
+        default: false
+      }
+    }
+  }
+})
+
+function loadConfig () {
+  const configPath = path.join(process.cwd(), 'config/config.development.json')
+  const configSamplePath = path.join(__dirname, 'config/config.development.json.sample')
+  const sampleConfig = fs.readFileSync(configSamplePath, { encoding: 'utf-8'})
+
+  try {
+    var s = fs.readFileSync(configPath, { encoding: 'utf-8'})
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      var made = mkdirp.sync(path.join(process.cwd(), 'config'))
+      fs.writeFileSync(configPath, sampleConfig)
+      console.log('\nCreated configuration file at ' + configPath + '\n')
+    }
+  } finally {
+    const env = conf.get('env')
+    conf.loadFile('config/config.' + env + '.json')
+    conf.validate({ strict: true })
+  }
+}
+
+loadConfig()
+
+module.exports = conf

config/config.development.json.sample

@@ -17,7 +17,7 @@
     "enabled": true,
     "level": "info",
     "path": "./log",
-    "filename": "error",
+    "filename": "myQueue",
     "extension": "log",
     "accessLog": {
       "enabled": false

doc-config.json

@@ -0,0 +1,30 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc","closure"]
+  },
+  "source": {
+    "includePattern": ".+\\.js(doc)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": [
+    
+  ],
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false,
+    "systemName"            : "DADI Queue",
+    "footer"                : "{string}",
+    "copyright"             :  "{string}",
+    "includeDate"           : false,
+    "navType"               : "inline",
+    "theme"                 : "journal",
+    "linenums"              : true,
+    "collapseSymbols"       : true,
+    "inverseNav"            : false,
+    "outputSourceFiles"     : true ,
+    "outputSourcePath"      : false,
+    "syntaxTheme"           : "default",
+    "sort"                  : true
+  }
+}

index.js

@@ -1,2 +1,2 @@
-const app = require('./lib/app')
-module.exports = app()
+const QueueHandler = require('./lib/queue-handler')
+module.exports = new QueueHandler()