This monorepo contains the following CAFEX packages:
- cafex-core: The core package providing foundational functionalities and utilities.
- cafex-api: Package for API testing, including request building, response parsing, and assertion methods.
- cafex-db: Package for database testing, supporting various databases like MSSQL, MySQL, Oracle, Hive, Postgres, and Cassandra.
- cafex-ui: Package for web UI and mobile app testing, including driver management, element interaction, and assertion methods.
- cafex-desktop: Package for desktop application testing, supporting Windows applications with functionalities for window handling, element interaction, and assertions.
- cafex: The super package containing all the above packages
CAFEX (Centralized Automation Framework Enabler) is a Python-based automation framework designed to simplify and streamline various testing tasks. This monorepo structure allows for efficient management and development of all CAFEX packages in a single location.
CAFEX is designed for QA engineers, test automation developers, and development teams who need comprehensive test automation across web UI, mobile, API, and database layers. It's ideal for teams looking to standardize their testing approach with a unified framework.
CAFEX enables teams to achieve faster, more reliable testing with reduced manual effort. Users can expect consistent test results, comprehensive reporting with screenshots and logs, faster feedback cycles, and improved product quality through unified automation across multiple testing domains.
CAFEX runs locally during development for rapid testing and debugging. It's designed for CI/CD pipeline integration for automated testing in continuous deployment workflows. The framework supports both individual developer workflows and enterprise-scale automated testing environments.
- Python 3.12.10
- pip 24 or later(Python package manager)
- Clone or download the CAFEX monorepo.
- Install the required dependencies:
- With uv:
pip install uv uv pip install -r dev-requirements.txt
- With pip:
pip install -r dev-requirements.txt
- With uv:
Dependencies with uv:
- For UI, API,Desktop and DB testing:
uv pip install cafex - For UI testing:
uv pip install cafex-ui - For DB testing:
uv pip install cafex-db - For API testing:
uv pip install cafex-api - For Desktop App testing:
uv pip install cafex-desktop - For Core modules:
uv pip install cafex-core
Dependencies with pip:
- For UI, API,Desktop and DB testing:
pip install cafex - For UI testing:
pip install cafex-ui - For DB testing:
pip install cafex-db - For API testing:
pip install cafex-api - For Desktop App testing:
pip install cafex-desktop - For Core modules:
pip install cafex-core
For detailed information about each package, please refer to their respective README files:
- cafex: libs/cafex/README.md
- cafex-api: libs/cafex_api/README.md
- cafex-db: libs/cafex_db/README.md
- cafex-ui: libs/cafex_ui/README.md
- cafex-desktop: libs/cafex_desktop/README.md
- cafex-core: libs/cafex_core/README.md
The cafex_sandbox_project included in this repository contains a complete working example with all necessary files and folders. Use it as your reference and starting point.
cafex init my_project
cd my_projectmy_project/
├── features/
│ ├── configuration/ # Config files (browserstack, mobile, etc.)
│ ├── forms/ # UI automation business logic
│ ├── services/ # API automation business logic
│ ├── queries/ # Database automation business logic
│ ├── testdata/ # Test data files (JSON/YAML preferred)
│ └── tests/
│ ├── pytest_bdd_feature/ # BDD tests with .feature files
│ ├── pytest_testsuite/ # Regular pytest tests
│ └── unittest_testsuite/ # Unit tests
├── result/ # Test execution results
└── config.yml # Main configuration
current_execution_browser: chrome
environment: https://the-internet.herokuapp.com
execution_environment: dev
default_explicit_wait: 60
env:
dev:
web_demo:
base_url: https://the-internet.herokuapp.com
default_user:
username: tomsmith
password: SuperSecretPassword!Create feature files in features/tests/pytest_bdd_feature/ with mandatory tags:
Feature: Login functionality
@ui_web @smoke
Scenario: Successful login with valid credentials
Given the user is on the login page
When the user enters valid credentials
And the user clicks the login button
Then the user should be logged in successfully
@api @smoke
Scenario: Get user details via API
Given the API is available
When I send a GET request to "/users/1"
Then the response status should be 200
@db @regression
Scenario: Validate user data in database
Given the database connection is established
When I query for user with id 1
Then the user details should match expected values
@mobile_app @smoke
Scenario: Mobile app login
Given the mobile app is launched
When the user logs in with valid credentials
Then the dashboard should be displayedImplement step definitions using CAFEX APIs:
from pytest_bdd import given, when, then, scenario
from cafex import CafeXWeb, CafeXAPI, CafeXDB
@scenario('login.feature', 'Successful login with valid credentials')
def test_login():
pass
@given('the user is on the login page')
def open_login_page():
CafeXWeb().navigate("https://the-internet.herokuapp.com/login")
@when('the user enters valid credentials')
def enter_credentials():
CafeXWeb().type("id=username", "tomsmith")
CafeXWeb().type("id=password", "SuperSecretPassword!")
@when('the user clicks the login button')
def click_login():
CafeXWeb().click("xpath=//button[@type='submit']")
@then('the user should be logged in successfully')
def verify_login():
success_message = CafeXWeb().get_web_element("css=.flash.success").text
assert "You logged into a secure area!" in success_messageFor pytest in features/tests/pytest_testsuite/ with pytest markers:
import pytest
from cafex import CafeXWeb, CafeXAPI
@pytest.mark.ui_web
def test_add_remove_elements():
CafeXWeb().navigate("https://the-internet.herokuapp.com/")
CafeXWeb().click("xpath=//a[text()='Add/Remove Elements']")
CafeXWeb().click("xpath=//button[text()='Add Element']")
delete_button = CafeXWeb().get_web_element("xpath=//button[text()='Delete']")
assert delete_button.is_displayed()
@pytest.mark.api
def test_api_get_posts():
response = CafeXAPI().call_request(
method="GET",
url="https://jsonplaceholder.typicode.com/posts/1"
)
assert response.status_code == 200
assert "userId" in response.json()
@pytest.mark.db
def test_database_connection():
from cafex_db import DatabaseHandler
db = DatabaseHandler()
# Add your database test logic hereUI Methods in features/forms/ui_methods/:
from cafex import CafeXWeb
from cafex_core.reporting_.reporting import Reporting
class LoginPageMethods:
def __init__(self):
self.reporting = Reporting()
def perform_login(self, username, password):
CafeXWeb().type("id=username", username)
CafeXWeb().type("id=password", password)
CafeXWeb().click("xpath=//button[@type='submit']")
self.reporting.insert_step("Login", "User logged in successfully", "Pass")API Services in features/services/:
from cafex import CafeXAPI
import json
class UserAPI:
def __init__(self):
self.base_url = "https://jsonplaceholder.typicode.com"
def create_user(self, user_data):
return CafeXAPI().call_request(
method="POST",
url=f"{self.base_url}/users",
headers={"Content-Type": "application/json"},
payload=json.dumps(user_data)
)# Run all tests
cafex run
# Run specific test types
pytest -m ui_web # Web UI tests only
pytest -m api # API tests only
pytest -m "ui_web and smoke" # Web UI smoke tests
# Run BDD tests
pytest features/tests/pytest_bdd_feature/ -v
# Run with specific browser
pytest --browser=firefox -m ui_webcafex report # Opens latest HTML report in browserTo get started with Playwright, please follow these steps in your command prompt:
-
Set the environment variable to allow self-signed certificates:
set NODE_TLS_REJECT_UNAUTHORIZED=0
-
Install Playwright using the following command:
playwright install
Note: If you are using multiple Python versions and the default Python version is not set to the version supported by Café, try the following command:
<python_path> -m playwright install
- Playwright test files are generated using the Playwright codegen tool, and the logic is adapted for use with pytest. Since Playwright's pytest plugin is not supported in our environment, we manually handle the Playwright driver setup and teardown in our tests.
You can generate code for your interactions using the Playwright codegen command. Open your terminal and run:
playwright codegen https://example.comThis command will open a browser window where you can manually interact with the site. Playwright will automatically generate the corresponding code for your actions in real-time.
When using the codegen command, you can also specify various parameters to customize its behavior. Here are some useful parameters:
--target: Specify the target language for the generated code.- Example:
playwright codegen --target=python https://example.com
- Example:
--output: Define the output file where the generated code will be saved.- Example:
playwright codegen --output=generated_script.py https://example.com
- Example:
--headless: Run the browser in headless mode (without a GUI).- Example:
playwright codegen --headless https://example.com
- Example:
These parameters allow you to tailor the code generation process to fit your specific needs.
For developers wanting to integrate CAFEX into their workflow:
# Quick API validation in development
from cafex import CafeXAPI
def test_my_endpoint():
response = CafeXAPI().call_request(
method="GET",
url="http://localhost:8080/api/health"
)
assert response.status_code == 200
# Quick UI smoke test
from cafex import CafeXWeb
def test_app_loads():
CafeXWeb().navigate("http://localhost:3000")
assert "My App" in CafeXWeb().get_title()For detailed help and examples:
- Run
cafex helpfor complete CLI documentation - Explore
cafex_sandbox_projectfor working examples - Check the individual package READMEs for advanced features
All commits must be signed with a DCO signature to avoid being flagged by the DCO Bot. This means that your commit log message must contain a line that looks like the following one, with your actual name and email address:
Signed-off-by: John Doe <john.doe@example.com>
Adding the -s flag to your git commit will add that line automatically. You can also add it manually as part of your commit log message or add it afterwards with git commit --amend -s.
See CONTRIBUTING.md for more information
Copyright 2024 QA Automation
Distributed under the Apache License, Version 2.0.
SPDX-License-Identifier: Apache-2.0