step-registry/sandboxed-containers-operator: Add run command to create-prowjob-commands.sh

- Add 'run' command as placeholder for future prowjob execution
- Update usage help to include run command
- Add command_run() function with unimplemented message
- Maintain backward compatibility with create command

Assisted-by: Cursor
Signed-off-by: Wainer dos Santos Moschetta <[email protected]>

Author: wainersm

ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/README.md

@@ -11,6 +11,7 @@ The `sandboxed-containers-operator-create-prowjob-commands.sh` script creates pr
 The script supports the following commands:
 
 - `create` - Create prowjob configuration files
+- `run` - Run prowjobs from YAML configuration
 
 ### Command Usage
 
@@ -48,6 +49,12 @@ ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed
 
 # Generate configuration with custom OCP version
 OCP_VERSION=4.17 ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed-containers-operator-create-prowjob-commands.sh create
+
+# Run jobs from generated YAML file
+PROW_API_TOKEN=your_token_here ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed-containers-operator-create-prowjob-commands.sh run openshift-sandboxed-containers-operator-devel__downstream-candidate419.yaml
+
+# Run specific job
+PROW_API_TOKEN=your_token_here ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed-containers-operator-create-prowjob-commands.sh run openshift-sandboxed-containers-operator-devel__downstream-candidate419.yaml azure-ipi-kata
 ```
 
 ### Environment Variables
@@ -136,6 +143,34 @@ ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed
 - **Method**: Quay API with pagination (max 50 pages)
 - **Special Case**: OCP 4.16 uses `trustee-fbc/` subfolder
 
+## Run Command
+
+The `run` command allows you to trigger ProwJobs from a generated YAML configuration file. This command requires a valid Prow API token.
+
+### Run Command Usage
+
+```bash
+# Run all jobs from a YAML file
+./sandboxed-containers-operator-create-prowjob-commands.sh run /path/to/job_yaml.yaml
+
+# Run specific jobs from a YAML file
+./sandboxed-containers-operator-create-prowjob-commands.sh run /path/to/job_yaml.yaml azure-ipi-kata aws-ipi-peerpods
+```
+
+### Run Command Features
+
+- **Job Name Generation**: Automatically constructs job names using the pattern `periodic-ci-{org}-{repo}-{branch}-{variant}-{job_suffix}`
+- **Metadata Extraction**: Extracts organization, repository, branch, and variant from the YAML file's `zz_generated_metadata` section
+- **API Integration**: Uses the Prow/Gangway API to trigger jobs
+- **Job Status Monitoring**: Provides job IDs and status information
+- **Flexible Job Selection**: Can run all jobs or specific jobs by name
+
+### Run Command Environment Variables
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `PROW_API_TOKEN` | Yes | Prow API authentication token |
+
 ## Generated Test Matrix
 
 The script generates configuration for 5 test scenarios:
@@ -219,3 +254,25 @@ yq eval '.' openshift-sandboxed-containers-operator-devel__downstream-candidate4
 - **Required**: `curl`, `jq`, `awk`, `sort`, `head`
 - **Optional**: `yq` (for YAML syntax validation)
 - **Network**: Access to `quay.io` API endpoints
+
+## Prow API Token
+
+To trigger ProwJobs via the REST API, you need an authentication token. Each SSO user is entitled to obtain a personal authentication token.
+
+### Obtaining a Token
+
+Tokens can be retrieved through the UI of the app.ci cluster at [OpenShift Console](https://console-openshift-console.apps.ci.l2s4.p1.openshiftapps.com). Alternatively, if the app.ci cluster context is already configured, you may execute:
+
+```bash
+oc whoami -t
+```
+
+### Using the Token
+
+Once you have obtained a token, set it as an environment variable:
+
+```bash
+export PROW_API_TOKEN=your_token_here
+```
+
+For complete information about triggering ProwJobs via REST, including permanent tokens for automation, see the [OpenShift CI documentation](https://docs.ci.openshift.org/docs/how-tos/triggering-prowjobs-via-rest/#obtaining-an-authentication-token).

ci-operator/step-registry/sandboxed-containers-operator/create-prowjob/sandboxed-containers-operator-create-prowjob-commands.sh

@@ -2,6 +2,7 @@
 # script to create prowjobs in ci-operator/config/openshift/sandboxed-containers-operator using environment variables.
 # Usage: 
 #   ./sandboxed-containers-operator-create-prowjob-commands.sh gen    # Generate prowjob configuration
+#   ./sandboxed-containers-operator-create-prowjob-commands.sh run    # Run prowjobs
 # should be run in a branch of a fork of https://github.com/openshift/release/
 
 # created with the assistance of Cursor AI
@@ -10,6 +11,10 @@ set -o nounset
 set -o errexit
 set -o pipefail
 
+# Endpoint for the Gangway API (https://docs.prow.k8s.io/docs/components/optional/gangway/)
+# used to interact with Prow via REST API
+GANGWAY_API_ENDPOINT="https://gangway-ci.apps.ci.l2s4.p1.openshiftapps.com/v1/executions"
+
 # Function to get latest OSC catalog tag
 get_latest_osc_catalog_tag() {
     local apiurl="https://quay.io/api/v1/repository/redhat-user-workloads/ose-osc-tenant/osc-test-fbc"
@@ -259,9 +264,12 @@ show_usage() {
     echo ""
     echo "Commands:"
     echo "  create  Create prowjob configuration files"
+    echo "  run     Run prowjobs from YAML configuration"
     echo ""
     echo "Examples:"
     echo "  $0 create"
+    echo "  $0 run /path/to/job_yaml.yaml"
+    echo "  $0 run /path/to/job_yaml.yaml azure-ipi-kata"
     echo ""
     echo "Environment variables for 'create' command:"
     echo "  OCP_VERSION                    - OpenShift version (default: 4.19)"
@@ -299,6 +307,9 @@ main() {
         create)
             command_create
             ;;
+        run)
+            command_run "$@"
+            ;;
         *)
             echo "ERROR: Unknown command '${COMMAND}'"
             echo ""
@@ -539,7 +550,19 @@ EOF
     echo "Generated file: ${OUTPUT_FILE}"
     echo "File size: ${file_size} bytes"
     echo "=========================================="
-    echo "Next Steps:"
+    echo "Next steps you have two options:"
+    echo ""
+    echo "Option A - Run jobs immediately:"
+    echo "1. Set your Prow API token:"
+    echo "   export PROW_API_TOKEN=your_token_here"
+    echo ""
+    echo "2. Run all jobs from the generated file:"
+    echo "   ./sandboxed-containers-operator-create-prowjob-commands.sh run ${OUTPUT_FILE}"
+    echo ""
+    echo "3. Or run specific jobs:"
+    echo "   ./sandboxed-containers-operator-create-prowjob-commands.sh run ${OUTPUT_FILE} azure-ipi-kata"
+    echo ""
+    echo "Option B - Submit configuration to CI:"
     echo "1. Review the created configuration file:"
     echo "   cat ${OUTPUT_FILE}"
     echo ""
@@ -556,6 +579,152 @@ EOF
     echo ""
 }
 
+# Function to run prowjobs
+command_run() {
+    echo "=========================================="
+    echo "Sandboxed Containers Operator - Run Prowjobs"
+    echo ""
+
+    # Check if job_yaml file is provided
+    if [[ $# -eq 0 ]]; then
+        echo "ERROR: No job YAML file specified"
+        echo ""
+        echo "Usage: $0 run <job_yaml_file> [job_names...]"
+        echo ""
+        echo "Examples:"
+        echo "  $0 run /path/to/job_yaml.yaml"
+        echo "  $0 run /path/to/job_yaml.yaml azure-ipi-kata"
+        echo "  $0 run /path/to/job_yaml.yaml azure-ipi-kata azure-ipi-peerpods"
+        echo ""
+        exit 1
+    fi
+
+    JOB_YAML_FILE="$1"
+    shift
+
+    # Check if job_yaml file exists
+    if [[ ! -f "${JOB_YAML_FILE}" ]]; then
+        echo "ERROR: Job YAML file not found: ${JOB_YAML_FILE}"
+        exit 1
+    fi
+
+    echo "Job YAML file: ${JOB_YAML_FILE}"
+
+    # Extract metadata from job_yaml
+    ORG=$(yq eval '.zz_generated_metadata.org' "${JOB_YAML_FILE}")
+    REPO=$(yq eval '.zz_generated_metadata.repo' "${JOB_YAML_FILE}")
+    BRANCH=$(yq eval '.zz_generated_metadata.branch' "${JOB_YAML_FILE}")
+    VARIANT=$(yq eval '.zz_generated_metadata.variant' "${JOB_YAML_FILE}")
+
+    if [[ -z "${ORG}" || -z "${REPO}" || -z "${BRANCH}" || -z "${VARIANT}" ]]; then
+        echo "ERROR: Missing required metadata in job YAML file"
+        echo "Required fields: org, repo, branch, variant in zz_generated_metadata section"
+        exit 1
+    fi
+
+    # Generate job name prefix
+    JOB_PREFIX="periodic-ci-${ORG}-${REPO}-${BRANCH}-${VARIANT}"
+    echo "Job name prefix: ${JOB_PREFIX}"
+
+    # Determine job names to run
+    if [[ $# -eq 0 ]]; then
+        # No specific jobs provided, extract all 'as' values from tests
+        echo "No specific jobs provided, extracting all jobs from YAML..."
+        mapfile -t JOB_NAMES < <(yq eval '.tests[].as' "${JOB_YAML_FILE}")
+    else
+        # Use provided job names
+        echo "Using provided job names: $*"
+        JOB_NAMES=("$@")
+    fi
+
+    if [[ ${#JOB_NAMES[@]} -eq 0 ]]; then
+        echo "ERROR: No jobs found to run"
+        exit 1
+    fi
+
+    echo ""
+    echo "Jobs to run:"
+    for job_suffix in "${JOB_NAMES[@]}"; do
+        full_job_name="${JOB_PREFIX}-${job_suffix}"
+        echo "  - ${full_job_name}"
+    done
+
+    echo ""
+    echo "Preparing job execution..."
+
+    # Check for PROW_API_TOKEN
+    if [[ -z "${PROW_API_TOKEN:-}" ]]; then
+        echo "ERROR: PROW_API_TOKEN environment variable is not set"
+        echo "Please set your Prow API token:"
+        echo "  export PROW_API_TOKEN=your_token_here"
+        exit 1
+    fi
+    echo "✓ PROW_API_TOKEN is set"
+
+    # Convert job YAML to JSON
+    echo "Converting job YAML to JSON..."
+    if ! yq -o=json "${JOB_YAML_FILE}" | jq -Rs . > config.json; then
+        echo "ERROR: Failed to convert YAML to JSON"
+        exit 1
+    fi
+    echo "✓ Job configuration converted to JSON"
+
+    # Trigger jobs
+    echo ""
+    echo "Triggering jobs..."
+
+    for job_suffix in "${JOB_NAMES[@]}"; do
+        full_job_name="${JOB_PREFIX}-${job_suffix}"
+        echo ""
+        echo "Triggering job: ${full_job_name}"
+
+        # Create payload
+        UNRESOLVED_SPEC=$(cat config.json)
+        payload=$(jq -n --arg job "${full_job_name}" \
+           --argjson config "${UNRESOLVED_SPEC}" \
+           '{
+               "job_name": $job,
+               "job_execution_type": "1",
+               "pod_spec_options": {
+                  "envs": {
+                     "UNRESOLVED_CONFIG": $config
+                   },
+                }
+            }')
+
+        # Make API call
+        echo "Making API call to trigger job..."
+        if curl -s -X POST -H "Authorization: Bearer ${PROW_API_TOKEN}" \
+            -H "Content-Type: application/json" -d "${payload}" \
+            "${GANGWAY_API_ENDPOINT}" > "output_${job_suffix}.json"; then
+
+            # Extract job ID
+            job_id=$(jq -r '.id' "output_${job_suffix}.json")
+            if [[ "${job_id}" != "null" && -n "${job_id}" ]]; then
+                echo "✓ Job triggered successfully!"
+                echo "  Job ID: ${job_id}"
+                echo "  Output saved to: output_${job_suffix}.json"
+
+                # Get job status
+                echo "Fetching job status..."
+                curl -s -X GET -H "Authorization: Bearer ${PROW_API_TOKEN}" \
+                    "${GANGWAY_API_ENDPOINT}/${job_id}" > "status_${job_suffix}.json"
+                echo "  Status saved to: status_${job_suffix}.json"
+            else
+                echo "✗ Failed to get job ID from response"
+                echo "Response content:"
+                cat "output_${job_suffix}.json"
+            fi
+        else
+            echo "✗ Failed to trigger job"
+            echo "Check output_${job_suffix}.json for details"
+        fi
+    done
+
+    echo ""
+    echo "Job triggering completed!"
+    echo "Check the output_*.json and status_*.json files for details"
+}
 
 # Call main function with all command line arguments
 main "$@"