Merge pull request #1303 from cloudbees-oss/feat/AIENG-420-schema

feat(AIENG:420): Add command to download OpenAPI schema for Smart Tes…

Author: psakthivel04

pyproject.toml

@@ -54,6 +54,7 @@ test = "python -m unittest"
 test-xml = "python -m test-runner"
 type = "mypy smart_tests tests"
 update-docs = "bash scripts/update_docs.sh"
+update-schema = "bash scripts/update_schema.sh"
 
 [build-system]
 requires = ["setuptools>=45", "wheel", "setuptools_scm"]
@@ -63,6 +64,6 @@ build-backend = "setuptools.build_meta"
 packages = ["smart_tests"]
 
 [tool.setuptools.package-data]
-smart_tests = ["jar/exe_deploy.jar", "docs/**/*"]
+smart_tests = ["jar/exe_deploy.jar", "docs/**/*", "schema/**/*"]
 
 [tool.setuptools_scm]

scripts/update_schema.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# Update the bundled OpenAPI schema from mothership dev server
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+CLI_DIR="$(dirname "$SCRIPT_DIR")"
+SCHEMA_FILE="$CLI_DIR/smart_tests/schema/openapi-schema.json"
+
+echo "Fetching OpenAPI schema from local dev server..."
+
+# Check if mothership is running
+if ! curl -s -f http://localhost:8080/intake/v3/api-docs > /dev/null 2>&1; then
+    echo "Error: Mothership dev server not running at localhost:8080"
+    echo "Please start it with: cd mothership && bazel run //src/main/java/com/launchableinc/mercury/intake"
+    exit 1
+fi
+
+# Create schema directory if it doesn't exist
+mkdir -p "$(dirname "$SCHEMA_FILE")"
+
+# Fetch and save schema
+curl -s http://localhost:8080/intake/v3/api-docs > "$SCHEMA_FILE"
+
+# Validate and format the JSON with proper indentation and trailing newline
+python3 << PYTHON_EOF
+import json
+
+with open("$SCHEMA_FILE", 'r') as f:
+    schema = json.load(f)
+
+# Write back with proper formatting
+with open("$SCHEMA_FILE", 'w') as f:
+    json.dump(schema, f, indent=2)
+    f.write('\n')  # Add trailing newline
+PYTHON_EOF
+
+echo "✓ Schema updated successfully: $SCHEMA_FILE"
+echo ""
+
+# Show what changed
+if git diff --quiet "$SCHEMA_FILE" 2>/dev/null; then
+    echo "No changes detected in schema"
+else
+    echo "Changes detected:"
+    git diff --stat "$SCHEMA_FILE" 2>/dev/null || echo "(Not a git repository)"
+    echo ""
+    echo "Review with: git diff $SCHEMA_FILE"
+    echo "Commit with: git add $SCHEMA_FILE && git commit -m 'Update OpenAPI schema'"
+fi

smart_tests/commands/get/__init__.py

@@ -1,5 +1,6 @@
 from ... import args4p
 from ...app import Application
+from .api_schema import api_schema
 from .docs import docs
 
 
@@ -8,4 +9,5 @@ def get(app: Application):
     return app
 
 
+get.add_command(api_schema)
 get.add_command(docs)

smart_tests/commands/get/api_schema.py

@@ -0,0 +1,28 @@
+import importlib.resources
+import shutil
+import sys
+from pathlib import Path
+
+import click
+
+from smart_tests import args4p
+from smart_tests.app import Application
+
+OUTPUT_FILE = 'openapi-schema.json'
+
+
+@args4p.command(help="Copy OpenAPI schema to ./openapi-schema.json")
+def api_schema(app: Application):
+    output = Path(OUTPUT_FILE)
+    if output.exists():
+        click.secho(
+            f"'{OUTPUT_FILE}' already exists. Please delete it first, then re-run this command.",
+            fg='red', err=True,
+        )
+        sys.exit(1)
+
+    # Copy bundled schema file to current directory
+    schema_src = Path(str(importlib.resources.files('smart_tests') / 'schema' / 'openapi-schema.json'))
+    click.echo(f"Copying OpenAPI schema to ./{OUTPUT_FILE} ...")
+    shutil.copy(schema_src, output)
+    click.echo(f"Done. OpenAPI schema is in ./{OUTPUT_FILE}")