CLOUDP-295956: Resolve jest importing spectral issue

Author: lovisaberggren

package-lock.json

@@ -3,6 +3,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import { beforeEach, describe, expect, it, jest } from '@jest/globals';
 import { runMetricCollectionJob } from '../../metrics/metricCollection.js';
+import * as spectral from '@stoplight/spectral-core';
 
 const dirname = path.dirname(fileURLToPath(require('url').pathToFileURL(__filename).toString()));
 const expectedResultFilePath = path.join(dirname, 'data', 'expected-metric-results.json');
@@ -26,7 +27,7 @@ describe('tools/spectral/ipa/metrics/metricCollection.js runMetricCollectionJob'
   it('Outputs the expected metrics collection results', async () => {
     const expectedResults = JSON.parse(fs.readFileSync(expectedResultFilePath, 'utf8'));
 
-    const results = await runMetricCollectionJob(testConfig);
+    const results = await runMetricCollectionJob(testConfig, spectral);
 
     expect(results).not.toBe(undefined);
     expect(results.length).toEqual(expectedResults.length);

tools/spectral/ipa/__tests__/metrics/metricCollection.test.js

@@ -12,7 +12,5 @@ const config = {
 };
 
 config.defaultMetricCollectionResultsFilePath = path.join(config.defaultOutputsDir, 'metric-collection-results.json');
-config.defaultSpectralReportFile = path.join(config.defaultOutputsDir, 'spectral-report.xml');
-config.defaultSpectralOutputFile = path.join(config.defaultOutputsDir, 'spectral-output.txt');
 
 export default config;

tools/spectral/ipa/metrics/config.js

@@ -8,11 +8,14 @@ import {
   merge,
 } from './utils.js';
 
-export async function runMetricCollectionJob({
-  oasFilePath = config.defaultOasFilePath,
-  rulesetFilePath = config.defaultRulesetFilePath,
-  collectorResultsFilePath = config.defaultCollectorResultsFilePath,
-}) {
+export async function runMetricCollectionJob(
+  {
+    oasFilePath = config.defaultOasFilePath,
+    rulesetFilePath = config.defaultRulesetFilePath,
+    collectorResultsFilePath = config.defaultCollectorResultsFilePath,
+  },
+  spectral
+) {
   try {
     console.log(`Loading OpenAPI file: ${oasFilePath}`);
     const oasContent = loadOpenAPIFile(oasFilePath);
@@ -21,7 +24,7 @@ export async function runMetricCollectionJob({
     const ownershipData = extractTeamOwnership(oasContent);
 
     console.log('Getting rule severities...');
-    const ruleset = await loadRuleset(rulesetFilePath);
+    const ruleset = await loadRuleset(rulesetFilePath, spectral);
     const ruleSeverityMap = getSeverityPerRule(ruleset);
 
     console.log('Loading collector results...');

tools/spectral/ipa/metrics/metricCollection.js

@@ -1,13 +1,14 @@
 import fs from 'node:fs';
 import { spawnSync } from 'child_process';
+import spectral from '@stoplight/spectral-core';
 import config from '../config.js';
 import { runMetricCollectionJob } from '../metricCollection.js';
 
 const args = process.argv.slice(2);
 const oasFilePath = args[0];
 
 if (!fs.existsSync(config.defaultOutputsDir)) {
-  fs.mkdirSync('outputs');
+  fs.mkdirSync(config.defaultOutputsDir);
   console.log(`Output directory created successfully`);
 }
 
@@ -20,8 +21,14 @@ if (result.error) {
 
 console.log('Spectral lint completed successfully.');
 
-runMetricCollectionJob({
-  oasFilePath,
-})
-  .then((results) => fs.writeFileSync(config.defaultMetricCollectionResultsFilePath, JSON.stringify(results)))
+runMetricCollectionJob(
+  {
+    oasFilePath,
+  },
+  spectral
+)
+  .then((results) => {
+    console.log('Writing results');
+    fs.writeFileSync(config.defaultMetricCollectionResultsFilePath, JSON.stringify(results));
+  })
   .catch((error) => console.error(error.message));

tools/spectral/ipa/metrics/scripts/runMetricCollection.js

@@ -1,5 +1,4 @@
 import fs from 'node:fs';
-import { Spectral } from '@stoplight/spectral-core';
 import { bundleAndLoadRuleset } from '@stoplight/spectral-ruleset-bundler/with-loader';
 import { EntryType } from './collector.js';
 
@@ -21,7 +20,9 @@ export function getSeverityPerRule(ruleset) {
   return map;
 }
 
-export async function loadRuleset(rulesetPath) {
+export async function loadRuleset(rulesetPath, spectral) {
+  const { Spectral } = spectral;
+
   try {
     const spectral = new Spectral();
     const ruleset = await bundleAndLoadRuleset(rulesetPath, { fs, fetch });