Tests: Custom script to run unit tests filtered by code ownership (#111210)

* feat(script): generate a source file x teams manifest from CODEOWNERS * feat(script): unit tests + coverage report only for files owned by team * feat(script): calculate CODEOWNERS metadata * refactor(script): export a pure codeowners manifest generation function * refactor(script): export a pure test coverage by team function * refactor(script): generate raw JSONL codeowners data from Node.js script * feat(script): put codeowners manifest all together in one script * refactor(scripts): group consistently with NPM script name * refactor(scripts): deduplicate constants for file paths etc. * refactor(scripts): make console output cute 💅✨ * refactor(tests): make coverage by "owner" directory more human readable * refactor(scripts): use consistent naming "codeowner" instead of "team" * chore(codeowners): mark DataViz as owners of scripts for now * chore(todo): leave a note where coverage metrics should be emitted later * fix(gitignore): ignore root codeowners-manifest directory not scripts/* * refactor(script): rename manifest to generate for clarity * docs(readme): add a brief README describing new scrips * chore(linter): ignore temporary files in prettier, fix whitespace format * refactor(script): simplify Jest config by using team files list directly * refactor(script): simplify script, partition sourceFiles and testFiles * refactor(script): simplify and parallelize manifest write operations * fix(script): handle errors for JSONL line reader * refactor(script): use Map instead of POJOs * fix(script): handle errors when streaming raw JSONL output * fix(script): add error handling, and use promise API for metadata check * fix(reporter): suppress duplicate Jest CLI coverage report output * refactor(script): simplify with fs promises API for consistency * fix(script): error handling for cp spawn-ed process * refactor(script): use Promise API for mkdir + exists * refactor(script): use fs Promise API * refactor(script): use fs Promise API * fix(script): same allow list for sourceFilter and all Jest config rules Co-authored-by: Paul Marbach <paul.marbach@grafana.com> * fix(script): bust cache when new files are created also --------- Co-authored-by: Paul Marbach <paul.marbach@grafana.com>
2025-10-07 17:07:55 -04:00
parent 9d60d03d11
commit 70dc9a0027
13 changed files with 737 additions and 11 deletions
@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+
+const fs = require('node:fs');
+const { stat, writeFile } = require('node:fs/promises');
+const readline = require('node:readline');
+
+const {
+  RAW_AUDIT_JSONL_PATH,
+  CODEOWNERS_BY_FILENAME_JSON_PATH,
+  FILENAMES_BY_CODEOWNER_JSON_PATH,
+  CODEOWNERS_JSON_PATH,
+} = require('./constants.js');
+
+/**
+ * Generate codeowners manifest files from raw audit data
+ * @param {string} rawAuditPath - Path to the raw audit JSONL file
+ * @param {string} codeownersJsonPath - Path to write teams.json
+ * @param {string} codeownersByFilenamePath - Path to write teams-by-filename.json
+ * @param {string} filenamesByCodeownerPath - Path to write filenames-by-team.json
+ */
+async function generateCodeownersManifest(
+  rawAuditPath,
+  codeownersJsonPath,
+  codeownersByFilenamePath,
+  filenamesByCodeownerPath
+) {
+  const hasRawAuditJsonl = await stat(rawAuditPath);
+  if (!hasRawAuditJsonl) {
+    throw new Error(
+      `No raw CODEOWNERS audit JSONL file found at: ${rawAuditPath} ... run "yarn codeowners-manifest:raw"`
+    );
+  }
+
+  const auditFileInput = fs.createReadStream(rawAuditPath);
+
+  const lineReader = readline.createInterface({
+    input: auditFileInput,
+    crlfDelay: Infinity,
+  });
+
+  let codeowners = new Set();
+  let codeownersByFilename = new Map();
+  let filenamesByCodeowner = new Map();
+
+  lineReader.on('error', (error) => {
+    console.error('Error reading file:', error);
+    throw error;
+  });
+
+  lineReader.on('line', (line) => {
+    try {
+      const { path, owners: fileOwners } = JSON.parse(line.toString().trim());
+
+      for (let owner of fileOwners) {
+        codeowners.add(owner);
+      }
+
+      codeownersByFilename.set(path, fileOwners);
+
+      for (let owner of fileOwners) {
+        const filenames = filenamesByCodeowner.get(owner) || [];
+        filenamesByCodeowner.set(owner, filenames.concat(path));
+      }
+    } catch (parseError) {
+      console.error(`Error parsing line: ${line}`, parseError);
+      throw parseError;
+    }
+  });
+
+  await new Promise((resolve) => lineReader.once('close', resolve));
+
+  await Promise.all([
+    writeFile(codeownersJsonPath, JSON.stringify(Array.from(codeowners).sort(), null, 2)),
+    writeFile(codeownersByFilenamePath, JSON.stringify(Object.fromEntries(codeownersByFilename), null, 2)),
+    writeFile(filenamesByCodeownerPath, JSON.stringify(Object.fromEntries(filenamesByCodeowner), null, 2)),
+  ]);
+}
+
+if (require.main === module) {
+  (async () => {
+    try {
+      console.log(`📋 Generating files ↔ teams manifests from ${RAW_AUDIT_JSONL_PATH} ...`);
+      await generateCodeownersManifest(
+        RAW_AUDIT_JSONL_PATH,
+        CODEOWNERS_JSON_PATH,
+        CODEOWNERS_BY_FILENAME_JSON_PATH,
+        FILENAMES_BY_CODEOWNER_JSON_PATH
+      );
+      console.log('✅ Manifest files generated:');
+      console.log(`   • ${CODEOWNERS_JSON_PATH}`);
+      console.log(`   • ${CODEOWNERS_BY_FILENAME_JSON_PATH}`);
+      console.log(`   • ${FILENAMES_BY_CODEOWNER_JSON_PATH}`);
+    } catch (e) {
+      console.error(e);
+      process.exit(1);
+    }
+  })();
+}
+
+module.exports = { generateCodeownersManifest };