🧪 QA Multipurpose Framework

Enterprise-grade test automation ecosystem covering Web, API and Mobile from a single repository, applying SOLID principles and clean architecture.

---

📋 Table of Contents

• Overview
• Architecture
• Tech Stack
• Project Structure
• Getting Started
• Running Tests
• Mobile Testing
• Reporting
• Environments
• CI/CD Pipeline
• Design Patterns

---

🎯 Overview

This framework demonstrates how a single repository can serve as the backbone for an entire QA organization. It provides a unified, scalable, and maintainable test automation solution across four testing layers:

Layer	Tool	Coverage
🌐 Web	Playwright + POM	UI regression, cross-browser, visual
🔌 API	Playwright APIRequestContext	REST, schema validation, contract
📱 Mobile	Appium 3.x + UiAutomator2	Android native apps on real emulators
🔄 E2E	Playwright + WebdriverIO	Cross-layer end-to-end flows
☁️ Cloud	BrowserStack	Real devices & browsers at scale

---

🏛️ Architecture

┌─────────────────────────────────────────────────┐
│              TEST SUITES LAYER                  │
│  Web Tests │ API Tests │ Mobile Tests │ E2E     │
├─────────────────────────────────────────────────┤
│              PAGE OBJECT MODEL                  │
│  Pages │ Components │ Screens │ API Clients     │
├─────────────────────────────────────────────────┤
│              CORE FRAMEWORK                     │
│  Base Classes │ DI Container │ Interfaces       │
├─────────────────────────────────────────────────┤
│              SHARED UTILITIES                   │
│   Helpers │ Constants │ Types │ Data Factories  │
├─────────────────────────────────────────────────┤
│              CONFIG LAYER                       │
│    Dev │ QA │ Staging │ BrowserStack            │
└─────────────────────────────────────────────────┘

---

🛠️ Tech Stack

Category	Technology	Purpose
Language	TypeScript 5.x	Type-safe test development
Web Testing	Playwright 1.60	Cross-browser automation
Mobile Testing	Appium 3.4.2 + UiAutomator2	Android automation
Mobile Client	WebdriverIO	Appium session management
Reporting	Allure Reports	Visual test reporting
Cloud Testing	BrowserStack	Real device testing
Data Generation	Custom Factories	Dynamic test data
CI/CD	GitHub Actions	Automated pipelines
Pattern	Page/Screen Object Model	Maintainable test structure
Architecture	SOLID Principles	Scalable framework design

---

📁 Project Structure

qa-multipurpose-framework/
├── 📁 src/
│   ├── 📁 web/
│   │   ├── pages/          # Page Object classes
│   │   ├── components/     # Reusable UI components
│   │   └── fixtures/       # Web test fixtures
│   ├── 📁 api/
│   │   ├── clients/        # API client classes
│   │   ├── schemas/        # JSON schema validators
│   │   └── interceptors/   # Request/response interceptors
│   ├── 📁 mobile/
│   │   ├── screens/        # Screen Object classes
│   │   ├── gestures/       # Mobile gesture helpers
│   │   └── fixtures/       # Mobile test fixtures
│   ├── 📁 core/
│   │   ├── base/           # Base test classes
│   │   ├── di/             # Dependency injection
│   │   └── interfaces/     # TypeScript interfaces
│   └── 📁 shared/
│       ├── utils/          # Data factories
│       ├── helpers/        # Utility functions
│       ├── constants/      # Global constants
│       └── types/          # Shared TypeScript types
├── 📁 config/
│   ├── environments/       # dev / qa / staging configs
│   └── browserstack/       # BrowserStack capabilities
├── 📁 tests/
│   ├── web/                # Web test specs
│   ├── api/                # API test specs
│   ├── mobile/             # Mobile test specs
│   └── e2e/                # End-to-end flows
├── 📁 .github/workflows/   # CI/CD pipelines
├── 📁 docs/                # Technical documentation
├── 📁 reports/             # Allure output
├── playwright.config.ts    # Main Playwright config
├── tsconfig.json           # TypeScript config
└── package.json            # Scripts & dependencies

---

🚀 Getting Started

Prerequisites

• Node.js 18+
• npm 9+
• Java 11+ (for Appium)
• Android Studio + Emulator (for mobile)

Installation

# Clone the repository
git clone https://github.com/VladimirRamirez07/qa-multipurpose-framework.git
cd qa-multipurpose-framework

# Install dependencies
npm install

# Install Playwright browsers
npx playwright install

# Configure environment
cp .env.example .env

---

▶️ Running Tests

# Web tests (all browsers)
npm run test:web

# API tests
npm run test:api

# E2E tests
npm run test:e2e

# All tests
npm run test:all

# Parallel execution (4 workers)
npm run test:parallel

# By environment
npm run test:dev
npm run test:staging

# Cloud (BrowserStack)
npm run test:browserstack

---

📱 Mobile Testing

This framework includes full Android automation using Appium 3.x with the UiAutomator2 driver, following the Screen Object Model pattern.

Setup

# Install Appium globally
npm install -g appium

# Install Android driver
appium driver install uiautomator2

Running Mobile Tests

# 1. Start Android emulator from Android Studio Device Manager

# 2. Start Appium server
appium

# 3. Run mobile tests in a new terminal
MOBILE=true npx playwright test tests/mobile --project=mobile-chrome

Mobile Capabilities (Pixel 8 - Android 17)

{
  platformName: 'Android',
  'appium:automationName': 'UiAutomator2',
  'appium:deviceName': 'emulator-5554',
  'appium:platformVersion': '17.0',
  'appium:appPackage': 'com.android.settings',
  'appium:appActivity': '.Settings',
}

Screen Object Pattern

// Every screen extends a base class
export class HomeScreen {
  constructor(private driver: Browser) {}

  async isAppLoaded(): Promise<boolean> { ... }
  async getCurrentPackage(): Promise<string> { ... }
  async getCurrentActivity(): Promise<string> { ... }
}

---

📊 Reporting

This framework uses Allure Reports for rich, interactive test reporting with screenshots, videos, and step-by-step logs.

# Generate report
npm run allure:generate

# Open report in browser
npm run allure:open

# Live serve
npm run allure:serve

---

🌍 Environments

Environment	Base URL	API URL	Retries
dev	dev.example.com	api-dev.example.com	1
qa	qa.example.com	api-qa.example.com	2
staging	staging.example.com	api-staging.example.com	3

---

⚙️ CI/CD Pipeline

GitHub Actions pipelines run automatically on every push and pull request:

• ✅ TypeScript compilation check
• ✅ Web tests on Chromium, Firefox & WebKit in parallel
• ✅ API tests
• ✅ Allure report generation
• ✅ Test results published as artifacts

---

🎨 Design Patterns

Pattern	Application
Page Object Model	Every UI screen has its own class
Screen Object Model	Every mobile screen has its own class
Factory Pattern	Dynamic test data generation
Singleton	Driver/browser instance management
Dependency Injection	Decoupled service layer
Strategy Pattern	Environment-based configuration
Builder Pattern	API request construction

---

📚 Documentation

• Architecture Guide
• Contributing Guide
• Environments Guide

---

👨‍💻 Author

Vladimir Ramirez

QA Automation Engineer passionate about building scalable test frameworks that deliver real business value.

---

Built with ❤️ and a lot of ☕