submodule and coverage support

Author: k1o0

README.md

@@ -50,6 +50,7 @@ Some extra optional settings:
 - `events:event:ref_include` - same as `ref_ignore`, but a pass list instead of block list.
 - `kill_children` - if present and true, `tree-kill` is used to kill the child processes, required 
 if shell/batch script forks test process (e.g. a batch script calls python).
+- `repos` - an array of submodules or map of modules to their corresponding paths.
 
 Finally, ensure these scripts are executable by node:
 ```

runAllTests.m

@@ -12,6 +12,7 @@ function runAllTests(id, repo, logDir)
 try
   %% Initialize enviroment
   dbPath = fullfile(logDir, '.db.json'); % TODO Load from config file
+  [~, repo] = fileparts(repo); % Ensure not full path
   fprintf('Running tests\n')
   fprintf('Repo = %s, sha = %s\n', repo, id)
   origDir = pwd;
@@ -30,7 +31,7 @@ function runAllTests(id, repo, logDir)
   main_tests = testsuite('IncludeSubfolders', true);
 
   %% Gather signals tests
-  root = getOr(dat.paths,'rigbox');
+  root = getOr(dat.paths, 'rigbox');
   signals_tests = testsuite(fullfile(root, 'signals', 'tests'), ...
     'IncludeSubfolders', true);
 
@@ -44,12 +45,14 @@ function runAllTests(id, repo, logDir)
   % the sortByFixtures method to sort the suite.
   all_tests = [main_tests signals_tests alyx_tests];
   % If the repo under test is alyx, filter out irrelevent tests
-  if endsWith(repo, 'alyx')
+  if strcmp(repo, 'alyx')
     all_tests = all_tests(startsWith({all_tests.Name}, 'Alyx', 'IgnoreCase', true));
-  elseif endsWith(repo, 'alyx-matlab')
+  elseif strcmp(repo, 'alyx-matlab')
     all_tests = alyx_tests;
-  elseif endsWith(repo, 'signals')
+    root = fullfile(root, repo);
+  elseif strcmp(repo, 'signals')
     all_tests = signals_tests;
+    root = fullfile(root, repo);
   end
 
   % Filter out performance tests

serve.js

@@ -350,10 +350,10 @@ function checkout(repoPath, ref) {
 function listSubmodules(repoPath) {
    if (!shell.which('git')) { throw new Error('Git not found on path'); }
    shell.pushd(repoPath);
-   let listModules = 'git config --file .gitmodules --get-regexp path | awk \'{ print $2 }\'';
-   const modules = shell.exec(listModules);
+   let listModules = 'git config --file .gitmodules --get-regexp path';
+   const modules = shell.exec(listModules)
    shell.popd();
-   return (!modules.code && modules.stdout !== '')? modules.split('\n') : null;
+   return (!modules.code && modules.stdout !== '')? modules.match(/(?<=submodule.)[\w-]+/g) : null;
 }
 
 /**
@@ -366,14 +366,14 @@ function listSubmodules(repoPath) {
  */
 function getRepoPath(name) {
    if (!config.repos) { return process.env['REPO_PATH']; }  // Legacy, to remove
-   if (config.repos.name) { return config.repos.name; }  // Found path, return
-   for (let repo of config.repos) {
-      let modules = listSubmodules(repo);
-      if (modules && modules.includes(name)) {
-         // If the repo is a submodule, modify path
-         return repo + path.sep + name;
-      }
+   if (config.repos[name]) { return config.repos[name]; }  // Found path, return
+   const modules = listSubmodules(process.env['REPO_PATH']);
+   let repoPath = process.env['REPO_PATH'];
+   if (modules && modules.includes(name)) {
+      // If the repo is a submodule, modify path
+      repoPath += (path.sep + name);
    }
+   return repoPath;  // No modules matched, return default
 }
 
 
@@ -578,5 +578,6 @@ queue.on('finish', (err, job) => { // On job end post result to API
 });
 
 module.exports = {
-   updateStatus, srv, handler, setAccessToken, prepareEnv, runTests, eventCallback
+   updateStatus, srv, handler, setAccessToken, prepareEnv,
+   runTests, eventCallback, getRepoPath, listSubmodules
 }

test/coverage.test.js

@@ -2,22 +2,36 @@ const fs = require('fs');
 const assert = require('assert');
 const path = require('path');
 const sinon = require('sinon');
+const expect = require('chai').expect;
 
 const config = require('../config/config').settings;
 const Coverage = require('../coverage');
 
 const dummy_id = '1c33a6e2ac7d7fc098105b21a702e104e09767cf';
 
 
-xdescribe('Test coverage parser:', function() {
+describe('Test coverage parser:', function() {
     var testable;
+    var sandbox;
       // Check NODE_ENV is correctly set, meaning our imported settings will be test ones
-    before(function () {
-        assert(process.env.NODE_ENV.startsWith('test'), 'Test run outside test env')
+    beforeEach(function () {
+        let md5 = '385a5d56850127317c317b0f66e91078';
+        let code = 'line1\nline2\n\rline3\n\rline4';
         testable = function(obj, done) {
-            assert(obj.source_files);
+            expect([291, 63]).to.include(obj.source_files.length);
+            let file = obj.source_files[0];
+            expect(file).to.have.all.keys('name', 'source_digest', 'coverage');
+            expect(file['source_digest']).to.eq(md5);
             done();
         };
+        sandbox = sinon.createSandbox();
+        sandbox
+            .stub(fs, 'readFileSync')
+            .withArgs(sinon.match((x) => x.replace('\\', '/').startsWith('C:/Rigbox')))
+            .returns(code)
+            .withArgs(sinon.match((x) => x.replace('\\', '/').startsWith('C:/ibllib')))
+            .returns(code);
+        fs.readFileSync.callThrough();
     })
 
     it('Check loading MATLAB', function (done) {
@@ -27,8 +41,10 @@ xdescribe('Test coverage parser:', function() {
 
     it('Check loading Python', function (done) {
         let xmlPath = path.resolve('test', 'fixtures', 'CoverageResults.py.xml')
-        Coverage(xmlPath, '', dummy_id, obj => testable(obj, done) );
+        Coverage(xmlPath, 'ibllib', dummy_id, obj => testable(obj, done) );
     });
+
+    afterEach(function () { sandbox.restore(); });
 });
 
 

test/fixtures/CoverageResults.mat.xml

@@ -6,7 +6,7 @@
           timestamp="1603119812.882"
           version="">
    <sources>
-      <source>C:\Users\Experiment\Documents\GitHub\Rigbox\</source>
+      <source>C:\Rigbox\</source>
    </sources>
    <packages>
       <package branch-rate="NaN" complexity="NaN" line-rate="0.31707" name="">
@@ -51801,4 +51801,4 @@
          </classes>
       </package>
    </packages>
-</coverage>
+</coverage>