feat(EPMGPTBADG-260): autotests framework #1052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

aleksejsobolew wants to merge 41 commits into epam:main from aleksejsobolew:EPMGPTBADG-260-first-taf-draft

test_automation_framework/.flake8

-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    [flake8]
+    max-line-length = 120
+    ignore = E203, W503
+    exclude = .git,__pycache__,build,dist

test_automation_framework/.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    .env
+    __pycache__/
+    *.pyc
+    .vscode/
+    .idea/

test_automation_framework/.pre-commit-config.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    repos:
+      - repo: https://github.com/psf/black
+        rev: 25.1.0
+        hooks:
+          - id: black
+            args: [--line-length=120]
+            language_version: python3
+      - repo: https://github.com/pycqa/flake8
+        rev: 7.3.0
+        hooks:
+          - id: flake8
+            args: [--config=test_automation_framework/.flake8]
+            additional_dependencies: []

test_automation_framework/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,47 @@
+    # BadgerDoc Test Automation Framework
+    This project is a Python-based **test automation framework** built with [pytest](https://docs.pytest.org/).
+    ## Getting Started
+    ### 1. Install PDM
+    Make sure you have [PDM](https://pdm-project.org/latest/#installation) installed:
+    ```bash
+    brew install pdm    # macOS
+    # or
+    pip install pdm
+    ```
+    Verify installation:
+    ```bash
+    pdm --version
+    ```
+    ### 2. Clone the repository
+    ```bash
+    git clone https://github.com/epam/badgerdoc.git
+    cd badgerdoc
+    ```
+    ### 3. Install dependencies
+    ```bash
+    pdm install
+    ```
+    ### 4. Pre-commit hooks
+    Enable pre-commit to enforce style and linting:
+    ```bash
+    pre-commit install
+    ```
+    Now hooks will run automatically before each commit.
+    ### 5. Run tests
+    ```bash
+    pdm run pytest
+    ```

test_automation_framework/config/defaults.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    BASE_URL: "http://demo.badgerdoc.com"
+    BASE_PORT: 8080
+    TIMEOUT_SECONDS: 30
+    MAX_WORKERS: 4
+    USE_MOCK_LLM: true
+    LOG_LEVEL: "INFO"
+    API_USER: "user@example.com"
+    API_PASS: "changeme"

test_automation_framework/conftest.py

-Original file line number
+Diff line change
@@ -0,0 +1,201 @@
+    import logging
+    from logging import getLogger
+    from typing import Tuple
+    from playwright.sync_api import expect
+    import pytest
+    from settings import load_settings
+    from helpers.auth.auth_client import AuthClient
+    from helpers.base_client.base_client import BaseClient
+    from helpers.datasets.dataset_client import DatasetClient
+    from helpers.files.file_client import FileClient
+    from helpers.jobs.jobs_client import JobsClient
+    from helpers.menu.menu_client import MenuClient
+    from helpers.category.categories import CategoriesClient
+    from helpers.users.users import UsersClient
+    from helpers.reports.reports_client import ReportsClient
+    from helpers.plugins.plugins_client import PluginsClient
+    from playwright.sync_api import Page
+    logger = getLogger(__name__)
+    def pytest_configure():
+        logging.basicConfig(level=logging.INFO, format="%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+    @pytest.fixture(scope="session")
+    def settings():
+        return load_settings()
+    @pytest.fixture(scope="session")
+    def tenant(settings) -> str:
+        return getattr(settings, "TENANT", "demo-badgerdoc")
+    @pytest.fixture(scope="session")
+    def base_client(settings) -> BaseClient:
+        client = BaseClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", timeout=10)
+        yield client
+        client.close()
+    @pytest.fixture(scope="session")
+    def auth_service(base_client) -> AuthClient:
+        return AuthClient(base_client)
+    @pytest.fixture(scope="session")
+    def auth_token(auth_service, settings) -> Tuple[str, str]:
+        return auth_service.get_token(settings.API_USER, settings.API_PASS.get_secret_value())
+    @pytest.fixture
+    def access_token(auth_token) -> str:
+        return auth_token[0]
+    @pytest.fixture
+    def menu_client(settings, access_token, tenant) -> MenuClient:
+        return MenuClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def dataset_client(settings, access_token, tenant) -> DatasetClient:
+        return DatasetClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def file_client(settings, access_token, tenant) -> FileClient:
+        return FileClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def jobs_client(settings, access_token, tenant) -> JobsClient:
+        return JobsClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def reports_client(settings, access_token, tenant) -> ReportsClient:
+        return ReportsClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def plugins_client(settings, access_token, tenant) -> PluginsClient:
+        return PluginsClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def user_uuid(settings, access_token, tenant) -> str:
+        users_client = UsersClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+        users = users_client.search_users()
+        return next((u.id for u in users if u.username == "admin"), None)
+    @pytest.fixture
+    def categories_client(settings, access_token, tenant) -> CategoriesClient:
+        return CategoriesClient(f"{settings.BASE_URL}:{settings.BASE_PORT}", access_token, tenant)
+    @pytest.fixture
+    def dataset_tracker(dataset_client):
+        created: list[str] = []
+        yield created, dataset_client
+        for name in created:
+            try:
+                resp = dataset_client.delete_dataset(name=name)
+                logger.info(f"[dataset_tracker] Deleted dataset {name}: {resp.get('detail')}")
+            except Exception as e:
+                logger.warning(f"[dataset_tracker] Failed to delete dataset {name}: {e}")
+    @pytest.fixture
+    def file_tracker(file_client):
+        created_files: list[dict] = []
+        yield created_files, file_client
+        if created_files:
+            ids = [f["id"] for f in created_files if f.get("id") is not None]
+            if ids:
+                try:
+                    result = file_client.delete_files(ids)
+                    logger.info(f"[file_tracker] Deleted files: {ids}, response={result}")
+                except Exception as e:
+                    logger.warning(f"[file_tracker] Failed to cleanup files {ids}: {e}")
+    @pytest.fixture
+    def job_tracker(jobs_client):
+        created: list[dict] = []
+        yield created, jobs_client
+        for job in created:
+            job_id = job.get("id") or job.get("job_id") or (job.get("job") or {}).get("id")
+            if not job_id:
+                continue
+            try:
+                jobs_client.post("/jobs/jobs/cancel", json={"id": job_id}, headers=jobs_client._default_headers())
+                logger.info(f"[job_tracker] Cancelled job {job_id}")
+            except Exception as e:
+                logger.warning(f"[job_tracker] Could not cancel job {job_id}: {e}")
+    @pytest.fixture
+    def plugins_tracker(plugins_client):
+        created: list[int] = []
+        yield created, plugins_client
+        for id in created:
+            try:
+                plugins_client.delete_plugin(plugin_id=id)
+                logger.info(f"[plugins_tracker] Deleted plugin {id}")
+            except Exception as e:
+                logger.warning(f"[plugins_tracker] Failed to delete plugin {id}: {e}")
+    @pytest.fixture
+    def logged_in_page(page: Page, settings) -> Page:
+        page.goto(f"{settings.BASE_URL}:8083/login", timeout=180000)
+        page.get_by_role("textbox", name="Username").fill("admin")
+        page.get_by_role("textbox", name="Password").fill("admin")
+        page.get_by_role("button", name="Login", exact=True).click()
+        items = page.locator("a[class^='document-card-view-item_card-item']")
+        expect(items.first).to_be_visible(timeout=100000)
+        return page
+    @pytest.fixture
+    def plugins_page(logged_in_page, settings) -> Page:
+        page = logged_in_page
+        page.goto(f"{settings.BASE_URL}:8083/settings/plugins")
+        row_cells = page.locator("div[role='row'] div[role='cell']:first-child div div")
+        expect(row_cells.first).to_be_visible(timeout=100000)
+        return page
+    @pytest.fixture
+    def jobs_page(logged_in_page, settings) -> Page:
+        page = logged_in_page
+        page.goto(f"{settings.BASE_URL}:8083/jobs")
+        rows = page.locator("div[role='row']").locator("xpath=..").locator("div[role='row']:not(.uui-table-header-row)")
+        expect(rows.first).to_be_visible(timeout=5000)
+        return page
+    @pytest.fixture
+    def categories_page(logged_in_page, settings) -> Page:
+        page = logged_in_page
+        page.goto(f"{settings.BASE_URL}:8083/categories")
+        rows = page.locator("div[role='row']").locator("xpath=..").locator("div[role='row']:not(.uui-table-header-row)")
+        expect(rows.first).to_be_visible(timeout=5000)
+        return page
+    @pytest.fixture
+    def tasks_page(logged_in_page, settings) -> Page:
+        page = logged_in_page
+        page.goto(f"{settings.BASE_URL}:8083/my tasks")
+        rows = page.locator("div[role='row']").locator("xpath=..").locator("div[role='row']:not(.uui-table-header-row)")
+        expect(rows.first).to_be_visible(timeout=5000)
+        return page

test_automation_framework/helpers/auth/auth_client.py

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    from __future__ import annotations
+    from typing import Optional
+    from pydantic import BaseModel
+    from helpers.base_client.base_client import BaseClient
+    class TokenResponse(BaseModel):
+        access_token: str
+        refresh_token: str
+        id_token: Optional[str] = None
+        scope: Optional[str] = None
+        session_state: Optional[str] = None
+        token_type: Optional[str] = None
+        expires_in: Optional[int] = None
+    class AuthClient:
+        def __init__(self, client: BaseClient) -> None:
+            self.client = client
+        def get_token(self, username: str, password: str, client_id: str = "admin-cli") -> tuple[str, str]:
+            resp = self.client.post_json(
+                "/users/token",
+                data={
+                    "grant_type": "password",
+                    "username": username,
+                    "password": password,
+                    "client_id": client_id,
+                },
+                headers={"Content-Type": "application/x-www-form-urlencoded"},
+            )
+            result = TokenResponse.model_validate(resp)
+            return result.access_token, result.refresh_token
+        def refresh_token(self, refresh_token: str, client_id: str = "admin-cli") -> tuple[str, str]:
+            resp = self.client.post_json(
+                "/users/refresh_token",
+                json={
+                    "grant_type": "refresh_token",
+                    "client_id": client_id,
+                    "refresh_token": refresh_token,
+                },
+            )
+            result = TokenResponse.model_validate(resp)
+            return result.access_token, result.refresh_token

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(EPMGPTBADG-260): autotests framework #1052

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

feat(EPMGPTBADG-260): autotests framework #1052

Are you sure you want to change the base?

Uh oh!

feat(EPMGPTBADG-260): autotests framework #1052

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!