Merge pull request #185 from StackStorm/add-tests

Add tests to improve coverage for scripts/stackstorm.js

Author: blag

package.json

@@ -37,6 +37,7 @@
     "babel-eslint": "^10.0.1",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
+    "chai-string": "^1.5.0",
     "eslint": "^5.16.0",
     "eslint-plugin-notice": "0.7.8",
     "gulp": "^3.9.1",

tests/test-st2-invalid-auth.js

@@ -0,0 +1,141 @@
+/*
+ Licensed to the StackStorm, Inc ('StackStorm') under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/*jshint quotmark:false*/
+/*jshint -W030*/
+/*global describe, it, before, after, beforeEach, afterEach*/
+'use strict';
+
+var chai = require("chai"),
+  expect = chai.expect,
+  chaiString = require("chai-string"),
+  sinon = require('sinon'),
+  sinonChai = require('sinon-chai'),
+  chaiAsPromised = require('chai-as-promised'),
+  mockedEnv = require('mocked-env'),
+  Robot = require("hubot/src/robot"),
+  Logger = require('./dummy-logger.js');
+
+chai.use(sinonChai);
+chai.use(chaiString);
+chai.use(chaiAsPromised);
+
+global.process.exit = sinon.spy();
+
+describe("invalid st2 credential configuration", function() {
+  var robot = new Robot(null, "mock-adapter", false, "Hubot");
+  robot.logger = new Logger(true);
+  var restore_env = null,
+    info_spy = sinon.spy(robot.logger, 'info'),
+    error_spy = sinon.spy(robot.logger, 'error');
+
+  beforeEach(function () {
+    process.exit.resetHistory();
+  });
+
+  afterEach(function() {
+    restore_env && restore_env();
+    error_spy.resetHistory();
+    info_spy.resetHistory();
+    // Remove stackstorm.js from the require cache
+    // https://medium.com/@gattermeier/invalidate-node-js-require-cache-c2989af8f8b0
+    delete require.cache[require.resolve("../scripts/stackstorm.js")];
+  });
+
+  it("should error out with missing auth URL", function(done) {
+    // Mock process.env for all modules
+    // https://glebbahmutov.com/blog/mocking-process-env/
+    restore_env = mockedEnv({
+      ST2_AUTH_USERNAME: 'nonexistent-st2-auth-username',
+      ST2_AUTH_PASSWORD: 'nonexistent-st2-auth-password'
+    });
+
+    // Load script under test
+    var stackstorm = require("../scripts/stackstorm.js");
+    try {
+      stackstorm(robot);
+      done(new Error("The previous code should have thrown an exception"))
+    } catch (err) {
+      expect(err.message).to.equal("Env variables ST2_AUTH_USERNAME, ST2_AUTH_PASSWORD and ST2_AUTH_URL should only be used together.");
+      done();
+    }
+  });
+
+  it("should error out with missing auth username", function(done) {
+    // Mock process.env for all modules
+    // https://glebbahmutov.com/blog/mocking-process-env/
+    restore_env = mockedEnv({
+      ST2_AUTH_URL: 'https://nonexistent-st2-auth-url',
+      ST2_AUTH_PASSWORD: 'nonexistent-st2-auth-password'
+    });
+
+    // Load script under test
+    var stackstorm = require("../scripts/stackstorm.js");
+    try {
+      stackstorm(robot);
+      done(new Error("The previous code should have thrown an exception"))
+    } catch (err) {
+      expect(err.message).to.equal("Env variables ST2_AUTH_USERNAME, ST2_AUTH_PASSWORD and ST2_AUTH_URL should only be used together.");
+      done();
+    }
+  });
+
+
+  it("should error out with missing auth password", function(done) {
+    // Mock process.env for all modules
+    // https://glebbahmutov.com/blog/mocking-process-env/
+    restore_env = mockedEnv({
+      ST2_AUTH_URL: 'https://nonexistent-st2-auth-url',
+      ST2_AUTH_USERNAME: 'nonexistent-st2-auth-username'
+    });
+
+    // Load script under test
+    var stackstorm = require("../scripts/stackstorm.js");
+    try {
+      stackstorm(robot);
+      done(new Error("The previous code should have thrown an exception"))
+    } catch (err) {
+      expect(err.message).to.equal("Env variables ST2_AUTH_USERNAME, ST2_AUTH_PASSWORD and ST2_AUTH_URL should only be used together.");
+      done();
+    }
+  });
+
+  it("should throw exception with bad auth URL", function(done) {
+    restore_env = mockedEnv({
+      ST2_AUTH_URL: 'https://nonexistent-st2-auth-url:9101',
+      ST2_AUTH_USERNAME: 'nonexistent-st2-auth-username',
+      ST2_AUTH_PASSWORD: 'nonexistent-st2-auth-password'
+    });
+
+    // Load script under test
+    var i, stackstorm = require("../scripts/stackstorm.js");
+    stackstorm(robot).catch(function (err) {
+      expect(error_spy.args).to.have.lengthOf(1);
+      expect(error_spy.args[0][0]).to.be.a('string');
+      expect(error_spy.args[0][0]).to.startWith('Failed to authenticate');
+
+      // On Mac, this is:
+      // getaddrinfo ENOTFOUND nonexistent-st2-auth-url nonexistent-st2-auth-url:9101
+      // But on Linux, it is:
+      // 
+      // So instead of using basic string comparison, we use a regex and check for common substrings
+      expect(err.message).to.match(/getaddrinfo ENOTFOUND nonexistent-st2-auth-url nonexistent-st2-auth-url:9101/);
+
+      done();
+    });
+  });
+});

