feat: redocly respect support for testing arazzo files (#9)

Author: SnakeDoc

package-lock.json

@@ -24,7 +24,8 @@
     "redocly-bundle": "./dist/bin/redocly/bundle.js",
     "redocly-lint": "./dist/bin/redocly/lint.js",
     "redocly-build-docs": "./dist/bin/redocly/build-docs.js",
-    "redocly-generate-arazzo": "./dist/bin/redocly/generate-arazzo.js"
+    "redocly-generate-arazzo": "./dist/bin/redocly/generate-arazzo.js",
+    "redocly-respect": "./dist/bin/redocly/respect.js"
   },
   "scripts": {
     "build": "tsc",

package.json

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { respect } from "../../lib/redocly/respect.js";
+
+respect();

src/bin/redocly/respect.ts

@@ -0,0 +1,49 @@
+import { execSync } from "child_process";
+
+export interface RespectOptions {
+  files: string;
+  verbose: boolean;
+  harOutput?: string;
+  jsonOutput?: string;
+}
+
+export function getOptions(): RespectOptions {
+  return {
+    files: process.env.ARAZZO_INPUT || "arazzo/*.arazzo.yaml",
+    verbose: process.env.ARAZZO_VERBOSE === "true",
+    harOutput: process.env.ARAZZO_HAR_OUTPUT,
+    jsonOutput: process.env.ARAZZO_JSON_OUTPUT,
+  };
+}
+
+export function respect(): void {
+  const options = getOptions();
+
+  console.log(`🧪 Running Arazzo workflows...`);
+  console.log(`   Files: ${options.files}`);
+
+  let command = `npx --no @redocly/cli respect ${options.files}`;
+
+  if (options.verbose) {
+    command += ` --verbose`;
+  }
+
+  if (options.harOutput) {
+    command += ` --har-output ${options.harOutput}`;
+    console.log(`   HAR Output: ${options.harOutput}`);
+  }
+
+  if (options.jsonOutput) {
+    command += ` --json-output ${options.jsonOutput}`;
+    console.log(`   JSON Output: ${options.jsonOutput}`);
+  }
+
+  try {
+    execSync(command, { stdio: "inherit" });
+    console.log(`✅ Arazzo workflows executed successfully.`);
+  } catch (error) {
+    console.error(`❌ Arazzo workflows failed!`);
+    console.error(`${error instanceof Error ? error.message : String(error)}`);
+    process.exit(1);
+  }
+}

src/lib/redocly/respect.ts

@@ -0,0 +1,5 @@
+arazzo: 1.0.1
+info:
+  title: Invalid Workflow
+
+workflows:

test/__snapshots__/bundle.integration.test.ts.snap

@@ -0,0 +1,30 @@
+arazzo: 1.0.1
+info:
+  title: Simple Test API
+  version: 1.0.0
+sourceDescriptions:
+  - name: openapi
+    type: openapi
+    url: ../test/fixtures/valid/simple-spec/openapi.yaml
+workflows:
+  - workflowId: get-test-workflow
+    inputs:
+      $ref: "#/components/inputs/BearerToken"
+    parameters:
+      - name: Authorization
+        value: Bearer {$inputs.BearerToken}
+        in: header
+    steps:
+      - stepId: get-test-step
+        operationId: $sourceDescriptions.openapi.getTest
+        successCriteria:
+          - condition: $statusCode == 200
+components:
+  inputs:
+    BearerToken:
+      type: object
+      properties:
+        BearerToken:
+          type: string
+          description: JWT Authentication token for ${name}
+          format: password