Where Python makes magic…

Python TA Framework Docs

Welcome to the Python Hybrid Test Automation Framework documentation!

This project focuses on testing the UI, front-end, and back-end API of restful-booker web-site: https://automationintesting.online

For more details about the web site that is using for tests please, visit https://www.ministryoftesting.com/.

---

Table of Contents

Project Overview

This section includes high-level information about the project, including framework components, setup instructions, and key features.

Overview

• 1. About this Guide
  • 1.1. The Story
  • 1.2. Scope
  • 1.3. Goals
  • 1.4. Principles
• 2. Readme.md
  • 2.1. Table of contents
  • 2.2. Resources of web app
  • 2.3. Test framework configuration and setup
  • 2.4. Project docs
  • 2.5. Project setup process
  • 2.6. Tests
  • 2.7. Publishing Sphinx doc on GitHub pages
  • 2.8. Resources for TA frameworks
• 3. Framework structure
  • 3.1. Main directories
  • 3.2. Main components
• 4. Project features

Framework Setup

This section contains Instructions for setting up the project, installing dependencies, configuring test environments and running tests.

Setup Guide

• 1. Installation guide
• 2. Environment
  • 2.1. Environment configuration
• 3. Virtual environment
• 4. Running tests

Tests

This section contains details about the UI, API, and backend tests included in the framework. In teh current project used pytest framework approach and all related information about packages, test, some helpful information you can find below.

Test Details

• 1. tests package
  • 1.1. Package contents
  • 1.2. tests.conftest module

Diagrams and Graphs

This section contains visualization of framework components, relationships, and dependencies. Most important part is in core package and here you can find detailed description on how it was built and used in UI/API tests.

Diagrams and Graphs

• Dependency diagrams
  • core package
  • tests
  • utilities
  • resources
• Class relationships
  • api client function relationships
  • classes_ta_framework_ui_api.png
  • packages_ta_framework_ui_api.png
  • packages_core.png
  • packages_core_api.png
  • packages_core_data.png
  • packages_ta_framework_ui_api.png
• API client class representation
• Function and Class Relationships

Additional Notes

This section was created for contributors, guidelines, and troubleshooting.

Contributors and FAQ

• Note for Contributors
• FAQ
  • 1. How do I install all required dependencies for the test automation framework?
  • 2. How can I run the tests using `pytest`?
  • 3. How can I generate a test report using `allure`?
  • 4. What is the purpose of `tox` in the framework?
  • 5. How do I run tests in parallel using `pytest-xdist`?
  • 6. How can I skip tests conditionally?
  • 7. What is the correct way to structure my tests in the framework?
  • 8. How can I rerun failed tests automatically?
  • 9. How can I filter tests by markers or test names?
  • 10. How do I integrate the framework with CI/CD pipelines?

Module Index

Here you can find references on most important python modules (files) that is used in the project.

Python Module Index

• Module Index

Glossary

Glossary

• Glossary

Glossary section contains most important references and terms that are used in the project. My focus was concentrated on basics and building clear and short references for most important entities of the project.