Architecture Overview

TAFLEX PY is built on a robust, extensible architecture that follows enterprise-grade design patterns. This document explains the architectural decisions and how different components interact.

Design Philosophy

TAFLEX PY follows these core principles:

Principle	Description
🧩 Strategy Pattern	Runtime driver resolution allows the same test code to run on Web, API, or Mobile without modification.
📄 Separation of Concerns	Test logic is completely decoupled from driver implementation and locator definitions.
⚙️ Configuration Over Code	Behavior is controlled through external configuration, not hardcoded values.
🧪 Fast Feedback Loop	High-performance execution using Playwright and Pytest for rapid development.

High-Level Architecture

flowchart TB
    subgraph "Test Layer"
        TC[Test Specs]
        BDD[BDD Features]
        FIX[Fixtures]
    end

    subgraph "Framework Core"
        DF[DriverFactory]
        CM[AppConfig]
        LOG[Logger]
    end

    subgraph "Driver Strategies"
        direction TB
        ADS[UiDriver & ApiClient<br/>Protocols]
        PD[PlaywrightDriver]
        HC[HttpxClient]
        AD[AppiumDriver]
    end

    subgraph "Service Clients"
        direction TB
        MQC[BaseMQClient]
        RMQ[RabbitMQClient]
        KFK[KafkaClient]
    end

    subgraph "External Resources"
        ENV[.env Configuration]
        ALR[Allure Reports]
        RP[ReportPortal]
        XRAY[Jira Xray]
    end

    TC --> FIX
    BDD --> FIX
    FIX --> DF
    FIX --> CM
    FIX --> MQC

    DF --> ADS
    ADS --> PD
    ADS --> HC
    ADS --> AD

    MQC --> RMQ
    MQC --> KFK

    CM --> ENV
    FIX --> ALR

Component Breakdown

1. Driver Layer

The Driver Layer implements the Strategy Pattern, allowing runtime selection of the appropriate driver implementation.

classDiagram
    class UiDriver {
        <<abstract>>
        +start()
        +stop()
        +navigate(str)
    }
    class ApiClient {
        <<abstract>>
        +start()
        +stop()
        +get(str)
    }

    class PlaywrightDriver {
        -browser
        -context
        -page
        +start()
        +navigate(str)
    }

    class AppiumDriver {
        -client
        +start()
        +navigate(str)
    }

    class HttpxClient {
        -client
        +get(str)
        +post(str, dict)
    }

    class BaseMQClient {
        <<abstract>>
        +connect()
        +disconnect()
        +publish(destination, payload)
        +wait_for_message(destination, timeout, condition)
        +purge_queue(destination)
    }

    class RabbitMQClient {
        -connection
        -channel
    }

    class KafkaClient {
        -producer
        -consumer
    }

    UiDriver <|-- PlaywrightDriver
    ApiClient <|-- HttpxClient
    UiDriver <|-- AppiumDriver
    BaseMQClient <|-- RabbitMQClient
    BaseMQClient <|-- KafkaClient

Key Benefits: - ✅ Single test codebase for all platforms. - ✅ Driver changes (e.g., swapping engines) don't affect test specs. - ✅ Independent clients (like BaseMQClient) can be injected alongside UI/API drivers for asynchronous backend validation. - ✅ Supports parallel execution with different strategies.

2. Configuration Management

The AppConfig (via Pydantic Settings) provides centralized access to validated environment variables:

from taflex.core.config.app_config import AppConfig

# Type-safe access with Pydantic validation
config = AppConfig()
browser = config.browser
timeout = config.timeout_ms

3. Test Execution Flow

sequenceDiagram
    participant Suite as Pytest
    participant Conf as conftest.py
    participant AC as AppConfig
    participant DF as DriverFactory
    participant Strat as Strategy
    participant Test as Spec

    Suite->>Conf: Request driver fixture
    Conf->>AC: Initialize AppConfig (reads .env)
    AC-->>Conf: AppConfig object
    Conf->>Conf: Check EXECUTION_MODE or markers
    Conf->>DF: DriverFactory.create(config)
    DF-->>Conf: Strategy Instance (Web/API/Mobile)
    Conf->>Strat: start()
    Strat-->>Conf: Ready
    Conf->>Test: Execute test(driver)
    Test->>Strat: perform actions (e.g. navigate)
    Strat-->>Test: Returns state/elements
    Test-->>Conf: Test Complete
    Conf->>Strat: stop()
    Suite->>Suite: Finalize Reports

Technology Stack

Category	Technologies
Core Framework	Python 3.10+, Pydantic, Pytest
Web Testing	Playwright, Chromium/Firefox/WebKit
BDD Testing	Gherkin, pytest-bdd
API Testing	Playwright (Hybrid) · HTTPX (Specialized)
Mobile Testing	Appium
Message Queue	RabbitMQ (pika), Kafka (confluent-kafka)
Unit Testing	Pytest
Database	SQLAlchemy, psycopg2, PyMySQL
Reporting	Allure, Playwright HTML

Extensibility Points

TAFLEX PY is designed for extension at multiple levels:

1. Custom Driver Strategies

Simply extend the UiDriver or ApiClient base classes and register it in the DriverFactory.

2. Custom Element Wrappers

Extend or create new element wrappers to support unique platform interactions while maintaining a consistent API.

3. Fixtures

Customize Playwright fixtures in conftest.py to inject global setup/teardown logic or custom dependencies.