Merge branch 'main' into mysql-version-uniform

Author: mikeharder

.github/shared/package.json

@@ -6,8 +6,10 @@
     "./array": "./src/array.js",
     "./changed-files": "./src/changed-files.js",
     "./equality": "./src/equality.js",
+    "./error-reporting": "./src/error-reporting.js",
     "./exec": "./src/exec.js",
     "./logger": "./src/logger.js",
+    "./path": "./src/path.js",
     "./readme": "./src/readme.js",
     "./sdk-types": "./src/sdk-types.js",
     "./sleep": "./src/sleep.js",

.github/shared/src/error-reporting.js

@@ -0,0 +1,33 @@
+// @ts-check
+import * as fs from "fs";
+
+/**
+ * Set the summary of the github step summary for a job. This feature is intended for formatted markdown,
+ * which can be used to display the results of a job in a more readable format.
+ *
+ * Format your results as a markdown table and go to town!
+ * @param {string} content
+ * @returns {void}
+ */
+export function setSummary(content) {
+  if (!process.env.GITHUB_STEP_SUMMARY) {
+    console.log("GITHUB_STEP_SUMMARY is not set. Skipping summary update.");
+    return;
+  }
+  const summaryFile = process.env.GITHUB_STEP_SUMMARY;
+
+  fs.writeFileSync(summaryFile, content);
+}
+
+/**
+ * This function is used to ask the github agent to annotate a file in a github PR with an error message.
+ * @param {string} repoPath
+ * @param {string} message
+ * @param {number} line
+ * @param {number} col
+ * @returns {void}
+ */
+export function annotateFileError(repoPath, message, line, col) {
+  const errorLine = `::error file=${repoPath},line=${line},col=${col}::${message}`;
+  console.log(errorLine);
+}

.github/shared/src/path.js

@@ -0,0 +1,13 @@
+// @ts-check
+
+import { resolve, sep } from "path";
+
+/**
+ *
+ * @param {string} path
+ * @param {string} folder
+ * @returns {boolean} True if path contains the named folder
+ */
+export function includesFolder(path, folder) {
+  return resolve(path).includes(sep + folder + sep);
+}

.github/shared/src/swagger.js

@@ -4,6 +4,7 @@ import $RefParser, { ResolverError } from "@apidevtools/json-schema-ref-parser";
 import { readFile } from "fs/promises";
 import { dirname, relative, resolve } from "path";
 import { mapAsync } from "./array.js";
