feat: A new feature [Psupatpos 63] Robot framework runner

feat: A new feature [Psupatpos 63] Robot framework runner

Author: mrMigles

Dockerfile

@@ -11,6 +11,7 @@ ENV ROBOT_HOME=/opt/robot \
 
 COPY scripts/docker-entrypoint.sh /
 COPY scripts/*.py ${ROBOT_HOME}/
+COPY scripts/adapter-S3 ${ROBOT_HOME}/scripts/adapter-S3
 COPY requirements.txt ${ROBOT_HOME}/requirements.txt
 COPY library ${ROBOT_HOME}/integration-tests-built-in-library
 
@@ -26,6 +27,13 @@ RUN \
         apk-tools \
         py3-yaml \
         ca-certificates \
+        inotify-tools \
+    # Clean up
+    && rm -rf /var/cache/apk/*
+
+RUN echo 'https://dl-cdn.alpinelinux.org/alpine/edge/testing' >> /etc/apk/repositories \
+    && apk add --update --no-cache \
+        s5cmd \
     # Clean up
     && rm -rf /var/cache/apk/*
 
@@ -42,12 +50,19 @@ RUN \
     && python3 -m pip install --no-cache-dir ${ROBOT_HOME}/integration-tests-built-in-library \
     # Clean up
     && rm -rf ${ROBOT_HOME}/integration-tests-built-in-library \
+    # Create output directory
+    && mkdir -p ${ROBOT_HOME}/output \
     # Set permissions
     && chmod +x /docker-entrypoint.sh \
+    && chmod -R 775 ${ROBOT_HOME} \
+    && chown -R ${USER_ID}:0 ${ROBOT_HOME} \
+    && chgrp -R 0 ${ROBOT_HOME} \
     && chgrp 0 /docker-entrypoint.sh
 
 WORKDIR ${ROBOT_HOME}
 
+USER 1000:0
+
 ENTRYPOINT ["/docker-entrypoint.sh"]
 CMD ["run-robot"]
 

README.md

@@ -3,10 +3,10 @@
 The `Docker Integration Tests` (aka `BDI`) is image for integration tests.
 Supposed that this image will not be used to execute integration tests directly
 but real images for integration tests will use this image as basic
-(`FROM` command in the particular docker file). BDI builds some `sandbox` which
+(`FROM` command in the particular Docker file). BDI builds some `sandbox` which
 includes `python` interpreter, Robot Framework, some useful tools such as
 `bash`, `shadow`, `vim`, `rsync`, `ttyd`, common custom Robot Framework libraries
-(for example, `PlatformLibrary`) and customized docker entry point script.
+(for example, `PlatformLibrary`) and customized Docker entry point script.
 
 * [Introduction](#introduction)
   * [Pre-installed tools](#pre-installed-tools)
@@ -46,7 +46,7 @@ and move `PlatformLibrary.html` file to documentation directory.
 
 ## Docker Entry point Script
 
-A docker entry point script is a script which will be executed after docker container is created.
+A Docker entry point script is a script which will be executed after Docker container is created.
 If you override the image, its entry point script
 will be executed by default. But if you override the entry point as well, your own entry point will be run.
 Docker Integration Tests contains simple and customized entry point script - `/docker-entrypoint.sh`
@@ -59,7 +59,7 @@ with the following command (possible `CMD` arguments):
 
 * `run-ttyd` command starts `ttyd` tool. `ttyd` is Web-console which rather useful for dev and troubleshooting purposes.
 
-* `custom` command executes custom bash script if this script's path is provided.
+* `custom` command executes custom Bash script if this script's path is provided.
 * To provide custom script this script should exist within container
   and environment variable `CUSTOM_ENTRYPOINT_SCRIPT` should contain path to the script.
   Actually, `custom` command is equivalent to overriding the entry point
@@ -211,7 +211,7 @@ STATUS_CUSTOM_RESOURCE_NAME=zookeeper
 ```
 
 If your k8s pod with integration tests always writes status to well-known custom resource you can override all this environment
-variables (excluding `STATUS_CUSTOM_RESOURCE_NAMESPACE`) in your docker file and set namespace in helm chart.
+variables (excluding `STATUS_CUSTOM_RESOURCE_NAMESPACE`) in your Docker file and set namespace in helm chart.
 
 Both of this approaches work with native k8s entities too. For example:
 
@@ -223,7 +223,7 @@ STATUS_CUSTOM_RESOURCE_PLURAL=deployments
 STATUS_CUSTOM_RESOURCE_NAME=zookeeper-1
 ```
 
-If feature is available `write_status.py` script is called two times. The first time immediately after docker
+If feature is available `write_status.py` script is called two times. The first time immediately after Docker
 entrypoint script was started to set `In progress` condition. The second time after tests are finished and parsed by
 `analyze results` script to set in the `message` field tests results. Default analyzer script is `write_status.py`
 but inheritor image can override it by `WRITE_STATUS_SCRIPT` environment variable which contains path to custom
@@ -244,7 +244,7 @@ should be placed in the `result.txt` file and the first line will be used as sho
 
 **Note!** This feature (write status to k8s entities) is disabled by default! To turn on it please set the
 `STATUS_WRITING_ENABLED` environment variable to `true`.
-For example in your docker file as
+For example in your Docker file as
 
 ```ini
 ENV STATUS_WRITING_ENABLED=true
@@ -276,5 +276,33 @@ Docker Integration Tests uses the following environment variables:
 * IS_STATUS_BOOLEAN
 
 All of them instead of `TAGS`, `ONLY_INTEGRATION_TESTS`, `STATUS_CUSTOM_RESOURCE_NAMESPACE`,
-`STATUS_CUSTOM_RESOURCE_PATH` and maybe `DEBUG` we recommend overriding in the docker file and do not
+`STATUS_CUSTOM_RESOURCE_PATH` and maybe `DEBUG` we recommend overriding in the Docker file and do not
+forward them to the integration tests deployment environment.
+
+### ATP Storage (S3) Variables
+
+These variables enable automatic upload of test results and reports to S3-compatible storage:
+
+* `ATP_STORAGE_PROVIDER` - Storage provider type: `aws` (AWS S3), `minio` (MinIO), or `s3` (S3-compatible storage)
+* `ATP_STORAGE_SERVER_URL` - S3 API endpoint URL (required for MinIO and S3-compatible storage, e.g., <https://minio.example.com> or <https://s3.amazonaws.com>)
+* `ATP_STORAGE_SERVER_UI_URL` - S3 UI URL for browsing uploaded files (optional, e.g., <https://minio-ui.example.com>)
+* `ATP_STORAGE_BUCKET` - S3 bucket name for storing test results. If empty, S3 integration is disabled
+* `ATP_STORAGE_REGION` - S3 region (optional, default: us-east-1). Required for AWS S3
+* `ATP_STORAGE_USERNAME` - S3 credentials username:
+  * For AWS S3: AWS Access Key ID
+  * For MinIO: MinIO Access Key
+  * Required when `ATP_STORAGE_BUCKET` is set
+* `ATP_STORAGE_PASSWORD` - S3 credentials password:
+  * For AWS S3: AWS Secret Access Key
+  * For MinIO: MinIO Secret Key
+  * Required when `ATP_STORAGE_BUCKET` is set
+* `ATP_REPORT_VIEW_UI_URL` - URL for viewing Allure reports (optional, e.g., <https://allure.example.com>)
+* `ENVIRONMENT_NAME` - Environment name for organizing test results in S3 (e.g., dev, staging, prod). Results are stored in: `s3://{bucket}/Result/{environment}/{date}/{time}/`
+* `UPLOAD_METHOD` - Upload method: `sync` (directory sync) or `cp` (file-by-file upload, default: sync)
+
+**Note:** Test results are automatically uploaded to S3 with the following structure:
+- Allure results: `s3://{bucket}/Result/{environment}/{date}/{time}/allure-results/`
+- Attachments: `s3://{bucket}/Report/{environment}/{date}/{time}/attachments/`
+
+All ATP Storage variables except `ENVIRONMENT_NAME` it is recommended to override in the Docker file and do not
 forward them to the integration tests deployment environment.

demo/docker/Dockerfile

@@ -1,3 +1,3 @@
 FROM ghcr.io/netcracker/qubership-docker-integration-tests:main
 
-COPY docker/robot  ${ROBOT_HOME}
+COPY docker/robot ${ROBOT_HOME}

requirements.txt

@@ -8,6 +8,7 @@ pyyaml==6.0.3
 requests==2.32.5
 requests_oauthlib==2.0.0
 robotframework-requests==0.9.7
+allure-robotframework==2.15.0
 robotframework==7.3.2
 setuptools~=80.10.0
 urllib3~=2.3.0

scripts/adapter-S3/adapter-S3-entrypoint.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+set -e
+
+# Main test job entrypoint script - coordinates all modules
+echo " Starting test job entrypoint script..."
+echo " Working directory: $(pwd)"
+echo " Timestamp: $(date)"
+
+# Set default upload method
+export UPLOAD_METHOD="${UPLOAD_METHOD:-sync}"
+echo " Upload method: $UPLOAD_METHOD"
+echo " Report view host URL: $ATP_REPORT_VIEW_UI_URL"
+echo " S3 bucket: ${ATP_STORAGE_BUCKET:-<not set>}"
+echo " S3 provider: ${ATP_STORAGE_PROVIDER:-<not set>}"
+echo " S3 API host: ${ATP_STORAGE_SERVER_URL:-<not set>}"
+echo " S3 UI URL: ${ATP_STORAGE_SERVER_UI_URL:-<not set>}"
+echo " Environment name: $ENVIRONMENT_NAME"
+
+# Import modular components
+source "${ROBOT_HOME}/scripts/adapter-S3/init.sh"
+source "${ROBOT_HOME}/scripts/adapter-S3/test-runner.sh"
+source "${ROBOT_HOME}/scripts/adapter-S3/upload-monitor.sh"
+
+# Execute main workflow
+echo " Starting test execution workflow..."
+
+# Store all arguments passed to this script
+echo " Robot arguments: $*"
+
+# Initialize environment
+init_environment
+
+# Start upload monitoring only if S3 is enabled
+if [[ -n "${ATP_STORAGE_BUCKET}" ]]; then
+    start_upload_monitoring
+else
+    echo "️ Skipping upload monitoring (S3 integration disabled)"
+fi
+
+# Run tests
+run_tests "$@"
+
+# Finalize upload only if S3 is enabled
+if [[ -n "${ATP_STORAGE_BUCKET}" ]]; then
+    finalize_upload
+else
+    echo "️ Skipping upload finalization (S3 integration disabled)"
+    echo " Test results are available locally at: $TMP_DIR"
+fi
+
+echo " Test job finished successfully!"

scripts/adapter-S3/email-notification/calculate-email-notification-variables.sh

@@ -0,0 +1,172 @@
+#!/bin/bash
+
+# Calculate Test Pass Rate from Allure Results
+#
+# This script analyzes test results from allure-results directory
+# and calculates the overall pass rate, then exports it as environment variable
+#
+# Dependencies:
+# - jq (for JSON parsing)
+# - bc (for floating point calculations)
+
+set -eo pipefail
+
+# Logging functions
+log_info() {
+    echo "INFO: $1"
+}
+
+log_success() {
+    echo "SUCCESS: $1"
+}
+
+log_warning() {
+    echo "WARNING: $1"
+}
+
+log_error() {
+    echo "ERROR: $1"
+}
+
+# Get script directory (exported for potential external use)
+# shellcheck disable=SC2034
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+# Default allure-results directory (now in parent directory)
+ALLURE_RESULTS_DIR="${1:-/tmp/clone/allure-results}"
+
+# Check if allure-results directory exists
+if [ ! -d "$ALLURE_RESULTS_DIR" ]; then
+    log_error "Allure results directory not found: $ALLURE_RESULTS_DIR"
+    exit 1
+fi
+
+# Check if jq is available
+if ! command -v jq &>/dev/null; then
+    log_error "jq is required but not installed. Please install jq to parse JSON files."
+    exit 1
+fi
+
+# Check if bc is available, if not we'll use awk for calculations
+BC_AVAILABLE=false
+if command -v bc &>/dev/null; then
+    BC_AVAILABLE=true
+fi
+
+log_info "Analyzing test results from: $ALLURE_RESULTS_DIR"
+
+# Initialize counters
+total_tests=0
+passed_tests=0
+failed_tests=0
+skipped_tests=0
+
+# Initialize test details arrays
+declare -a test_details=()
+# Add table header
+test_details+=("$(printf "%-12s" "Status") | Test Name")
+test_details+=("------------ | ------------------------------------------------------------")
+
+# Process each result file
+for result_file in "$ALLURE_RESULTS_DIR"/*-result.json; do
+    if [ -f "$result_file" ]; then
+        log_info "Processing: $(basename "$result_file")"
+
+        # Extract test status using jq
+        status=$(jq -r '.status' "$result_file" 2>/dev/null || echo "unknown")
+        test_name=$(jq -r '.name' "$result_file" 2>/dev/null || echo "Unknown Test")
+
+        case "$status" in
+        "passed")
+            passed_tests=$((passed_tests + 1))
+            log_success "PASSED: $test_name"
+            test_details+=("PASSED       | $test_name")
+            ;;
+        "failed")
+            failed_tests=$((failed_tests + 1))
+            log_error "FAILED: $test_name"
+            test_details+=("FAILED       | $test_name")
+            ;;
+        "skipped")
+            skipped_tests=$((skipped_tests + 1))
+            log_warning "SKIPPED: $test_name"
+            test_details+=("SKIPPED      | $test_name")
+            ;;
+        *)
+            log_warning "? $test_name (status: $status)"
+            test_details+=("UNKNOWN      | $test_name")
+            ;;
+        esac
+
+        total_tests=$((total_tests + 1))
+    fi
+done
+
+# Calculate pass rate
+if [ $total_tests -eq 0 ]; then
+    log_error "No test results found in $ALLURE_RESULTS_DIR"
+    exit 1
+fi
+
+# Calculate pass rate as percentage (passed / total * 100)
+if [ "$BC_AVAILABLE" = true ]; then
+    pass_rate=$(echo "scale=2; $passed_tests * 100 / $total_tests" | bc)
+    pass_rate_rounded=$(echo "scale=0; $passed_tests * 100 / $total_tests" | bc)
+else
+    # Use awk for calculations if bc is not available
+    pass_rate=$(awk "BEGIN {printf \"%.2f\", $passed_tests * 100 / $total_tests}")
+    pass_rate_rounded=$(awk "BEGIN {printf \"%.0f\", $passed_tests * 100 / $total_tests}")
+fi
+
+# Determine overall status
+if [ "$pass_rate_rounded" -eq 100 ]; then
+    overall_status="PASSED"
+elif [ "$pass_rate_rounded" -ge 80 ]; then
+    overall_status="PARTIAL"
+else
+    overall_status="FAILED"
+fi
+
+# Export results as environment variables
+export TEST_PASS_RATE="$pass_rate"
+export TEST_PASS_RATE_ROUNDED="$pass_rate_rounded"
+export TEST_TOTAL_COUNT="$total_tests"
+export TEST_PASSED_COUNT="$passed_tests"
+export TEST_FAILED_COUNT="$failed_tests"
+export TEST_SKIPPED_COUNT="$skipped_tests"
+export TEST_OVERALL_STATUS="$overall_status"
+
+# Create test details string
+TEST_DETAILS_STRING=""
+for test_detail in "${test_details[@]}"; do
+    if [ -n "$TEST_DETAILS_STRING" ]; then
+        TEST_DETAILS_STRING="$TEST_DETAILS_STRING\n$test_detail"
+    else
+        TEST_DETAILS_STRING="$test_detail"
+    fi
+done
+export TEST_DETAILS_STRING="$TEST_DETAILS_STRING"
+
+# Display summary
+echo ""
+log_info "=== Test Results Summary ==="
+echo "Overall Status: $overall_status"
+echo "Pass Rate: ${pass_rate}%"
+echo "Total Tests: $total_tests"
+echo "Passed: $passed_tests"
+echo "Failed: $failed_tests"
+echo "Skipped: $skipped_tests"
+echo ""
+
+# Export variables for use in other scripts
+log_info "Environment variables exported:"
+echo "TEST_PASS_RATE=$pass_rate"
+echo "TEST_PASS_RATE_ROUNDED=$pass_rate_rounded"
+echo "TEST_TOTAL_COUNT=$total_tests"
+echo "TEST_PASSED_COUNT=$passed_tests"
+echo "TEST_FAILED_COUNT=$failed_tests"
+echo "TEST_SKIPPED_COUNT=$skipped_tests"
+echo "TEST_OVERALL_STATUS=$overall_status"
+echo "TEST_DETAILS_STRING=<multiline string with test details>"
+
+log_success "Pass rate calculation completed successfully"