Devanshjainms Sap Automation QA Setup Guide

SAP Testing Automation Framework (STAF) Setup Guide

This skill guides you through setting up the STAF environment on a management server. For full details, see docs/SETUP.MD.

Local vs Container: When to Use Which

The container builds its own isolated environment — local setup is not required when using Docker. Both setups read the same workspace configs from WORKSPACES/SYSTEM/.

⚠️ This skill is guidance only. Do NOT modify any source code, scripts, or framework files. Only help the user by providing instructions, running commands, and answering questions.

When to Use

Prerequisites

Infrastructure

• SAP System on Azure IaaS — must follow SAP on Azure best practices
• Management (Jump) server — must run a supported OS version
• Network connectivity — management server must reach the SAP system VNet; if separate, peer the VNets

Identity & Authorization

The framework needs a managed identity to access Azure resources. Choose one option:

Option 1: User-Assigned Managed Identity

1. Create a user-assigned managed identity — copy the Client ID
2. Assign identity to management VM → Settings → Identity → User assigned → +Add
3. Grant roles (recommend resource-group scope): assign from identity's Azure role assignments, or from each target resource's IAM blade → Add role assignment → Managed identity
4. Set user_assigned_identity_client_id in sap-parameters.yaml to the Client ID

Option 2: System-Assigned Managed Identity

1. On management VM → Settings → Identity → System assigned → Status On → Save
2. Grant roles using same methods as Option 1
3. Leave user_assigned_identity_client_id blank or "" in sap-parameters.yaml

Software

• Python 3.10+ (3.12 recommended for Docker)
• Docker (for container deployments only)
• Git (see install commands below)

Analytics (Optional)

See docs/TELEMETRY_SETUP.md for Azure Log Analytics and Azure Data Explorer integration.

Getting Started

1. Login to Management Server

Ensure you are logged into the management server connected to the SAP system's virtual network.

2. Install Git

# Debian/Ubuntu                # RHEL/CentOS               # SUSE
sudo su -                      sudo su -                    sudo su -
apt-get install git            yum install git              zypper install git

3. Fork and Clone

# First: fork https://github.com/Azure/sap-automation-qa in your browser
# Then clone YOUR fork (not the Azure repo directly):
sudo su -
git clone https://github.com/GITHUB-USERNAME/sap-automation-qa.git
cd sap-automation-qa

4. Local Setup

./scripts/setup.sh

Options:

Python 3.6 warning: Some management servers ship with Python 3.6 as default (not supported). Check available versions and point setup to a supported one:

ls /usr/bin/python3*
./scripts/setup.sh --python /usr/bin/python3.11

What it does:

• Creates Python virtual environment (.venv/)
• Installs pip dependencies and system packages (python3-pip, sshpass, python3-venv)
• Installs Azure CLI tools
• Prepares local execution environment

5. Activate Virtual Environment

source .venv/bin/activate

Container Deployment

Commands

Container Options (for ACR images)

./scripts/setup.sh container start --image <acr>.azurecr.io/sap-automation-qa:latest

Using --image requires ACR access. The script attempts az acr login first; if that fails, set ACR_USERNAME and ACR_PASSWORD environment variables.

What Runs

• FastAPI on http://localhost:8000 — REST API (docs at /docs)
• React on http://localhost:3000 — Web UI (in development)
• SQLite database with persistent volume
• Uses deploy/docker-compose.yml, non-root user (appuser:1000)

Verify

curl http://localhost:8000/healthz
# Expected: {"status": "ok"}

Configuration: vars.yaml

Create vars.yaml at the project root:

# --- Required fields ---
TEST_TYPE:                         SAPFunctionalTests    # or ConfigurationChecks
SAP_FUNCTIONAL_TEST_TYPE:          DatabaseHighAvailability
# Options: DatabaseHighAvailability, CentralServicesHighAvailability, AzureBackupDatabase

SYSTEM_CONFIG_NAME:                DEV-WEEU-SAP01-X00    # dir under WORKSPACES/SYSTEM/
AUTHENTICATION_TYPE:               SSHKEY                # or VMPASSWORD

# --- Telemetry fields (all optional) ---
telemetry_data_destination:        null    # azureloganalytics or azuredataexplorer
telemetry_table_name:              null
service_log_table_name:            null    # default: <telemetry_table_name>_ServiceLogs

# Azure Log Analytics
laws_shared_key:                   null    # if omitted, auto-fetched via params below
laws_workspace_id:                 null
laws_subscription_id:              null
laws_resource_group:               null
laws_workspace_name:               null

