feat: compare coverage against given threshold (#7)

Author: jorgecoca

.github/workflows/test.yml

@@ -22,4 +22,4 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ./
         with:
-          path: "./fixtures/lcov.info"
+          path: "./fixtures/lcov.100.info"

action.yml

@@ -5,6 +5,10 @@ inputs:
     description: 'lcov path'
     required: false
     default: './coverage/lcov.info'
+  min_coverage:
+    description: 'minimum coverage percentage allowed'
+    required: false
+    default: 100
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -0,0 +1,120 @@
+SF:/Users/felix/Development/github.com/felangel/bloc/packages/bloc/lib/src/bloc.dart
+DA:21,2
+DA:22,1
+DA:26,3
+DA:37,1
+DA:39,2
+DA:41,1
+DA:42,2
+DA:44,1
+DA:66,1
+DA:70,2
+DA:105,1
+DA:109,1
+DA:135,1
+DA:162,1
+DA:166,2
+DA:170,1
+DA:172,1
+DA:197,1
+DA:201,1
+DA:212,1
+DA:213,3
+DA:214,3
+DA:215,1
+DA:223,1
+DA:225,1
+DA:227,1
+DA:228,2
+DA:229,1
+DA:230,2
+DA:231,3
+DA:232,2
+DA:233,1
+DA:239,1
+DA:240,1
+DA:241,4
+DA:243,1
+DA:244,2
+DA:246,1
+DA:248,1
+DA:250,1
+LF:40
+LH:40
+end_of_record
+SF:/Users/felix/Development/github.com/felangel/bloc/packages/bloc/lib/src/bloc_observer.dart
+DA:14,1
+DA:20,0
+DA:27,0
+DA:36,0
+DA:43,0
+DA:51,0
+LF:6
+LH:1
+end_of_record
+SF:/Users/felix/Development/github.com/felangel/bloc/packages/bloc/lib/src/change.dart
+DA:10,1
+DA:18,1
+DA:21,1
+DA:22,3
+DA:23,3
+DA:24,3
+DA:26,1
+DA:27,5
+DA:29,1
+DA:31,3
+LF:10
+LH:10
+end_of_record
+SF:/Users/felix/Development/github.com/felangel/bloc/packages/bloc/lib/src/cubit.dart
+DA:16,1
+DA:27,1
+DA:29,3
+DA:30,1
+DA:54,1
+DA:56,2
+DA:60,2
+DA:62,2
+DA:79,1
+DA:82,2
+DA:83,2
+DA:84,3
+DA:85,3
+DA:86,1
+DA:87,3
+DA:88,1
+DA:92,1
+DA:93,1
+DA:115,1
+DA:118,2
+DA:138,1
+DA:142,2
+DA:143,1
+DA:144,1
+DA:145,1
+DA:152,1
+DA:159,2
+DA:160,3
+DA:170,1
+DA:175,1
+DA:178,2
+DA:179,2
+LF:32
+LH:32
+end_of_record
+SF:/Users/felix/Development/github.com/felangel/bloc/packages/bloc/lib/src/transition.dart
+DA:14,1
+DA:18,1
+DA:23,1
+DA:26,1
+DA:27,3
+DA:28,3
+DA:29,3
+DA:30,3
+DA:32,1
+DA:34,8
+DA:37,1
+DA:39,4
+LF:12
+LH:12
+end_of_record

dist/index.js.map

@@ -0,0 +1 @@
+this should not parse

fixtures/lcov.info fixtures/lcov.100.infofixtures/lcov.info renamed to fixtures/lcov.100.info

@@ -3,18 +3,24 @@ const parse = require("lcov-parse");
 
 function run() {
   const lcovPath = core.getInput("path");
+  const minCoverage = core.getInput("min_coverage");
 
-  parse(lcovPath, function (err, data) {
-    if (err) {
+  parse(lcovPath, function (_, data) {
+    if (typeof data === "undefined") {
       core.setFailed("parsing error!");
+      return;
     }
     let totalFinds = 0;
     let totalHits = 0;
     data.forEach(element => {
       totalHits += element['lines']['hit'];
       totalFinds += element['lines']['found'];
     });
-    core.debug((totalHits / totalFinds) * 100);
+    const coverage = (totalHits / totalFinds) * 100;
+    const isValidBuild = coverage >= minCoverage;
+    if (!isValidBuild) {
+      core.setFailed(`Coverage ${coverage} is below the minimum ${minCoverage} expected`);
+    }
   });
 }
 

fixtures/lcov.95.info

@@ -1,12 +1,58 @@
 const process = require("process");
 const cp = require("child_process");
 const path = require("path");
+const { fail } = require("assert");
 
-test("test runs", () => {
-  const lcovPath = "./fixtures/lcov.info";
+test("invalid LCOV format throws an error", () => {
+  const lcovPath = "./fixtures/lcov.error.info";
   process.env["INPUT_PATH"] = lcovPath;
   const ip = path.join(__dirname, "index.js");
-  const actual = cp.execSync(`node ${ip}`, { env: process.env }).toString();
-  const expected = '::debug::100\n';
-  expect(actual).toEqual(expected);
+  try {
+    cp.execSync(`node ${ip}`, { env: process.env }).toString();
+    fail('this code should fail');
+  } catch (err) {
+    expect(err).toBeDefined();
+  }
 });
+
+test("completes when the coverage is 100 and min_coverage is not provided", () => {
+  const lcovPath = "./fixtures/lcov.100.info";
+  process.env["INPUT_PATH"] = lcovPath;
+  const ip = path.join(__dirname, "index.js");
+  cp.execSync(`node ${ip}`, { env: process.env }).toString();
+});
+
+test("fails when the coverage is not 100 and min_coverage is not provided", () => {
+  const lcovPath = "./fixtures/lcov.95.info";
+  process.env["INPUT_PATH"] = lcovPath;
+  const ip = path.join(__dirname, "index.js");
+  try {
+    cp.execSync(`node ${ip}`, { env: process.env }).toString();
+    fail('this code should fail');
+  } catch (err) {
+    expect(err).toBeDefined();
+  }
+});
+
+test("completes when the coverage is above the given min_threshold", () => {
+  const lcovPath = "./fixtures/lcov.95.info";
+  const minCoverage = 80;
+  process.env["INPUT_PATH"] = lcovPath;
+  process.env["INPUT_MIN_COVERAGE"] = minCoverage;
+  const ip = path.join(__dirname, "index.js");
+  cp.execSync(`node ${ip}`, { env: process.env }).toString();
+});
+
+test("fails when the coverage is below the given min_threshold", () => {
+  const lcovPath = "./fixtures/lcov.95.info";
+  const minCoverage = 98;
+  process.env["INPUT_PATH"] = lcovPath;
+  process.env["INPUT_MIN_COVERAGE"] = minCoverage;
+  const ip = path.join(__dirname, "index.js");
+  try {
+    cp.execSync(`node ${ip}`, { env: process.env }).toString();
+    fail('this code should fail');
+  } catch (err) {
+    expect(err).toBeDefined();
+  }
+});