+import { includesFolder } from "./path.js";
 import { SpecModelError } from "./spec-model-error.js";
 
 /**
@@ -58,6 +59,15 @@ export class Swagger {
    * @returns {Promise<Map<string, Swagger>>}
    */
   async getRefs() {
+    const allRefs = await this.#getRefs();
+
+    // filter out any paths that are examples
+    const filtered = new Map([...allRefs].filter(([path]) => !example(path)));
+
+    return filtered;
+  }
+
+  async #getRefs() {
     if (!this.#refs) {
       let schema;
       try {
@@ -82,8 +92,6 @@ export class Swagger {
 
       const refPaths = schema
         .paths("file")
-        // Exclude examples
-        .filter((p) => !example(p))
         // Exclude ourself
         .filter((p) => resolve(p) !== resolve(this.#path));
 
@@ -101,6 +109,18 @@ export class Swagger {
     return this.#refs;
   }
 
+  /**
+   * @returns {Promise<Map<string, Swagger>>}
+   */
+  async getExamples() {
+    const allRefs = await this.#getRefs();
+
+    // filter out any paths that are examples
+    const filtered = new Map([...allRefs].filter(([path]) => example(path)));
+
+    return filtered;
+  }
+
   /**
    * @returns {string} absolute path
    */
@@ -151,7 +171,9 @@ export class Swagger {
  */
 function example(file) {
   // Folder name "examples" should match case for consistency across specs
-  return typeof file === "string" && json(file) && file.includes("/examples/");
+  return (
+    typeof file === "string" && json(file) && includesFolder(file, "examples")
+  );
 }
 
 /**

.github/shared/test/error-reporting.test.js

@@ -0,0 +1,53 @@
+// @ts-check
+
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { setSummary, annotateFileError } from "../src/error-reporting.js";
+import fs from "fs/promises";
+
+describe("ErrorReporting", () => {
+  let logSpy;
+
+  beforeEach(() => {
+    logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
+    // ensure that on test runs GITHUB_STEP_SUMMARY is not set in my current env by default
+    // this gives us a clean slate for each test
+    delete process.env.GITHUB_STEP_SUMMARY;
+  });
+
+  afterEach(() => {
+    logSpy.mockRestore();
+  });
+
+  it("should warn when GITHUB_STEP_SUMMARY is unset", () => {
+    setSummary("hello");
+    expect(logSpy).toHaveBeenCalledWith(
+      "GITHUB_STEP_SUMMARY is not set. Skipping summary update.",
+    );
+  });
+
+  it("should write to the summary file when GITHUB_STEP_SUMMARY is set", async () => {
+    process.env.GITHUB_STEP_SUMMARY = `${__dirname}/tmp-summary.md`;
+
+    await fs.rm(process.env.GITHUB_STEP_SUMMARY, { force: true });
+
+    setSummary("# Title");
+
+    expect(logSpy).not.toHaveBeenCalledWith(
+      "GITHUB_STEP_SUMMARY is not set. Skipping summary update.",
+    );
+
+    const content = await fs.readFile(process.env.GITHUB_STEP_SUMMARY, "utf-8");
+
+    // cleanup after the test so nothing is left behi
+    await fs.rm(process.env.GITHUB_STEP_SUMMARY, { force: true });
+
+    expect(content).toBe("# Title");
+  });
+
+  it("should emit a GitHub-style error annotation", () => {
+    annotateFileError("src/foo.js", "Something broke", 42, 7);
+    expect(logSpy).toHaveBeenCalledWith(
+      "::error file=src/foo.js,line=42,col=7::Something broke",
+    );
+  });
+});

.github/workflows/oav-runner-tests.yaml

@@ -0,0 +1,30 @@
+name: OAV Runner - Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - package-lock.json
+      - package.json
+      - tsconfig.json
+      - .github/shared
+      - .github/workflows/_reusable-eng-tools-test.yaml
+      - .github/workflows/oav-runner-test.yaml
+      - eng/tools/package.json
+      - eng/tools/tsconfig.json
+      - eng/tools/oav-runner/**
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  oavrunnertests:
+    name: Check OAV Runner
+    uses: ./.github/workflows/_reusable-eng-tools-test.yaml
+    with:
+      package: oav-runner
+      lint: false
+      prettier: false

.github/workflows/swagger-modelvalidation-code.yaml

@@ -0,0 +1,25 @@
+name: "[TEST-IGNORE] Swagger ModelValidation"
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  oav:
+    name: "[TEST-IGNORE] Swagger ModelValidation"
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node and install deps
+        uses: ./.github/actions/setup-node-install-deps
+
+      - name: Swagger Model Validation
+        run: |
+          npm exec --no -- oav-runner examples
+

.github/workflows/swagger-modelvalidation-status.yaml

@@ -0,0 +1,35 @@
+name: "[TEST-IGNORE] Swagger ModelValidation - Set Status"
+
+on:
+  # Must run on pull_request_target instead of pull_request, since the latter cannot trigger on
+  # labels from bot accounts in fork PRs. pull_request_target is also more similar to the other
+  # trigger "workflow_run" -- they are both privileged and run in the target branch and repo --
+  # which simplifies implementation.
+  pull_request_target:
+    types:
+      # Run workflow on default types, to update status as quickly as possible.
+      - opened
+      - synchronize
+      - reopened
+      # Depends on labels, so must re-evaluate whenever a relevant label is manually added or removed.
+      - labeled
+      - unlabeled
+  workflow_run:
+    workflows: ["\\[TEST-IGNORE\\] Swagger ModelValidation"]
+    types: [completed]
+
+permissions:
+  actions: read
+  contents: read
+  issues: read
+  pull-requests: read
+  statuses: write
+
+jobs:
+  model-validation-status:
+    name: Set ModelValidation Status
+    uses: ./.github/workflows/_reusable-set-check-status.yml
+    with:
+      monitored_workflow_name: "[TEST-IGNORE] Swagger ModelValidation"
+      required_check_name: "[TEST-IGNORE] Swagger ModelValidation"
+      overriding_label: "Approved-ModelValidation"

.github/workflows/swagger-semanticvalidation-code.yaml

@@ -0,0 +1,25 @@
+name: "[TEST-IGNORE] Swagger SemanticValidation"
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  oav:
+    name: "[TEST-IGNORE] Swagger SemanticValidation"
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node and install deps
+        uses: ./.github/actions/setup-node-install-deps
+
+      - name: Swagger Semantic Validation
+        run: |
+          npm exec --no -- oav-runner specs
+

.github/workflows/swagger-semanticvalidation-status.yaml

@@ -0,0 +1,35 @@
+name: "[TEST-IGNORE] Swagger ModelValidation - Set Status"
+
+on:
+  # Must run on pull_request_target instead of pull_request, since the latter cannot trigger on
+  # labels from bot accounts in fork PRs. pull_request_target is also more similar to the other
+  # trigger "workflow_run" -- they are both privileged and run in the target branch and repo --
+  # which simplifies implementation.
+  pull_request_target:
+    types:
+      # Run workflow on default types, to update status as quickly as possible.
+      - opened
+      - synchronize
+      - reopened
+      # Depends on labels, so must re-evaluate whenever a relevant label is manually added or removed.
+      - labeled
+      - unlabeled
+  workflow_run:
+    workflows: ["\\[TEST-IGNORE\\] Swagger SemanticValidation"]
+    types: [completed]
+
+permissions:
+  actions: read
+  contents: read
+  issues: read
+  pull-requests: read
+  statuses: write
+
+jobs:
+  spec-validation-status:
+    name: Set SemanticValidation Status
+    uses: ./.github/workflows/_reusable-set-check-status.yml
+    with:
+      monitored_workflow_name: "[TEST-IGNORE] Swagger SemanticValidation"
+      required_check_name: "[TEST-IGNORE] Swagger SemanticValidation"
+      overriding_label: "Approved-SemanticValidation"

.vscode/launch.json

@@ -4,6 +4,16 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Split Deployments",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "npm",
+      "args": [
+        "start"
+      ],
+      "cwd": "${workspaceFolder}/dev/deployments/convert"
+    },
     {
       "type": "node",
       "request": "launch",

dev/deployments/convert/.tsconfig

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "module": "commonjs",
+    "noEmitOnError": true,
+    "noImplicitReturns": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "strict": true,
+    "declaration": true,
+    "stripInternal": true,
+    "noEmitHelpers": false,
+    "target": "es2019",
+    "types": ["node"],
+    "esModuleInterop": true,
+    "lib": ["es2020"],
+    "newLine": "LF",
+    "outDir": "dist",
+    "rootDir": "."
+  },
+  "exclude": ["dist", "node_modules"]
+}