Skip to content

README.md

Latest commit

 

History

History
192 lines (152 loc) · 8.7 KB

README.md

File metadata and controls

192 lines (152 loc) · 8.7 KB

Qubership Testing Platform Python Collections Runner

Qubership Testing Platform Python Collections Runner is a CI/CD utility designed to automate and manage the deployment and execution of Python-based test collections. It streamlines setting up test environments, deploying applications, validating infrastructure, and securely running Python tests in cloud-native environments. The runner integrates with Git repositories, collects environment variables, and supports parameterized test launches suitable for modern DevOps workflows.

Key features include:

  • Automated provisioning of test environments and dependencies.
  • Execution of Python test suites from modular, versioned collections.
  • CI/CD integration to fit seamlessly into existing pipelines.
  • Secure handling of credentials and deployment parameters.
  • Flexible configuration for a variety of infrastructure and S3-compatible storage backends.

Table of Contents

Description of CI/CD process

Main flow

flowchart TD
    subgraph p_cicd_pipeline["Project CI/CD Pipeline"]
        direction LR
        git_job1(("Prepare<br>Env"))
        git_job2(("Deploy<br>Apps"))
        git_job3(("Env<br>Check"))
        git_job4(("Run<br>Python<br>Test"))
        git_job1 --> git_job2 --> git_job3 --> git_job4
    end

    subgraph p_argo_pipeline["Project Argo Pipeline"]
        direction LR
        argo_job1["Get Input EnvVars
            ENV_NAME
            GIT_COLLECTIONS_REPO_URL
            GIT_COLLECTIONS_BRANCH
            GIT_TOKEN
            TEST_PARAMS
        "]
        argo_job2(("Deploy<br>Runner"))
        argo_job3(("Launch<br>Python<br>Runner"))
        argo_job1 --> argo_job2 --> argo_job3
    end

    subgraph atp_Python_runner["ATP Python Runner"]
        direction LR
        runner_step1["Get Input EnvVars
            S3_API_HOST
            S3_ACCESS_KEY
            S3_SECRET_KEY
            S3_BUCKET
            S3_TYPE
            S3_UI_URL
            CURRENT_DATE
            CURRENT_TIME
            REPORT_VIEW_HOST_URL
        "] -->
        runner_step2["Check EnvVars and
            extract TEST_PARAMS
        "] -->
        runner_step3["Download Git
            repository"] -->
        runner_stepX["Launching Python
            collections
        "] -->
        runner_step4["Uploading
            results to S3
        "]
    end

    p_cicd_pipeline --> p_argo_pipeline --> atp_Python_runner
Loading

Deploy parameters

Parameter Type Mandatory Default value Description
ENVIRONMENT_NAME string yes "default" Environment name (e.g., dev, test, prod).
ATP_TESTS_GIT_REPO_URL string yes "" Git repository URL for cloning test sources.
ATP_TESTS_GIT_REPO_BRANCH string no main Git branch to checkout.
ATP_TESTS_GIT_TOKEN string yes "" Access token for private Git repositories with tests.
TEST_PARAMS json no {} Additional test parameters to pass to test runner.
ATP_ENVGENE_CONFIGURATION json no {} Additional test parameters to pass to test runner from EnvGene.
ATP_STORAGE_PROVIDER string no "minio" Type of S3 storage (e.g., minio, aws).
ATP_STORAGE_BUCKET string yes "" S3 bucket name for uploading results.
ATP_STORAGE_USERNAME string yes "" Access key for S3 bucket.
ATP_STORAGE_PASSWORD string yes "" Secret key for S3 bucket.
ATP_STORAGE_SERVER_URL string yes "" API endpoint for accessing S3 storage.
ATP_STORAGE_SERVER_UI_URL string yes "" Web UI endpoint for viewing files in the S3 bucket.
ATP_REPORT_VIEW_UI_URL string yes "" URL for viewing generated test reports.
CURRENT_DATE string no "" Date to use in report naming (format: YYYY-MM-DD).
CURRENT_TIME string no "" Time to use in report naming (format: HH:MM:SS).
ATP_RUNNER_JOB_TTL integer no 3600 Time-to-live for the test job in seconds.
ATP_RUNNER_JOB_EXIT_STRATEGY integer no 0 Delay in seconds before job termination (for debugging).
ENABLE_JIRA_INTEGRATION boolean no false Enable Jira integration for tests.
MONITORING_ENABLED boolean no true Enable creation monitoring objects for runners.
SECURITY_CONTEXT_ENABLED boolean no false Flag to enable or disable the security context for the Python Runner service.

Hardware / Resource Requirements (HWE)

Supported 2 profiles: dev, prod.

Parameter Dev Prod
MEMORY_REQUEST 500Mi 100Mi
MEMORY_LIMIT 1000Mi 2000Mi
CPU_REQUEST 100m 300m
CPU_LIMIT 500m 1000m

Quick Start

This runner executes Python test collections from a separate Git repository. Follow these steps to set up your test repository:

Prerequisites

  • A Git repository containing your pytest test suite
  • Python 3.x with pytest installed
  • Allure reporting support (optional, for test reports)

Setting Up Your Test Repository

  1. Create a separate Git repository for your test collections

    • This repository will be cloned by the runner during execution
    • Ensure the repository is accessible (public or with proper authentication)

  2. Organize your pytest tests

    • Place your test files in a tests/ directory (or configure a custom path)
    • If you need additional dependencies, list them in requirements.txt and add installation commands to start_tests.sh

  3. Create a test launcher script (start_tests.sh)

    • This script will be executed by the runner to launch your tests
    • Place it in the root of your test repository
    • The script should handle test execution and result generation

Example Test Launcher Script

Create start_tests.sh in your test repository root:

#!/bin/bash

# Exit immediately if any command fails
set -e

echo "=== Starting Pytest Launcher ==="

# Ensure TEST_PARAMS is set
if [ -z "$TEST_PARAMS" ]; then
  echo "ERROR: TEST_PARAMS environment variable is not set"
  exit 1
fi

echo "TEST_PARAMS: $TEST_PARAMS"

# Show current working directory
echo "Working directory: $(pwd)"

# Optionally activate virtualenv if needed
if [ -d "venv" ]; then
  echo "Activating virtual environment"
  source venv/bin/activate
fi

# Create the allure results directory if it doesn't exist
mkdir -p /tmp/clone/allure-results

# Run pytest with Allure reporting
echo "Running Python test launcher..."
pytest -v tests --alluredir=/tmp/clone/allure-results

echo "=== Test execution complete ==="

Note: The runner expects test results to be generated in /tmp/clone/allure-results for Allure report generation.

Configuration

When deploying the runner, provide the following required parameters:

  • ATP_TESTS_GIT_REPO_URL: URL of your test repository
  • ATP_TESTS_GIT_REPO_BRANCH: Branch to checkout (default: main)
  • ATP_TESTS_GIT_TOKEN: Access token if using a private repository
  • TEST_PARAMS: JSON object with test-specific parameters