Add baseline metrics for lines of code

This commit uses a third party library to estimate the lines of code in
a database that is to be analyzed by codeql.

The estimate uses the same includes and excludes globs for determining
which files should be counted.

The lines of code count is returned by language and injected into the
SARIF as `baseline` property in the `${language}/summary/lines-of-code`
metric.

lib/analyze.test.js

@@ -11,9 +11,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
 const ava_1 = __importDefault(require("ava"));
+const sinon_1 = __importDefault(require("sinon"));
 const analyze_1 = require("./analyze");
 const codeql_1 = require("./codeql");
+const count = __importStar(require("./count-loc"));
 const languages_1 = require("./languages");
 const logging_1 = require("./logging");
 const testing_utils_1 = require("./testing-utils");
@@ -23,21 +26,53 @@ testing_utils_1.setupTests(ava_1.default);
 // and correct case of builtin or custom. Also checks the correct search
 // paths are set in the database analyze invocation.
 ava_1.default("status report fields and search path setting", async (t) => {
+    const mockLinesOfCode = Object.entries(languages_1.Language).reduce((obj, [lang], i) => {
+        // use a different line count for each languaged
+        obj[lang] = i + 1;
+        return obj;
+    }, {});
+    sinon_1.default.stub(count, "countLoc").resolves(mockLinesOfCode);
     let searchPathsUsed = [];
     return await util.withTmpDir(async (tmpDir) => {
         testing_utils_1.setupActionsVars(tmpDir, tmpDir);
-        codeql_1.setCodeQL({
-            databaseAnalyze: async (_, sarifFile, searchPath) => {
-                fs.writeFileSync(sarifFile, JSON.stringify({
-                    runs: [],
-                }));
-                searchPathsUsed.push(searchPath);
-            },
-        });
         const memoryFlag = "";
         const addSnippetsFlag = "";
         const threadsFlag = "";
         for (const language of Object.values(languages_1.Language)) {
+            codeql_1.setCodeQL({
+                databaseAnalyze: async (_, sarifFile, searchPath) => {
+                    fs.writeFileSync(sarifFile, JSON.stringify({
+                        runs: [
+                            // variant 1 uses metricId
+                            {
+                                properties: {
+                                    metricResults: [
+                                        {
+                                            metricId: `${language}/summary/lines-of-code`,
+                                            value: 123,
+                                        },
+                                    ],
+                                },
+                            },
+                            // variant 2 uses metric.id
+                            {
+                                properties: {
+                                    metricResults: [
+                                        {
+                                            metric: {
+                                                id: `${language}/summary/lines-of-code`,
+                                            },
+                                            value: 123,
+                                        },
+                                    ],
+                                },
+                            },
+                            {},
+                        ],
+                    }));
+                    searchPathsUsed.push(searchPath);
+                },
+            });
             searchPathsUsed = [];
             const config = {
                 languages: [language],
@@ -80,6 +115,35 @@ ava_1.default("status report fields and search path setting", async (t) => {
             t.true(`analyze_custom_queries_${language}_duration_ms` in customStatusReport);
             t.deepEqual(searchPathsUsed, [undefined, "/1", "/2"]);
         }
+        verifyLineCounts(tmpDir);
     });
+    function verifyLineCounts(tmpDir) {
+        // eslint-disable-next-line github/array-foreach
+        Object.keys(languages_1.Language).forEach((lang, i) => {
+            verifyLineCountForFile(lang, path.join(tmpDir, `${lang}-builtin.sarif`), i + 1);
+            verifyLineCountForFile(lang, path.join(tmpDir, `${lang}-custom.sarif`), i + 1);
+        });
+    }
+    function verifyLineCountForFile(lang, filePath, lineCount) {
+        const sarif = JSON.parse(fs.readFileSync(filePath, "utf8"));
+        t.deepEqual(sarif.runs[0].properties.metricResults, [
+            {
+                metricId: `${lang}/summary/lines-of-code`,
+                value: 123,
+                baseline: lineCount,
+            },
+        ]);
+        t.deepEqual(sarif.runs[1].properties.metricResults, [
+            {
+                metric: {
+                    id: `${lang}/summary/lines-of-code`,
+                },
+                value: 123,
+                baseline: lineCount,
+            },
+        ]);
+        // when the metric doesn't exists, it should not be added
+        t.deepEqual(sarif.runs[2].properties.metricResults, []);
+    }
 });
 //# sourceMappingURL=analyze.test.js.map