201 status -> 200; more tests; added test duration to description

Author: k1o0

CHANGELOG.md

@@ -14,9 +14,11 @@
 
  ## Modified
 
+ - renamed MATLAB-CI to labCI
  - records endpoint can return pending jobs
  - tests badge endpoint returns 'error' on errored tests instead of 'unknown'
  - job waits for coverage calculation and updating of records before finishing
+ - On successful completion of tests the duration is appended to the description
 
 ## [2.2.1]
 

config/config.js

@@ -9,11 +9,9 @@ let settings;
 
 // Defaults for when there's no user file; will almost certainly fail
 const defaults = {
-    setup_function: null,
-    test_function: null,
+    max_description_len: 140,  // GitHub status API has a description char limit
     listen_port: 3000,
     timeout: 8 * 60000,
-    program: 'python',
     strict_coverage: false,
     events: {
         push: {
@@ -57,12 +55,15 @@ if (env.startsWith('test')) {
     settings = testing;
 } else if (userSettings) {
     settings = userSettings;
-    if (!('dbFile' in settings)) settings.dbFile = path.join(dataPath, dbFilename);
-    if (!('dataPath' in settings)) settings.dataPath = dataPath;
 } else {
     settings = defaults;
 }
 
+// Ensure defaults for absent fields
+for (let field in defaults) {
+    if (!(field in settings)) settings[field] = defaults[field];
+}
+
 // Check ENV set up correctly
 required = ['GITHUB_PRIVATE_KEY', 'GITHUB_APP_IDENTIFIER', 'GITHUB_WEBHOOK_SECRET',
     'WEBHOOK_PROXY_URL', 'REPO_PATH', 'REPO_NAME', 'REPO_OWNER', 'TUNNEL_HOST',
@@ -75,4 +76,4 @@ if (missing.length > 0) {
     throw ReferenceError(errMsg);
 }
 
-module.exports = {settings};
+module.exports = { settings };

lib.js

@@ -165,13 +165,24 @@ async function updateJobFromRecord(job) {
     let log = _log.extend('updateJobFromRecord');
     log('Loading test records for head commit %g', job.data['sha']);
     let rec = loadTestRecords(job.data['sha']);  // Load test result from json log
-    if (rec.length === 0) {
+    if (rec.length === 0) {  // No record found
         log('No record found, return false');
         return false;
-    }      // No record found
+    }
     rec = Array.isArray(rec) ? rec.pop() : rec;  // in case of duplicates, take last
     job.data['status'] = rec['status'];
     job.data['description'] = rec['description'];
+    // Append the duration in minutes if available
+    if (rec['status'] === 'success' && job.created) {
+        let diff = (new Date().getTime() - job.created.getTime()) / 1000;
+        let duration = ` (took ${Math.round(diff / 60)} min)`;
+        // Truncate description if necessary
+        let strSize = (config.max_description_len - duration.length);
+        if (job.data['description'].length > strSize) {
+            job.data['description'] = job.data['description'].slice(0, strSize - 3) + '...';
+        }
+        job.data['description'] += duration;
+    }
     job.data['coverage'] = ('coverage' in rec) ? rec['coverage'] : null;
     if (!job.data['coverage'] && rec['status'] !== 'error') {
         log('Coverage missing, computing from XML');
@@ -523,9 +534,7 @@ function computeCoverage(job) {
             console.log('Coverage saved into records');
             // If this test was to ascertain coverage, call comparison function
             let toCompare = (job.data.context || '').startsWith('coverage') && job.data.base;
-            if (toCompare) {
-                return compareCoverage(job);
-            }
+            if (toCompare) return compareCoverage(job);
         });
     }).catch(err => {
         job.status = 'error';
@@ -620,12 +629,12 @@ function compareCoverage(job) {
 function getBadgeData(data) {
     let id = data.sha;
     if (!id) throw new ReferenceError('Invalid "sha" field in input data');
-    var report = {'schemaVersion': 1, 'label': data.context};
+    const report = {'schemaVersion': 1, 'label': data.context};
     // Try to load coverage record
     let record = data.force ? [] : loadTestRecords(id);
     // If no record found
     if (record.length === 0) {
-        report['message'] = 'pending';
+        report['message'] = data.context === 'tests'? 'in progress' : 'pending';
         report['color'] = 'orange';
         // Check test isn't already on the pile
         let onPile = false;

serve.js

@@ -24,7 +24,6 @@ const secret = process.env['GITHUB_WEBHOOK_SECRET'];
 // Currently this app is only set up to process push and pull request events so we will have the
 // handler reject any others.  We will also check that only these are set up in the config.
 const supportedEvents = ['push', 'pull_request'];  // events the ci can handle
-const maxN = 140;  // The maximum n chars of the status description
 const ENDPOINT = 'logs';  // The URL endpoint for fetching status check details
 // An optional static directory for serving css files
 const STATIC = 'public';
@@ -326,6 +325,7 @@ srv.get('/:badge/:repo/:id', async (req, res) => {
         repo: req.params.repo,
         routine: lib.context2routine(context)
     };
+
     // Check we have a matching routine
     if (!data.routine) {
         console.error(`No routine for "${context}" context`);
@@ -341,7 +341,7 @@ srv.get('/:badge/:repo/:id', async (req, res) => {
             console.log(`Request for ${req.params.id} ${data.context}`);
             const report = lib.getBadgeData(data);
             // Send report
-            res.statusCode = (report['message'] === 'pending') ? 201 : 200;
+            res.statusCode = 200;
             res.setHeader('Content-Type', 'application/json');
             res.end(JSON.stringify(report));
         })
@@ -384,7 +384,7 @@ async function updateStatus(data, targetURL = '') {
         sha: data['sha'],
         state: data['status'],
         target_url: targetURL,
-        description: (data['description'] || '').substring(0, maxN),
+        description: (data['description'] || '').substring(0, config.max_description_len),
         context: data['context']
     });
 }
@@ -404,7 +404,7 @@ async function eventCallback(event) {
     debug('eventCallback called');
     var ref;  // ref (i.e. branch name) and head commit
     const eventType = event.event;  // 'push' or 'pull_request'
-    var job_template = {  // the data structure containing information about our check
+    const job_template = {  // the data structure containing information about our check
         sha: null,  // The head commit sha to test on
         base: null,  // The previous commit sha (for comparing changes in code coverage)
         force: false,  // Whether to run tests when results already cached

test/fixtures/.db.json

@@ -1 +1 @@
-[{"commit": "cabe27e5c8b8cb7cdc4e152f1cf013a89adc7a71", "results": [{"Duration": 0.07038330000000001, "Details": {}, "Name": "Parameters_test/test_set", "Passed": false, "Failed": true, "Incomplete": true}, {"Duration": 2.5838056999999996, "Details": {}, "Name": "Alyx_test[base_url=https___test_alyx_internationalbrainlab_org]/test_getSessions", "Passed": false, "Failed": true, "Incomplete": false}, {"Duration": 5.1105206, "Details": {}, "Name": "Block2ALF_test/test_incomplete", "Passed": true, "Failed": false, "Incomplete": false}], "status": "failure", "description": "18/320 tests failed", "coverage": 22.19690421937613}, {"commit": "1c33a6e2ac7d7fc098105b21a702e104e09767cf", "results": [{"Duration": 0.0500121, "Details": {}, "Name": "patch_test/Test3_Circle", "Passed": true, "Failed": false, "Incomplete": false}, {"Duration": 0.0482601, "Details": {}, "Name": "toStr_test/test_toStr", "Passed": true, "Failed": false, "Incomplete": false}, {"Duration": 0.0389527, "Details": {}, "Name": "Signals_test/test_output", "Passed": true, "Failed": false, "Incomplete": false}, {"Duration": 0.016370700000000002, "Details": {}, "Name": "Signals_test/test_erf", "Passed": true, "Failed": false, "Incomplete": false}, {"Duration": 0.0152839, "Details": {}, "Name": "rnd_test/test_uni", "Passed": true, "Failed": false, "Incomplete": false}], "status": "success", "description": "All passed", "coverage": 75.77018633540374}, {"commit": "7bdf62", "results": null, "status": "error", "description": "Failed to checkout code: 7bdf62", "coverage": null}]
+[{"commit":"cabe27e5c8b8cb7cdc4e152f1cf013a89adc7a71","datetime":"2021-04-30T08:23:06.764580","results":[{"Duration":0.07038330000000001,"Details":{},"Name":"Parameters_test/test_set","Passed":false,"Failed":true,"Incomplete":true},{"Duration":2.5838056999999996,"Details":{},"Name":"Alyx_test[base_url=https___test_alyx_internationalbrainlab_org]/test_getSessions","Passed":false,"Failed":true,"Incomplete":false},{"Duration":5.1105206,"Details":{},"Name":"Block2ALF_test/test_incomplete","Passed":true,"Failed":false,"Incomplete":false}],"status":"failure","description":"18/320 tests failed","statistics":{"total":320,"failed":16,"errored":2,"skipped":5,"passed":297,"duration":146},"coverage":22.19690421937613},{"commit":"1c33a6e2ac7d7fc098105b21a702e104e09767cf","results":[{"Duration":0.0500121,"Details":{},"Name":"patch_test/Test3_Circle","Passed":true,"Failed":false,"Incomplete":false},{"Duration":0.0482601,"Details":{},"Name":"toStr_test/test_toStr","Passed":true,"Failed":false,"Incomplete":false},{"Duration":0.0389527,"Details":{},"Name":"Signals_test/test_output","Passed":true,"Failed":false,"Incomplete":false},{"Duration":0.016370700000000002,"Details":{},"Name":"Signals_test/test_erf","Passed":true,"Failed":false,"Incomplete":false},{"Duration":0.0152839,"Details":{},"Name":"rnd_test/test_uni","Passed":true,"Failed":false,"Incomplete":false}],"status":"success","description":"All passed","coverage":75.77018633540374},{"commit":"7bdf62","results":null,"status":"error","description":"Failed to checkout code: 7bdf62","coverage":null}]

test/lib.test.js

@@ -229,7 +229,7 @@ describe('Test compareCoverage:', function () {
  * A test for the function updateJobFromRecord.
  * @todo add test for compareCoverage call
  */
-describe('Test updateJobFromRecord:', function () {
+describe('Test updateJobFromRecord', function () {
     var job;
 
     beforeEach(function () {
@@ -257,6 +257,54 @@ describe('Test updateJobFromRecord:', function () {
 });
 
 
+/**
+ * A test for inserting the duration in description field by updateJobFromRecord.
+ */
+describe('Test duration in description', function () {
+    var job;
+    var _dbFile = config.dbFile;
+
+    before(function (done) {
+        job = {
+            data: {
+                sha: ids[1]
+            },
+            created: new Date(Date.now() - 1000 * 60 * 10)
+        };
+        config.dbFile = path.join(path.parse(config.dbFile).dir, '._db.json');
+        fs.copyFile(_dbFile, config.dbFile, err => {
+            if (err) throw err;
+            done();
+        });
+    });
+
+    after(function (done) {
+        queue.pile = [];  // In case a job was added
+        fs.unlink(config.dbFile, err => {
+            config.dbFile = _dbFile;
+            if (err) throw err;
+            done();
+        });
+    });
+
+    it('expect duration in description', async function () {
+        const updated = await lib.updateJobFromRecord(job);
+        expect(updated).true;
+        expect(job.data.description).contains('10 min');
+    });
+
+    it('expect truncated description', async function () {
+        const records = JSON.parse(await fs.promises.readFile(config.dbFile, 'utf8'));
+        records[1]['description'] = 'Lorem ipsum '.repeat(13);
+        await fs.promises.writeFile(config.dbFile, JSON.stringify(records));
+        const updated = await lib.updateJobFromRecord(job);
+        expect(updated).true;
+        expect(job.data.description.length).lte(config.max_description_len);
+        expect(job.data.description.endsWith('... (took 10 min)')).true;
+    });
+});
+
+
 /**
  * A test for the function startJobTimer.  Should kill the process when time is up and update the
  * job data.
@@ -795,6 +843,39 @@ describe('getBadgeData function', () => {
         sandbox.assert.calledOnce(queue.add);
     });
 
+    it('Check tests status', function () {
+        var data, expected;
+
+        // Failed tests
+        input['sha'] = ids[0];
+        input['context'] = 'tests';
+        data = lib.getBadgeData(input);
+        expected = {
+            schemaVersion: 1,
+            label: 'tests',
+            message: '297 passed, 18 failed, 5 skipped',
+            color: 'red'
+        };
+        expect(data).to.deep.equal(expected);
+        sandbox.assert.notCalled(queue.add);
+
+        // Errored
+        input['sha'] = ids[3];
+        expected['message'] = 'errored';
+        expected['color'] = 'red';
+        data = lib.getBadgeData(input);
+        expect(data).to.deep.equal(expected);
+        sandbox.assert.notCalled(queue.add);
+
+        // No stats field
+        input['sha'] = ids[1];
+        expected['message'] = 'passed';
+        expected['color'] = 'brightgreen';
+        data = lib.getBadgeData(input);
+        expect(data).to.deep.equal(expected);
+        sandbox.assert.notCalled(queue.add);
+    });
+
     it('Check force flag', function () {
         input['sha'] = ids[1];
         input['context'] = 'build';

test/serve.test.js

@@ -624,7 +624,7 @@ describe('shields callback', () => {
         request(srv)
             .get(`/coverage/${info.repo}/${SHA}?force=1`)
             .expect('Content-Type', 'application/json')
-            .expect(201)
+            .expect(200)
             .end(function (err, res) {
                 scope.done();
                 if (err) return done(err);