[TypeSpecValidation] Add basic suppressions (Azure#29133)

mikeharder · web-flow · commit d8fea3be3e32 · 2024-05-16T22:07:47.000-07:00
- Fixes Azure#29131
diff --git a/eng/tools/suppressions/src/index.ts b/eng/tools/suppressions/src/index.ts
@@ -1,4 +1,4 @@
-import { access, constants, readFile } from "fs/promises";
+import { access, constants, lstat, readFile } from "fs/promises";
 import { minimatch } from "minimatch";
 import { dirname, join, resolve, sep } from "path";
 import { sep as posixSep } from "path/posix";
@@ -9,11 +9,14 @@ import { fromError } from "zod-validation-error";
 
 function getUsage(): string {
   return (
-    "  Usage: npx get-suppressions <tool-name> <path-to-file>\n" +
-    "Returns: JSON array of suppressions, with specified tool name, applying to file (may be empty)\n" +
+    "  Usage: npx get-suppressions <tool-name> <path-to-file-or-directory>\n" +
+    "Returns: JSON array of suppressions, with specified tool name, applying to file or directory (may be empty)\n" +
     "\n" +
     "Example: npx get-suppressions TypeSpecRequirement specification/foo/data-plane/Foo/stable/2023-01-01/Foo.json\n" +
-    'Returns: [{"tool":"TypeSpecRequirement","path":"data-plane/Foo/stable/2023-01-01/*.json","reason":"foo"}]\n'
+    'Returns: [{"tool":"TypeSpecRequirement","path":"data-plane/Foo/stable/2023-01-01/*.json","reason":"foo"}]\n' +
+    "\n" +
+    "Example: npx get-suppressions TypeSpecValidation specification/foo/Microsoft.Foo\n" +
+    'Returns: [{"tool":"TypeSpecValidation","path":"**","reason":"foo"}]\n'
   );
 }
 
@@ -51,7 +54,7 @@ export async function main() {
  * "suppressions.yaml", parses and validates the contents, and returns the suppressions matching the tool and path.
  *
  * @param tool Name of tool. Matched against property "tool" in suppressions.yaml.
- * @param path Path to file under analysis.
+ * @param path Path to file or directory under analysis.
  * @returns Array of suppressions matching tool and path (may be empty).
  *
  * @example
@@ -161,7 +164,9 @@ export function _getSuppressionsFromYaml(
 async function findSuppressionsYaml(path: string): Promise<string | undefined> {
   path = resolve(path);
 
-  let currentDirectory: string = dirname(path);
+  const stats = await lstat(path);
+  let currentDirectory: string = stats.isDirectory() ? path : dirname(path);
+
   while (true) {
     const suppressionsFile: string = join(currentDirectory, "suppressions.yaml");
     try {
diff --git a/eng/tools/suppressions/test/index.test.ts b/eng/tools/suppressions/test/index.test.ts
@@ -37,6 +37,22 @@ test("one suppression match", () => {
   ]);
 });
 
+test("one suppression match directory", () => {
+  const suppressions: Suppression[] = _getSuppressionsFromYaml(
+    "TestTool",
+    "Microsoft.Foo",
+    "suppressions.yaml",
+    '- tool: TestTool\n  path: "**"\n  reason: test',
+  );
+  expect(suppressions).toEqual([
+    {
+      tool: "TestTool",
+      path: "**",
+      reason: "test",
+    },
+  ]);
+});
+
 test("globstar matching", () => {
   const suppressions: Suppression[] = _getSuppressionsFromYaml(
     "TestTool",
diff --git a/eng/tools/typespec-validation/package.json b/eng/tools/typespec-validation/package.json
@@ -10,6 +10,7 @@
     "dependencies": {
         "globby": "^14.0.1",
         "simple-git": "^3.24.0",
+        "suppressions": "file:../suppressions",
         "yaml": "^2.4.2"
     },
     "devDependencies": {
@@ -20,7 +21,7 @@
     },
     "scripts": {
         "build": "tsc",
-        "postinstall": "npm run build",
+        "postinstall": "cd ../suppressions && npm run build && cd ../typespec-validation && npm run build",
         "test": "npm run build && mocha --recursive --exit"
     },
     "engines": {
diff --git a/eng/tools/typespec-validation/src/index.ts b/eng/tools/typespec-validation/src/index.ts
@@ -7,6 +7,7 @@ import { FormatRule } from "./rules/format.js";
 import { LinterRulesetRule } from "./rules/linter-ruleset.js";
 import { NpmPrefixRule } from "./rules/npm-prefix.js";
 import { TsvRunnerHost } from "./tsv-runner-host.js";
+import { getSuppressions, Suppression } from "suppressions";
 
 export async function main() {
   const host = new TsvRunnerHost();
@@ -31,6 +32,13 @@ export async function main() {
   }
   console.log("Running TypeSpecValidation on folder: ", absolutePath);
 
+  const suppressions: Suppression[] = await getSuppressions("TypeSpecValidation", absolutePath);
+  if (suppressions && suppressions[0]) {
+    // Use reason from first matching suppression and ignore rest
+    console.log(`  Suppressed: ${suppressions[0].reason}`);
+    return;
+  }
+
   const rules = [
     new FolderStructureRule(),
     new NpmPrefixRule(),
diff --git a/package-lock.json b/package-lock.json