# Azure Data Explorer
adx_database_name:                 null
adx_cluster_fqdn:                  null
adx_client_id:                     null

# Managed Identity (optional)
user_assigned_identity_client_id:  null

Configuration: sap-parameters.yaml

Place in WORKSPACES/SYSTEM/<SYSTEM_CONFIG_NAME>/sap-parameters.yaml:

sap_sid:                           "X00"
db_sid:                            "X00"

scs_high_availability:             true
database_high_availability:        true
database_scale_out:                false

# Cluster type: AFA (Azure Fencing Agent), ISCSI, or ASD (Azure Shared Disks)
scs_cluster_type:                  "AFA"
database_cluster_type:             "AFA"

scs_instance_number:               "00"
ers_instance_number:               "01"
db_instance_number:                "00"
platform:                          "HANA"
NFS_provider:                      "AFS"     # or "ANF" (Azure NetApp Files)

user_assigned_identity_client_id:  ""        # blank for system-assigned MSI

# Key Vault credentials (remove if using local credential files)
key_vault_id:                      /subscriptions/.../Microsoft.KeyVault/vaults/<name>
secret_id:                         https://<vault>.vault.azure.net/secrets/<secret>/<id>

# ANF-specific (when NFS_provider = ANF)
ANF_account_rg:                    "ANF-RESOURCE-GROUP"
ANF_account_name:                  "ANF-ACCOUNT-NAME"

Credential Files

Option A: Local Files

SSH Key: Place private key as ssh_key.ppk in workspace directory:

WORKSPACES/SYSTEM/<DIR>/ssh_key.ppk

Password: Create a password file (username comes from hosts.yaml):

echo "password" > WORKSPACES/SYSTEM/<DIR>/password
chmod 600 WORKSPACES/SYSTEM/<DIR>/password

When using local credential files, remove key_vault_id and secret_id from sap-parameters.yaml.

Option B: Azure Key Vault

Store SSH key or password as a Key Vault secret. Configure key_vault_id and secret_id in sap-parameters.yaml. Requirements:

• Managed identity must have "Key Vault Secrets User" role on the vault
• Do NOT create local credential files when using Key Vault

Workspace Structure

WORKSPACES/
└── SYSTEM/
    └── DEV-WEEU-SAP01-X00/           # SYSTEM_CONFIG_NAME
        ├── sap-parameters.yaml        # SAP system parameters
        ├── hosts.yaml                 # Ansible inventory (or {SID}_hosts.yaml)
        ├── ssh_key.ppk / password     # Credential file (if not using Key Vault)
        ├── logs/                      # Auto-created by framework
        │   ├── {invocation_id}.log    # JSON lines - test case results
        │   └── execution_{timestamp}.log  # Raw Ansible output
        └── quality_assurance/         # Auto-created by render_html_report
            └── {test_group}_{invocation_id}.html

Log Locations

API Mode (FastAPI/uvicorn)

Direct Execution Mode

Docker Deployment

Accessing Logs

# API mode — view recent job log
./scripts/sap_automation_qa.sh job log --id <JOB_ID> --tail 50

# Docker — follow container logs
docker logs -f sap-automation-qa

# Direct mode — capture output to file
./scripts/sap_automation_qa.sh --test_groups=HA_DB_HANA 2>&1 | tee run.log

Output Format

Setup Status Report

- Mode: Local / Docker
- Python: ✅ 3.12.x / ❌ Not found
- Virtual env: ✅ Active / ❌ Missing
- Azure CLI: ✅ Installed / ⚠️ Not found
- Docker: ✅ Running / ❌ Not available
- API Health: ✅ Responding / ❌ Not reachable
- Next step: [specific action]

Error Handling

Pre-Completion Checklist

Before reporting setup complete, verify:

• Setup mode completed without errors
• For local: .venv/bin/activate works and ansible --version succeeds
• For Docker: curl http://localhost:8000/healthz returns {"status": "ok"}
• vars.yaml exists at project root with valid TEST_TYPE and AUTHENTICATION_TYPE
• Workspace directory exists under WORKSPACES/SYSTEM/ with sap-parameters.yaml and hosts.yaml
• Credential file present (local) or Key Vault configured (remote)
• Managed identity configured and roles assigned

Copilot CLI Skills

Related Skills

Source: devanshjainms/sap-automation-qa — distributed by TomeVault.