testy-pytest-adapter 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- testy_pytest_adapter-1.0.0/LICENSE +21 -0
- testy_pytest_adapter-1.0.0/PKG-INFO +321 -0
- testy_pytest_adapter-1.0.0/README.md +291 -0
- testy_pytest_adapter-1.0.0/pyproject.toml +46 -0
- testy_pytest_adapter-1.0.0/setup.cfg +4 -0
- testy_pytest_adapter-1.0.0/testy.py +3 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/__init__.py +9 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/allure_meta.py +49 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/attachments.py +19 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/client.py +558 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/config.py +152 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/matcher.py +14 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/models.py +32 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/plugin.py +289 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter/step_capture.py +77 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/PKG-INFO +321 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/SOURCES.txt +19 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/dependency_links.txt +1 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/entry_points.txt +2 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/requires.txt +6 -0
- testy_pytest_adapter-1.0.0/testy_pytest_adapter.egg-info/top_level.txt +2 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Igor Safronov
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,321 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: testy-pytest-adapter
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Pytest plugin for sync Tests with TestY TMS
|
|
5
|
+
Author: Igor Safronov
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/TheGreatPepix/testy-pytest-adapter
|
|
8
|
+
Project-URL: Repository, https://github.com/TheGreatPepix/testy-pytest-adapter
|
|
9
|
+
Keywords: pytest,testy,tms,test-management,allure,reporting
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: Framework :: Pytest
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Topic :: Software Development :: Testing
|
|
20
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: pytest>=7
|
|
25
|
+
Requires-Dist: requests>=2.28
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: responses>=0.25; extra == "dev"
|
|
28
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
29
|
+
Dynamic: license-file
|
|
30
|
+
|
|
31
|
+
# testy-pytest-adapter
|
|
32
|
+
|
|
33
|
+
Pytest-плагин, который после прогона отправляет результаты автотестов в **TestY TMS**:
|
|
34
|
+
в нужный тест-план, рядом с ручными тестами, с историей запусков и связкой «кейс ↔ автотест».
|
|
35
|
+
|
|
36
|
+
## Зачем это нужно
|
|
37
|
+
|
|
38
|
+
Обычно автотесты и TMS живут отдельно. Результаты остаются в Allure или JUnit, каждый новый
|
|
39
|
+
прогон перетирает предыдущий, а статусы в TMS приходится обновлять руками.
|
|
40
|
+
|
|
41
|
+
Этот адаптер решает эту проблему:
|
|
42
|
+
|
|
43
|
+
- сопоставляет pytest-тест с тест-кейсом в TestY и отправляет результат
|
|
44
|
+
(`passed`, `failed`, `skipped`, `broken`) с комментарием и трейсбеком;
|
|
45
|
+
- записывает результаты в конкретный тест-план и сохраняет историю прогонов;
|
|
46
|
+
- может создавать недостающие кейсы, наборы и планы из кода по разметке Allure;
|
|
47
|
+
- добавляет к результату логи и ссылки на CI-джобу.
|
|
48
|
+
|
|
49
|
+
Это именно мост между автотестами и TMS, а не замена Allure. Allure по-прежнему можно
|
|
50
|
+
использовать для подробного разбора прогона.
|
|
51
|
+
|
|
52
|
+
## Установка
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pip install testy-pytest-adapter
|
|
56
|
+
````
|
|
57
|
+
|
|
58
|
+
Плагин подхватывается pytest автоматически. Пока не передан флаг `--testy`
|
|
59
|
+
или не включён `TESTY_ENABLED` / `testy_enabled`, он ничего не делает.
|
|
60
|
+
|
|
61
|
+
## Быстрый старт
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pytest --testy \
|
|
65
|
+
--testy-url="https://testy.example.com" \
|
|
66
|
+
--testy-token="$TESTY_TOKEN" \
|
|
67
|
+
--testy-project=1 \
|
|
68
|
+
--testy-root-name="Autotests"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
После прогона адаптер найдёт подходящие кейсы и запишет результаты в план `1234`.
|
|
72
|
+
|
|
73
|
+
## Как сопоставляются тест и кейс
|
|
74
|
+
|
|
75
|
+
Адаптер берёт стабильный идентификатор теста из pytest **nodeid**.
|
|
76
|
+
По умолчанию суффикс параметризации `[...]` отрезается.
|
|
77
|
+
|
|
78
|
+
Пример nodeid:
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
tests/api/login_test.py::TestLogin::test_login
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Дальше адаптер ищет кейс, у которого в атрибутах есть `automation_id` с таким же значением:
|
|
85
|
+
|
|
86
|
+
```text
|
|
87
|
+
cases/?case_attributes={"automation_id":"..."}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
То есть id кейса в коде прописывать не нужно. Достаточно, чтобы у кейса в TestY был атрибут
|
|
91
|
+
`automation_id` с nodeid теста.
|
|
92
|
+
|
|
93
|
+
Заполнить этот атрибут можно вручную или автоматически через `--testy-sync`.
|
|
94
|
+
Название ключа настраивается через `testy_automation_key`.
|
|
95
|
+
|
|
96
|
+
## Конфигурация
|
|
97
|
+
|
|
98
|
+
Значения берутся в таком порядке:
|
|
99
|
+
|
|
100
|
+
```text
|
|
101
|
+
CLI → переменные окружения → pytest.ini → дефолт
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Токен намеренно не читается из `pytest.ini`. Его лучше передавать через переменную окружения
|
|
105
|
+
или CLI:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
--testy-token / TESTY_TOKEN
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Несекретные настройки удобно хранить в `pytest.ini` или в `[tool.pytest.ini_options]`
|
|
112
|
+
в `pyproject.toml`.
|
|
113
|
+
|
|
114
|
+
```ini
|
|
115
|
+
[pytest]
|
|
116
|
+
testy_enabled = true
|
|
117
|
+
testy_url = https://testy.example.com
|
|
118
|
+
testy_project_id = 4
|
|
119
|
+
testy_root_name = Autotests
|
|
120
|
+
|
|
121
|
+
; самоподписанный сертификат на стенде:
|
|
122
|
+
testy_insecure = true
|
|
123
|
+
|
|
124
|
+
; имена статусов в проекте могут быть локализованы:
|
|
125
|
+
testy_status_passed = Пройден
|
|
126
|
+
testy_status_failed = Провален
|
|
127
|
+
testy_status_skipped = Пропущен
|
|
128
|
+
testy_status_broken = Сломан
|
|
129
|
+
testy_status_untested = Untested
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Тогда для запуска достаточно передать токен через окружение:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
TESTY_TOKEN=... pytest --testy --testy-root-name=Autotests
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Основные опции
|
|
139
|
+
|
|
140
|
+
| CLI | Переменная окружения | pytest.ini | Назначение |
|
|
141
|
+
| ------------------- | ----------------------------------------- | ---------------------- |--------------------------------------------------------------------|
|
|
142
|
+
| `--testy` | `TESTY_ENABLED` | `testy_enabled` | включить отправку в TestY |
|
|
143
|
+
| `--testy-url` | `TESTY_URL` | `testy_url` | базовый адрес TestY |
|
|
144
|
+
| `--testy-token` | `TESTY_TOKEN` | - | токен доступа |
|
|
145
|
+
| `--testy-project` | `TESTY_PROJECT_ID` | `testy_project_id` | id проекта |
|
|
146
|
+
| `--testy-plan` | `TESTY_PLAN_ID` | `testy_plan_id` | id корневого тест-плана |
|
|
147
|
+
| `--testy-root-name` | `TESTY_ROOT_NAME` | `testy_root_name` | имя корня, если план нужно найти или создать по имени |
|
|
148
|
+
| `--testy-suite` | `TESTY_SUITE_ID` | `testy_suite_id` | корневой набор для автосоздания кейсов |
|
|
149
|
+
| `--testy-sync` | - | - | создать кейсы и структуру перед прогоном |
|
|
150
|
+
| - | `TESTY_AUTOMATION_KEY` | `testy_automation_key` | ключ атрибута для матчинга, по умолчанию `automation_id` |
|
|
151
|
+
| - | `TESTY_KEEP_PARAMS` | `testy_keep_params` | не срезать `[param]`, каждая параметризация будет отдельным кейсом |
|
|
152
|
+
| - | `TESTY_OVERRIDE_CASES` | `testy_override_cases` | перезаписывать шаги существующего кейса, по умолчанию `true` |
|
|
153
|
+
| - | `TESTY_ATTACH` | `testy_attach` | когда загружать вложения: `failure`, `always`, `never` |
|
|
154
|
+
| - | `TESTY_AUTH_SCHEME` | `testy_auth_scheme` | схема авторизации: `Token` или `Bearer` |
|
|
155
|
+
| - | `TESTY_INSECURE` | `testy_insecure` | отключить проверку TLS-сертификата |
|
|
156
|
+
| - | `TESTY_STATUS_PASSED` и остальные статусы | `testy_status_*` | реальные имена статусов проекта |
|
|
157
|
+
|
|
158
|
+
## Авторизация и статусы
|
|
159
|
+
|
|
160
|
+
Для авторизации используется TTL-токен из TestY:
|
|
161
|
+
|
|
162
|
+
```text
|
|
163
|
+
POST /api/token/obtain/
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Имена статусов в TestY могут отличаться от стандартных. Например, в проекте они могут
|
|
167
|
+
называться `Пройден`, `Провален`, `Пропущен`.
|
|
168
|
+
|
|
169
|
+
Адаптер сначала приводит результат pytest к одному из канонических статусов:
|
|
170
|
+
|
|
171
|
+
```text
|
|
172
|
+
Passed / Failed / Skipped / Broken / Untested
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Затем эти статусы можно замапить на реальные имена проекта:
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
TESTY_STATUS_PASSED=Пройден
|
|
179
|
+
TESTY_STATUS_FAILED=Провален
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Или задать их в `pytest.ini`:
|
|
183
|
+
|
|
184
|
+
```ini
|
|
185
|
+
testy_status_passed = Пройден
|
|
186
|
+
testy_status_failed = Провален
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## Автосоздание кейсов и структуры
|
|
190
|
+
|
|
191
|
+
Чтобы не заполнять `automation_id` вручную, можно запустить отдельный sync-шаг.
|
|
192
|
+
Он создаст недостающие кейсы и добавит их в план.
|
|
193
|
+
|
|
194
|
+
Тесты при этом не выполняются, запуск идёт через `--collect-only`:
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
pytest --collect-only --testy --testy-sync \
|
|
198
|
+
--testy-root-name=Autotests \
|
|
199
|
+
--testy-url="$TESTY_URL" \
|
|
200
|
+
--testy-token="$TESTY_TOKEN" \
|
|
201
|
+
--testy-project=4
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Дерево суитов и тест-планов в TestY строится из разметки Allure:
|
|
205
|
+
|
|
206
|
+
| Allure в коде | В TestY |
|
|
207
|
+
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
|
208
|
+
| `@allure.parent_suite("API")` / `@allure.suite("/api/login")` / `@allure.sub_suite(...)` | вложенное дерево `TestSuite` и `TestPlan` под корнем |
|
|
209
|
+
| `@allure.title("GET /api/login")` | имя `TestCase` |
|
|
210
|
+
|
|
211
|
+
Без Allure тоже работает. Allure не обязателен и даже не должен быть установлен.
|
|
212
|
+
|
|
213
|
+
Если у теста нет `@allure.title`, имя кейса берётся из имени pytest-теста:
|
|
214
|
+
|
|
215
|
+
```text
|
|
216
|
+
test_login
|
|
217
|
+
test_login[case1]
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
Если нет `@allure.suite`, `@allure.parent_suite` или `@allure.sub_suite`, дерево не строится.
|
|
221
|
+
Кейсы создаются плоско под корнем, который задан через `--testy-suite` или `--testy-root-name`.
|
|
222
|
+
|
|
223
|
+
Матчинг при этом всё равно работает по nodeid → `automation_id`.
|
|
224
|
+
Allure нужен только для более читаемых имён и структуры.
|
|
225
|
+
|
|
226
|
+
Sync идемпотентный: повторный запуск находит уже созданные сущности и не плодит дубли.
|
|
227
|
+
Лучше запускать его отдельным шагом, без xdist-воркеров, а уже после этого запускать обычный прогон
|
|
228
|
+
с отправкой результатов.
|
|
229
|
+
|
|
230
|
+
## Доказательства падений: вложения и ссылки
|
|
231
|
+
|
|
232
|
+
```python
|
|
233
|
+
import testy
|
|
234
|
+
|
|
235
|
+
def test_login(page):
|
|
236
|
+
page.screenshot(path="fail.png")
|
|
237
|
+
testy.attach("fail.png")
|
|
238
|
+
...
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Когда загружать вложения, задаётся через `TESTY_ATTACH`:
|
|
242
|
+
|
|
243
|
+
```text
|
|
244
|
+
failure / always / never
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
По умолчанию используется `failure`, то есть вложения отправляются только на падениях.
|
|
248
|
+
|
|
249
|
+
Также адаптер сохраняет в атрибутах результата ссылки из GitLab CI:
|
|
250
|
+
|
|
251
|
+
```text
|
|
252
|
+
CI_PIPELINE_URL
|
|
253
|
+
CI_JOB_URL
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Шаги Allure
|
|
257
|
+
|
|
258
|
+
Если установлен `allure-pytest`, адаптер забирает дерево выполненных `allure.step`
|
|
259
|
+
и синхронизирует его в кейс как структурные шаги.
|
|
260
|
+
|
|
261
|
+
Перезапись шагов существующего кейса управляется настройкой:
|
|
262
|
+
|
|
263
|
+
```text
|
|
264
|
+
testy_override_cases
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
По умолчанию значение `true`: кейсы поддерживаются в актуальном состоянии относительно кода.
|
|
268
|
+
|
|
269
|
+
Если Allure не установлен, этот механизм просто не используется.
|
|
270
|
+
|
|
271
|
+
## Параметризованные тесты
|
|
272
|
+
|
|
273
|
+
По умолчанию все варианты одного параметризованного теста схлопываются в один кейс.
|
|
274
|
+
Суффикс параметризации `[...]` отрезается.
|
|
275
|
+
|
|
276
|
+
Итоговый статус выбирается как худший из всех вариантов. Например, если один вариант упал,
|
|
277
|
+
весь кейс будет отмечен как `failed`. В комментарий добавляется краткая сводка.
|
|
278
|
+
|
|
279
|
+
Если нужно, чтобы каждый параметр стал отдельным кейсом, включите:
|
|
280
|
+
|
|
281
|
+
```bash
|
|
282
|
+
TESTY_KEEP_PARAMS=1
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## Пример для GitLab CI
|
|
286
|
+
|
|
287
|
+
```yaml
|
|
288
|
+
testy_run:
|
|
289
|
+
stage: test
|
|
290
|
+
rules:
|
|
291
|
+
- if: '$CI_PIPELINE_SOURCE == "trigger" && $TESTY_PLAN_ID'
|
|
292
|
+
script:
|
|
293
|
+
- pip install -r requirements.txt testy-pytest-adapter
|
|
294
|
+
- >
|
|
295
|
+
pytest -v
|
|
296
|
+
--testy
|
|
297
|
+
--testy-url="$TESTY_URL"
|
|
298
|
+
--testy-token="$TESTY_TOKEN"
|
|
299
|
+
--testy-project="$TESTY_PROJECT_ID"
|
|
300
|
+
--testy-plan="$TESTY_PLAN_ID"
|
|
301
|
+
--alluredir=./allure-results
|
|
302
|
+
tests
|
|
303
|
+
artifacts:
|
|
304
|
+
when: always
|
|
305
|
+
paths:
|
|
306
|
+
- ./allure-results
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
`TESTY_*` удобно передавать как переменные пайплайна.
|
|
310
|
+
`TESTY_TOKEN` лучше хранить как masked CI/CD-переменную репозитория.
|
|
311
|
+
|
|
312
|
+
## Поведение и гарантии
|
|
313
|
+
|
|
314
|
+
* Ошибки отправки результатов только логируются.
|
|
315
|
+
* Прогон тестов не падает из-за проблем с TestY.
|
|
316
|
+
* При запуске через `pytest-xdist` воркеры собирают результаты, а запись в TestY выполняет
|
|
317
|
+
только контроллер в конце прогона.
|
|
318
|
+
|
|
319
|
+
## Лицензия
|
|
320
|
+
|
|
321
|
+
MIT - см. файл [`LICENSE`](./LICENSE).
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
# testy-pytest-adapter
|
|
2
|
+
|
|
3
|
+
Pytest-плагин, который после прогона отправляет результаты автотестов в **TestY TMS**:
|
|
4
|
+
в нужный тест-план, рядом с ручными тестами, с историей запусков и связкой «кейс ↔ автотест».
|
|
5
|
+
|
|
6
|
+
## Зачем это нужно
|
|
7
|
+
|
|
8
|
+
Обычно автотесты и TMS живут отдельно. Результаты остаются в Allure или JUnit, каждый новый
|
|
9
|
+
прогон перетирает предыдущий, а статусы в TMS приходится обновлять руками.
|
|
10
|
+
|
|
11
|
+
Этот адаптер решает эту проблему:
|
|
12
|
+
|
|
13
|
+
- сопоставляет pytest-тест с тест-кейсом в TestY и отправляет результат
|
|
14
|
+
(`passed`, `failed`, `skipped`, `broken`) с комментарием и трейсбеком;
|
|
15
|
+
- записывает результаты в конкретный тест-план и сохраняет историю прогонов;
|
|
16
|
+
- может создавать недостающие кейсы, наборы и планы из кода по разметке Allure;
|
|
17
|
+
- добавляет к результату логи и ссылки на CI-джобу.
|
|
18
|
+
|
|
19
|
+
Это именно мост между автотестами и TMS, а не замена Allure. Allure по-прежнему можно
|
|
20
|
+
использовать для подробного разбора прогона.
|
|
21
|
+
|
|
22
|
+
## Установка
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
pip install testy-pytest-adapter
|
|
26
|
+
````
|
|
27
|
+
|
|
28
|
+
Плагин подхватывается pytest автоматически. Пока не передан флаг `--testy`
|
|
29
|
+
или не включён `TESTY_ENABLED` / `testy_enabled`, он ничего не делает.
|
|
30
|
+
|
|
31
|
+
## Быстрый старт
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
pytest --testy \
|
|
35
|
+
--testy-url="https://testy.example.com" \
|
|
36
|
+
--testy-token="$TESTY_TOKEN" \
|
|
37
|
+
--testy-project=1 \
|
|
38
|
+
--testy-root-name="Autotests"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
После прогона адаптер найдёт подходящие кейсы и запишет результаты в план `1234`.
|
|
42
|
+
|
|
43
|
+
## Как сопоставляются тест и кейс
|
|
44
|
+
|
|
45
|
+
Адаптер берёт стабильный идентификатор теста из pytest **nodeid**.
|
|
46
|
+
По умолчанию суффикс параметризации `[...]` отрезается.
|
|
47
|
+
|
|
48
|
+
Пример nodeid:
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
tests/api/login_test.py::TestLogin::test_login
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Дальше адаптер ищет кейс, у которого в атрибутах есть `automation_id` с таким же значением:
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
cases/?case_attributes={"automation_id":"..."}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
То есть id кейса в коде прописывать не нужно. Достаточно, чтобы у кейса в TestY был атрибут
|
|
61
|
+
`automation_id` с nodeid теста.
|
|
62
|
+
|
|
63
|
+
Заполнить этот атрибут можно вручную или автоматически через `--testy-sync`.
|
|
64
|
+
Название ключа настраивается через `testy_automation_key`.
|
|
65
|
+
|
|
66
|
+
## Конфигурация
|
|
67
|
+
|
|
68
|
+
Значения берутся в таком порядке:
|
|
69
|
+
|
|
70
|
+
```text
|
|
71
|
+
CLI → переменные окружения → pytest.ini → дефолт
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Токен намеренно не читается из `pytest.ini`. Его лучше передавать через переменную окружения
|
|
75
|
+
или CLI:
|
|
76
|
+
|
|
77
|
+
```text
|
|
78
|
+
--testy-token / TESTY_TOKEN
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Несекретные настройки удобно хранить в `pytest.ini` или в `[tool.pytest.ini_options]`
|
|
82
|
+
в `pyproject.toml`.
|
|
83
|
+
|
|
84
|
+
```ini
|
|
85
|
+
[pytest]
|
|
86
|
+
testy_enabled = true
|
|
87
|
+
testy_url = https://testy.example.com
|
|
88
|
+
testy_project_id = 4
|
|
89
|
+
testy_root_name = Autotests
|
|
90
|
+
|
|
91
|
+
; самоподписанный сертификат на стенде:
|
|
92
|
+
testy_insecure = true
|
|
93
|
+
|
|
94
|
+
; имена статусов в проекте могут быть локализованы:
|
|
95
|
+
testy_status_passed = Пройден
|
|
96
|
+
testy_status_failed = Провален
|
|
97
|
+
testy_status_skipped = Пропущен
|
|
98
|
+
testy_status_broken = Сломан
|
|
99
|
+
testy_status_untested = Untested
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Тогда для запуска достаточно передать токен через окружение:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
TESTY_TOKEN=... pytest --testy --testy-root-name=Autotests
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Основные опции
|
|
109
|
+
|
|
110
|
+
| CLI | Переменная окружения | pytest.ini | Назначение |
|
|
111
|
+
| ------------------- | ----------------------------------------- | ---------------------- |--------------------------------------------------------------------|
|
|
112
|
+
| `--testy` | `TESTY_ENABLED` | `testy_enabled` | включить отправку в TestY |
|
|
113
|
+
| `--testy-url` | `TESTY_URL` | `testy_url` | базовый адрес TestY |
|
|
114
|
+
| `--testy-token` | `TESTY_TOKEN` | - | токен доступа |
|
|
115
|
+
| `--testy-project` | `TESTY_PROJECT_ID` | `testy_project_id` | id проекта |
|
|
116
|
+
| `--testy-plan` | `TESTY_PLAN_ID` | `testy_plan_id` | id корневого тест-плана |
|
|
117
|
+
| `--testy-root-name` | `TESTY_ROOT_NAME` | `testy_root_name` | имя корня, если план нужно найти или создать по имени |
|
|
118
|
+
| `--testy-suite` | `TESTY_SUITE_ID` | `testy_suite_id` | корневой набор для автосоздания кейсов |
|
|
119
|
+
| `--testy-sync` | - | - | создать кейсы и структуру перед прогоном |
|
|
120
|
+
| - | `TESTY_AUTOMATION_KEY` | `testy_automation_key` | ключ атрибута для матчинга, по умолчанию `automation_id` |
|
|
121
|
+
| - | `TESTY_KEEP_PARAMS` | `testy_keep_params` | не срезать `[param]`, каждая параметризация будет отдельным кейсом |
|
|
122
|
+
| - | `TESTY_OVERRIDE_CASES` | `testy_override_cases` | перезаписывать шаги существующего кейса, по умолчанию `true` |
|
|
123
|
+
| - | `TESTY_ATTACH` | `testy_attach` | когда загружать вложения: `failure`, `always`, `never` |
|
|
124
|
+
| - | `TESTY_AUTH_SCHEME` | `testy_auth_scheme` | схема авторизации: `Token` или `Bearer` |
|
|
125
|
+
| - | `TESTY_INSECURE` | `testy_insecure` | отключить проверку TLS-сертификата |
|
|
126
|
+
| - | `TESTY_STATUS_PASSED` и остальные статусы | `testy_status_*` | реальные имена статусов проекта |
|
|
127
|
+
|
|
128
|
+
## Авторизация и статусы
|
|
129
|
+
|
|
130
|
+
Для авторизации используется TTL-токен из TestY:
|
|
131
|
+
|
|
132
|
+
```text
|
|
133
|
+
POST /api/token/obtain/
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
Имена статусов в TestY могут отличаться от стандартных. Например, в проекте они могут
|
|
137
|
+
называться `Пройден`, `Провален`, `Пропущен`.
|
|
138
|
+
|
|
139
|
+
Адаптер сначала приводит результат pytest к одному из канонических статусов:
|
|
140
|
+
|
|
141
|
+
```text
|
|
142
|
+
Passed / Failed / Skipped / Broken / Untested
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Затем эти статусы можно замапить на реальные имена проекта:
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
TESTY_STATUS_PASSED=Пройден
|
|
149
|
+
TESTY_STATUS_FAILED=Провален
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Или задать их в `pytest.ini`:
|
|
153
|
+
|
|
154
|
+
```ini
|
|
155
|
+
testy_status_passed = Пройден
|
|
156
|
+
testy_status_failed = Провален
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Автосоздание кейсов и структуры
|
|
160
|
+
|
|
161
|
+
Чтобы не заполнять `automation_id` вручную, можно запустить отдельный sync-шаг.
|
|
162
|
+
Он создаст недостающие кейсы и добавит их в план.
|
|
163
|
+
|
|
164
|
+
Тесты при этом не выполняются, запуск идёт через `--collect-only`:
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
pytest --collect-only --testy --testy-sync \
|
|
168
|
+
--testy-root-name=Autotests \
|
|
169
|
+
--testy-url="$TESTY_URL" \
|
|
170
|
+
--testy-token="$TESTY_TOKEN" \
|
|
171
|
+
--testy-project=4
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Дерево суитов и тест-планов в TestY строится из разметки Allure:
|
|
175
|
+
|
|
176
|
+
| Allure в коде | В TestY |
|
|
177
|
+
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
|
178
|
+
| `@allure.parent_suite("API")` / `@allure.suite("/api/login")` / `@allure.sub_suite(...)` | вложенное дерево `TestSuite` и `TestPlan` под корнем |
|
|
179
|
+
| `@allure.title("GET /api/login")` | имя `TestCase` |
|
|
180
|
+
|
|
181
|
+
Без Allure тоже работает. Allure не обязателен и даже не должен быть установлен.
|
|
182
|
+
|
|
183
|
+
Если у теста нет `@allure.title`, имя кейса берётся из имени pytest-теста:
|
|
184
|
+
|
|
185
|
+
```text
|
|
186
|
+
test_login
|
|
187
|
+
test_login[case1]
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
Если нет `@allure.suite`, `@allure.parent_suite` или `@allure.sub_suite`, дерево не строится.
|
|
191
|
+
Кейсы создаются плоско под корнем, который задан через `--testy-suite` или `--testy-root-name`.
|
|
192
|
+
|
|
193
|
+
Матчинг при этом всё равно работает по nodeid → `automation_id`.
|
|
194
|
+
Allure нужен только для более читаемых имён и структуры.
|
|
195
|
+
|
|
196
|
+
Sync идемпотентный: повторный запуск находит уже созданные сущности и не плодит дубли.
|
|
197
|
+
Лучше запускать его отдельным шагом, без xdist-воркеров, а уже после этого запускать обычный прогон
|
|
198
|
+
с отправкой результатов.
|
|
199
|
+
|
|
200
|
+
## Доказательства падений: вложения и ссылки
|
|
201
|
+
|
|
202
|
+
```python
|
|
203
|
+
import testy
|
|
204
|
+
|
|
205
|
+
def test_login(page):
|
|
206
|
+
page.screenshot(path="fail.png")
|
|
207
|
+
testy.attach("fail.png")
|
|
208
|
+
...
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Когда загружать вложения, задаётся через `TESTY_ATTACH`:
|
|
212
|
+
|
|
213
|
+
```text
|
|
214
|
+
failure / always / never
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
По умолчанию используется `failure`, то есть вложения отправляются только на падениях.
|
|
218
|
+
|
|
219
|
+
Также адаптер сохраняет в атрибутах результата ссылки из GitLab CI:
|
|
220
|
+
|
|
221
|
+
```text
|
|
222
|
+
CI_PIPELINE_URL
|
|
223
|
+
CI_JOB_URL
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Шаги Allure
|
|
227
|
+
|
|
228
|
+
Если установлен `allure-pytest`, адаптер забирает дерево выполненных `allure.step`
|
|
229
|
+
и синхронизирует его в кейс как структурные шаги.
|
|
230
|
+
|
|
231
|
+
Перезапись шагов существующего кейса управляется настройкой:
|
|
232
|
+
|
|
233
|
+
```text
|
|
234
|
+
testy_override_cases
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
По умолчанию значение `true`: кейсы поддерживаются в актуальном состоянии относительно кода.
|
|
238
|
+
|
|
239
|
+
Если Allure не установлен, этот механизм просто не используется.
|
|
240
|
+
|
|
241
|
+
## Параметризованные тесты
|
|
242
|
+
|
|
243
|
+
По умолчанию все варианты одного параметризованного теста схлопываются в один кейс.
|
|
244
|
+
Суффикс параметризации `[...]` отрезается.
|
|
245
|
+
|
|
246
|
+
Итоговый статус выбирается как худший из всех вариантов. Например, если один вариант упал,
|
|
247
|
+
весь кейс будет отмечен как `failed`. В комментарий добавляется краткая сводка.
|
|
248
|
+
|
|
249
|
+
Если нужно, чтобы каждый параметр стал отдельным кейсом, включите:
|
|
250
|
+
|
|
251
|
+
```bash
|
|
252
|
+
TESTY_KEEP_PARAMS=1
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
## Пример для GitLab CI
|
|
256
|
+
|
|
257
|
+
```yaml
|
|
258
|
+
testy_run:
|
|
259
|
+
stage: test
|
|
260
|
+
rules:
|
|
261
|
+
- if: '$CI_PIPELINE_SOURCE == "trigger" && $TESTY_PLAN_ID'
|
|
262
|
+
script:
|
|
263
|
+
- pip install -r requirements.txt testy-pytest-adapter
|
|
264
|
+
- >
|
|
265
|
+
pytest -v
|
|
266
|
+
--testy
|
|
267
|
+
--testy-url="$TESTY_URL"
|
|
268
|
+
--testy-token="$TESTY_TOKEN"
|
|
269
|
+
--testy-project="$TESTY_PROJECT_ID"
|
|
270
|
+
--testy-plan="$TESTY_PLAN_ID"
|
|
271
|
+
--alluredir=./allure-results
|
|
272
|
+
tests
|
|
273
|
+
artifacts:
|
|
274
|
+
when: always
|
|
275
|
+
paths:
|
|
276
|
+
- ./allure-results
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
`TESTY_*` удобно передавать как переменные пайплайна.
|
|
280
|
+
`TESTY_TOKEN` лучше хранить как masked CI/CD-переменную репозитория.
|
|
281
|
+
|
|
282
|
+
## Поведение и гарантии
|
|
283
|
+
|
|
284
|
+
* Ошибки отправки результатов только логируются.
|
|
285
|
+
* Прогон тестов не падает из-за проблем с TestY.
|
|
286
|
+
* При запуске через `pytest-xdist` воркеры собирают результаты, а запись в TestY выполняет
|
|
287
|
+
только контроллер в конце прогона.
|
|
288
|
+
|
|
289
|
+
## Лицензия
|
|
290
|
+
|
|
291
|
+
MIT - см. файл [`LICENSE`](./LICENSE).
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "testy-pytest-adapter"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
description = "Pytest plugin for sync Tests with TestY TMS"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = { text = "MIT" }
|
|
12
|
+
authors = [{ name = "Igor Safronov" }]
|
|
13
|
+
keywords = ["pytest", "testy", "tms", "test-management", "allure", "reporting"]
|
|
14
|
+
dependencies = [
|
|
15
|
+
"pytest>=7",
|
|
16
|
+
"requests>=2.28",
|
|
17
|
+
]
|
|
18
|
+
classifiers = [
|
|
19
|
+
"Development Status :: 5 - Production/Stable",
|
|
20
|
+
"Framework :: Pytest",
|
|
21
|
+
"Intended Audience :: Developers",
|
|
22
|
+
"License :: OSI Approved :: MIT License",
|
|
23
|
+
"Operating System :: OS Independent",
|
|
24
|
+
"Programming Language :: Python :: 3",
|
|
25
|
+
"Programming Language :: Python :: 3.10",
|
|
26
|
+
"Programming Language :: Python :: 3.11",
|
|
27
|
+
"Programming Language :: Python :: 3.12",
|
|
28
|
+
"Topic :: Software Development :: Testing",
|
|
29
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
[project.optional-dependencies]
|
|
33
|
+
dev = ["responses>=0.25", "pytest-cov"]
|
|
34
|
+
|
|
35
|
+
[project.urls]
|
|
36
|
+
Homepage = "https://github.com/TheGreatPepix/testy-pytest-adapter"
|
|
37
|
+
Repository = "https://github.com/TheGreatPepix/testy-pytest-adapter"
|
|
38
|
+
|
|
39
|
+
[project.entry-points.pytest11]
|
|
40
|
+
testy = "testy_pytest.plugin"
|
|
41
|
+
|
|
42
|
+
[tool.setuptools.packages.find]
|
|
43
|
+
include = ["testy_pytest*"]
|
|
44
|
+
|
|
45
|
+
[tool.setuptools]
|
|
46
|
+
py-modules = ["testy"]
|