Make status descriptions and status context configurable (#11)

* Make status descriptions and status context configurable

This commit adds configuration page for the plugin where user can configure:
 * context of a status message
 * description of each status message

* Use [ci/strider] as a default context

* Improve config page HTML

Author: iradul

config/config.html

@@ -0,0 +1,42 @@
+<h2>
+  Github Status
+  <button ng-click="save()" class="btn btn-primary pull-right">Save</button>
+</h2>
+
+<div class="form-group">
+  <h4>Context for status message</h4>
+
+  <input id="github-status-context" type="text" ng-model="config.context">
+  <p class="help-text">
+    Status message context. Default it "ci/strider".
+  </p>
+</div>
+
+<div class="form-group">
+  <h4>Description of status</h4>
+
+  <label for="github-status-messages-pending" class="bold-label">Pending:</label>
+  <input id="github-status-messages-pending" type="text" ng-model="config.messages.pending">
+  <p class="help-text">
+    Description for "pending" status. Default it "Strider test in progress".
+  </p>
+
+  <label for="github-status-messages-success" class="bold-label">Success:</label>
+  <input id="github-status-messages-success" type="text" ng-model="config.messages.success">
+  <p class="help-text">
+    Description for "success" status. Default it "Strider tests succeeded".
+  </p>
+
+  <label for="github-status-messages-failure" class="bold-label">Failure:</label>
+  <input id="github-status-messages-failure" type="text" ng-model="config.messages.failure">
+  <p class="help-text">
+    Description for "failure" status. Default it "Strider tests failed".
+  </p>
+
+  <label for="github-status-messages-error" class="bold-label">Error:</label>
+  <input id="github-status-messages-error" type="text" ng-model="config.messages.error">
+  <p class="help-text">
+    Description for "error" status. Default it "Strider tests errored".
+  </p>
+</div>
+<button ng-click="save()" class="btn btn-primary pull-right">Save</button>

config/config.js

@@ -0,0 +1,31 @@
+var app = window.app;
+
+app.controller('GithubStatusCtrl', ['$scope', function ($scope) {
+	$scope.config = {
+		messages: {
+			pending: 'Strider test in progress',
+			success: 'Strider tests succeeded',
+			failure: 'Strider tests failed',
+			error: 'Strider tests errored',
+		},
+		context: 'ci/strider',
+	};
+	$scope.saving = false;
+
+	$scope.$watch('configs[branch.name]["github-status"].config', function (value) {
+		for (var p in value) {
+			if (value.hasOwnProperty(p)) {
+				$scope.config = value;
+				break;
+			}
+		}
+	});
+
+	$scope.save = function () {
+		$scope.saving = true;
+		$scope.pluginConfig('github-status', $scope.config, function () {
+			$scope.saving = false;
+		});
+	};
+
+}]);

config/config.less

@@ -0,0 +1,6 @@
+#plugin-github-status .bold-label {
+  font-weight: bold;
+}
+#plugin-github-status .form-group {
+  margin-bottom: 20px;
+}

lib/handler.js

@@ -17,7 +17,7 @@ if (GITHUB_API_ENDPOINT) {
   config.pathPrefix = url.parse(GITHUB_API_ENDPOINT).path;
 }
 
-module.exports = function (token, url, data, status, description) {
+module.exports = function (token, url, data, status, description, context) {
   debug('Setting status', token, url, data, status, description);
   var github = new GithubApi(config);
   github.authenticate({
@@ -30,7 +30,8 @@ module.exports = function (token, url, data, status, description) {
     repo: data.repo,
     state: status,
     sha: data.sha,
-    description: description
+    description: description,
+    context: context
   }, function (err) {
     if (err) console.error('failed to set github status', url, data, err.message);
   });

package.json

@@ -24,7 +24,7 @@
   },
   "homepage": "https://github.com/Strider-CD/strider-github-status",
   "dependencies": {
-    "github": "~0.1.12",
+    "github": "~0.2.4",
     "debug": "~0.7.4"
   },
   "publishConfig": {
@@ -44,7 +44,10 @@
     "title": "Github Status",
     "webapp": "webapp.js",
     "worker": "worker.js",
-    "icon": "icon.png"
+    "icon": "icon.png",
+    "config": {
+      "controller": "GithubStatusCtrl"
+    }
   },
   "devDependencies": {
     "eslint": "^3.1.1",

webapp.js

@@ -1,36 +1,47 @@
 var debug = require('debug')('strider-github-status');
 var setStatus = require('./lib/handler');
 
-function jobStatus(job) {
-  if (job.errored) return 'error';
-  return job.test_exitcode === 0 ? 'success' : 'failure';
-}
-
 // TODO: give information here as to why it errored/failed?
-function jobDescription(job) {
-  if (job.errored) return 'Strider tests errored';
-  return 'Strider tests ' + (job.test_exitcode === 0 ? 'succeeded' : 'failed');
+function jobInfo(job, config) {
+  var info = {};
+
+  if (job.errored) info.status = 'error';
+  else if (job.test_exitcode === 0) info.status = 'success';
+  else info.status = 'failure';
+
+  info.description = config.messages[info.status];
+  info.context = config.context;
+
+  return info;
 }
 
 module.exports = {
+  config: {
+    messages: {
+      pending: {type: String, default: 'Strider test in progress'},
+      success: {type: String, default: 'Strider tests succeeded'},
+      failure: {type: String, default: 'Strider tests failed'},
+      error: {type: String, default: 'Strider tests errored'},
+    },
+    context: {type: String, default: 'ci/strider'},
+  },
   // global events
   listen: function (io, context) {
-    io.on('plugin.github-status.started', function (jobId, projectName, token, data) {
+    io.on('plugin.github-status.started', function (jobId, projectName, token, data, config) {
       debug('got', jobId, projectName, token, data);
       var url = context.config.server_name + '/' + projectName + '/job/' + jobId;
-      setStatus(token, url, data, 'pending', 'Strider test in progress');
+      setStatus(token, url, data, 'pending', config.messages.pending, config.context);
     });
 
-    io.on('plugin.github-status.done', function (jobId, projectName, token, data) {
+    io.on('plugin.github-status.done', function (jobId, projectName, token, data, config) {
       function onDoneAndSaved(job) {
         if (job._id.toString() !== jobId.toString()) return;
         debug('plugin done', jobId, projectName, token, data);
 
         io.removeListener('job.doneAndSaved', onDoneAndSaved);
         var url = context.config.server_name + '/' + projectName + '/job/' + jobId
-          , status = jobStatus(job)
-          , description = jobDescription(job);
-        setStatus(token, url, data, status, description);
+          , info = jobInfo(job, config);
+        setStatus(token, url, data, info.status, info.description, info.context);
       }
       io.on('job.doneAndSaved', onDoneAndSaved);
     });

worker.js

@@ -30,10 +30,10 @@ module.exports = {
           repo: job.project.provider.config.repo,
           sha: job.plugin_data.github.pull_request.sha
         };
-        emitter.emit('plugin.github-status.started', job._id, projectName, token, github_repo_data);
+        emitter.emit('plugin.github-status.started', job._id, projectName, token, github_repo_data, config);
         emitter.once('job.status.tested', function (jobId) {
           debug('job was tested', jobId);
-          emitter.emit('plugin.github-status.done', jobId, projectName, token, github_repo_data);
+          emitter.emit('plugin.github-status.done', jobId, projectName, token, github_repo_data, config);
         });
       }
     });