BasePage

Модуль base_page содержит базовый класс для работы со страницами.

Класс BasePage предоставляет общие методы для взаимодействия со страницами через Playwright и выполнения API-запросов.

BasePage

Базовый класс для работы со страницами через Playwright.

Содержит общие методы для: - Навигации по страницам - Выполнения API-запросов - Проверок состояния страницы

Source code in pages\base_page.py

class BasePage:
    """Базовый класс для работы со страницами через Playwright.

    Содержит общие методы для:
    - Навигации по страницам
    - Выполнения API-запросов
    - Проверок состояния страницы
    """

    def __init__(self, page: Page) -> None:
        """Инициализирует базовую страницу.

        Args:
            page: Экземпляр страницы Playwright
        """

        self.page = page

    # Действия:
    def current_url(self) -> str:
        """Возвращает текущий URL страницы."""

        return self.page.url

    def open(self, uri: str) -> Optional[Response]:
        """Открывает указанный URI на базовом URL."""

        return self.page.goto(f"{host.get_base_url()}{uri}", wait_until='domcontentloaded')

    def page_reload(self) -> None:
        """Перезагружает текущую страницу."""

        self.page.reload()

    def wait_for_timeout(self, timeout: int) -> None:
        """Ожидает указанное количество миллисекунд."""

        self.page.wait_for_timeout(timeout)

    def get_api_request_context(self) -> APIRequestContext:
        """Возвращает контекст для выполнения API-запросов."""

        return self.page.context.request

    def send_get_api_request(self, uri: str) -> Response:
        """Отправляет GET-запрос к API.

        Args:
            uri: URI для запроса
        """

        api_request_context = self.get_api_request_context()
        token = host.get_access_token()
        headers = {"Accept": "application/json", "Authorization": f"Bearer {token}"}
        response = api_request_context.get(
            f"{host.get_request_url()}{uri}",
            headers=headers
        )
        return response

    def send_post_api_request(self, uri: str, payload: Dict[str, Any]) -> Response:
        """Отправляет POST-запрос к API.

        Args:
            uri: URI для запроса
            payload: Тело запроса
        """

        api_request_context = self.get_api_request_context()
        token = host.get_access_token()
        headers = {"Accept": "application/json", "Authorization": f"Bearer {token}"}
        response = api_request_context.post(
            f"{host.get_request_url()}{uri}",
            headers=headers,
            data=payload
        )
        return response

    def get_response_body(self, response: Response) -> Optional[Dict[str, Any]]:
        """Возвращает тело ответа в формате JSON.

        Args:
            response: Объект ответа
        """

        try:
            response_body = response.json()
        except json.JSONDecodeError:
            logger.error("Failed to decode JSON response")
            return None
        return response_body

    # Проверки:
    def check_URL(self, uri: str, msg: str) -> None:
        """Проверяет соответствие текущего URL ожидаемому.

        Args:
            uri: Ожидаемый URI
            msg: Сообщение об ошибке
        """

        expect(self.page).to_have_url(
            f"{host.get_base_url()}{uri}",
            timeout=60000
        ), msg

    def check_equals(self, actual: Any, expected: Any, msg: str) -> None:
        """Проверяет равенство фактического и ожидаемого значений.

        Args:
            actual: Фактическое значение
            expected: Ожидаемое значение
            msg: Сообщение об ошибке
        """

        assert actual == expected, msg

    def check_lists_equals(self, actual: List[Any], expected: List[Any], msg: str) -> None:
        """Рекурсивно проверяет равенство двух списков.

        Args:
            actual: Фактический список
            expected: Ожидаемый список
            msg: Сообщение об ошибке
        """

        def compare_lists(list1: List[Any], list2: List[Any]) -> bool:
            if len(list1) != len(list2):
                return False
            for item1, item2 in zip(list1, list2):
                if isinstance(item1, list) and isinstance(item2, list):
                    if not compare_lists(item1, item2):
                        return False
                elif item1 != item2:
                    return False
            return True

        assert compare_lists(actual, expected), msg

__init__(page)

Инициализирует базовую страницу.

Parameters:

Name	Type	Description	Default
page	Page	Экземпляр страницы Playwright	required

Source code in pages\base_page.py

def __init__(self, page: Page) -> None:
    """Инициализирует базовую страницу.

    Args:
        page: Экземпляр страницы Playwright
    """

    self.page = page

check_URL(uri, msg)

Проверяет соответствие текущего URL ожидаемому.

Parameters:

Name	Type	Description	Default
uri	str	Ожидаемый URI	required
msg	str	Сообщение об ошибке	required

Source code in pages\base_page.py

