Setup

WAFT (Warp Automation Framework for Testing)

A comprehensive automation framework for testing Cloudflare’s WARP client across multiple operating systems and architectures.

🚀 Overview

WAFT provides a unified framework for:

• Multi-OS Testing: Ubuntu, Windows, RHEL/AlmaLinux, Debian

• Cross-Architecture Support: Intel/AMD64 and ARM64

• VM Management: Automated VM provisioning and configuration

• Test Orchestration: Comprehensive test suite execution

• CI/CD Integration: GitLab CI/CD pipeline templates

📦 Components

Core Framework (waft/src/waft/)

• CLI Interface: Command-line tools for VM and test management

• VM Management: Automated VM creation, configuration, and cleanup

• Test Execution: Pytest-based test runner with WARP client integration

• Configuration Management: Centralized configuration and secrets handling

Test Pipeline (waft/.gitlab/ci/)

• CI/CD Templates: Ready-to-use GitLab CI/CD templates for external projects

• Multi-OS Support: Comprehensive OS and architecture matrix testing

📖 Documentation

Test Pipeline Documentation

For comprehensive information about using WAFT’s CI/CD pipeline system:

👉 WAFT Test Pipeline Documentation

This documentation covers:

• External Integration: How to use WAFT testing in your projects

• OS Version Support: Complete matrix of supported operating systems

Core Framework Documentation

👉 WAFT Framework Documentation

• CLI Reference: At-a-glance

• CLI Commands: waft --help and waft <command> --help

• Documentation: waft show --help

• VM Management: waft vm --help

• Configuration: waft config --help

🚀 Quick Start

For External Projects

Include WAFT testing in your project:

# .gitlab-ci.yml
stages:
  - test_stage
include:
  - component: $CI_SERVER_FQDN/cloudflare/ztqa/waft/test-with-waft@latest
    inputs:
      runs-on:
        - ubuntu_24_04_multiarch_arm
        - ubuntu_22_04_multiarch_intel
      test-path: src/
      stage: test_stage

WAFT Testing CI Component Inputs

Input	Description	Default	Type	Required
pytest-markers	Pytest markers to run	""	string	No
pytest-args	Pytest args to run	""	string	No
runs-on	List of VMs to run on	-	list	Yes
test-path	Path to tests to run	-	string	Yes
release-track	Release track of WARP client to use for testing (ga, beta, nightly)	ga	string	No
stage	Stage to run tests in	-	string	Yes
allow-failure	Allow tests to fail	false	boolean	No
test-timeout	Test timeout	1h	string	No
test-job-name	Name of job where tests will be run	waft-${CI_PROJECT_NAME}	string	No
needs	Jobs required to be run before component should be run	null	array	No

Available VM Options

The following options are available for the runs-on input:

Linux

• almalinux8_multiarch_intel, almalinux8_multiarch_arm

• debian_bullseye_multiarch_intel, debian_bullseye_multiarch_arm

• debian_bookworm_multiarch_intel, debian_bookworm_multiarch_arm

• fedora34_multiarch_intel, fedora34_multiarch_arm

• fedora35_multiarch_intel, fedora35_multiarch_arm

• ubuntu_20_04_multiarch_intel, ubuntu_20_04_multiarch_arm

• ubuntu_22_04_multiarch_intel, ubuntu_22_04_multiarch_arm

• ubuntu_24_04_multiarch_intel, ubuntu_24_04_multiarch_arm

Windows

• windows_11_intel, windows_11_arm

• windows_2022_intel

For Local Execution

Run WAFT tests from your system:

1. 💻 Prepare test systems

2. ⚙️ Configure clients to be tested, either:

   • a) Download client installers

   • b) Place installers manually

3. 🧪 Run tests - See VS Code Test Configuration Guide

🏗️ Architecture

WAFT Framework
├── Core Framework (waft/)
│   ├── VM Management
│   ├── Test Orchestration
│   ├── Configuration Management
│   └── CLI Interface
├── Test Pipeline (.gitlab/waft_test_pipeline/)
    ├── CI/CD Templates
    ├── OS Job Definitions
    └── Reporting Integration

📊 Supported Operating Systems

OS Family	Versions	Architectures	Matrix Size
Ubuntu	24.04, 22.04, 20.04 LTS	Intel, ARM64	6 combinations
Windows	11, 10, Server 2022, 2019	Intel, ARM64¹	5 combinations
RHEL/AlmaLinux	AlmaLinux 8	Intel, ARM64	2 combinations
Debian	13, 12, 11 LTS	Intel, ARM64	6 combinations

¹ ARM64 support varies by OS version

📞 Support

• Pipeline Issues: See Test Pipeline Documentation

• Framework Issues: Submit a ticket to the ZTQA JIRA project

• General Questions: Contact the ZTQA Test & Automation team

---

Ready to get started? Check out the following references for detailed setup instructions and examples:

Getting Started

Complete the default Python Environment Setup configuration.

Execute

Finalize your local WAFT Framework Configuration and Setup.

Contribute

Check out our best practices for contributing to the framework.

Run tests via CLI!