# ToolbarComponent - Документация тестов eNODE-Мониторинг

Skip to content

# ToolbarComponent

Модуль компонента тулбара (панели инструментов).

Содержит класс ToolbarComponent для работы с элементами тулбара: - Управление кнопками и их подсказками - Проверка видимости элементов - Взаимодействие с панелью инструментов

## `ToolbarComponent`

Bases: `BaseComponent`

Компонент тулбара. Предоставляет методы для работы с панелью инструментов.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`page` | `Page` | Экземпляр страницы Playwright | required
`title` | `str` | Заголовок тулбара | required

Source code in `components\toolbar_component.py`

     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248

    class ToolbarComponent(BaseComponent):
        """Компонент тулбара. Предоставляет методы для работы с панелью инструментов.

        Args:
            page (Page): Экземпляр страницы Playwright
            title (str): Заголовок тулбара
        """

        # Действия:
        def __init__(self, page: Page, title: str):
            """Инициализирует компонент тулбара с указанным заголовком."""
            super().__init__(page)
            self.title = title
            self.buttons = []

        def add_title(self, title: str) -> None:
            """Устанавливает новый заголовок тулбара.

            Args:
                title (str): Новый заголовок
            """
            self.title = title

        def add_tooltip_button(self, locator: Locator, name: str) -> None:
            """Добавляет кнопку с подсказкой в тулбар.

            Args:
                locator (Locator): Локатор кнопки
                name (str): Уникальное имя кнопки
            """
            self.buttons.append(TooltipButton(self.page, locator, name))

        def add_tab_button(self, locator: Locator, name: str) -> None:
            """Добавляет кнопку типа v-tab в тулбар.

            Args:
                locator (Locator): Локатор кнопки
                name (str): Уникальное имя кнопки
            """
            self.buttons.append(TabButton(self.page, locator, name))

        def add_button(self, locator: Locator, name: str) -> None:
            """Добавляет кнопку в тулбар.

            Args:
                locator (Locator): Локатор кнопки
                name (str): Уникальное имя кнопки
            """
            self.buttons.append(Button(self.page, locator, name))

        def get_button_by_name(self, name: str) -> TooltipButton | TabButton | Button | None:
            """Возвращает кнопку по имени.

            Args:
                name (str): Имя кнопки

            Returns:
                TooltipButton | TabButton | Button | None: Найденная кнопка или None
            """
            for button in self.buttons:
                if button.name == name:
                    return button
            return None

        def click_button(self, name: str) -> None:
            """Кликает по кнопке тулбара.

            Args:
                name (str): Имя кнопки

            Raises:
                AssertionError: Если кнопка не найдена
            """
            button = self.get_button_by_name(name)
            if button is None:
                raise AssertionError(f"Unsupported button name {name}")
            button.click()

        def get_toolbar_title_text(self, locator: str = 'ToolbarLocators.TITLE',
                                  filter_text: str = None, timeout: int = 5000) -> str:
            """Получает заголовок тулбара окна.

            Args:
                locator: Локатор для заголовка тулбара (по умолчанию 'ToolbarLocators.TITLE')
                filter_text: Текст для фильтрации заголовка (опционально)
                timeout: Таймаут ожидания в миллисекундах

            Returns:
                str: Текст заголовка тулбара

            Raises:
                Exception: Если не удалось получить заголовок
            """
            # Получаем локатор заголовка
            title_locator = self.get_locator(locator)

            # Фильтруем по тексту если указан
            if filter_text:
                title_locator = title_locator.filter(has_text=filter_text)

            # Ждем появления заголовка с помощью expect
            expect(title_locator).to_be_visible(timeout=timeout)

            # Получаем текст заголовка
            title_text = title_locator.text_content().strip()
            logger.info("Заголовок тулбара: '%s'", title_text)

            return title_text

        def get_toolbar_composite_title_text(self, locator: str|Locator ,
                                                timeout: int = 5000) -> []:
            """Получает составной заголовок тулбара окна в виде списка подзаголовков.

            Args:
                locator: Локатор для заголовка тулбара
                separator: Разделитель подзаголовков, по умолчанию галочка вправо (chevron_right)
                timeout: Таймаут ожидания в миллисекундах

            Returns:
                str: Текст заголовка тулбара

            Raises:
                Exception: Если не удалось получить заголовок
            """

            toolbar_title_items = []

            # Получаем локатор заголовка
            title_locator = self.get_locator(locator)

            # Ждем появления заголовка с помощью expect
            expect(title_locator).to_be_visible(timeout=timeout)

            # Найти все элементы <li> внутри <ul>
            list_items = title_locator.locator("ul > li")

            # Перебрать элементы и получить текст
            for i in range(list_items.count()):
                item_text = list_items.nth(i).inner_text()
                toolbar_title_items.append(item_text)

            return toolbar_title_items

        # Проверки:
        def is_button_present(self, name: str) -> bool:
            """Проверяет наличие кнопки.

            Args:
                name (str): Имя кнопки

            Returns:
                bool: True если кнопка присутствует

            Raises:
                AssertionError: Если имя кнопки не поддерживается
            """
            button = self.get_button_by_name(name)
            if button is None:
                raise AssertionError(f"Unsupported button name {name}")
            return button.is_present(timeout=1000)  # Ожидание 1 секунда

        def is_button_not_present(self, name: str) -> bool:
            """Проверяет отсутствие кнопки.

            Args:
                name (str): Имя кнопки

            Returns:
                bool: True если кнопка отсутствует

            Raises:
                AssertionError: Если имя кнопки не поддерживается
            """
            button = self.get_button_by_name(name)
            if button is None:
                raise AssertionError(f"Unsupported button name {name}")
            return button.is_not_present(timeout=1000)  # Ожидание 1 секунда

        def check_toolbar_presence(self, message: str) -> None:
            """Проверяет видимость тулбара.

            Args:
                message (str): Сообщение об ошибке если тулбар не виден
            """

            locator = self.get_locator(ToolbarLocators.TITLE).filter(has_text=self.title)
            expect(locator).to_be_visible(), message

        def check_toolbar_presence_by_locator(self, locator: str|Locator, message: str) -> None:
            """Проверяет видимость тулбара.

            Args:
                message (str): Сообщение об ошибке если тулбар не виден
            """

            locator = self.get_locator(locator)
            expect(locator).to_be_visible(), message

        def check_button_visibility(self, name: str) -> None:
            """Проверяет наличие и видимость кнопки с предварительной прокруткой к элементу.

            Args:
                name (str): Имя кнопки

            Raises:
                AssertionError: Если кнопка не найдена или не видна
            """
            button = self.get_button_by_name(name)

            if button is None:
                raise AssertionError(f"Unsupported button name {name}")

            button.locator.scroll_into_view_if_needed()
            button.check_visibility(f"Button with name {name} is missing")

        def check_button_tooltip(self, name: str, tooltip: str) -> None:
            """Проверяет текст подсказки кнопки.

            Args:
                name (str): Имя кнопки
                tooltip (str): Ожидаемый текст подсказки

            Raises:
                AssertionError: Если текст подсказки не совпадает
            """
            button = self.get_button_by_name(name)
            if button is None:
                raise AssertionError(f"Unsupported button name {name}")
            button.check_tooltip_with_text(tooltip)

