savetest-cli 0.1.0__py3-none-any.whl

savetest_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

savetest_cli/cli.py

@@ -0,0 +1,401 @@
+import json
+import math
+import sys
+import time
+import zipfile
+from pathlib import Path
+from typing import Any, Dict
+
+import click
+import requests
+
+ATTACHMENT_EXTENSIONS = {
+    ".png", ".jpg", ".jpeg", ".gif", ".svg", ".mp4", ".webm",
+}
+ATTACHMENT_SUFFIXES = {"-attachment.json"}
+
+DEFAULT_HOST = "https://save-test.ptnl.moscow"
+DEFAULT_CHUNK_SIZE_MB = 50
+DEFAULT_POLL_INTERVAL_SEC = 1.5
+DEFAULT_WAIT_TIMEOUT_SEC = 3600
+TERMINAL_STATUSES = frozenset({"completed", "partial", "failed", "cancelled"})
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+def _is_attachment(name: str) -> bool:
+    p = Path(name)
+    if p.suffix.lower() in ATTACHMENT_EXTENSIONS:
+        return True
+    for s in ATTACHMENT_SUFFIXES:
+        if p.name.endswith(s):
+            return True
+    return False
+
+
+def _sizeof_fmt(num: int) -> str:
+    for unit in ("B", "KB", "MB", "GB"):
+        if num < 1024:
+            return f"{num:.1f} {unit}"
+        num /= 1024
+    return f"{num:.1f} TB"
+
+
+def _poll_import_task(
+    host: str,
+    project_id: str,
+    task_id: str,
+    headers: Dict[str, str],
+    poll_interval: float,
+    timeout_sec: int,
+) -> dict[str, Any]:
+    """Ожидает завершения фонового импорта (как UI SaveTest)."""
+    url = f"{host}/api/v1/projects/{project_id}/allure-results/tasks/{task_id}"
+    deadline = time.monotonic() + timeout_sec
+    poll_errors = 0
+    max_poll_errors = 10
+    last_progress = -1
+
+    click.echo(f"\nОжидание обработки (task_id: {task_id})...")
+
+    while time.monotonic() < deadline:
+        try:
+            resp = requests.get(url, headers=headers, timeout=60)
+            _check_response(resp, "task status")
+            status = resp.json()
+            poll_errors = 0
+        except SystemExit:
+            raise
+        except requests.RequestException as exc:
+            poll_errors += 1
+            if poll_errors >= max_poll_errors:
+                click.echo(
+                    f"\nНе удалось получить статус задачи после {max_poll_errors} попыток: {exc}",
+                    err=True,
+                )
+                sys.exit(1)
+            time.sleep(poll_interval)
+            continue
+
+        state = status.get("status", "")
+        progress = status.get("progress") or 0
+
+        if progress != last_progress:
+            click.echo(f"  [{state}] прогресс: {progress}%")
+            last_progress = progress
+
+        if state in TERMINAL_STATUSES:
+            return status
+
+        time.sleep(poll_interval)
+
+    click.echo(f"\nТаймаут ожидания ({timeout_sec} с). Задача ещё выполняется: {task_id}", err=True)
+    sys.exit(1)
+
+
+def _print_import_result(host: str, project_id: str, status: dict[str, Any]) -> None:
+    state = status.get("status", "")
+    test_run_id = status.get("test_run_id")
+    test_run_name = status.get("test_run_name")
+
+    click.echo("\n--- Итог импорта ---")
+    click.echo(f"Статус:            {state}")
+    if test_run_id is not None:
+        click.echo(f"Тест-ран ID:       {test_run_id}")
+        click.echo(f"Тест-ран:          {test_run_name or '—'}")
+        click.echo(f"Ссылка:            {host}/projects/{project_id}/test-runs/{test_run_id}")
+    click.echo(f"Обработано:        {status.get('results_processed', 0)}")
+    click.echo(f"Создано:           {status.get('results_created', 0)}")
+    click.echo(f"Сопоставлено:      {status.get('test_cases_matched', 0)}")
+    click.echo(f"Пропущено:         {status.get('skipped', 0)}")
+
+    errors = status.get("errors") or []
+    if errors:
+        click.echo("Ошибки:")
+        for err in errors:
+            click.echo(f"  - {err}")
+
+    if state == "completed":
+        click.echo("\nИмпорт завершён успешно.")
+    elif state == "partial":
+        click.echo("\nИмпорт завершён с ошибками (часть результатов создана).", err=True)
+        sys.exit(1)
+    elif state == "cancelled":
+        click.echo("\nИмпорт отменён.", err=True)
+        sys.exit(1)
+    else:
+        click.echo("\nИмпорт не удался.", err=True)
+        sys.exit(1)
+
+
+# ---------------------------------------------------------------------------
+# CLI root
+# ---------------------------------------------------------------------------
+
+@click.group()
+@click.version_option(package_name="savetest-cli")
+def cli() -> None:
+    """SaveTest CLI — упаковка и загрузка Allure-результатов."""
+
+
+# ---------------------------------------------------------------------------
+# zip_report
+# ---------------------------------------------------------------------------
+
+@cli.command("zip_report")
+@click.argument("path", type=click.Path(exists=True, file_okay=False, resolve_path=True))
+@click.option(
+    "--output", "-o",
+    default="allure-results.zip",
+    show_default=True,
+    help="Путь к выходному ZIP-файлу.",
+)
+@click.option(
+    "--include-attachments/--no-include-attachments",
+    default=False,
+    show_default=True,
+    help="Включать вложения (картинки, видео, *-attachment.json).",
+)
+def zip_report(path: str, output: str, include_attachments: bool) -> None:
+    """Упаковать директорию PATH с Allure-результатами в ZIP.
+
+    \b
+    Примеры:
+      savetest zip_report ./AllureReport
+      savetest zip_report ./AllureReport --output report.zip
+      savetest zip_report ./AllureReport --include-attachments
+    """
+    src = Path(path)
+    out = Path(output)
+
+    if out.exists():
+        out.unlink()
+
+    skipped = 0
+    added = 0
+
+    click.echo(f"Упаковка: {src} → {out}")
+
+    with zipfile.ZipFile(out, "w", compression=zipfile.ZIP_DEFLATED, allowZip64=True) as zf:
+        for file_path in sorted(src.rglob("*")):
+            if not file_path.is_file():
+                continue
+
+            rel = file_path.relative_to(src.parent)
+
+            if not include_attachments and _is_attachment(file_path.name):
+                skipped += 1
+                continue
+
+            zf.write(file_path, rel)
+            added += 1
+
+    size = _sizeof_fmt(out.stat().st_size)
+    click.echo(f"Готово: добавлено {added} файлов, пропущено {skipped} вложений. Размер: {size}")
+    click.echo(f"Файл: {out.resolve()}")
+
+
+# ---------------------------------------------------------------------------
+# upload
+# ---------------------------------------------------------------------------
+
+@cli.command("upload")
+@click.option(
+    "--zip-file", "-z",
+    default="allure-results.zip",
+    show_default=True,
+    type=click.Path(exists=True, dir_okay=False, resolve_path=True),
+    help="Путь к ZIP-файлу с Allure-результатами.",
+)
+@click.option(
+    "--host",
+    default=DEFAULT_HOST,
+    show_default=True,
+    envvar="SAVETEST_HOST",
+    help="Хост SaveTest (или переменная окружения SAVETEST_HOST).",
+)
+@click.option(
+    "--token", "-t",
+    required=True,
+    envvar="SAVETEST_TOKEN",
+    help="API-токен SaveTest (или переменная окружения SAVETEST_TOKEN).",
+)
+@click.option(
+    "--project-id", "-p",
+    required=True,
+    envvar="SAVETEST_PROJECT_ID",
+    help="ID проекта в SaveTest (или переменная окружения SAVETEST_PROJECT_ID).",
+)
+@click.option(
+    "--test-run-id",
+    default="",
+    envvar="SAVETEST_TEST_RUN_ID",
+    help="ID существующего тест-рана (если не задан — создаётся новый).",
+)
+@click.option(
+    "--test-run-name",
+    default="",
+    envvar="SAVETEST_TEST_RUN_NAME",
+    help="Имя нового тест-рана (используется, если --test-run-id не задан).",
+)
+@click.option(
+    "--branch", "-b",
+    default="",
+    envvar="SAVETEST_BRANCH",
+    help="Ветка Git для тест-рана.",
+)
+@click.option(
+    "--include-attachments/--no-include-attachments",
+    default=False,
+    show_default=True,
+    envvar="SAVETEST_INCLUDE_ATTACHMENTS",
+    help="Сообщить серверу, что ZIP содержит вложения.",
+)
+@click.option(
+    "--chunk-size",
+    default=DEFAULT_CHUNK_SIZE_MB,
+    show_default=True,
+    type=int,
+    help="Размер чанка при загрузке (МБ).",
+)
+@click.option(
+    "--wait/--no-wait",
+    default=True,
+    show_default=True,
+    help="Дождаться полной обработки импорта на сервере.",
+)
+@click.option(
+    "--poll-interval",
+    default=DEFAULT_POLL_INTERVAL_SEC,
+    show_default=True,
+    type=float,
+    help="Интервал опроса статуса задачи (сек).",
+)
+@click.option(
+    "--timeout",
+    default=DEFAULT_WAIT_TIMEOUT_SEC,
+    show_default=True,
+    type=int,
+    help="Максимальное время ожидания обработки (сек).",
+)
+def upload(
+    zip_file: str,
+    host: str,
+    token: str,
+    project_id: str,
+    test_run_id: str,
+    test_run_name: str,
+    branch: str,
+    include_attachments: bool,
+    chunk_size: int,
+    wait: bool,
+    poll_interval: float,
+    timeout: int,
+) -> None:
+    """Загрузить ZIP с Allure-результатами в SaveTest и дождаться импорта.
+
+    \b
+    После загрузки чанков CLI опрашивает статус задачи, пока не создастся
+    тест-ран и не завершится импорт (по умолчанию --wait).
+
+    \b
+    Токен можно передать через переменную окружения SAVETEST_TOKEN.
+
+    \b
+    Примеры:
+      savetest upload --token sat_xxx --project-id 40
+      savetest upload --token sat_xxx --project-id 40 --test-run-id 7
+      savetest upload --token sat_xxx --project-id 40 --test-run-name "Smoke DEV" --branch dev
+      SAVETEST_TOKEN=sat_xxx savetest upload --project-id 40
+    """
+    host = host.rstrip("/")
+    chunk_bytes = chunk_size * 1024 * 1024
+    zip_path = Path(zip_file)
+    zip_size = zip_path.stat().st_size
+    total_chunks = math.ceil(zip_size / chunk_bytes)
+
+    click.echo(f"Файл:     {zip_path} ({_sizeof_fmt(zip_size)})")
+    click.echo(f"Хост:     {host}")
+    click.echo(f"Проект:   {project_id}")
+    click.echo(f"Чанков:   {total_chunks} × {chunk_size} МБ")
+
+    headers = {"Authorization": f"Bearer {token}"}
+
+    # --- INIT ---
+    init_data: dict = {
+        "filename": "allure-results.zip",
+        "total_chunks": str(total_chunks),
+        "chunk_size": str(chunk_bytes),
+        "git_branch": branch,
+        "include_attachments": "true" if include_attachments else "false",
+    }
+    if test_run_id:
+        init_data["test_run_id"] = test_run_id
+    elif test_run_name:
+        init_data["test_run_name"] = test_run_name
+
+    click.echo("\nИнициализация загрузки...")
+    resp = requests.post(
+        f"{host}/api/v1/projects/{project_id}/allure-results/upload/init",
+        headers=headers,
+        data=init_data,
+        timeout=60,
+    )
+    _check_response(resp, "init")
+
+    upload_id = resp.json()["upload_id"]
+    click.echo(f"Upload ID: {upload_id}")
+
+    # --- CHUNKS ---
+    click.echo("\nЗагрузка чанков...")
+    with open(zip_path, "rb") as fh:
+        for i in range(total_chunks):
+            chunk_data = fh.read(chunk_bytes)
+            resp = requests.put(
+                f"{host}/api/v1/projects/{project_id}/allure-results/upload/{upload_id}/chunk",
+                headers=headers,
+                data={"chunk_index": str(i)},
+                files={"file": (f"part_{i:06d}", chunk_data, "application/octet-stream")},
+                timeout=120,
+            )
+            _check_response(resp, f"chunk {i}")
+            click.echo(f"  [{i + 1}/{total_chunks}] ✓  {_sizeof_fmt(len(chunk_data))}")
+
+    # --- COMPLETE ---
+    click.echo("\nЗавершение загрузки...")
+    resp = requests.post(
+        f"{host}/api/v1/projects/{project_id}/allure-results/upload/{upload_id}/complete",
+        headers=headers,
+        timeout=60,
+    )
+    _check_response(resp, "complete")
+
+    result = resp.json()
+    task_id = result.get("task_id")
+    if not task_id:
+        click.echo("Чанки приняты, но task_id не получен:", err=True)
+        click.echo(json.dumps(result, ensure_ascii=False, indent=2))
+        sys.exit(1)
+
+    click.echo(f"Чанки загружены. Задача импорта: {task_id}")
+
+    if not wait:
+        click.echo(json.dumps(result, ensure_ascii=False, indent=2))
+        click.echo("\nИмпорт выполняется в фоне. Используйте --wait или проверьте задачу в UI.")
+        return
+
+    final = _poll_import_task(
+        host, project_id, task_id, headers, poll_interval, timeout
+    )
+    _print_import_result(host, project_id, final)
+
+
+def _check_response(resp: "requests.Response", step: str) -> None:
+    if not resp.ok:
+        click.echo(
+            f"\nОшибка на шаге '{step}': HTTP {resp.status_code}\n{resp.text}",
+            err=True,
+        )
+        sys.exit(1)

