Added coverage integration; swapped out smee for serveo

Author: k1o0

README.md

@@ -8,11 +8,11 @@ Run the install script to install all dependencies, then create your .env file c
 
 ### Prerequisites
 
-Requires MATLAB 2017a or later and Node.js.  The following Node.js modules are required:
+Requires MATLAB 2017a or later, Node.js and Git Bash.  The following Node.js modules are required:
 
 ```
 npm install --save express dotenv @octokit/app @octokit/request ...
-github-webhook-handler smee-client xml2js
+github-webhook-handler xml2js
 ```
 
 ### Installing
@@ -63,6 +63,8 @@ Create a shortcut in your startup folder ([Windows-logo] + [R] in Windows-10 and
 ## Built With
 
 * [Coveralls](coveralls.io) - Code coverage
+* [Serveo](serveo.net) - SSH tunneling service
+* [Shields.io](shields.io) - Display shields
 
 ## Contributing
 

coverage.js

@@ -23,7 +23,7 @@ var fs = require('fs'),
     crypto = require('crypto'),
     assert = require('assert').strict,
     parser = new xml2js.Parser(),
-    timestamp, md5;
+    timestamp, md5, cb;
 var timestamp;
 var token = process.env.COVERALLS_TOKEN;
 
@@ -33,7 +33,9 @@ var token = process.env.COVERALLS_TOKEN;
  * @param {Array} classList - An array of class objects from the loaded XML file.
  * @param {String} path - The root path of the code repository.
  * @param {String} sha - The commit SHA for this coverage test.
- * @returns {Object} Object containing array of source code files and their code coverage
+ * @param {function} callback - The callback function to run when complete.  Takes object containing array of source
+ * code files and their code coverage
+ * @returns {Object}
  * @todo Generalize path default
  */
 const formatCoverage = function(classList, path, sha) {
@@ -63,20 +65,22 @@ const formatCoverage = function(classList, path, sha) {
   job.source_files = sourceFiles;
   job.commit_sha = sha;
   job.run_at = timestamp; // "2013-02-18 00:52:48 -0800"
-  return job;
+  cb(job);
 }
 
 /**
  * Loads a code coverage XML file in Cobertura Format and returns payload object for Coveralls API
  * @see {@link https://docs.coveralls.io/api-reference|Coveralls API docs}
  * @param {String} path - Path to the XML file containing coverage information.
  * @param {String} sha - The commit SHA for this coverage test
- * @returns {Object} Object containing array of source code files and their code coverage
+ * @param {String} repo - The repo to which the commit belongs
+ * @param {function} callback - The callback function to run when complete
  * @todo Remove assert
  * @todo Generalize ignoring of submodules
  * @see {@link https://github.com/cobertura/cobertura/wiki|Cobertura Wiki}
  */
-const coverage = function(path, sha) {
+const coverage = function(path, repo, sha, callback) {
+  cb = callback; // @fixme Making callback global feels hacky
   fs.readFile(path, function(err, data) { // Read in XML file
      parser.parseString(data, function (err, result) { // Parse XML
         const rigboxPath = result.coverage.sources[0].source[0]; // Extract root code path
@@ -90,22 +94,19 @@ const coverage = function(path, sha) {
         //console.log(classes.length);
 
         // The submodules
-        var alyx_matlab = [];
-        var signals = [];
-        var npy_matlab = [];
-        var wheelAnalysis = [];
+        var modules = {'rigbox' : [], 'alyx-matlab' : [], 'signals' : [], 'npy-matlab' : [], 'wheelAnalysis' : []};
         // Sort into piles
-        classes = classes.filter(function (e) {
+        modules['rigbox'] = classes.filter(function (e) {
             if (e.$.filename.search(/(tests\\|_.*test|docs\\)/i) != -1) {return false;} // Filter out tests and docs
             if (!Array.isArray(e.lines[0].line)) {return false;} // Filter out files with no functional lines
-            if (e.$.filename.startsWith('alyx-matlab\\')) {alyx_matlab.push(e); return false;}
-            if (e.$.filename.startsWith('signals\\')) {signals.push(e); return false;}
-            if (e.$.filename.startsWith('npy-matlab\\')) {npy_matlab.push(e); return false;}
-            if (e.$.filename.startsWith('wheelAnalysis\\')) {wheelAnalysis.push(e); return false;}
+            if (e.$.filename.startsWith('alyx-matlab\\')) {modules['alyx-matlab'].push(e); return false;}
+            if (e.$.filename.startsWith('signals\\')) {modules.signals.push(e); return false;}
+            if (e.$.filename.startsWith('npy-matlab\\')) {modules['npy-matlab'].push(e); return false;}
+            if (e.$.filename.startsWith('wheelAnalysis\\')) {modules.wheelAnalysis.push(e); return false;}
             else {return true};
         });
         //console.log(obj.source_files[0].coverage.length);
-        return obj = formatCoverage(classes, rigboxPath);
+        formatCoverage(modules[repo], rigboxPath, callback);
      });
   });
 };
@@ -115,7 +116,7 @@ const coverage = function(path, sha) {
  * @param {String} path - Path to the source code file.
  * @returns {Object} key `Hash` contains MD5 digest string of file; `count` contains number of lines in source file
  */
-const md5 = function(path) {
+md5 = function(path) {
   var hash = crypto.createHash('md5'); // Creating hash object
   var buf = fs.readFileSync(path, 'utf-8'); // Read in file
   var count = buf.split(/\r\n|\r|\n/).length; // Count the number of lines

index.js

@@ -1,31 +1,33 @@
 /**
  * @author Miles Wells <[email protected]>
  * @requires ./queue.js
+ * @requires ./coverage.js
  * @requires module:dotenv
  * @requires module:"@octokit/app"
  * @requires module:"@octokit/request"
  * @requires module:express
  * @requires module:github-webhook-handler
- * @requires module:smee-client
  */
 const fs = require('fs');
 const express = require('express')
 const srv = express();
 const cp = require('child_process');
 const queue = new (require('./queue.js'))()
+const Coverage = require('./coverage');
 const { App } = require('@octokit/app');
 const { request } = require("@octokit/request");
 
 const id = process.env.GITHUB_APP_IDENTIFIER;
 const secret = process.env.GITHUB_WEBHOOK_SECRET;
 
-// Create new tunnel to receive hooks
-const SmeeClient = require('smee-client')
-const smee = new SmeeClient({
-  source: process.env.WEBHOOK_PROXY_URL,
-  target: 'http://localhost:3000/github',
-  logger: console
-})
+// Configure ssh tunnel
+const cmd = 'ssh -tt -R 80:localhost:3000 serveo.net';
+const sh = String(cp.execFileSync('where', ['git'])).replace('cmd\\git.exe', 'bin\\sh.exe');
+const tunnel = () => {
+  let ssh = cp.spawn(sh, ['-c', cmd])
+  ssh.stdout.on('data', (data) => { console.log(`stdout: ${data}`); });
+  ssh.on('exit', () => { console.log('Reconnecting to Serveo'); tunnel(); });
+}
 
 // Create handler to verify posts signed with webhook secret.  Content type must be application/json
 var createHandler = require('github-webhook-handler');
@@ -75,22 +77,63 @@ srv.post('/github', async (req, res, next) => {
  */
 function loadTestRecords(id) {
   let obj = JSON.parse(fs.readFileSync('./db.json', 'utf8'));
-  if (!Array.isArray(obj)) obj = [obj];
-  let record;
-  for (record of obj) {
-    if (record['commit'] === id) {
-       return record;
-     }
-  };
+  if (!Array.isArray(obj)) obj = [obj]; // Ensure array
+  return obj.find(o => o.commit === id);
 };
 
-/*
 // Serve the test results for requested commit id
 srv.get('/github/:id', function (req, res) {
   console.log(req.params.id)
   const record = loadTestRecords(req.params.id);
   res.send(record['results']);
-}); */
+});
+
+// Serve the coverage results
+srv.get('/coverage/:repo/:branch', function (req, res) {
+  // Find head commit of branch
+  try {
+    const result = await request('GET /repos/:owner/:repo/git/refs/heads/:branch', {
+      owner: 'cortex-lab', // @todo Generalize repo owner
+      repo: req.params.repo,
+      branch: req.params.branch
+    });
+    if result.data.ref.endsWith('/' + req.params.branch) {
+      console.log('Request for ' + req.params.branch + ' coverage')
+      let id = result.data.object.sha;
+      var report = {'schemaVersion': 1, 'label': 'coverage'};
+      try { // Try to load coverage record
+        record = await loadTestRecords(id);
+        if (typeof record == 'undefined' || record['coverage'] == []) {throw 404}; // Test not found for commit
+        if (record['status'] === 'error') {throw 500}; // Test found for commit but errored
+        report['message'] = record['coverage'] + '%';
+        report['color'] = (record['coverage'] > 75 ? 'green' : 'red');
+      } catch (err) { // No coverage value
+        report['message'] = (err === 404 ? 'pending' : 'unknown');
+        report['color'] = 'orange';
+        // Check test isn't already on the pile
+        let onPile = false;
+        for (let job of queue.pile) { if job.id === id { onPile = true; break; } };
+        if !onPile { // Add test to queue
+          queue.add({
+            sha: id,
+            owner: 'cortex-lab', // @todo Generalize repo owner
+            repo: req.params.repo,
+            status: '',
+            context: ''});
+        }
+      } finally { // Send report
+        res.setHeader('Content-Type', 'application/json');
+        console.log(report)
+        res.end(JSON.stringify(report));}
+      }
+    } else { throw 404 }; // Specified repo or branch not found
+  catch (error) {
+    let msg = (error === 404 ? `${req.params.repo}/${req.params.branch} not found` : error);
+    console.error(msg)
+    res.statusCode = 401; // If not found, send 401 for security reasons
+    res.send(msg);
+  }
+});
 
 // Define how to process tests.  Here we checkout git and call MATLAB
 queue.process(async (job, done) => {
@@ -114,7 +157,7 @@ queue.process(async (job, done) => {
      console.log(stdout)
      // Go ahead with MATLAB tests
      var runTests;
-     const timer = setTimeout(function() { 
+     const timer = setTimeout(function() {
       	  console.log('Max test time exceeded')
       	  job.data['status'] = 'error';
            job.data['context'] = 'Tests stalled after ~2 min';
@@ -161,6 +204,31 @@ queue.on('finish', job => { // On job end post result to API
   });
 });
 
+/**
+ * Callback triggered when job completes.  Called when all tests run to end.
+ * @param {Object} job - Job object which has finished being processed.
+ * @todo Save full coverage object for future inspection
+ */
+queue.on('complete', job => { // On job end post result to API
+  console.log('Updating coverage for ' + job.id)
+  Coverage('./CoverageResults.xml', job.data.repo, job.data.id, obj => {
+    // Digest and save percentage coverage
+    let misses = 0, hits = 0;
+    for (let file of job.source_files) {
+      misses += file.coverage.filter(x => x == 0).length;
+      hits += file.coverage.filter(x => x > 0).length;
+    }
+    // Load data and save
+    let records = JSON.parse(fs.readFileSync('./db.json', 'utf8'));
+    if (!Array.isArray(records)) records = [records]; // Ensure array
+    for (let o of records) { if o.commit === job.data.id {o.coverage = hits / (hits + misses)}; break; } // Add percentage
+    // Save object
+    fs.writeFile('./db.json', JSON.stringify(records), function(err) {
+    if (err) { console.log(err); }
+    });
+  });
+});
+
 // Let fail silently: we report error via status
 queue.on('error', err => {return;});
 // Log handler errors
@@ -193,7 +261,7 @@ handler.on('push', async function (event) {
     // Add a new test job to the queue
     queue.add({
         sha: commit['id'],
-        owner: 'cortex-lab',
+        owner: 'cortex-lab', // @todo Generalize repo owner field
         repo: event.payload.repository.name,
         status: '',
         context: ''
@@ -210,7 +278,7 @@ var server = srv.listen(3000, function () {
    console.log("Handler listening at http://%s:%s", host, port)
 });
 // Start tunnel
-const events = smee.start()
+tunnel();
 
 // Log any unhandled errors
 process.on('unhandledRejection', (reason, p) => {

runAllTests.m

@@ -2,8 +2,9 @@ function runAllTests(id, repo)
 %% Script for running all Rigbox tests
 % To be called for code checks and the like
 % TODO May add flags for levels of testing
-% TODO Method setup in dat_test may become global fixture
-% TODO Delete sinusoidLayer_test from this folder
+% TODO Possible for repo commit sha conflict
+% @body Technically two different repos can have the same commit hash, in
+% which case the db.json file should be restructured
 if nargin == 1; repo = 'rigbox'; end
 try
   %% Initialize enviroment
@@ -54,20 +55,26 @@ function runAllTests(id, repo)
     'Coverage file may not have been updated')
 
   %% Diagnostics
-  % failed = {all_tests([results.Failed]).Name}';
-  % [info,filePaths] = checkcode(...);
-  % Load benchmarks and compare for performance tests?
+  % Summarize the results of the tests and write results to the JSON file
+  % located at dbPath
   status = iff(all([results.Passed]), 'success', 'failure');
   failStr = sprintf('%i/%i tests failed', sum([results.Failed]), length(results));
   context = iff(all([results.Passed]), 'All passed', failStr);
   report = struct(...
     'commit', id, ...
     'results', results, ...
     'status', status, ...
-    'description', context);
+    'description', context, ...
+    'coverage', []); % Coverage updated by Node.js script
   if file.exists(dbPath)
     data = jsondecode(fileread(dbPath));
-    report = [report; data];
+    idx = strcmp(id, {data.commit}); % Check record exists for this commit
+    if any(idx) % If so update record
+      data(idx) = report;
+      report = data;
+    else % ...or append record
+      report = [report; data];
+    end
   end
   fid = fopen(dbPath, 'w+');
   fprintf(fid, '%s', jsonencode(report));