### `__init__(page, title)`

Инициализирует компонент тулбара с указанным заголовком.

Source code in `components\toolbar_component.py`

    29
    30
    31
    32
    33

    def __init__(self, page: Page, title: str):
        """Инициализирует компонент тулбара с указанным заголовком."""
        super().__init__(page)
        self.title = title
        self.buttons = []

### `add_button(locator, name)`

Добавляет кнопку в тулбар.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`locator` | `Locator` | Локатор кнопки | required
`name` | `str` | Уникальное имя кнопки | required

Source code in `components\toolbar_component.py`

    61
    62
    63
    64
    65
    66
    67
    68

    def add_button(self, locator: Locator, name: str) -> None:
        """Добавляет кнопку в тулбар.

        Args:
            locator (Locator): Локатор кнопки
            name (str): Уникальное имя кнопки
        """
        self.buttons.append(Button(self.page, locator, name))

### `add_tab_button(locator, name)`

Добавляет кнопку типа v-tab в тулбар.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`locator` | `Locator` | Локатор кнопки | required
`name` | `str` | Уникальное имя кнопки | required

Source code in `components\toolbar_component.py`

    52
    53
    54
    55
    56
    57
    58
    59

    def add_tab_button(self, locator: Locator, name: str) -> None:
        """Добавляет кнопку типа v-tab в тулбар.

        Args:
            locator (Locator): Локатор кнопки
            name (str): Уникальное имя кнопки
        """
        self.buttons.append(TabButton(self.page, locator, name))

### `add_title(title)`

Устанавливает новый заголовок тулбара.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`title` | `str` | Новый заголовок | required

Source code in `components\toolbar_component.py`

    35
    36
    37
    38
    39
    40
    41

    def add_title(self, title: str) -> None:
        """Устанавливает новый заголовок тулбара.

        Args:
            title (str): Новый заголовок
        """
        self.title = title

### `add_tooltip_button(locator, name)`

Добавляет кнопку с подсказкой в тулбар.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`locator` | `Locator` | Локатор кнопки | required
`name` | `str` | Уникальное имя кнопки | required