tests/test-st2-unauthorized.js

@@ -30,6 +30,7 @@ chai.use(sinonChai);
 describe("auth with invalid st2 API key", function() {
   var stop;
   var robot = new Robot(null, "mock-adapter", true, "Hubot");
+  robot.logger = new Logger(true);
   var recordedError = null,
     error_spy = sinon.spy(robot.logger, 'error'),
     warning_spy = sinon.spy(robot.logger, 'warning'),

tests/test-st2bot-envvars.js

@@ -46,6 +46,12 @@ describe("environment variable configuration", function () {
     // Remove stackstorm.js from the require cache
     // https://medium.com/@gattermeier/invalidate-node-js-require-cache-c2989af8f8b0
     delete require.cache[require.resolve("../scripts/stackstorm.js")];
+    if (robot) {
+      robot.shutdown();
+      if (robot.server) {
+        robot.server.close();
+      }
+    }
   });
 
   it("should log a warning when ST2_API is used", function (done) {
@@ -82,7 +88,7 @@ describe("environment variable configuration", function () {
     // Load script under test
     var stackstorm = require("../scripts/stackstorm.js");
     stackstorm(robot).then(function (stop) {
-      expect(info_spy).to.have.been.calledThrice;
+      expect(info_spy.args).length.to.be.above(1);
       expect(info_spy).to.have.been.calledWith('Two-factor auth is enabled');
       expect(info_spy).to.have.been.calledWith('Loading commands....');
 

tests/test-st2bot-sigusr2.js

@@ -24,6 +24,7 @@ var chai = require("chai"),
   expect = chai.expect,
   sinon = require('sinon'),
   sinonChai = require('sinon-chai'),
+  nock = require('nock'),
   Robot = require("hubot/src/robot"),
   Logger = require('./dummy-logger.js');
 
@@ -35,9 +36,37 @@ describe("SIGUSR2", function () {
   var debug_spy = sinon.spy(robot.logger, 'debug'),
     info_spy = sinon.spy(robot.logger, 'info');
 
+  // Not required for SIGUSR2 to work, but mocking the response increases code
+  // coverage and more closely approximates the real world
+  beforeEach(function () {
+    // emulate ST2 API response
+    nock('http://localhost:9101')
+      .get('/v1/actionalias')
+      .times(2)
+      .query({"limit": "-1", "offset": "0"})
+      .reply(200, [
+        {
+          "name": "hello",
+          "description": "long hello",
+          "enabled": true,
+          "formats": [
+            {
+              "display": "format_one",
+              "representation": "format_one"
+            },
+            {
+              "display": "format_two",
+              "representation": "format_two"
+            }
+          ]
+        }
+      ]);
+  });
+
   afterEach(function() {
     info_spy.resetHistory();
     debug_spy.resetHistory();
+    nock.cleanAll();
     // Remove stackstorm.js from the require cache
     // https://medium.com/@gattermeier/invalidate-node-js-require-cache-c2989af8f8b0
     delete require.cache[require.resolve("../scripts/stackstorm.js")];
@@ -51,16 +80,12 @@ describe("SIGUSR2", function () {
       expect(debug_spy).to.have.callCount(2);
       expect(debug_spy).to.have.been.calledWith('Using default post data handler.');
       expect(debug_spy).to.have.been.calledWith('Caught SIGUSR2, reloading commands');
-      expect(info_spy).to.have.callCount(3);
+      expect(info_spy.args).to.have.length.above(1);
       expect(info_spy).to.have.been.calledWith('Loading commands....');
 
       stop();
 
       done();
-    }).catch(function (err) {
-      console.log(err);
-      stop && stop();
-      done(err);
     });
   });
 });