custom formatter

Author: yelizhenden-mdb

package-lock.json

@@ -1,6 +1,7 @@
 {
     "name": "mongodb-openapi",
     "description": "MongoDB repository with OpenAPI specification",
+    "type": "module",
     "scripts": {
         "format": "npx prettier . --write",
         "format-check": "npx prettier . --check",
@@ -9,7 +10,11 @@
     },
     "dependencies": {
         "@stoplight/spectral-cli": "^6.14.2",
-        "openapi-to-postmanv2": "4.24.0"
+        "@stoplight/spectral-core": "^1.19.4",
+        "@stoplight/spectral-ruleset-bundler": "^1.6.1",
+        "@stoplight/spectral-runtime": "^1.1.3",
+        "openapi-to-postmanv2": "4.24.0",
+        "xmlbuilder2": "^3.1.1"
     },
     "devDependencies": {
         "@eslint/js": "^9.15.0",

package.json

@@ -0,0 +1,34 @@
+import { create } from 'xmlbuilder2';
+
+
+export default async function customJUnitFormatter(results, document, spectral) {
+  const allRules = spectral.ruleset.rules;
+  const failedRules = new Set(results.map((result) => result.code));
+
+  // Create a new XML document
+  const xml = create({ version: '1.0' }) // Specify XML version
+  .ele('testsuite', {
+    name: 'SpectralLint',
+    tests: Object.keys(allRules).length,
+  });
+
+  // Add test cases for each rule
+  for (const ruleName of Object.keys(allRules)) {
+    const rule = allRules[ruleName];
+    const testCase = xml.ele('testcase', {
+      classname: ruleName,
+      name: rule.description || 'No description available',
+      time: '0', // Default time
+    });
+
+    if (failedRules.has(ruleName)) {
+      const failure = results.find((result) => result.code === ruleName);
+      testCase.ele('failure', { type: ruleName }, failure.message);
+    } else {
+      testCase.ele('success'); // Mark as success for passed rules
+    }
+  }
+
+  // Convert the XML structure to a string
+  return xml.end({ prettyPrint: true });
+}

tools/ipa/formatters/custom-formatter.js

@@ -1,2 +1,2 @@
 extends:
-  - ./rulesets/IPA-104.yaml
+  - ./rulesets/IPA-104.yaml

tools/ipa/ipa-spectral.yaml

@@ -4,7 +4,6 @@
 functions:
   - "eachResourceHasGetMethod"
 
-
 rules:
   xgen-IPA-104-resource-has-GET:
     description: "APIs must provide a get method for resources. http://go/ipa/104"

tools/ipa/rulesets/IPA-104.yaml

@@ -0,0 +1,36 @@
+import spectral from "@stoplight/spectral-core";
+import { bundleAndLoadRuleset } from "@stoplight/spectral-ruleset-bundler/with-loader";
+import { fileURLToPath } from "node:url";
+import * as fs from "node:fs";
+import * as path from "node:path";
+import customJUnitFormatter from "./formatters/custom-formatter.js";
+const { Spectral } = spectral;
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+(async () => {
+  const spectral = new Spectral();
+
+  try {
+    // Load the ruleset
+    const rulesetPath = path.join(__dirname, "./ipa-spectral.yaml");
+    const ruleset = await bundleAndLoadRuleset(rulesetPath, { fs, fetch });
+    await spectral.setRuleset(ruleset);
+
+    // Read the OpenAPI file and run Spectral
+    const { readFile, writeFile } = fs.promises;
+    const openApiContent = await readFile('../../openapi/v2.json', 'utf8');
+    const results = await spectral.run(openApiContent);
+
+    // Use the custom formatter
+    const formattedOutput = await customJUnitFormatter(results, '../../openapi/v2.json', spectral);
+
+    // Write the output to a file
+    console.log(formattedOutput);
+    await writeFile('./spectral-report.xml', formattedOutput);
+
+  } catch (err) {
+    console.error('Error running Spectral:', err.message);
+    process.exit(1);
+  }
+})();