much further along in the journey. have it factored closer to what i …

…want, but am spending a bunch of time on getting debugging working the way I want it

eng/tools/oav-runner/README.md

@@ -0,0 +1,4 @@
+# `oav-runner`
+
+This is a simple wrapper script around the `oav` tool. It utilizes shared js code code modules from `.github/shared` to
+determine a list of swagger specs that should be processed.

eng/tools/oav-runner/package.json

@@ -5,21 +5,22 @@
   "version": "1.0.0",
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "test": "vitest"
+    "test": "vitest --run"
   },
   "bin": {
-    "invoke-oav": "dist/main.js"
+    "invoke-oav": "dist/cli.js"
   },
   "dependencies": {
-    "oav": "3.5.1",
     "@azure-tools/specs-shared": "file:../../../.github/shared",
     "js-yaml": "^4.1.0",
+    "oav": "3.5.1",
     "simple-git": "^3.27.0"
   },
   "devDependencies": {
-    "vitest": "^3.0.7",
+    "@types/glob": "^8.1.0",
+    "@types/node": "~20.11.0",
     "typescript": "~5.8.2",
-    "@types/node": "~20.11.0"
+    "vitest": "^3.0.7"
   },
   "engines": {
     "node": ">=20.0.0",

eng/tools/oav-runner/src/cli.ts

@@ -8,6 +8,6 @@ if (!targetDir) {
   process.exit(1);
 }
 else {
-    await main(targetDir);
     console.log(`Running oav-runner on ${targetDir}`);
+    await main(targetDir);
 }

eng/tools/oav-runner/src/main.ts

@@ -3,10 +3,116 @@
 // The original ordering of this code is pulled directly from the original at
 // openapi-alps#public/rest-api-specs-scripts/src/modelValidationPipeline.ts
 import * as oav from 'oav';
+import * as path from 'path';
+// import * as glob from 'glob';
+import * as fs from 'fs';
 
 // use ,specification, example to filter the changed files to just specs and examples
-import { getChangedFiles } from "@azure-tools/specs-shared/changed-files";
+import { getChangedFiles, swagger } from "@azure-tools/specs-shared/changed-files";
 
+export async function main(rootDirectory: string): Promise<Number> {
+    let errors: Array<string> = [];
+
+    console.log(`Executing checks in ${rootDirectory}`);
+
+    const changedFiles = await getChangedFiles({
+      cwd: rootDirectory
+    })
+
+    const swaggerFiles = await processFilesToSpecificationList(rootDirectory, changedFiles);
+
+    // todo: this will have to be hardened a bit. targeting the swagger file selection first
+    // as it is an easily testable operation.
+    for (const swaggerFile of swaggerFiles) {
+      try {
+        oav.validateSpec(swaggerFile, {});
+      }
+      catch (e) {
+        // todo: add error handling beyond logging
+        console.log(e);
+      }
+    }
+
+    if (errors){
+        return 1;
+    }
+    return 0;
+}
+
+
+export async function processFilesToSpecificationList(rootDirectory: string, files: string[]): Promise<Array<string>> {
+    // this is implemented in existing example and spec validation pipeline simply by pulling _all_ of the swagger files
+    // and then filtering them down to just the ones that are in the changed files list.
+
+    // we might have to do that, but as far as I can tell, the "pull everything" approach only works for the nonPR. If its PR
+    // it literally never uses the total result.
+    return files.filter((file) => {
+      if (
+          file.match(/.*\/cadl-project.yaml$/gi) !== null ||
+          file.match(/.*\/package.json$/gi) !== null ||
+          file.match(/.*\/sdk-suppressions.yaml$/gi) !== null ||
+          file.match(/.*\/suppressions.yaml$/gi) !== null ||
+          file.match(/.*\/tspconfig.yaml$/gi) !== null ||
+          file.match(/.*\/cspell.yaml$/gi) !== null
+        ) {
+          return false;
+        }
+        if (file.match(/.*\/scenarios\/*/gi) !== null) {
+          return false;
+        }
+        if (
+          file.match(/.*(json|yaml)$/gi) == null ||
+          file.match(/.*specification\/.*/gi) == null
+        ) {
+          return false;
+        }
+        if (file.match(/.*\/examples\/*/gi) !== null) {
+          return false;
+        }
+        if (file.match(/.*\/quickstart-templates\/*/gi) !== null) {
+          return false;
+        }
+
+        let swaggerResult = swagger(file);
+
+        // if it's a swagger file, we should check to see if it exists
+        // as a deleted file will also show up in the changed files list
+        if (swaggerResult && fs.existsSync(path.join(rootDirectory, file))) {
+          return true
+        }
+        return false;
+      });
+}
+
+
+// keep these around for now, but they are not used in the current implementation
+// the biggest thing is that I'm uncertain if I will need to keep some sort of this globbing around to support when _only_ examples
+// are changed, for instance.
+
+// export const getSwaggers = () => {
+//   const getGlobPath = () =>
+//     path.join(__dirname, "../", "../", "/specification/**/*.json");
+//     return glob.sync(getGlobPath(), {
+//     ignore: [
+//       "**/scenarios/**/*.json",
+//       "**/examples/**/*.json",
+//       "**/quickstart-templates/*.json",
+//       "**/schema/*.json",
+//     ],
+//   });
+// };
+
+// export const getExamples = () => {
+//   const exampleGlobPath = path.join(
+//     __dirname,
+//     "../",
+//     "../",
+//     "/specification/**/examples/**/*.json"
+//   );
+//   return glob.sync(exampleGlobPath);
+// };
+
+// this is some code from modelValidationPipeline.ts that is not used in the current implementation
 // import jsYaml from 'js-yaml';
 
 // // type ErrorType = "error" | "warning";
@@ -36,28 +142,3 @@ import { getChangedFiles } from "@azure-tools/specs-shared/changed-files";
 // //     }
 // //   }
 // // }
-
-export function greet(name: string): string {
-  return `Hello, ${name}!`;
-}
-
-export async function main(rootDirectory: string): Promise<Number> {
-    let errors: Array<string> = [];
-
-    const oavType = new oav.LiveValidator({}, undefined);
-    console.log(oavType);
-    console.log(rootDirectory);
-
-    let results = await getChangedFiles({
-      cwd: rootDirectory
-    })
-
-    for (const result of results) {
-      console.log(result);
-    }
-
-    if (errors){
-        return 1;
-    }
-    return 0;
-}

eng/tools/oav-runner/test/main.test.ts

@@ -1,9 +1,37 @@
 import { describe, it, expect } from 'vitest';
-import { greet } from '../src/main.js';
+import { processFilesToSpecificationList } from '../src/main.js';
+import path from 'path';
+
+const ROOT = path.resolve(__dirname, '../../../../')
+
+describe('file processing', () => {
+  it('should process a basic set of files and return a list of swagger files only', async () =>{
+    const changedFiles = [
+      'specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-06-01/workspaceRP.json',
+      'specification/machinelearningservices/resource-manager/readme.md'
+    ]
+
+    const result = await processFilesToSpecificationList(ROOT, changedFiles);
+    const expected = [
+      'specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2025-06-01/workspaceRP.json'
+    ]
+
+    expect(result).toEqual(expected);
+  });
+
+  it('should process a large set of files and return a list of swagger files only', () => {
+
+  });
+
+  it('should process the correct swagger file given only changed example files', () => {
+
+  });
+
+  it('should process the correct swagger file given only changed readme file', () => {
+
+  })
+
+  it('should handle deleted files without error', () => {
 
-describe('greet', () => {
-  it('should return greeting message', () => {
-    const result = greet('World');
-    expect(result).toBe('Hello, World!');
   });
 });

eng/tools/oav-runner/vitest.config.ts

@@ -1,9 +1,12 @@
-import { defineConfig } from 'vitest/config';
+import { configDefaults, defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
-    globals: true,
-    environment: 'node',
-    include: ['test/**/*.{test,spec}.{js,ts}'],
+    ...configDefaults,
+    testTimeout: 20000,
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "json", "html"],
+    },
   },
 });