CLOUDP-301224: Refactor

Author: lovisaberggren

tools/spectral/ipa/metrics/metricCollection.js

@@ -3,10 +3,9 @@ import {
   extractTeamOwnership,
   getSeverityPerRule,
   loadCollectorResults,
-  loadOpenAPIFile,
-  loadRuleset,
   merge,
 } from './utils/metricCollectionUtils.js';
+import { loadJsonFile, loadRuleset } from '../utils.js';
 
 export async function runMetricCollectionJob(
   {
@@ -18,7 +17,7 @@ export async function runMetricCollectionJob(
 ) {
   try {
     console.log(`Loading OpenAPI file: ${oasFilePath}`);
-    const oasContent = loadOpenAPIFile(oasFilePath);
+    const oasContent = loadJsonFile(oasFilePath);
 
     console.log('Extracting team ownership data...');
     const ownershipData = extractTeamOwnership(oasContent);

tools/spectral/ipa/metrics/utils/metricCollectionUtils.js

@@ -1,15 +1,5 @@
-import fs from 'node:fs';
-import { bundleAndLoadRuleset } from '@stoplight/spectral-ruleset-bundler/with-loader';
 import { EntryType } from '../collector.js';
-
-export function loadOpenAPIFile(filePath) {
-  try {
-    const content = fs.readFileSync(filePath, 'utf8');
-    return JSON.parse(content);
-  } catch (error) {
-    throw new Error(`Failed to load OpenAPI file: ${error.message}`);
-  }
-}
+import { loadJsonFile } from '../../utils.js';
 
 export function getSeverityPerRule(ruleset) {
   const rules = ruleset.rules || {};
@@ -20,16 +10,6 @@ export function getSeverityPerRule(ruleset) {
   return map;
 }
 
-export async function loadRuleset(rulesetPath, spectral) {
-  try {
-    const ruleset = await bundleAndLoadRuleset(rulesetPath, { fs, fetch });
-    await spectral.setRuleset(ruleset);
-    return ruleset;
-  } catch (error) {
-    throw new Error(`Failed to load ruleset: ${error.message}`);
-  }
-}
-
 export function extractTeamOwnership(oasContent) {
   const ownerTeams = {};
   const paths = oasContent.paths || {};
@@ -53,15 +33,14 @@ export function extractTeamOwnership(oasContent) {
 
 export function loadCollectorResults(collectorResultsFilePath) {
   try {
-    const content = fs.readFileSync(collectorResultsFilePath, 'utf8');
-    const contentParsed = JSON.parse(content);
+    const content = loadJsonFile(collectorResultsFilePath);
     return {
-      [EntryType.VIOLATION]: contentParsed[EntryType.VIOLATION],
-      [EntryType.ADOPTION]: contentParsed[EntryType.ADOPTION],
-      [EntryType.EXCEPTION]: contentParsed[EntryType.EXCEPTION],
+      [EntryType.VIOLATION]: content[EntryType.VIOLATION],
+      [EntryType.ADOPTION]: content[EntryType.ADOPTION],
+      [EntryType.EXCEPTION]: content[EntryType.EXCEPTION],
     };
   } catch (error) {
-    throw new Error(`Failed to load Collector Results file: ${error.message}`);
+    throw new Error(`Failed to parse Collector Results: ${error.message}`);
   }
 }
 

tools/spectral/ipa/scripts/generateRulesetReadme.js

@@ -3,7 +3,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import spectral from '@stoplight/spectral-core';
 import { markdownTable } from 'markdown-table';
-import { loadRuleset } from '../metrics/utils/metricCollectionUtils.js';
+import { loadRuleset } from '../utils.js';
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 const readmeFilePath = path.join(dirname, '../rulesets', 'README.md');

tools/spectral/ipa/utils.js

@@ -0,0 +1,21 @@
+import { bundleAndLoadRuleset } from '@stoplight/spectral-ruleset-bundler/with-loader';
+import fs from 'node:fs';
+
+export async function loadRuleset(rulesetPath, spectral) {
+  try {
+    const ruleset = await bundleAndLoadRuleset(rulesetPath, { fs, fetch });
+    await spectral.setRuleset(ruleset);
+    return ruleset;
+  } catch (error) {
+    throw new Error(`Failed to load ruleset: ${error.message}`);
+  }
+}
+
+export function loadJsonFile(filePath) {
+  try {
+    const content = fs.readFileSync(filePath, 'utf8');
+    return JSON.parse(content);
+  } catch (error) {
+    throw new Error(`Failed to load file: ${error.message}`);
+  }
+}