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,84 @@
+#!/usr/bin/env node
+
+const { spawn } = require('node:child_process');
+const fs = require('node:fs');
+const { access } = require('node:fs/promises');
+
+const { CODEOWNERS_FILE_PATH, CODEOWNERS_MANIFEST_DIR, RAW_AUDIT_JSONL_PATH } = require('./constants.js');
+
+/**
+ * Generate raw CODEOWNERS audit data using github-codeowners CLI
+ * @param {string} codeownersPath - Path to CODEOWNERS file
+ * @param {string} outputPath - Path to write audit JSONL file
+ */
+async function generateCodeownersRawAudit(codeownersPath, outputPath) {
+  try {
+    await access(codeownersPath);
+  } catch (error) {
+    throw new Error(`CODEOWNERS file not found at: ${codeownersPath}`);
+  }
+
+  return new Promise((resolve, reject) => {
+    const outputStream = fs.createWriteStream(outputPath);
+
+    const child = spawn('yarn', ['github-codeowners', 'audit', '--output', 'jsonl'], {
+      stdio: ['ignore', 'pipe', 'pipe'],
+      cwd: process.cwd(),
+      shell: true,
+    });
+
+    let stderrData = '';
+    child.stderr.on('data', (data) => {
+      stderrData += data.toString();
+    });
+
+    outputStream.on('error', (error) => {
+      child.kill();
+      reject(new Error(`Failed to write to output file: ${error.message}`));
+    });
+
+    child.stdout.pipe(outputStream);
+
+    child.on('close', (code) => {
+      outputStream.end();
+      if (code === 0) {
+        resolve();
+      } else {
+        const error = new Error(`github-codeowners process exited with code ${code}`);
+        if (stderrData) {
+          error.message += `\nStderr: ${stderrData.trim()}`;
+        }
+        reject(error);
+      }
+    });
+
+    child.on('error', (err) => {
+      outputStream.end();
+      if (err.code === 'ENOENT') {
+        reject(new Error('yarn command not found. Please ensure yarn and github-codeowners are available'));
+      } else {
+        reject(err);
+      }
+    });
+  });
+}
+
+if (require.main === module) {
+  (async () => {
+    try {
+      if (!fs.existsSync(CODEOWNERS_MANIFEST_DIR)) {
+        fs.mkdirSync(CODEOWNERS_MANIFEST_DIR, { recursive: true });
+      }
+
+      console.log(`🍣 Getting raw CODEOWNERS data for manifest ...`);
+      await generateCodeownersRawAudit(CODEOWNERS_FILE_PATH, RAW_AUDIT_JSONL_PATH);
+      console.log('✅ Raw audit generated:');
+      console.log(`   • ${RAW_AUDIT_JSONL_PATH}`);
+    } catch (e) {
+      console.error('❌ Error generating raw audit:', e.message);
+      process.exit(1);
+    }
+  })();
+}
+
+module.exports = { generateCodeownersRawAudit };