Source code in `components\toolbar_component.py`

    43
    44
    45
    46
    47
    48
    49
    50

    def add_tooltip_button(self, locator: Locator, name: str) -> None:
        """Добавляет кнопку с подсказкой в тулбар.

        Args:
            locator (Locator): Локатор кнопки
            name (str): Уникальное имя кнопки
        """
        self.buttons.append(TooltipButton(self.page, locator, name))

### `check_button_tooltip(name, tooltip)`

Проверяет текст подсказки кнопки.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required
`tooltip` | `str` | Ожидаемый текст подсказки | required

Raises:

Type | Description
--- | ---
`AssertionError` | Если текст подсказки не совпадает

Source code in `components\toolbar_component.py`

    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248

    def check_button_tooltip(self, name: str, tooltip: str) -> None:
        """Проверяет текст подсказки кнопки.

        Args:
            name (str): Имя кнопки
            tooltip (str): Ожидаемый текст подсказки

        Raises:
            AssertionError: Если текст подсказки не совпадает
        """
        button = self.get_button_by_name(name)
        if button is None:
            raise AssertionError(f"Unsupported button name {name}")
        button.check_tooltip_with_text(tooltip)

### `check_button_visibility(name)`

Проверяет наличие и видимость кнопки с предварительной прокруткой к элементу.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required

Raises:

Type | Description
--- | ---
`AssertionError` | Если кнопка не найдена или не видна

Source code in `components\toolbar_component.py`

    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233

    def check_button_visibility(self, name: str) -> None:
        """Проверяет наличие и видимость кнопки с предварительной прокруткой к элементу.

        Args:
            name (str): Имя кнопки

        Raises:
            AssertionError: Если кнопка не найдена или не видна
        """
        button = self.get_button_by_name(name)

        if button is None:
            raise AssertionError(f"Unsupported button name {name}")

        button.locator.scroll_into_view_if_needed()
        button.check_visibility(f"Button with name {name} is missing")

### `check_toolbar_presence(message)`

Проверяет видимость тулбара.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`message` | `str` | Сообщение об ошибке если тулбар не виден | required

Source code in `components\toolbar_component.py`

    198
    199
    200
    201
    202
    203
    204
    205
    206

    def check_toolbar_presence(self, message: str) -> None:
        """Проверяет видимость тулбара.

        Args:
            message (str): Сообщение об ошибке если тулбар не виден
        """

        locator = self.get_locator(ToolbarLocators.TITLE).filter(has_text=self.title)
        expect(locator).to_be_visible(), message

### `check_toolbar_presence_by_locator(locator, message)`

Проверяет видимость тулбара.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`message` | `str` | Сообщение об ошибке если тулбар не виден | required

Source code in `components\toolbar_component.py`

    208
    209
    210
    211
    212
    213
    214
    215
    216

    def check_toolbar_presence_by_locator(self, locator: str|Locator, message: str) -> None:
        """Проверяет видимость тулбара.

        Args:
            message (str): Сообщение об ошибке если тулбар не виден
        """

        locator = self.get_locator(locator)
        expect(locator).to_be_visible(), message

### `click_button(name)`

Кликает по кнопке тулбара.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required

Raises:

Type | Description
--- | ---
`AssertionError` | Если кнопка не найдена

Source code in `components\toolbar_component.py`

    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96

    def click_button(self, name: str) -> None:
        """Кликает по кнопке тулбара.

        Args:
            name (str): Имя кнопки

        Raises:
            AssertionError: Если кнопка не найдена
        """
        button = self.get_button_by_name(name)
        if button is None:
            raise AssertionError(f"Unsupported button name {name}")
        button.click()

### `get_button_by_name(name)`

Возвращает кнопку по имени.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required

Returns:

Type | Description
--- | ---
`TooltipButton | TabButton | Button | None` | TooltipButton | TabButton | Button | None: Найденная кнопка или None

Source code in `components\toolbar_component.py`

    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82

    def get_button_by_name(self, name: str) -> TooltipButton | TabButton | Button | None:
        """Возвращает кнопку по имени.

        Args:
            name (str): Имя кнопки

        Returns:
            TooltipButton | TabButton | Button | None: Найденная кнопка или None
        """
        for button in self.buttons:
            if button.name == name:
                return button
        return None

### `get_toolbar_composite_title_text(locator, timeout=5000)`

Получает составной заголовок тулбара окна в виде списка подзаголовков.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`locator` | `str | Locator` | Локатор для заголовка тулбара | required
`separator` |  | Разделитель подзаголовков, по умолчанию галочка вправо (chevron_right) | required
`timeout` | `int` | Таймаут ожидания в миллисекундах | `5000`

