feat(tests/hooks): adds husky hooks, ava and tests

Author: goldcaddy77

index.js

@@ -4,21 +4,31 @@ const AWS = require('aws-sdk')
 const elasticsearch = require('elasticsearch')
 const httpAWSESClass = require('http-aws-es')
 
-// serverless-offline will set IS_OFFLINE based on whether we're offline
-const devMode = process.env.IS_OFFLINE === 'true'
+module.exports = {
+  createClient: createClient,
+  getOptions: getOptions
+}
+
+function getOptions (options) {
+  options = options || {}
+
+  // serverless-offline will set IS_OFFLINE based on whether we're offline
+  const devMode = Boolean(process.env.IS_OFFLINE)
 
-function createClient (options) {
   const prefix = options.envPrefix || 'AWS'
   const region = options.region || process.env[`${prefix}_REGION`]
   const host = options.host || process.env[`${prefix}_HOST`]
 
-  if (!region) { throw new Error('region is required') }
-  if (!host) { throw new Error('host is required') }
+  delete (options.region) // this doesn't belong in ES options
+
+  if (!region) { throw new TypeError('region is required') }
+  if (!host) { throw new TypeError('host is required') }
 
   const credentials = options.credentials || new AWS.EnvironmentCredentials(prefix)
 
   const config = Object.assign({}, options, {
     host: host,
+    region: region,
     amazonES: {
       region,
       credentials
@@ -30,7 +40,9 @@ function createClient (options) {
     config.connectionClass = httpAWSESClass
   }
 
-  return new elasticsearch.Client(config)
+  return config
 }
 
-module.exports = createClient
+function createClient (options) {
+  return new elasticsearch.Client(getOptions(options))
+}

index.test.js

@@ -0,0 +1,82 @@
+'use strict'
+
+const test = require('ava')
+
+test('region is required', function (t) {
+  const error = t.throws(() => {
+    getOptionsWithEnv()
+  }, TypeError)
+
+  t.is(error.message, 'region is required')
+})
+
+test('host is required', function (t) {
+  const error = t.throws(() => {
+    getOptionsWithEnv({}, {region: 'foo'})
+  }, TypeError)
+
+  t.is(error.message, 'host is required')
+})
+
+
+test('region is taken from options if available', function (t) {
+  const env = {
+    AWS_REGION: 'aws_region',
+    AWS_DDB_REGION: 'aws_ddb_region'
+  }
+
+  const options = getOptionsWithEnv(env, {region: 'option_region', host: 'foo'})
+
+  t.is(options.amazonES.region, 'option_region')
+})
+
+test('region is taken from AWS_REGION by default', function (t) {
+  const env = {
+    AWS_REGION: 'aws_region'
+  }
+
+  const options = getOptionsWithEnv(env, {host: 'foo'})
+
+  t.is(options.amazonES.region, 'aws_region')
+})
+
+test('region prefers envPrefix variable', function (t) {
+  const env = {
+    AWS_REGION: 'aws_region',
+    AWS_DDB_REGION: 'aws_ddb_region'
+  }
+
+  const options = getOptionsWithEnv(env, {envPrefix: 'AWS_DDB', host: 'foo'})
+
+  t.is(options.amazonES.region, 'aws_ddb_region')
+})
+
+test('connectionClass ignored in offline mode', function (t) {
+  const env = {
+    IS_OFFLINE: true
+  }
+
+  const options = getOptionsWithEnv(env, {region: 'foo', host: 'bar'})
+
+  t.falsy(options.connectionClass)
+})
+
+test('connectionClass set by default', function (t) {
+  const options = getOptionsWithEnv(null, {region: 'foo', host: 'bar'})
+
+  t.is(typeof (options.connectionClass), 'function')
+})
+
+
+test('sets environment credentials by default', function (t) {
+  const options = getOptionsWithEnv({}, {region: 'foo', host: 'bar'})
+
+  t.is(options.amazonES.credentials.constructor.name, 'EnvironmentCredentials')
+})
+
+function getOptionsWithEnv (env, options) {
+  process.env = env || {}
+  options = options || {}
+
+  return require('./index').getOptions(options)
+}

package.json

@@ -4,7 +4,10 @@
   "description": "Elasticsearch client for AWS that plays nicely with serverless-offline and signed requests",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "precommit": "npm test",
+    "prepush": "npm test",
+    "preversion": "npm test",
+    "test": "./node_modules/.bin/ava --verbose"
   },
   "repository": {
     "type": "git",
@@ -23,8 +26,12 @@
   },
   "homepage": "https://github.com/goldcaddy77/serverless-elasticsearch-client#readme",
   "dependencies": {
-    "aws-sdk": "^2.20.0",
     "elasticsearch": "^12.1.3",
     "http-aws-es": "^1.1.3"
+  },
+  "devDependencies": {
+    "ava": "^0.18.2",
+    "aws-sdk": "^2.23.0",
+    "husky": "^0.13.2"
   }
 }