savetest_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: savetest-cli
+Version: 0.1.0
+Summary: CLI for SaveTest: zip Allure results and upload them to SaveTest
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.0
+Requires-Dist: requests>=2.28
+
+# savetest-cli
+
+CLI-утилита для упаковки Allure-результатов в ZIP и загрузки их в [SaveTest](https://save-test.ru).
+
+## Установка
+
+```bash
+pip install savetest-cli
+```
+
+## Команды
+
+### `savetest zip_report <path>`
+
+Упаковывает директорию с Allure-результатами в ZIP-архив.
+
+```bash
+savetest zip_report ./AllureReport
+```
+
+| Параметр | По умолчанию | Описание |
+|---|---|---|
+| `path` | — | Путь к директории с Allure-результатами |
+| `--output`, `-o` | `allure-results.zip` | Путь к выходному ZIP-файлу |
+| `--include-attachments` | `false` | Включить вложения (картинки, видео, `*-attachment.json`) |
+| `--no-include-attachments` | — | Исключить вложения (быстрее, меньше объём) |
+
+**Примеры:**
+
+```bash
+# Упаковать без вложений (быстрее)
+savetest zip_report ./AllureReport
+
+# Указать выходной файл
+savetest zip_report ./AllureReport --output my-report.zip
+
+# Включить вложения
+savetest zip_report ./AllureReport --include-attachments
+```
+
+---
+
+### `savetest upload`
+
+Загружает ZIP-архив в SaveTest по частям (чанками).
+
+```bash
+savetest upload --token sat_xxx --project-id 40
+```
+
+| Параметр | Env-переменная | По умолчанию | Описание |
+|---|---|---|---|
+| `--zip-file`, `-z` | — | `allure-results.zip` | Путь к ZIP-файлу |
+| `--host` | `SAVETEST_HOST` | `https://save-test.ptnl.moscow` | Хост SaveTest |
+| `--token`, `-t` | `SAVETEST_TOKEN` | — | API-токен (**обязательно**) |
+| `--project-id`, `-p` | `SAVETEST_PROJECT_ID` | — | ID проекта (**обязательно**) |
+| `--test-run-id` | `SAVETEST_TEST_RUN_ID` | — | ID существующего тест-рана (иначе создаётся новый) |
+| `--test-run-name` | `SAVETEST_TEST_RUN_NAME` | — | Имя нового тест-рана |
+| `--branch`, `-b` | `SAVETEST_BRANCH` | — | Ветка Git |
+| `--include-attachments` | `SAVETEST_INCLUDE_ATTACHMENTS` | `false` | Сообщить серверу, что ZIP содержит вложения |
+| `--chunk-size` | — | `50` | Размер чанка при загрузке (МБ) |
+| `--wait` / `--no-wait` | — | `--wait` | Дождаться завершения импорта и создания тест-рана |
+| `--poll-interval` | — | `1.5` | Интервал опроса статуса (сек) |
+| `--timeout` | — | `3600` | Таймаут ожидания обработки (сек) |
+
+**Примеры:**
+
+```bash
+# Минимальный вызов (токен через переменную окружения)
+export SAVETEST_TOKEN=sat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+savetest upload --project-id 40
+
+# Создать новый тест-ран с именем
+savetest upload \
+  --token sat_xxx \
+  --project-id 40 \
+  --test-run-name "Smoke DEV #42" \
+  --branch dev
+
+# Загрузить в существующий тест-ран
+savetest upload \
+  --token sat_xxx \
+  --project-id 40 \
+  --test-run-id 7
+
+# Загрузить с вложениями из другого файла
+savetest upload \
+  --token sat_xxx \
+  --project-id 40 \
+  --zip-file my-report.zip \
+  --include-attachments
+```
+
+---
+
+## Типичный сценарий
+
+```bash
+# 1. Упаковать результаты (без вложений)
+savetest zip_report ./AllureReport
+
+# 2. Загрузить в SaveTest (CLI дождётся импорта и выведет ссылку на тест-ран)
+export SAVETEST_TOKEN=sat_xxx
+savetest upload --project-id 40 --branch dev --test-run-name "CI build #123"
+```
+
+По умолчанию `upload` ждёт полной обработки. Чтобы вернуться сразу после приёма чанков: `--no-wait`.
+
+## Соответствие параметрам Jenkins Pipeline
+
+| Jenkins-параметр | CLI-опция |
+|---|---|
+| `savetest_host` | `--host` |
+| `savetest_project_id` | `--project-id` |
+| `savetest_test_run_id` | `--test-run-id` |
+| `savetest_include_attachments` | `--include-attachments` / `--no-include-attachments` |
+| `branch` | `--branch` |
+| токен (захардкожен) | `--token` / `SAVETEST_TOKEN` |

savetest_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+savetest_cli/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+savetest_cli/cli.py,sha256=gHvru0TVaaWdOx6iNI8f3lDTo2MksljWlNnlZTV2dG0,13518
+savetest_cli-0.1.0.dist-info/METADATA,sha256=nZ7AULbGVoFlO573kLc28dQnwdlzglTEKl1DSFZgcXs,4775
+savetest_cli-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+savetest_cli-0.1.0.dist-info/entry_points.txt,sha256=MxXyo6HuUJnAgVKz2dERTMj2-gE63oLZ_zIWj0WV3uE,50
+savetest_cli-0.1.0.dist-info/top_level.txt,sha256=xwNY_SqftXhmx2sSB6hVJ5ukfsfxTugV8vyApyu0TLM,13
+savetest_cli-0.1.0.dist-info/RECORD,,

savetest_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

savetest_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+savetest = savetest_cli.cli:cli

savetest_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+savetest_cli