Merge pull request #7 from cortex-lab/dev

Version 2.0 - Switch to Serveo

Author: k1o0

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [Latest](https://github.com/cortex-lab/matlab-ci/commits/master)
+
+### Added
+
+- changelog
+- status and coverage endpoints for shields
+
+### Modified
+
+- changed from using Smee client to Serveo for exposing ZTEST
+- fixes for test reports endpoint
+- tests now performed only on head commit

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
@@ -23,22 +23,6 @@ Make sure runAllTests.m is on your MATLAB paths
 
 TODO
 
-### Break down into end to end tests
-
-Explain what these tests test and why
-
-```
-Give an example
-```
-
-### And coding style tests
-
-Explain what these tests test and why
-
-```
-Give an example
-```
-
 ## Deployment
 
 To work properly you need to create install a Github app on your target repository and download the private key.  Update your .env file like so:
@@ -47,9 +31,8 @@ To work properly you need to create install a Github app on your target reposito
 GITHUB_PRIVATE_KEY=path\to\private-key.pem
 GITHUB_APP_IDENTIFIER=1234
 GITHUB_WEBHOOK_SECRET=
-WEBHOOK_PROXY_URL=https://smee.io/abcd
+WEBHOOK_PROXY_URL=
 RIGBOX_REPO_PATH=C:\Path\To\Code\Repo
-COVERALLS_TOKEN=
 ```
 
 To run at startup create a batch file with the following command:
@@ -62,7 +45,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
@@ -87,25 +91,20 @@ const coverage = function(path, sha) {
         const packages = result.coverage.packages[0].package;
         packages.forEach(package => { classes.push(package.classes[0].class) }); // Get all classes
         classes = classes.reduce((acc, val) => acc.concat(val), []); // Flatten
-        //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.toLowerCase()], rigboxPath, callback);
      });
   });
 };
@@ -115,7 +114,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