arazzo-runner 0.0.1 → 0.0.5

package/README.md

@@ -1 +1,114 @@
-# arazzo-runner
+# Arazzo-Runner
+
+<p>
+  <a href="https://www.npmjs.com/package/arazzo-runner">
+    <img src="https://img.shields.io/npm/v/arazzo-runner.svg?style=flat-square">
+  </a>
+  <a href="https://github.com/JaredCE/arazzo-runner/actions/workflows/node.yml">
+    <img src="https://github.com/JaredCE/arazzo-runner/actions/workflows/node.yml/badge.svg">
+  </a>
+  <a href="https://www.buymeacoffee.com/jarede">
+    <img src="https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-donate-yellow.svg">
+  </a>
+</p>
+
+Run your [OpenAPI Arazzo Workflow Spec](https://www.openapis.org/arazzo-specification).
+
+## Install
+
+**Using npm:**
+
+```bash
+npm install -g arazzo-runner
+```
+
+## Use
+
+```bash
+# Run the CLI
+arazzo-runner --arazzo ./arazzo.json --input ./input.json
+
+# Or with short flags
+arazzo-runner -a arazzo.json -i input.json
+
+# With URL
+arazzo-runner -a https://example.com/arazzo.json -i ./input.json
+
+# Show help
+arazzo-runner --help
+
+# Show version
+arazzo-runner --version
+```
+
+### Input file
+
+The input file is where you keep your variables that you wish to use within your workflow and should be a json file structured like:
+
+```json
+{
+  "worflowId1": {
+    "name": "Jared"
+  }
+}
+```
+
+The file should contain objects for each workflow, by workflowId, with the variables matching up to the inputs that you defined in your workflow inputs schema.
+
+This file is likely to be comitted to your repository, so you should not store secrets in the file, instead you might use something like [jq](https://jqlang.org/) that can take repository variables and insert them into your input file:
+
+```bash
+jq --arg password "$secret_password" '.workflowId1.password = $password' input.json
+```
+
+Obviously, if you have a lot of secret variables that need adding as inputs, then you might need to write a script that can alter the `input.json` file for you within your CI/CD runner.
+
+## Logging And Reporting
+
+### Logging
+
+Logging is currently pretty verbose, with an example Log looking like:
+
+```bash
+Running Workflows
+Running Workflow: createUser
+Running Step: createAUser
+Getting Source Description for: users-openAPI
+Making a POST to http://petstore.swagger.io/v2/user
+http://petstore.swagger.io/v2/user responded with a: 200
+==================================================================================
+Checking: $statusCode == 200
+✅ $statusCode == 200 passed
+==================================================================================
+✅ All criteria checks passed
+Running onSuccess Rules
+✅ Step createAUser completed
+✅ Workflow createUser completed
+✅ All Workflows run
+```
+
+### Reporting
+
+Work on Reporting still needs completeing.
+
+## Still unsupported
+
+### OpenAPI Params
+
+OpenAPI parameter types with style and explode are not quite supported yet
+
+### OpenAPI Servers on various levels
+
+This pulls from the top level servers object of an OpenAPI Document. Server variables do not work either.
+
+### JSONPath and XPath criteria objects
+
+Criteria Objects set as type JSON Path or XPath do not work
+
+### Non application/json Responses
+
+Responses that do not conform to application/json do not work
+
+### Non application/json Requests
+
+Requests that do not conform to application/json do not work

package/cli.js

@@ -0,0 +1,163 @@
+#!/usr/bin/env node
+"use strict";
+
+const { parseArgs } = require("node:util");
+const path = require("node:path");
+const fs = require("node:fs");
+
+const Runner = require("./src/Runner");
+
+// Parse command line arguments
+const options = {
+  arazzo: {
+    type: "string",
+    short: "a",
+  },
+  input: {
+    type: "string",
+    short: "i",
+  },
+  help: {
+    type: "boolean",
+    short: "h",
+  },
+  version: {
+    type: "boolean",
+    short: "v",
+  },
+};
+
+function showHelp() {
+  console.log(`
+Arazzo Runner - Execute Arazzo workflow specifications
+
+USAGE:
+  arazzo-runner --arazzo <file|url> --input <file>
+  arazzo-runner -a <file|url> -i <file>
+
+OPTIONS:
+  -a, --arazzo <file|url>   Path or URL to Arazzo Document file (required)
+  -i, --input <file>        Path to input JSON file (required)
+  -h, --help                Show this help message
+  -v, --version             Show version number
+
+EXAMPLES:
+  # Run with local files
+  arazzo-runner --arazzo ./arazzo.json --input ./input.json
+
+  # Run with URL
+  arazzo-runner -a https://example.com/arazzo.json -i ./input.json
+
+  # Short form
+  arazzo-runner -a arazzo.json -i input.json
+`);
+}
+
+function showVersion() {
+  const packageJson = require("./package.json");
+  console.log(`v${packageJson.version}`);
+}
+
+function isUrl(str) {
+  try {
+    new URL(str);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function validateArazzoPath(arazzoPath) {
+  if (isUrl(arazzoPath)) {
+    return arazzoPath;
+  }
+
+  const resolvedPath = path.resolve(arazzoPath);
+
+  if (!fs.existsSync(resolvedPath)) {
+    console.error(`Error: Arazzo file not found: ${arazzoPath}`);
+    process.exit(1);
+  }
+
+  return resolvedPath;
+}
+
+function validateInputPath(inputPath) {
+  const resolvedPath = path.resolve(inputPath);
+
+  if (!fs.existsSync(resolvedPath)) {
+    console.error(`Error: Input file not found: ${inputPath}`);
+    process.exit(1);
+  }
+
+  return resolvedPath;
+}
+
+async function main() {
+  let values;
+
+  try {
+    ({ values } = parseArgs({ options, allowPositionals: false }));
+  } catch (err) {
+    console.error(`Error: ${err.message}`);
+    console.log("Use --help for usage information");
+    process.exit(1);
+  }
+
+  // Handle help
+  if (values.help) {
+    showHelp();
+    process.exit(0);
+  }
+
+  // Handle version
+  if (values.version) {
+    showVersion();
+    process.exit(0);
+  }
+
+  // Validate required arguments
+  if (!values.arazzo) {
+    console.error("Error: --arazzo argument is required");
+    console.log("Use --help for usage information");
+    process.exit(1);
+  }
+
+  if (!values.input) {
+    console.error("Error: --input argument is required");
+    console.log("Use --help for usage information");
+    process.exit(1);
+  }
+
+  // Validate paths
+  const arazzoPath = validateArazzoPath(values.arazzo);
+  const inputPath = validateInputPath(values.input);
+
+  console.log(`Starting Arazzo Runner...`);
+  console.log(`Arazzo: ${arazzoPath}`);
+  console.log(`Input: ${inputPath}`);
+  console.log("");
+
+  try {
+    const runner = new Runner();
+    await runner.runArazzo(arazzoPath, inputPath);
+
+    console.log("");
+    console.log("✓ Arazzo execution completed successfully");
+    process.exit(0);
+  } catch (err) {
+    console.error("");
+    console.error("✗ Arazzo execution failed:");
+    console.error(err.message);
+
+    if (process.env.DEBUG) {
+      console.error("");
+      console.error("Stack trace:");
+      console.error(err.stack);
+    }
+
+    process.exit(1);
+  }
+}
+
+main();

package/index.js

@@ -0,0 +1,3 @@
+const Runner = require("./src/Runner");
+
+module.exports = Runner;

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "arazzo-runner",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "A runner to run through Arazzo Document workflows",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha --config './test/.mocharc.js'",
+    "test-coverage": "nyc mocha --config './test/.mocharc.js'",
+    "prepare": "husky",
+    "start": "node cli.js"
+  },
+  "bin": {
+    "arazzo-runner": "cli.js"
   },
   "repository": {
     "type": "git",
@@ -20,5 +26,23 @@
   "bugs": {
     "url": "https://github.com/JaredCE/Arazzo-Runner/issues"
   },
-  "homepage": "https://github.com/JaredCE/Arazzo-Runner#readme"
+  "homepage": "https://github.com/JaredCE/Arazzo-Runner#readme",
+  "devDependencies": {
+    "chai": "^6.2.2",
+    "husky": "^9.1.7",
+    "mocha": "^11.7.5",
+    "nock": "^14.0.10",
+    "nyc": "^17.1.0",
+    "sinon": "^21.0.1"
+  },
+  "dependencies": {
+    "@redocly/openapi-core": "^2.14.5",
+    "@swaggerexpert/arazzo-runtime-expression": "^1.0.1",
+    "@swaggerexpert/json-pointer": "^2.10.2",
+    "ajv": "^8.17.1",
+    "jsonpath": "^1.1.1",
+    "openapi-params": "^0.0.4",
+    "stream-chain": "^3.4.0",
+    "stream-json": "^1.9.1"
+  }
 }