def check_URL(self, uri: str, msg: str) -> None:
    """Проверяет соответствие текущего URL ожидаемому.

    Args:
        uri: Ожидаемый URI
        msg: Сообщение об ошибке
    """

    expect(self.page).to_have_url(
        f"{host.get_base_url()}{uri}",
        timeout=60000
    ), msg

check_equals(actual, expected, msg)

Проверяет равенство фактического и ожидаемого значений.

Parameters:

Name	Type	Description	Default
actual	Any	Фактическое значение	required
expected	Any	Ожидаемое значение	required
msg	str	Сообщение об ошибке	required

Source code in pages\base_page.py

def check_equals(self, actual: Any, expected: Any, msg: str) -> None:
    """Проверяет равенство фактического и ожидаемого значений.

    Args:
        actual: Фактическое значение
        expected: Ожидаемое значение
        msg: Сообщение об ошибке
    """

    assert actual == expected, msg

check_lists_equals(actual, expected, msg)

Рекурсивно проверяет равенство двух списков.

Parameters:

Name	Type	Description	Default
actual	List[Any]	Фактический список	required
expected	List[Any]	Ожидаемый список	required
msg	str	Сообщение об ошибке	required

Source code in pages\base_page.py

def check_lists_equals(self, actual: List[Any], expected: List[Any], msg: str) -> None:
    """Рекурсивно проверяет равенство двух списков.

    Args:
        actual: Фактический список
        expected: Ожидаемый список
        msg: Сообщение об ошибке
    """

    def compare_lists(list1: List[Any], list2: List[Any]) -> bool:
        if len(list1) != len(list2):
            return False
        for item1, item2 in zip(list1, list2):
            if isinstance(item1, list) and isinstance(item2, list):
                if not compare_lists(item1, item2):
                    return False
            elif item1 != item2:
                return False
        return True

    assert compare_lists(actual, expected), msg

current_url()

Возвращает текущий URL страницы.

Source code in pages\base_page.py

def current_url(self) -> str:
    """Возвращает текущий URL страницы."""

    return self.page.url

get_api_request_context()

Возвращает контекст для выполнения API-запросов.

Source code in pages\base_page.py

def get_api_request_context(self) -> APIRequestContext:
    """Возвращает контекст для выполнения API-запросов."""

    return self.page.context.request

get_response_body(response)

Возвращает тело ответа в формате JSON.

Parameters:

Name	Type	Description	Default
response	Response	Объект ответа	required

Source code in pages\base_page.py

def get_response_body(self, response: Response) -> Optional[Dict[str, Any]]:
    """Возвращает тело ответа в формате JSON.

    Args:
        response: Объект ответа
    """

    try:
        response_body = response.json()
    except json.JSONDecodeError:
        logger.error("Failed to decode JSON response")
        return None
    return response_body

open(uri)

Открывает указанный URI на базовом URL.

Source code in pages\base_page.py

def open(self, uri: str) -> Optional[Response]:
    """Открывает указанный URI на базовом URL."""

    return self.page.goto(f"{host.get_base_url()}{uri}", wait_until='domcontentloaded')

page_reload()

Перезагружает текущую страницу.

Source code in pages\base_page.py

def page_reload(self) -> None:
    """Перезагружает текущую страницу."""

    self.page.reload()

send_get_api_request(uri)

Отправляет GET-запрос к API.

Parameters:

Name	Type	Description	Default
uri	str	URI для запроса	required

Source code in pages\base_page.py

def send_get_api_request(self, uri: str) -> Response:
    """Отправляет GET-запрос к API.

    Args:
        uri: URI для запроса
    """

    api_request_context = self.get_api_request_context()
    token = host.get_access_token()
    headers = {"Accept": "application/json", "Authorization": f"Bearer {token}"}
    response = api_request_context.get(
        f"{host.get_request_url()}{uri}",
        headers=headers
    )
    return response

send_post_api_request(uri, payload)

Отправляет POST-запрос к API.

Parameters:

Name	Type	Description	Default
uri	str	URI для запроса	required
payload	Dict[str, Any]	Тело запроса	required

Source code in pages\base_page.py

def send_post_api_request(self, uri: str, payload: Dict[str, Any]) -> Response:
    """Отправляет POST-запрос к API.

    Args:
        uri: URI для запроса
        payload: Тело запроса
    """

    api_request_context = self.get_api_request_context()
    token = host.get_access_token()
    headers = {"Accept": "application/json", "Authorization": f"Bearer {token}"}
    response = api_request_context.post(
        f"{host.get_request_url()}{uri}",
        headers=headers,
        data=payload
    )
    return response

wait_for_timeout(timeout)

Ожидает указанное количество миллисекунд.

Source code in pages\base_page.py

def wait_for_timeout(self, timeout: int) -> None:
    """Ожидает указанное количество миллисекунд."""

    self.page.wait_for_timeout(timeout)