Coveralls workflow

.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  schedule:
+    - cron:  '0 0 * * 0'  # every Sunday at midnight
+  workflow_dispatch:  # For manual triggering
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master, dev ]
+
+env:
+  DOTENV_CONFIG_PATH: ./test/fixtures/.env.test
+
+jobs:
+  build:
+    name: build ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # Whether to stop execution of other instances
+      max-parallel: 4
+      matrix:
+        os: ["ubuntu-latest", "windows-latest"]  #  , "macos-latest"
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: |
+          npm run coverage
+          npx nyc report --reporter=lcovonly --reporter text
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: ${{ matrix.os }}
+          parallel: true
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

.gitignore

@@ -3,3 +3,5 @@
 node_modules/*
 .env
 .pem
+coverage/*
+.nyc_output/*

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## [Latest](https://github.com/cortex-lab/matlab-ci/commits/master) [3.1.0]
+## [Latest](https://github.com/cortex-lab/matlab-ci/commits/master) [3.2.0]
+
+## Added
+
+ - git workflow
+ - set coveralls env vars
+
+## [3.1.0]
 
 ## Modified
 

README.md

@@ -1,6 +1,6 @@
 # LabCI
-[![Build Status](https://travis-ci.com/cortex-lab/LabCI.svg?branch=master)](https://travis-ci.com/cortex-lab/matlab-ci)
-[![Coverage](https://img.shields.io/badge/coverage-91.91-brightgreen)](https://img.shields.io/badge/coverage-72.35-yellowgreen)
+![CI workflow](https://github.com/cortex-lab/LabCI/actions/workflows/tests.yml/badge.svg?branch=main)
+[![Coverage](https://img.shields.io/badge/coverage-91.69-brightgreen)](https://img.shields.io/badge/coverage-72.35-yellowgreen)
 
 A small set of modules written in Node.js for running automated tests of MATLAB and Python code in response to GitHub events.  Also submits code coverage to the Coveralls API.
 
@@ -111,6 +111,10 @@ Your test script must do the following:
 2. Save the results into the JSON cache file without duplication
 3. For code coverage the script must either save the coverage directly, or export a Cobertura formatted XML file.
 
+## Coveralls
+Coverage information can be sent to coveralls.io using the [node-coveralls](https://github.com/nickmerwin/node-coveralls) package.
+Adding `COVERALLS_REPO_TOKEN` to the .env file will cause the CI to set other dynamic env variables before running a pipeline.
+
 ## Built With
 
 * [LocalTunnel](https://localtunnel.me) - A secure tunneling service

lib.js

@@ -335,9 +335,29 @@ function startJobTimer(job, kill_children = false) {
 }
 
 
+/**
+ * Set dynamic env variables for node-coveralls.
+ * NB: This does not support submodules.
+ * @param {Object} job - The Job with an associated process in the data field.
+ */
+function initCoveralls(job) {
+    const debug = log.extend('pipeline');
+    debug('Setting COVERALLS env variables');
+    process.env.COVERALLS_SERVICE_JOB_ID = job.id;
+    const envMap = {
+        'COVERALLS_SERVICE_NAME': job.data.context,
+        'COVERALLS_GIT_COMMIT': job.data.sha,
+        'COVERALLS_GIT_BRANCH': job.data.branch,
+        'CI_PULL_REQUEST': job.data.pull_number
+    };
+    for (let key in envMap) { // assign value or delete key
+        if (envMap[key]) { process.env[key] = envMap[key]; } else { delete process.env[key]; }
+    }
+}
+
 /**
  * Build task pipeline.  Takes a list of scripts/functions and builds a promise chain.
- * @param {Object} job - The path of the repository
+ * @param {Object} job - The Job with an associated process in the data field.
  * @returns {Promise} - The job routine
  */
 async function buildRoutine(job) {
@@ -365,6 +385,9 @@ async function buildRoutine(job) {
     });
     const ops = config.shell ? {'shell': config.shell} : {};
 
+    // If environment variable COVERALLS_REPO_TOKEN is not null, set dynamic variables
+    if (process.env.COVERALLS_REPO_TOKEN) initCoveralls(job);
+
     const init = () => debug('Executing pipeline for job #%g', job.id);
     const routine = tasks.reduce(applyTask, Promise.resolve().then(init));
     return routine
@@ -719,5 +742,5 @@ module.exports = {
     ensureArray, loadTestRecords, compareCoverage, computeCoverage, getBadgeData, log, shortID,
     openTunnel, APIError, queue, partial, startJobTimer, updateJobFromRecord, shortCircuit, isSHA,
     fullpath, strToBool, saveTestRecords, listSubmodules, getRepoPath, addParam, context2routine,
-    buildRoutine
+    buildRoutine, initCoveralls
 };