Initial commit.

Author: obrizan

.github/workflows/ui-tests.yml

@@ -0,0 +1,57 @@
+name: UI Tests
+
+on:
+  push:
+    branches:
+      - main
+      - initial
+  pull_request:
+  workflow_dispatch:  # Manual trigger
+
+jobs:
+  ui-tests:
+    runs-on: ubuntu-latest
+    services:
+      headless:
+        image: browserless/chrome:latest
+        options: >-
+          --memory=2048m
+        env:
+          CONNECTION_TIMEOUT: "900000" # 15 minutes
+        ports:
+          # Opens tcp port 6379 on the host and service container
+          - 3000:3000
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Set up Python environment
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      # Install dependencies
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      # Set environment variables
+      - name: Set environment variables
+        run: |
+          echo "SELENIUM_DRIVER_KIND=remote" >> $GITHUB_ENV
+          echo "REMOTE_DRIVER_URL=http://127.0.0.1:3000" >> $GITHUB_ENV
+
+      # Run tests
+      - name: Run UI tests
+        run: pytest tests --html=test-reports/report.html --self-contained-html -vvv --junitxml=test-reports/report.xml
+        env:
+          FRONTEND_URL: ${{ vars.FRONTEND_URL }}
+
+      # Upload test reports
+      - name: Upload test reports
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-reports
+          path: test-reports/**

.gitignore

@@ -0,0 +1,4 @@
+.idea
+test-reports/
+__pycache__
+.DS_Store

Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.12-slim
+WORKDIR /app
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+COPY . .
+CMD ["pytest", "tests", "--html=test-reports/report.html", "--self-contained-html", "-vvv"]

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Volodymyr Obrizan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,116 @@
+# Selenium + Python Template Project
+
+Welcome to the Selenium + Python Template Project! This repository provides a well-structured, scalable framework for test automation using Selenium WebDriver and Python. It's designed to help you get started quickly and maintain your test automation efforts efficiently.
+
+---
+
+## 📋 Features
+
+- **Modular Design**: Organized structure with reusable components like PageObjects and Test Data Factories.
+- **Scalability**: Easy to extend for larger projects.
+- **Integration-Ready**: Built-in support for integrating with APIs, CI/CD pipelines, and reporting tools.
+- **Cross-Browser Support**: Pre-configured WebDriver factory for managing multiple browsers.
+
+---
+
+## 🏗️ Project Structure
+
+```plaintext
+selenium_python_template/
+├── .github/workflows/ui-tests.yml      # GitHub Workflow
+├── pages/                              # PageObject classes
+├── tests/                              # Test scripts
+├── utils/                              # Utility functions (e.g. text processing)
+├── data/                               # Test data files (coming soon)
+├── test-reports/                       # Test execution reports
+├── drivers/                            # WebDriver binaries (optional)
+├── config/                             # Configuration files (coming soon)
+├── requirements.txt                    # Python dependencies
+├── bitbucket-pipelines.yml             # BitBucket Pipelines configuration
+└── conftest.py                         # Global fixtures
+```
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+* Python 3.9+
+* Google Chrome or Firefox or Safari to run & debug tests locally
+* pip (Python package installer)
+
+### Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/obrizan/selenium_python_template.git
+cd selenium_python_template
+```
+
+
+Create and activate virutal environment (optional, but recommended):
+
+```bash
+python -m venv .venv
+
+# On Windows:
+.venv\Scripts\activate
+
+# On macOS/Linux:
+source .venv/bin/activate
+```
+
+Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+Set up WebDriver (optionally):
+
+Download the appropriate WebDriver for your browser (ChromeDriver, GeckoDriver, etc.)
+Place it in the drivers/ directory or update your system PATH.
+
+## ⚙️Configuration
+
+Set environment variables:
+
+| Variable             | Description                                                           | Default            |
+|----------------------|-----------------------------------------------------------------------|--------------------|
+| `SELENIUM_DRIVER_KIND` | Options: `remote`, `chrome`, `safari`, `firefox`.                     | `chrome`           |
+| `REMOTE_DRIVER_URL` | Used when `SELENIUM_DRIVER_KIND=remote`. | `http://localhost:3000`               |
+| `WINDOW_RESOLUTION` | Browser window resolution. Values are defined in `webdriver_factory.py` | `DESKTOP_1280X720` |
+
+## 🧪 Running Tests
+Run all tests using pytest:
+
+```bash
+pytest --html=test-reports/report.html --self-contained-html
+```
+
+Specify a particular test file or function:
+
+```bash
+pytest tests/test_example.py
+```
+
+## 🛠️ Customization
+
+* **Adding Pages:** Create new classes in pages/ to represent additional pages or components.
+* **Adding Tests:** Write test scripts in tests/ and use the pytest framework for execution.
+* **Configuration:** Update config/ files to customize browser, test data paths, and other settings.
+
+## 📄 License
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+## 🙌 Contributing
+Contributions are welcome! If you'd like to improve this project, feel free to fork the repository and submit a pull request.
+
+## 📞 Contact
+Have questions or suggestions? Reach out:
+
+**Author:** Volodymyr Obrizan
+
+**Email:** volodymyr.obrizan@gmail.com
+
+Happy Testing! 🚀

bitbucket-pipelines.yml

@@ -0,0 +1,30 @@
+image: python:3.12-slim
+
+definitions:
+  services:
+    headless:
+      image: browserless/chrome:latest
+      variables:
+        # Connection timeout is a parameter that sets how long any session can run for.
+        # This is in place to prevent scripts that don't clean up properly, or run into
+        # errors that cause them to the app froze. The value of which can be set in milliseconds,
+        # and defaults to 30000, or 30 seconds.
+        # https://docs.browserless.io/docs/docker.html#connection-timeout
+        CONNECTION_TIMEOUT: "900000"
+      memory: 2048
+
+pipelines:
+  default:
+    - step:
+        name: UI Tests
+        services:
+          - headless
+        caches:
+          - pip
+        script:
+          - pip install -r requirements.txt
+          - export SELENIUM_DRIVER_KIND=remote
+          - export REMOTE_DRIVER_URL=http://localhost:3000
+          - pytest tests --html=test-reports/report.html --self-contained-html -vvv --junitxml=test-reports/report.xml
+        artifacts:
+          - test-reports/**

conftest.py

@@ -0,0 +1,14 @@
+from typing import Generator
+
+import pytest
+from selenium.webdriver.remote.webdriver import WebDriver
+
+from webdriver_factory import get_driver
+
+
+@pytest.fixture(scope="module")
+def driver() -> Generator[WebDriver, None, None]:
+    """Returns initialized WedDriver instance."""
+    drv = get_driver()
+    yield drv
+    drv.quit()

docker-compose.yml

@@ -0,0 +1,38 @@
+services:
+  tests:
+    build:
+      context: .
+    environment:
+      SELENIUM_DRIVER_KIND: "remote"
+      FRONTEND_URL: ${FRONTEND_URL}
+      REMOTE_DRIVER_URL: "http://remote_driver:3000"
+      # Adjust TZ to your timezone to get correct date/time in test reports.
+      TZ: Europe/Kiev
+    depends_on:
+      - remote_driver
+    networks:
+      - selenium_template_python_network
+    volumes:
+      - test-reports:/app/test-reports
+
+  remote_driver:
+    image: browserless/chrome:latest
+    environment:
+      CONNECTION_TIMEOUT: "900000"
+    ports:
+      - "3000:3000"
+    networks:
+      - selenium_template_python_network
+
+
+networks:
+  selenium_template_python_network:
+    driver: bridge
+
+volumes:
+  test-reports:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: ./test-reports

pages/__init__.py

@@ -0,0 +1,22 @@
+import os
+from abc import abstractmethod, ABC
+
+from selenium.webdriver.remote.webdriver import WebDriver
+
+
+class BasePage(ABC):
+    def __init__(self, driver: WebDriver):
+        self.driver = driver
+
+    @abstractmethod
+    def wait_page_is_present(self) -> None:
+        """Implement in all children classes with an algorithm how to wait for complete page is loaded."""
+        ...
+
+    @abstractmethod
+    def get_relative_url(self) -> str:
+        """Returns relative URL of the current page."""
+        ...
+
+    def open(self) -> None:
+        self.driver.get(os.environ["FRONTEND_URL"] + self.get_relative_url())