make it possible to enable @here for certain events

RedHatInsights · Dec 19, 2017 · 4777824 · 4777824
1 parent cd6c26a
commit 4777824
Show file tree

Hide file tree

Showing 7 changed files with 168 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -14,3 +14,5 @@ The following environment variables can be used to tune Insights Slackbot:
 * `SLACK_CHANNEL` - Slack channel the bot will post messages to (insights-webhooks by default)
 * `SERVER_SECRET`- secret part of the URL that prevents unauthorized actors from posting
 * `SERVER_PORT` - server port (3006 by default)
+* `INSIGHTS_URL` - the base URL of Red Hat Insights. Defaults to https://access.redhat.com/insightsbeta
+* `ATHERE` - comma-separated list of events for which `@here` should be used. None by default
diff --git a/app/config.js b/app/config.js
@@ -19,5 +19,7 @@ module.exports = {
     },
     insights: {
         url: process.env.INSIGHTS_URL || 'https://access.redhat.com/insightsbeta'
-    }
+    },
+
+    here: process.env.ATHERE ? String(process.env.ATHERE).split(',') : []
 };
diff --git a/app/events/events.unit.js b/app/events/events.unit.js
@@ -1,8 +1,9 @@
 /* global describe, it */
 'use strict';
 
-require('should');
+const test = require('../../test');
 const events = require('./');
+const config = require('../config');
 
 describe('Events', function () {
 
@@ -53,6 +54,20 @@ describe('Events', function () {
         });
     });
 
+    describe('system:unregistered', function () {
+        it('produces desired output', function () {
+            const msg = {
+                system: {
+                    system_id: 'dd18ed75-44f5-4fd1-8ca0-ed08c2d9c320',
+                    toString: 'jozef_vm04'
+                }
+            };
+
+            const result = events['system:unregistered'](msg);
+            result.should.equal('@here System unregistered: *jozef_vm04* (dd18ed75-44f5-4fd1-8ca0-ed08c2d9c320)');
+        });
+    });
+
     describe('policy:new', function () {
         it('produces desired output', function () {
             const msg = {
@@ -67,7 +82,7 @@ describe('Events', function () {
         });
     });
 
-    describe('policy:new', function () {
+    describe('policy:removed', function () {
         it('produces desired output', function () {
             const msg = {
                 policy: {
@@ -79,4 +94,23 @@ describe('Events', function () {
             result.should.equal('Policy removed: *policy-1*');
         });
     });
+
+    describe('configuration', function () {
+        it('it uses configured base URL', function () {
+            test.sandbox.stub(config.insights, 'url').value('https://access.redhat.com/insights');
+
+            const msg = {
+                system: {
+                    system_id: 'dd18ed75-44f5-4fd1-8ca0-ed08c2d9c320',
+                    toString: 'jozef_vm04'
+                }
+            };
+
+            const result = events['system:registered'](msg);
+            result.should.equal('System registered: <https://access.redhat.com/insights/inventory?machine=dd18ed75-44f5-4fd1-8ca0-ed08c2d9c320|jozef_vm04>' +
+                ' (dd18ed75-44f5-4fd1-8ca0-ed08c2d9c320)');
+        });
+
+
+    });
 });
diff --git a/app/events/index.js b/app/events/index.js
@@ -1,7 +1,6 @@
 'use strict';
 
 const config = require('../config');
-const baseUrl = config.insights.url;
 
 const SEVERITIES = {
     INFO: 'low severity',
@@ -30,11 +29,11 @@ function getProblemDescription (msg) {
 }
 
 function systemLink (system) {
-    return `<${baseUrl}/inventory?machine=${system.system_id}|${system.toString}>`;
+    return `<${config.insights.url}/inventory?machine=${system.system_id}|${system.toString}>`;
 }
 
 function ruleLink (rule) {
-    return `<${baseUrl}/actions/${rule.category.toLowerCase()}/${encodeURIComponent(rule.rule_id)}|${rule.description}>`;
+    return `<${config.insights.url}/actions/${rule.category.toLowerCase()}/${encodeURIComponent(rule.rule_id)}|${rule.description}>`;
 }
 
 module.exports = {
@@ -68,3 +67,17 @@ module.exports = {
         return `Policy removed: *${msg.policy.policy_id}*`;
     }
 };
+
+// wrap event processor with @here for certain events configured via ATHERE
+config.here.forEach(event => {
+    const delegate = module.exports[event];
+
+    if (!delegate) {
+        throw new Error(`Invalid event type: ${event}`);
+    }
+
+    module.exports[event] = function (...args) {
+        const result = delegate(...args);
+        return `@here ${result}`;
+    };
+});
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -11,7 +11,7 @@
   "scripts": {
     "lint": "./node_modules/eslint/bin/eslint.js app server.js",
     "nsp": "./node_modules/nsp/bin/nsp check",
-    "test": "SLACK_TOKEN=xoxb123 ./node_modules/mocha/bin/mocha '**/*.unit.js'",
+    "test": "SLACK_TOKEN=xoxb123 ATHERE=system:unregistered ./node_modules/mocha/bin/mocha '**/*.unit.js'",
     "verify": "npm run lint && npm test && npm run nsp"
   },
   "pre-push": [
@@ -31,7 +31,8 @@
     "body-parser": "1.18.2",
     "bunyan": "1.8.12",
     "express": "4.16.0",
-    "lodash": "4.17.4"
+    "lodash": "4.17.4",
+    "sinon": "^4.1.3"
   },
   "devDependencies": {
     "eslint": "^4.11.0",

diff --git a/test.js b/test.js
@@ -0,0 +1,8 @@
+/* global beforeEach, afterEach */
+'use strict';
+
+require('should');
+const sinon = require('sinon');
+
+beforeEach(() => exports.sandbox = sinon.sandbox.create());
+afterEach(() => exports.sandbox.restore());