Returns:

Name | Type | Description
--- | --- | ---
`str` | `[]` | Текст заголовка тулбара

Raises:

Type | Description
--- | ---
`Exception` | Если не удалось получить заголовок

Source code in `components\toolbar_component.py`

    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161

    def get_toolbar_composite_title_text(self, locator: str|Locator ,
                                            timeout: int = 5000) -> []:
        """Получает составной заголовок тулбара окна в виде списка подзаголовков.

        Args:
            locator: Локатор для заголовка тулбара
            separator: Разделитель подзаголовков, по умолчанию галочка вправо (chevron_right)
            timeout: Таймаут ожидания в миллисекундах

        Returns:
            str: Текст заголовка тулбара

        Raises:
            Exception: Если не удалось получить заголовок
        """

        toolbar_title_items = []

        # Получаем локатор заголовка
        title_locator = self.get_locator(locator)

        # Ждем появления заголовка с помощью expect
        expect(title_locator).to_be_visible(timeout=timeout)

        # Найти все элементы <li> внутри <ul>
        list_items = title_locator.locator("ul > li")

        # Перебрать элементы и получить текст
        for i in range(list_items.count()):
            item_text = list_items.nth(i).inner_text()
            toolbar_title_items.append(item_text)

        return toolbar_title_items

### `get_toolbar_title_text(locator='ToolbarLocators.TITLE', filter_text=None, timeout=5000)`

Получает заголовок тулбара окна.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`locator` | `str` | Локатор для заголовка тулбара (по умолчанию 'ToolbarLocators.TITLE') | `'ToolbarLocators.TITLE'`
`filter_text` | `str` | Текст для фильтрации заголовка (опционально) | `None`
`timeout` | `int` | Таймаут ожидания в миллисекундах | `5000`

Returns:

Name | Type | Description
--- | --- | ---
`str` | `str` | Текст заголовка тулбара

Raises:

Type | Description
--- | ---
`Exception` | Если не удалось получить заголовок

Source code in `components\toolbar_component.py`

     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127

    def get_toolbar_title_text(self, locator: str = 'ToolbarLocators.TITLE',
                              filter_text: str = None, timeout: int = 5000) -> str:
        """Получает заголовок тулбара окна.

        Args:
            locator: Локатор для заголовка тулбара (по умолчанию 'ToolbarLocators.TITLE')
            filter_text: Текст для фильтрации заголовка (опционально)
            timeout: Таймаут ожидания в миллисекундах

        Returns:
            str: Текст заголовка тулбара

        Raises:
            Exception: Если не удалось получить заголовок
        """
        # Получаем локатор заголовка
        title_locator = self.get_locator(locator)

        # Фильтруем по тексту если указан
        if filter_text:
            title_locator = title_locator.filter(has_text=filter_text)

        # Ждем появления заголовка с помощью expect
        expect(title_locator).to_be_visible(timeout=timeout)

        # Получаем текст заголовка
        title_text = title_locator.text_content().strip()
        logger.info("Заголовок тулбара: '%s'", title_text)

        return title_text

### `is_button_not_present(name)`

Проверяет отсутствие кнопки.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required

Returns:

Name | Type | Description
--- | --- | ---
`bool` | `bool` | True если кнопка отсутствует

Raises:

Type | Description
--- | ---
`AssertionError` | Если имя кнопки не поддерживается

Source code in `components\toolbar_component.py`

    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196

    def is_button_not_present(self, name: str) -> bool:
        """Проверяет отсутствие кнопки.

        Args:
            name (str): Имя кнопки

        Returns:
            bool: True если кнопка отсутствует

        Raises:
            AssertionError: Если имя кнопки не поддерживается
        """
        button = self.get_button_by_name(name)
        if button is None:
            raise AssertionError(f"Unsupported button name {name}")
        return button.is_not_present(timeout=1000)  # Ожидание 1 секунда

### `is_button_present(name)`

Проверяет наличие кнопки.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`name` | `str` | Имя кнопки | required

Returns:

Name | Type | Description
--- | --- | ---
`bool` | `bool` | True если кнопка присутствует

Raises:

Type | Description
--- | ---
`AssertionError` | Если имя кнопки не поддерживается

Source code in `components\toolbar_component.py`

    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179

    def is_button_present(self, name: str) -> bool:
        """Проверяет наличие кнопки.

        Args:
            name (str): Имя кнопки

        Returns:
            bool: True если кнопка присутствует

        Raises:
            AssertionError: Если имя кнопки не поддерживается
        """
        button = self.get_button_by_name(name)
        if button is None:
            raise AssertionError(f"Unsupported button name {name}")
        return button.is_present(timeout=1000)  # Ожидание 1 секунда