Compare commits
55 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
676f7ede30 | ||
|
|
5dd234e7b3 | ||
|
|
59af7ce464 | ||
|
|
f6861382e6 | ||
|
|
67b5d093d9 | ||
|
|
f80f3a8b52 | ||
|
|
222d31730e | ||
|
|
86f083aa79 | ||
|
|
a82be05b83 | ||
|
|
ca89832d74 | ||
|
|
f6afc4096d | ||
|
|
738d9d543e | ||
|
|
58fa5a7ab4 | ||
|
|
14219564dd | ||
|
|
da069993b9 | ||
|
|
dbc4cf960a | ||
|
|
3a6d1b7ba7 | ||
|
|
3956decd4e | ||
|
|
0e4e0f3ee2 | ||
|
|
2db0ab1f0b | ||
|
|
8bc8181ce3 | ||
|
|
7bc6e024c0 | ||
|
|
06cd57e2c4 | ||
|
|
d7e927e6eb | ||
|
|
000bf37503 | ||
|
|
dfb8d474b4 | ||
|
|
b7f03666dc | ||
|
|
30310d614d | ||
|
|
ad62ef4f6c | ||
|
|
355849e004 | ||
|
|
d839be8776 | ||
|
|
ea90fe79d0 | ||
|
|
1f77088c21 | ||
|
|
8278864b01 | ||
|
|
f858618a13 | ||
|
|
e344715f61 | ||
|
|
245ea0a3fa | ||
|
|
2a39de467f | ||
|
|
6416df481e | ||
|
|
ead6c72d16 | ||
|
|
e7efda232c | ||
|
|
937885a12b | ||
|
|
932dd1198a | ||
|
|
0bff2363dc | ||
|
|
9b260b27fd | ||
|
|
a8511368ce | ||
|
|
7a8b629c7c | ||
|
|
41c7ef24a3 | ||
|
|
5b813c76e9 | ||
|
|
5a5ee00726 | ||
|
|
4a5dee7a14 | ||
|
|
2c123e9ae7 | ||
|
|
9a2f753480 | ||
|
|
bca24189c7 | ||
|
|
6fcc834617 |
7
.gitignore
vendored
7
.gitignore
vendored
@@ -85,3 +85,10 @@ secrets.json
|
|||||||
# Temporary files
|
# Temporary files
|
||||||
*.tmp
|
*.tmp
|
||||||
*.bak
|
*.bak
|
||||||
|
|
||||||
|
# Just in case
|
||||||
|
.~*
|
||||||
|
# Local report outputs
|
||||||
|
report.*
|
||||||
|
rep.*
|
||||||
|
*.html
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Artem Kokos
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
209
README.md
209
README.md
@@ -1,132 +1,179 @@
|
|||||||
# redmine-reporter
|
# redmine-reporter
|
||||||
|
|
||||||
Инструмент для генерации отчётов по задачам в Redmine на основе ваших записей о затраченном времени.
|
CLI-инструмент для генерации отчётов по задачам Redmine на основе записей о затраченном времени.
|
||||||
|
|
||||||
> Предназначен для внутреннего использования в Eltex. Работает с `https://red.eltex.loc/`.
|
Проект предназначен для внутреннего использования с `https://red.eltex.loc/`.
|
||||||
|
|
||||||
---
|
Лицензия: MIT.
|
||||||
|
|
||||||
## 🔧 Возможности
|
## Возможности
|
||||||
|
|
||||||
- Безопасная передача учётных данных через переменные окружения или `.env`
|
- Получение time entries **текущего** или **указанного** пользователя из Redmine.
|
||||||
- Два режима вывода: компактный (для копирования) и табличный (для просмотра)
|
- Авторизация через Redmine API token или логин/пароль.
|
||||||
- Группировка задач по проекту и версии
|
- Группировка задач по проекту и версии.
|
||||||
- Перевод статусов на русский язык
|
- Перевод статусов задач на русский язык.
|
||||||
- Простой CLI с понятными аргументами
|
- Вывод в консоль (таблица / компактный вид).
|
||||||
- Поддержка настройки диапазона дат по умолчанию через `.env`
|
- Экспорт в ODT, CSV, Markdown, HTML, JSON и Excel (.xlsx).
|
||||||
|
- Excel-отчёт с merge-ячейками по проекту/версии, итогами, автошириной, автофильтром и закреплённой шапкой.
|
||||||
|
- Сводка по времени (`--summary`).
|
||||||
|
- Понятные сообщения об ошибках Redmine API (401/403/5xx, таймаут, сеть).
|
||||||
|
- Загрузка альтернативного `.env` через `--config`.
|
||||||
|
|
||||||
---
|
## Установка
|
||||||
|
|
||||||
## 🚀 Установка и настройка (продакшен)
|
|
||||||
|
|
||||||
### 1. Клонируйте репозиторий
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.akokos.ru/artem.kokos/redmine-reporter.git
|
git clone https://git.akokos.ru/artem.kokos/redmine-reporter.git
|
||||||
cd redmine-reporter
|
cd redmine-reporter
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Создайте изолированное окружение и установите зависимости
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 -m venv .venv
|
python3 -m venv .venv
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
pip install --upgrade pip
|
pip install --upgrade pip
|
||||||
pip install .
|
pip install .
|
||||||
```
|
```
|
||||||
|
|
||||||
> 💡 Установка в виртуальное окружение — стандарт для Python-инструментов. Это безопасно и не влияет на систему.
|
Для разработки:
|
||||||
|
|
||||||
### 3. Настройте доверие к корпоративному сертификату (обязательно!)
|
|
||||||
|
|
||||||
По умолчанию Python использует собственный набор сертификатов (`certifi`), который **не включает** внутренние CA Eltex.
|
|
||||||
Чтобы избежать ошибки `CERTIFICATE_VERIFY_FAILED`, выполните **один раз**:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cat /etc/ssl/certs/ca-certificates.crt >> $(python -m certifi)
|
pip install -e ".[dev]"
|
||||||
```
|
```
|
||||||
|
|
||||||
> ✅ Это безопасно: вы просто добавляете доверенные системные сертификаты к Python.
|
## Настройка
|
||||||
> ❌ Не используйте `verify=False` — это создаёт уязвимость.
|
|
||||||
|
|
||||||
### 4. Настройте учётные данные и (опционально) даты
|
Создайте файл `.env` в корне проекта. Он не должен попадать в git.
|
||||||
|
|
||||||
Создайте файл `.env` в корне проекта (**никогда не коммитьте его!**):
|
Рекомендуемый вариант авторизации:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
REDMINE_URL=https://red.eltex.loc/
|
||||||
|
REDMINE_API_KEY=ваш_api_token
|
||||||
|
REDMINE_AUTHOR=Иванов Иван Иванович
|
||||||
|
|
||||||
|
DEFAULT_FROM_DATE=2026-01-01
|
||||||
|
DEFAULT_TO_DATE=2026-01-31
|
||||||
|
```
|
||||||
|
|
||||||
|
Резервный вариант:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
REDMINE_URL=https://red.eltex.loc/
|
REDMINE_URL=https://red.eltex.loc/
|
||||||
REDMINE_USER=ваш.логин
|
REDMINE_USER=ваш.логин
|
||||||
REDMINE_PASSWORD=ваш_пароль
|
REDMINE_PASSWORD=ваш_пароль
|
||||||
|
REDMINE_AUTHOR=Иванов Иван Иванович
|
||||||
# Опционально: диапазон дат по умолчанию
|
|
||||||
DEFAULT_FROM_DATE=2026-01-01
|
|
||||||
DEFAULT_TO_DATE=2026-01-31
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Альтернатива — задать переменные вручную:
|
Переменные окружения:
|
||||||
|
|
||||||
```bash
|
| Переменная | Обязательность | Описание |
|
||||||
export REDMINE_URL=https://red.eltex.loc/
|
| --- | --- | --- |
|
||||||
export REDMINE_USER=ваш.логин
|
| `REDMINE_URL` | Да | URL Redmine. |
|
||||||
export REDMINE_PASSWORD=...
|
| `REDMINE_API_KEY` | Да, если нет логина и пароля | Redmine API token. |
|
||||||
export DEFAULT_FROM_DATE=2026-01-01
|
| `REDMINE_USER` | Да, если нет токена | Логин Redmine. |
|
||||||
export DEFAULT_TO_DATE=2026-01-31
|
| `REDMINE_PASSWORD` | Да, если нет токена | Пароль Redmine. |
|
||||||
```
|
| `REDMINE_AUTHOR` | Нет | Имя автора для ODT-отчёта. |
|
||||||
|
| `DEFAULT_FROM_DATE` | Нет | Начальная дата периода по умолчанию (`YYYY-MM-DD`). |
|
||||||
|
| `DEFAULT_TO_DATE` | Нет | Конечная дата периода по умолчанию (`YYYY-MM-DD`). |
|
||||||
|
| `REDMINE_VERIFY` | Нет | TLS-проверка: `true` / `false` / путь к CA bundle. |
|
||||||
|
|
||||||
> 🔐 Рекомендуется использовать аккаунт с минимальными правами (только чтение time entries и задач).
|
## Использование
|
||||||
> 💡 Если `DEFAULT_FROM_DATE` и `DEFAULT_TO_DATE` не заданы, используется встроенный диапазон: `2025-12-19--2026-01-31`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## ▶️ Использование
|
|
||||||
|
|
||||||
Перед каждым запуском активируйте окружение:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
Затем:
|
Отчёт за период по умолчанию:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Отчёт за период по умолчанию (из .env или встроенный)
|
|
||||||
redmine-reporter
|
redmine-reporter
|
||||||
|
```
|
||||||
|
|
||||||
# Отчёт за произвольный период (переопределяет .env)
|
Отчёт за произвольный период:
|
||||||
|
|
||||||
|
```bash
|
||||||
redmine-reporter --date 2026-02-01--2026-02-28
|
redmine-reporter --date 2026-02-01--2026-02-28
|
||||||
|
```
|
||||||
|
|
||||||
# Компактный вывод (удобно копировать в письмо)
|
Отчёт по другому пользователю:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
redmine-reporter --user-id 42
|
||||||
|
redmine-reporter --user-login ivanov
|
||||||
|
redmine-reporter --user-name "Иванов И.И."
|
||||||
|
```
|
||||||
|
|
||||||
|
`--user-name` требует точного совпадения; если найдено несколько пользователей, CLI сообщает об ошибке и просит использовать `--user-id`.
|
||||||
|
|
||||||
|
Переопределить URL/API-ключ из `.env`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
redmine-reporter --url https://red.example.com --api-key ваш_токен
|
||||||
|
```
|
||||||
|
|
||||||
|
Альтернативный конфигурационный файл:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
redmine-reporter --config /path/to/.env
|
||||||
|
```
|
||||||
|
|
||||||
|
Компактный вывод:
|
||||||
|
|
||||||
|
```bash
|
||||||
redmine-reporter --compact
|
redmine-reporter --compact
|
||||||
```
|
```
|
||||||
|
|
||||||
Пример вывода:
|
Отладочный вывод:
|
||||||
```
|
|
||||||
✅ Total issues: 7 [2026-01-01--2026-01-31]
|
|
||||||
╒════════════╤═══════════╤══════════════════════════════════════╤═══════════╤════════════╕
|
|
||||||
│ Проект │ Версия │ Задача │ Статус │ Затрачено │
|
|
||||||
╞════════════╪═══════════╪══════════════════════════════════════╪═══════════╪════════════╡
|
|
||||||
│ Камеры │ v2.5.0 │ 12345. Поддержка нового датчика │ В работе │ 2.00h │
|
|
||||||
│ │ │ 12346. Исправить утечку памяти │ Решена │ 2.00h │
|
|
||||||
│ ПО │ <N/A> │ 12350. Обновить документацию │ Ожидание │ 12.00h │
|
|
||||||
╘════════════╧═══════════╧══════════════════════════════════════╧═══════════╧════════════╛
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 🛠 Разработка
|
|
||||||
|
|
||||||
Для участия в разработке:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -e ".[dev]"
|
redmine-reporter --debug
|
||||||
pytest
|
|
||||||
black .
|
|
||||||
isort .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
Экспорт:
|
||||||
|
|
||||||
> 🔒 **Важно**:
|
```bash
|
||||||
> - Никогда не коммитьте `.env`, пароли или логины.
|
redmine-reporter --output report.odt
|
||||||
> - Файл `.gitignore` уже исключает все чувствительные артефакты.
|
redmine-reporter --output report.csv
|
||||||
> - Инструмент работает только в режиме **чтения** — он не может изменять данные в Redmine.
|
redmine-reporter --output report.md
|
||||||
|
redmine-reporter --output report.html
|
||||||
|
redmine-reporter --output report.json
|
||||||
|
redmine-reporter --output report.xlsx
|
||||||
|
```
|
||||||
|
|
||||||
|
Отчёт без затраченного времени (работает для всех форматов):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
redmine-reporter --no-time
|
||||||
|
redmine-reporter --no-time --output report.xlsx
|
||||||
|
```
|
||||||
|
|
||||||
|
Сводка по времени:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
redmine-reporter --summary
|
||||||
|
```
|
||||||
|
|
||||||
|
## Форматы вывода
|
||||||
|
|
||||||
|
| Формат | Особенности |
|
||||||
|
| --- | --- |
|
||||||
|
| **ODT** | Заголовок с автором и месяцем, группировка по проекту/версии. |
|
||||||
|
| **CSV** | UTF-8 с BOM, полные значения `project`/`version` в каждой строке. |
|
||||||
|
| **Markdown** | Компактная таблица, повторяющиеся группы скрыты. |
|
||||||
|
| **HTML** | Полноценный HTML-документ с `meta charset="utf-8"`. |
|
||||||
|
| **JSON** | Массив объектов: `project`, `version`, `issue_id`, `subject`, `status`, `time`. |
|
||||||
|
| **Excel (.xlsx)** | Merge cells, колонки `Hours`/`Spent Time`, итоги, автоширина, автофильтр, freeze panes. |
|
||||||
|
|
||||||
|
## Разработка
|
||||||
|
|
||||||
|
Проверки перед коммитом:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pytest
|
||||||
|
ruff check redmine_reporter tests
|
||||||
|
black --check redmine_reporter tests
|
||||||
|
isort --check-only redmine_reporter tests
|
||||||
|
mypy redmine_reporter
|
||||||
|
```
|
||||||
|
|
||||||
|
## Безопасность
|
||||||
|
|
||||||
|
- Не коммитьте `.env`, API token, пароль или логин.
|
||||||
|
- Используйте аккаунт с минимальными правами, достаточными для чтения time entries и задач.
|
||||||
|
- Инструмент работает только в режиме чтения и не изменяет данные в Redmine.
|
||||||
|
|||||||
@@ -4,25 +4,26 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "redmine-reporter"
|
name = "redmine-reporter"
|
||||||
version = "0.1.1"
|
version = "1.8.1"
|
||||||
description = "Redmine time-entry based issue reporter for internal use"
|
description = "Redmine time-entry based issue reporter for internal use"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
authors = [{ name = "Artem Kokos", email = "artem-kokos@mail.ru" }]
|
authors = [{ name = "Artem Kokos", email = "artem-kokos@mail.ru" }]
|
||||||
license = { text = "Proprietary" }
|
license = { text = "MIT" }
|
||||||
classifiers = [
|
classifiers = [
|
||||||
"Programming Language :: Python :: 3",
|
"Programming Language :: Python :: 3",
|
||||||
"Programming Language :: Python :: 3.8",
|
|
||||||
"Programming Language :: Python :: 3.9",
|
"Programming Language :: Python :: 3.9",
|
||||||
"Programming Language :: Python :: 3.10",
|
"Programming Language :: Python :: 3.10",
|
||||||
"Programming Language :: Python :: 3.11",
|
"Programming Language :: Python :: 3.11",
|
||||||
"Operating System :: POSIX :: Linux",
|
"Operating System :: POSIX :: Linux",
|
||||||
"Environment :: Console",
|
"Environment :: Console",
|
||||||
]
|
]
|
||||||
requires-python = ">=3.8"
|
requires-python = ">=3.9"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"python-redmine>=2.4.0",
|
"python-redmine>=2.4.0",
|
||||||
"tabulate>=0.9.0",
|
"tabulate>=0.9.0",
|
||||||
"python-dotenv>=1.0.0",
|
"python-dotenv>=1.0.0",
|
||||||
|
"odfpy>=1.4.0",
|
||||||
|
"openpyxl>=3.1.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
@@ -41,10 +42,20 @@ redmine-reporter = "redmine_reporter.cli:main"
|
|||||||
where = ["."]
|
where = ["."]
|
||||||
include = ["redmine_reporter*"]
|
include = ["redmine_reporter*"]
|
||||||
|
|
||||||
|
[tool.setuptools.package-data]
|
||||||
|
"redmine_reporter" = ["templates/template.odt"]
|
||||||
|
|
||||||
[tool.black]
|
[tool.black]
|
||||||
line-length = 100
|
line-length = 100
|
||||||
target-version = ['py38']
|
target-version = ['py39']
|
||||||
|
|
||||||
[tool.isort]
|
[tool.isort]
|
||||||
profile = "black"
|
profile = "black"
|
||||||
multi_line_output = 3
|
multi_line_output = 3
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
warn_unused_configs = true
|
||||||
|
|
||||||
|
[[tool.mypy.overrides]]
|
||||||
|
module = ["odf.*", "redminelib.*", "tabulate", "openpyxl.*"]
|
||||||
|
ignore_missing_imports = true
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
__version__ = "0.1.1"
|
__version__ = "1.8.1"
|
||||||
|
|||||||
@@ -1,39 +1,123 @@
|
|||||||
import sys
|
|
||||||
import argparse
|
import argparse
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from datetime import datetime
|
||||||
from typing import List, Optional
|
from typing import List, Optional
|
||||||
from redminelib.resources import Issue
|
|
||||||
|
from . import __version__
|
||||||
|
from .client import RedmineAPIError, fetch_issues_with_spent_time
|
||||||
from .config import Config
|
from .config import Config
|
||||||
from .client import fetch_issues_with_spent_time
|
from .formatters.factory import get_console_formatter, get_formatter_by_extension
|
||||||
from .formatter import format_compact, format_table
|
from .report_builder import build_grouped_report, calculate_summary
|
||||||
|
|
||||||
|
|
||||||
def parse_date_range(date_arg: str) -> tuple[str, str]:
|
def parse_date_range(date_arg: str) -> tuple[str, str]:
|
||||||
if "--" not in date_arg:
|
if "--" not in date_arg:
|
||||||
raise ValueError("Date range must be in format YYYY-MM-DD--YYYY-MM-DD")
|
raise ValueError("Date range must be in format YYYY-MM-DD--YYYY-MM-DD")
|
||||||
parts = date_arg.split("--", 1)
|
parts = date_arg.split("--", 1)
|
||||||
if len(parts) != 2:
|
|
||||||
raise ValueError("Invalid date range format")
|
from_date, to_date = parts[0].strip(), parts[1].strip()
|
||||||
return parts[0].strip(), parts[1].strip()
|
date_pattern = r"\d{4}-\d{2}-\d{2}"
|
||||||
|
if not re.fullmatch(date_pattern, from_date) or not re.fullmatch(date_pattern, to_date):
|
||||||
|
raise ValueError("Date range must be in format YYYY-MM-DD--YYYY-MM-DD")
|
||||||
|
|
||||||
|
try:
|
||||||
|
start = datetime.strptime(from_date, "%Y-%m-%d").date()
|
||||||
|
end = datetime.strptime(to_date, "%Y-%m-%d").date()
|
||||||
|
except ValueError as e:
|
||||||
|
raise ValueError("Date range contains invalid calendar date") from e
|
||||||
|
|
||||||
|
if start > end:
|
||||||
|
raise ValueError("Date range start must be less than or equal to end")
|
||||||
|
|
||||||
|
return start.isoformat(), end.isoformat()
|
||||||
|
|
||||||
|
|
||||||
def main(argv: Optional[List[str]] = None) -> int:
|
def main(argv: Optional[List[str]] = None) -> int:
|
||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
prog="redmine-reporter",
|
prog="redmine-reporter",
|
||||||
description="Generate Redmine issue report based on your time entries."
|
description="Generate Redmine issue report based on your time entries.",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--date",
|
"--date",
|
||||||
default=Config.get_default_date_range(),
|
default=Config.get_default_date_range(),
|
||||||
# help="Date range in format YYYY-MM-DD--YYYY-MM-DD (default: %(default)s)"
|
help="Date range in format YYYY-MM-DD--YYYY-MM-DD (default: current month or from .env)",
|
||||||
help="Date range in format YYYY-MM-DD--YYYY-MM-DD (default from .env or %(default)s)"
|
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--compact",
|
"--compact",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
help="Use compact plain-text output instead of table"
|
help="Use compact plain-text output instead of table",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--output",
|
||||||
|
help="Path to output file (.odt, .csv, .md, .html, .json, .xlsx). If omitted, prints to stdout.",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--author", default="", help="Override author name from .env (REDMINE_AUTHOR)"
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--no-time", action="store_true", help="Do not include spent time into table"
|
||||||
|
)
|
||||||
|
parser.add_argument("--url", help="Override Redmine URL from .env (REDMINE_URL)")
|
||||||
|
parser.add_argument("--api-key", help="Override Redmine API key from .env (REDMINE_API_KEY)")
|
||||||
|
parser.add_argument("--config", help="Path to .env config file")
|
||||||
|
parser.add_argument("--verbose", action="store_true", help="Enable verbose output")
|
||||||
|
parser.add_argument("--debug", action="store_true", help="Enable debug output")
|
||||||
|
parser.add_argument(
|
||||||
|
"--version",
|
||||||
|
action="version",
|
||||||
|
version=f"%(prog)s {__version__}",
|
||||||
|
help="Show version and exit",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--summary",
|
||||||
|
action="store_true",
|
||||||
|
help="Print summary (total hours by project/version) to stderr",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--user-id",
|
||||||
|
help="Redmine user ID for the report (default: current user)",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--user-login",
|
||||||
|
help="Redmine user login for the report (alternative to --user-id)",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--user-name",
|
||||||
|
help="Redmine user full name for the report (alternative to --user-id; ambiguous names are rejected)",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--by-activity",
|
||||||
|
action="store_true",
|
||||||
|
help="Break down spent time by activity type",
|
||||||
)
|
)
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
# Валидация взаимоисключающих флагов пользователя
|
||||||
|
user_args = [args.user_id, args.user_login, args.user_name]
|
||||||
|
if sum(bool(a) for a in user_args) > 1:
|
||||||
|
print(
|
||||||
|
"❌ Specify only one of --user-id, --user-login, or --user-name.",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
# CLI-переопределения имеют приоритет над .env/env.
|
||||||
|
if args.config:
|
||||||
|
Config.load_config(args.config)
|
||||||
|
Config.set_redmine_url(args.url)
|
||||||
|
Config.set_redmine_api_key(args.api_key)
|
||||||
|
|
||||||
|
# Настройка уровня логирования
|
||||||
|
if args.debug:
|
||||||
|
logging.basicConfig(level=logging.DEBUG, format="%(levelname)s: %(message)s")
|
||||||
|
elif args.verbose:
|
||||||
|
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
|
||||||
|
else:
|
||||||
|
logging.basicConfig(level=logging.WARNING, format="%(levelname)s: %(message)s")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
Config.validate()
|
Config.validate()
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
@@ -47,26 +131,108 @@ def main(argv: Optional[List[str]] = None) -> int:
|
|||||||
return 1
|
return 1
|
||||||
|
|
||||||
try:
|
try:
|
||||||
issue_hours = fetch_issues_with_spent_time(from_date, to_date)
|
issue_hours = fetch_issues_with_spent_time(
|
||||||
|
from_date,
|
||||||
|
to_date,
|
||||||
|
user_id=args.user_id or args.user_login or args.user_name,
|
||||||
|
by_activity=args.by_activity,
|
||||||
|
)
|
||||||
|
except RedmineAPIError as e:
|
||||||
|
print(f"❌ {e.message}", file=sys.stderr)
|
||||||
|
if args.debug and e.original is not None:
|
||||||
|
logging.exception("Original Redmine API error")
|
||||||
|
return 1
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
print(f"❌ Redmine API error: {e}", file=sys.stderr)
|
print(f"❌ Unexpected error: {e}", file=sys.stderr)
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
if issue_hours is None:
|
if issue_hours is None:
|
||||||
print("ℹ️ No time entries found in the given period.", file=sys.stderr)
|
print("ℹ️ No time entries found in the given period.", file=sys.stderr)
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
print(f"✅ Total issues: {len(issue_hours)} [{args.date}]")
|
if not issue_hours:
|
||||||
|
print("ℹ️ No time entries found in the given period.", file=sys.stderr)
|
||||||
|
return 0
|
||||||
|
|
||||||
try:
|
print(f"✅ Total issues: {len(issue_hours)} [{args.date}]", file=sys.stderr)
|
||||||
|
|
||||||
|
rows = build_grouped_report(
|
||||||
|
issue_hours,
|
||||||
|
fill_time=not args.no_time,
|
||||||
|
by_activity=args.by_activity,
|
||||||
|
)
|
||||||
|
|
||||||
|
if args.summary:
|
||||||
|
summary = calculate_summary(rows, by_activity=args.by_activity)
|
||||||
|
print(f"⏱️ Total time: {summary['total']}h", file=sys.stderr)
|
||||||
|
project_keys = [k for k in sorted(summary) if k.startswith("project:")]
|
||||||
|
activity_keys = [k for k in sorted(summary) if k.startswith("activity:")]
|
||||||
|
for key in project_keys + activity_keys:
|
||||||
|
value = summary[key]
|
||||||
|
if key.startswith("project:"):
|
||||||
|
project = key.split(":", 1)[1]
|
||||||
|
print(f" {project}: {value}h", file=sys.stderr)
|
||||||
|
elif key.startswith("activity:"):
|
||||||
|
activity = key.split(":", 1)[1]
|
||||||
|
print(f" [{activity}]: {value}h", file=sys.stderr)
|
||||||
|
|
||||||
|
if args.output:
|
||||||
|
output_ext = os.path.splitext(args.output)[1].lower()
|
||||||
|
|
||||||
|
if not output_ext:
|
||||||
|
print(
|
||||||
|
"❌ Файл без расширения. Укажите расширение: .odt, .csv, .md, .html, .json или .xlsx",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
formatter = get_formatter_by_extension(
|
||||||
|
output_ext,
|
||||||
|
author=Config.get_author(args.author),
|
||||||
|
from_date=from_date,
|
||||||
|
to_date=to_date,
|
||||||
|
no_time=args.no_time,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not formatter:
|
||||||
|
if output_ext == ".odt":
|
||||||
|
print(
|
||||||
|
"❌ odfpy is not installed. Install with: pip install odfpy",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
known_exts = ", ".join([".odt", ".csv", ".md", ".html", ".json", ".xlsx"])
|
||||||
|
print(
|
||||||
|
f"❌ Неизвестный формат файла: {output_ext!r}. "
|
||||||
|
f"Поддерживаются: {known_exts}",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
try:
|
||||||
|
formatter.save(rows, args.output)
|
||||||
|
print(f"✅ Report saved to {args.output}")
|
||||||
|
except Exception as e:
|
||||||
|
fmt = output_ext.lstrip(".").upper()
|
||||||
|
print(f"❌ {fmt} export error: {e}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
else:
|
||||||
if args.compact:
|
if args.compact:
|
||||||
output = format_compact(issue_hours)
|
formatter = get_console_formatter("compact")
|
||||||
else:
|
else:
|
||||||
output = format_table(issue_hours)
|
formatter = get_console_formatter("table")
|
||||||
print(output)
|
|
||||||
except Exception as e:
|
if not formatter:
|
||||||
print(f"❌ Formatting error: {e}", file=sys.stderr)
|
print("❌ Неизвестный тип консольного форматтера.", file=sys.stderr)
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
|
try:
|
||||||
|
output = formatter.format(rows)
|
||||||
|
print(output)
|
||||||
|
except Exception as e:
|
||||||
|
print(f"❌ Formatting error: {e}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
|
|||||||
@@ -1,58 +1,285 @@
|
|||||||
from typing import List, Optional, Dict, Tuple
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
||||||
|
|
||||||
|
import requests
|
||||||
from redminelib import Redmine
|
from redminelib import Redmine
|
||||||
|
from redminelib.exceptions import AuthError, ForbiddenError, ResourceNotFoundError
|
||||||
from redminelib.resources import Issue
|
from redminelib.resources import Issue
|
||||||
|
from urllib3.util.retry import Retry
|
||||||
|
|
||||||
from .config import Config
|
from .config import Config
|
||||||
from .utils import get_version
|
|
||||||
|
# Таймаут на один HTTP-запрос к Redmine (секунды).
|
||||||
|
REQUEST_TIMEOUT = 30
|
||||||
|
|
||||||
|
# Размер чанка для запроса задач по issue_id, чтобы не превышать лимит длины URL (#21).
|
||||||
|
ISSUE_ID_CHUNK_SIZE = 100
|
||||||
|
|
||||||
|
|
||||||
def fetch_issues_with_spent_time(from_date: str, to_date: str) -> Optional[List[Tuple[Issue, float]]]:
|
class RedmineAPIError(Exception):
|
||||||
"""
|
"""Пользовательское исключение с понятным сообщением об ошибке Redmine API."""
|
||||||
Fetch unique issues linked to time entries of the current user in given date range,
|
|
||||||
along with total spent hours per issue.
|
|
||||||
Returns list of (issue, total_hours) tuples.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
def __init__(self, message: str, original: Optional[Exception] = None):
|
||||||
|
super().__init__(message)
|
||||||
|
self.message = message
|
||||||
|
self.original = original
|
||||||
|
|
||||||
|
|
||||||
|
def _get_redmine_auth_kwargs() -> Dict[str, Any]:
|
||||||
|
"""Return Redmine auth kwargs. API key has priority over legacy password auth."""
|
||||||
|
api_key = Config.get_redmine_api_key()
|
||||||
|
if api_key:
|
||||||
|
return {"key": api_key}
|
||||||
|
return {
|
||||||
|
"username": Config.get_redmine_user(),
|
||||||
|
"password": Config.get_redmine_password(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _make_retry_adapter() -> requests.adapters.HTTPAdapter:
|
||||||
|
"""Создаёт HTTPAdapter с retry для временных ошибок (#24)."""
|
||||||
|
retry = Retry(
|
||||||
|
total=3,
|
||||||
|
backoff_factor=0.5,
|
||||||
|
status_forcelist=[429, 500, 502, 503, 504],
|
||||||
|
allowed_methods=["GET", "HEAD", "OPTIONS"],
|
||||||
|
)
|
||||||
|
return requests.adapters.HTTPAdapter(max_retries=retry)
|
||||||
|
|
||||||
|
|
||||||
|
def _create_redmine() -> Redmine:
|
||||||
|
"""Создаёт Redmine-клиент с таймаутом и retry-адаптером (#24)."""
|
||||||
redmine = Redmine(
|
redmine = Redmine(
|
||||||
Config.REDMINE_URL,
|
Config.get_redmine_url(),
|
||||||
username=Config.REDMINE_USER,
|
**_get_redmine_auth_kwargs(),
|
||||||
password=Config.REDMINE_PASSWORD,
|
requests={
|
||||||
requests={'verify': '/etc/ssl/certs/ca-certificates.crt'}
|
"verify": Config.get_redmine_verify(),
|
||||||
|
"timeout": REQUEST_TIMEOUT,
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
current_user = redmine.user.get('current')
|
# Монтируем retry-адаптер на сессию для автоматических повторов.
|
||||||
time_entries = redmine.time_entry.filter(
|
# В python-redmine сессия живёт в engine, а redmine.session — контекстный менеджер.
|
||||||
user_id=current_user.id,
|
retry_adapter = _make_retry_adapter()
|
||||||
from_date=from_date,
|
redmine.engine.session.mount("https://", retry_adapter)
|
||||||
to_date=to_date
|
redmine.engine.session.mount("http://", retry_adapter)
|
||||||
|
|
||||||
|
return redmine
|
||||||
|
|
||||||
|
|
||||||
|
def _format_redmine_error(exc: Exception) -> str:
|
||||||
|
"""Преобразует исключение Redmine/requests в понятное сообщение."""
|
||||||
|
if isinstance(exc, AuthError):
|
||||||
|
return (
|
||||||
|
"Authentication failed: invalid API key, login or password. "
|
||||||
|
"Check REDMINE_API_KEY / REDMINE_USER / REDMINE_PASSWORD."
|
||||||
|
)
|
||||||
|
if isinstance(exc, ForbiddenError):
|
||||||
|
return (
|
||||||
|
"Access denied: your Redmine account does not have permission "
|
||||||
|
"to read time entries or issues."
|
||||||
|
)
|
||||||
|
if isinstance(exc, ResourceNotFoundError):
|
||||||
|
return "Requested Redmine resource not found: check user/project identifiers."
|
||||||
|
|
||||||
|
# requests HTTPError может быть обёрнуто в python-redmine
|
||||||
|
original = getattr(exc, "response", None)
|
||||||
|
if original is None:
|
||||||
|
original = exc
|
||||||
|
|
||||||
|
response = getattr(original, "response", None)
|
||||||
|
if response is not None and hasattr(response, "status_code"):
|
||||||
|
status = response.status_code
|
||||||
|
if status == 401:
|
||||||
|
return "Authentication failed (HTTP 401): check your API key or login/password."
|
||||||
|
if status == 403:
|
||||||
|
return "Access denied (HTTP 403): insufficient Redmine permissions."
|
||||||
|
if status == 404:
|
||||||
|
return "Redmine endpoint not found (HTTP 404): check REDMINE_URL."
|
||||||
|
if status == 429:
|
||||||
|
return "Too many requests (HTTP 429): Redmine rate limit exceeded."
|
||||||
|
if 500 <= status < 600:
|
||||||
|
return f"Redmine server error (HTTP {status}): try again later."
|
||||||
|
return f"Redmine API returned HTTP {status}."
|
||||||
|
|
||||||
|
if isinstance(exc, requests.exceptions.Timeout):
|
||||||
|
return f"Redmine request timed out after {REQUEST_TIMEOUT} seconds."
|
||||||
|
if isinstance(exc, requests.exceptions.ConnectionError):
|
||||||
|
return "Cannot connect to Redmine: check the URL and network."
|
||||||
|
if isinstance(exc, requests.exceptions.RequestException):
|
||||||
|
return f"Network error while calling Redmine: {exc}"
|
||||||
|
|
||||||
|
return str(exc)
|
||||||
|
|
||||||
|
|
||||||
|
def _load_time_entry_activities(redmine: Redmine) -> Dict[int, str]:
|
||||||
|
"""Загружает справочник типов активности time entries.
|
||||||
|
|
||||||
|
Возвращает словарь id -> name. Если справочник недоступен,
|
||||||
|
возвращает пустой словарь — тогда будем использовать данные из самих entries.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
activities = redmine.enumeration.filter(resource="time_entry_activities")
|
||||||
|
return {int(a.id): str(a.name) for a in activities}
|
||||||
|
except Exception:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def _get_activity_name(entry, activities: Dict[int, str]) -> str:
|
||||||
|
"""Определяет название активности для time entry."""
|
||||||
|
activity = getattr(entry, "activity", None)
|
||||||
|
if activity is None:
|
||||||
|
return "<N/A>"
|
||||||
|
|
||||||
|
# activity может быть объектом с id/name или просто значением
|
||||||
|
activity_id = getattr(activity, "id", None)
|
||||||
|
if activity_id is not None:
|
||||||
|
name = activities.get(int(activity_id))
|
||||||
|
if name:
|
||||||
|
return name
|
||||||
|
activity_name = getattr(activity, "name", None)
|
||||||
|
if activity_name:
|
||||||
|
return str(activity_name)
|
||||||
|
return str(activity_id)
|
||||||
|
|
||||||
|
return str(activity)
|
||||||
|
|
||||||
|
|
||||||
|
def _fetch_issues_chunked(redmine: Redmine, issue_ids: List[int]) -> List[Issue]:
|
||||||
|
"""Загружает задачи чанками, чтобы не превышать лимит длины URL (#21)."""
|
||||||
|
all_issues: List[Issue] = []
|
||||||
|
for i in range(0, len(issue_ids), ISSUE_ID_CHUNK_SIZE):
|
||||||
|
chunk = issue_ids[i : i + ISSUE_ID_CHUNK_SIZE]
|
||||||
|
issue_list_str = ",".join(str(x) for x in chunk)
|
||||||
|
issues = redmine.issue.filter(issue_id=issue_list_str, status_id="*", sort="project:asc")
|
||||||
|
all_issues.extend(issues)
|
||||||
|
return all_issues
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_user_id(redmine: Redmine, user_arg: Union[int, str]) -> int:
|
||||||
|
"""Преобразует строковый идентификатор пользователя в числовой ID.
|
||||||
|
|
||||||
|
Если аргумент — число, возвращает его как есть.
|
||||||
|
Если строка, пытается найти пользователя по логину или имени.
|
||||||
|
"""
|
||||||
|
if isinstance(user_arg, int):
|
||||||
|
return user_arg
|
||||||
|
|
||||||
|
text = str(user_arg).strip()
|
||||||
|
if not text:
|
||||||
|
raise RedmineAPIError("User identifier cannot be empty.")
|
||||||
|
|
||||||
|
# Сначала пробуем интерпретировать как числовой ID
|
||||||
|
if text.isdigit():
|
||||||
|
return int(text)
|
||||||
|
|
||||||
|
# Затем ищем по логину
|
||||||
|
try:
|
||||||
|
users = redmine.user.filter(login=text)
|
||||||
|
if users:
|
||||||
|
return int(users[0].id)
|
||||||
|
except Exception as exc:
|
||||||
|
raise RedmineAPIError(
|
||||||
|
f"Cannot resolve user login '{text}': {_format_redmine_error(exc)}",
|
||||||
|
original=exc,
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
# Потом по имени
|
||||||
|
try:
|
||||||
|
users = redmine.user.filter(name=text)
|
||||||
|
if len(users) == 1:
|
||||||
|
return int(users[0].id)
|
||||||
|
if len(users) > 1:
|
||||||
|
matches = ", ".join(str(getattr(u, "login", u.id)) for u in users[:5])
|
||||||
|
raise RedmineAPIError(
|
||||||
|
f"Multiple users match '{text}': {matches}. Use --user-id with numeric ID."
|
||||||
|
)
|
||||||
|
except RedmineAPIError:
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
raise RedmineAPIError(
|
||||||
|
f"Cannot resolve user name '{text}': {_format_redmine_error(exc)}",
|
||||||
|
original=exc,
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
raise RedmineAPIError(
|
||||||
|
f"User '{text}' not found. Check the login/name or use --user-id with numeric Redmine ID."
|
||||||
)
|
)
|
||||||
|
|
||||||
# Агрегируем часы по issue.id
|
|
||||||
|
def _get_current_user_id(redmine: Redmine) -> int:
|
||||||
|
"""Возвращает ID текущего пользователя."""
|
||||||
|
try:
|
||||||
|
current_user = redmine.user.get("current")
|
||||||
|
return int(current_user.id)
|
||||||
|
except Exception as exc:
|
||||||
|
raise RedmineAPIError(_format_redmine_error(exc), original=exc) from exc
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_issues_with_spent_time(
|
||||||
|
from_date: str,
|
||||||
|
to_date: str,
|
||||||
|
user_id: Optional[Union[int, str]] = None,
|
||||||
|
by_activity: bool = False,
|
||||||
|
) -> Optional[List[Tuple[Issue, float, Optional[Dict[str, float]]]]]:
|
||||||
|
"""
|
||||||
|
Fetch unique issues linked to time entries of the given user in date range,
|
||||||
|
along with total spent hours per issue.
|
||||||
|
If user_id is None, uses current user.
|
||||||
|
If by_activity is True, returns per-activity breakdown as third tuple element.
|
||||||
|
Returns list of (issue, total_hours, activities) tuples.
|
||||||
|
Raises RedmineAPIError on API/auth/network failures.
|
||||||
|
"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
redmine = _create_redmine()
|
||||||
|
target_user_id = (
|
||||||
|
_resolve_user_id(redmine, user_id)
|
||||||
|
if user_id is not None
|
||||||
|
else _get_current_user_id(redmine)
|
||||||
|
)
|
||||||
|
activities_lookup = _load_time_entry_activities(redmine) if by_activity else {}
|
||||||
|
time_entries = redmine.time_entry.filter(
|
||||||
|
user_id=target_user_id, from_date=from_date, to_date=to_date
|
||||||
|
)
|
||||||
|
except RedmineAPIError:
|
||||||
|
raise
|
||||||
|
except Exception as exc:
|
||||||
|
raise RedmineAPIError(_format_redmine_error(exc), original=exc) from exc
|
||||||
|
|
||||||
|
# Агрегируем часы по issue.id (и активности, если требуется)
|
||||||
spent_time: Dict[int, float] = {}
|
spent_time: Dict[int, float] = {}
|
||||||
|
spent_by_activity: Dict[int, Dict[str, float]] = {}
|
||||||
issue_ids = set()
|
issue_ids = set()
|
||||||
for entry in time_entries:
|
for entry in time_entries:
|
||||||
if hasattr(entry, 'issue') and entry.issue and hasattr(entry, 'hours'):
|
if hasattr(entry, "issue") and entry.issue and hasattr(entry, "hours"):
|
||||||
iid = entry.issue.id
|
iid = entry.issue.id
|
||||||
|
hours = float(entry.hours)
|
||||||
issue_ids.add(iid)
|
issue_ids.add(iid)
|
||||||
spent_time[iid] = spent_time.get(iid, 0.0) + float(entry.hours)
|
spent_time[iid] = spent_time.get(iid, 0.0) + hours
|
||||||
|
|
||||||
|
if by_activity:
|
||||||
|
activity_name = _get_activity_name(entry, activities_lookup)
|
||||||
|
by_act = spent_by_activity.setdefault(iid, {})
|
||||||
|
by_act[activity_name] = by_act.get(activity_name, 0.0) + hours
|
||||||
|
|
||||||
if not issue_ids:
|
if not issue_ids:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
# Загружаем полные объекты задач
|
# Загружаем полные объекты задач чанками (#21)
|
||||||
issue_list_str = ','.join(str(i) for i in issue_ids)
|
try:
|
||||||
issues = redmine.issue.filter(
|
sorted_ids = sorted(issue_ids)
|
||||||
issue_id=issue_list_str,
|
issues = _fetch_issues_chunked(redmine, sorted_ids)
|
||||||
status_id='*',
|
except Exception as exc:
|
||||||
sort='project:asc'
|
raise RedmineAPIError(_format_redmine_error(exc), original=exc) from exc
|
||||||
)
|
|
||||||
|
|
||||||
# Сопоставляем задачи с суммарным временем
|
# Сопоставляем задачи с суммарным временем.
|
||||||
|
# Сортировка выполняется в report_builder.build_grouped_report,
|
||||||
|
# здесь оставляем порядок API как есть.
|
||||||
result = []
|
result = []
|
||||||
for issue in issues:
|
for issue in issues:
|
||||||
total_hours = spent_time.get(issue.id, 0.0)
|
iid = issue.id
|
||||||
result.append((issue, total_hours))
|
total_hours = spent_time.get(iid, 0.0)
|
||||||
|
activity_breakdown = spent_by_activity.get(iid) if by_activity else None
|
||||||
# Сортируем по (проект, версия)
|
result.append((issue, total_hours, activity_breakdown))
|
||||||
result.sort(key=lambda x: (str(x[0].project), get_version(x[0])))
|
|
||||||
|
|
||||||
return result
|
return result
|
||||||
|
|||||||
@@ -1,29 +1,98 @@
|
|||||||
import os
|
import os
|
||||||
|
from datetime import date, timedelta
|
||||||
|
from typing import Union
|
||||||
|
|
||||||
from dotenv import load_dotenv
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
load_dotenv(override=False)
|
||||||
|
|
||||||
load_dotenv()
|
DEFAULT_REDMINE_VERIFY = "/etc/ssl/certs/ca-certificates.crt"
|
||||||
|
FALSE_VALUES = {"0", "false", "no", "off"}
|
||||||
|
TRUE_VALUES = {"1", "true", "yes", "on"}
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
REDMINE_URL = os.getenv("REDMINE_URL", "").rstrip("/")
|
_cli_url: str | None = None
|
||||||
REDMINE_USER = os.getenv("REDMINE_USER")
|
_cli_api_key: str | None = None
|
||||||
REDMINE_PASSWORD = os.getenv("REDMINE_PASSWORD")
|
|
||||||
DEFAULT_FROM_DATE = os.getenv("DEFAULT_FROM_DATE")
|
@classmethod
|
||||||
DEFAULT_TO_DATE = os.getenv("DEFAULT_TO_DATE")
|
def load_config(cls, path: str) -> None:
|
||||||
|
"""Загружает переменные из указанного .env-файла с override."""
|
||||||
|
load_dotenv(path, override=True)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def set_redmine_url(cls, url: str) -> None:
|
||||||
|
cls._cli_url = url.strip().rstrip("/") if url else None
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def set_redmine_api_key(cls, key: str) -> None:
|
||||||
|
cls._cli_api_key = key.strip() if key else None
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_redmine_url(cls) -> str:
|
||||||
|
if cls._cli_url is not None:
|
||||||
|
return cls._cli_url
|
||||||
|
return os.getenv("REDMINE_URL", "").strip().rstrip("/")
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_redmine_api_key(cls) -> str:
|
||||||
|
if cls._cli_api_key is not None:
|
||||||
|
return cls._cli_api_key
|
||||||
|
return os.getenv("REDMINE_API_KEY", "").strip()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_redmine_user(cls) -> str:
|
||||||
|
return os.getenv("REDMINE_USER", "").strip()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_redmine_password(cls) -> str:
|
||||||
|
return os.getenv("REDMINE_PASSWORD", "").strip()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_redmine_verify(cls) -> Union[bool, str]:
|
||||||
|
value = os.getenv("REDMINE_VERIFY", "").strip()
|
||||||
|
if not value:
|
||||||
|
return DEFAULT_REDMINE_VERIFY
|
||||||
|
|
||||||
|
normalized = value.lower()
|
||||||
|
if normalized in FALSE_VALUES:
|
||||||
|
return False
|
||||||
|
if normalized in TRUE_VALUES:
|
||||||
|
return True
|
||||||
|
return value
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get_author(cls, cli_author: str = "") -> str:
|
||||||
|
"""Возвращает автора: из CLI если задан, иначе из .env, иначе — заглушку."""
|
||||||
|
if cli_author:
|
||||||
|
return cli_author
|
||||||
|
return os.getenv("REDMINE_AUTHOR", "").strip()
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_default_date_range(cls) -> str:
|
def get_default_date_range(cls) -> str:
|
||||||
if cls.DEFAULT_FROM_DATE and cls.DEFAULT_TO_DATE:
|
default_from_date = os.getenv("DEFAULT_FROM_DATE", "").strip()
|
||||||
return f"{cls.DEFAULT_FROM_DATE}--{cls.DEFAULT_TO_DATE}"
|
default_to_date = os.getenv("DEFAULT_TO_DATE", "").strip()
|
||||||
# fallback hardcoded
|
if default_from_date and default_to_date:
|
||||||
return "2025-12-19--2026-01-31"
|
return f"{default_from_date}--{default_to_date}"
|
||||||
|
|
||||||
|
# fallback: текущий месяц
|
||||||
|
today = date.today()
|
||||||
|
start = today.replace(day=1)
|
||||||
|
# последний день месяца: берём первое число следующего месяца и вычитаем день
|
||||||
|
if today.month == 12:
|
||||||
|
next_month = today.replace(year=today.year + 1, month=1, day=1)
|
||||||
|
else:
|
||||||
|
next_month = today.replace(month=today.month + 1, day=1)
|
||||||
|
end = next_month - timedelta(days=1)
|
||||||
|
return f"{start.isoformat()}--{end.isoformat()}"
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def validate(cls) -> None:
|
def validate(cls) -> None:
|
||||||
if not cls.REDMINE_URL:
|
if not cls.get_redmine_url():
|
||||||
raise ValueError("REDMINE_URL is required (set via env or .env)")
|
raise ValueError("REDMINE_URL is required (set via env or .env)")
|
||||||
if not cls.REDMINE_USER:
|
if cls.get_redmine_api_key():
|
||||||
raise ValueError("REDMINE_USER is required")
|
return
|
||||||
if not cls.REDMINE_PASSWORD:
|
if not (cls.get_redmine_user() and cls.get_redmine_password()):
|
||||||
raise ValueError("REDMINE_PASSWORD is required")
|
raise ValueError(
|
||||||
|
"REDMINE_API_KEY is required, or set both REDMINE_USER and REDMINE_PASSWORD"
|
||||||
|
)
|
||||||
|
|||||||
@@ -1,83 +0,0 @@
|
|||||||
from typing import List, Tuple
|
|
||||||
from redminelib.resources import Issue
|
|
||||||
from .utils import get_version
|
|
||||||
|
|
||||||
|
|
||||||
STATUS_TRANSLATION = {
|
|
||||||
'Closed': 'Закрыто',
|
|
||||||
'Re-opened': 'В работе',
|
|
||||||
'New': 'В работе',
|
|
||||||
'Resolved': 'Решена',
|
|
||||||
'Pending': 'Ожидание',
|
|
||||||
'Feedback': 'В работе',
|
|
||||||
'In Progress': 'В работе',
|
|
||||||
'Rejected': 'Закрыто',
|
|
||||||
'Confirming': 'Ожидание',
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def hours_to_human(hours: float) -> str:
|
|
||||||
if hours <= 0:
|
|
||||||
return "0ч"
|
|
||||||
|
|
||||||
total_minutes = round(hours * 60)
|
|
||||||
h = total_minutes // 60
|
|
||||||
m = total_minutes % 60
|
|
||||||
parts = []
|
|
||||||
|
|
||||||
if h:
|
|
||||||
parts.append(f"{h}ч")
|
|
||||||
if m:
|
|
||||||
parts.append(f"{m}м")
|
|
||||||
|
|
||||||
return " ".join(parts) if parts else "0ч"
|
|
||||||
|
|
||||||
|
|
||||||
def format_compact(issue_hours: List[Tuple[Issue, float]]) -> str:
|
|
||||||
lines = []
|
|
||||||
prev_project = None
|
|
||||||
prev_version = None
|
|
||||||
|
|
||||||
for issue, hours in issue_hours:
|
|
||||||
project = str(issue.project)
|
|
||||||
version = get_version(issue)
|
|
||||||
status = str(issue.status)
|
|
||||||
|
|
||||||
display_project = project if project != prev_project else ""
|
|
||||||
display_version = version if (project != prev_project or version != prev_version) else ""
|
|
||||||
lines.append(f"{display_project} | {display_version} | {issue.id}. {issue.subject} | {status} | {hours_to_human(hours)}")
|
|
||||||
|
|
||||||
prev_project = project
|
|
||||||
prev_version = version
|
|
||||||
|
|
||||||
return "\n".join(lines)
|
|
||||||
|
|
||||||
|
|
||||||
def format_table(issue_hours: List[Tuple[Issue, float]]) -> str:
|
|
||||||
from tabulate import tabulate
|
|
||||||
|
|
||||||
rows = [['Проект', 'Версия', 'Задача', 'Статус', 'Затрачено']]
|
|
||||||
prev_project = None
|
|
||||||
prev_version = None
|
|
||||||
|
|
||||||
for issue, hours in issue_hours:
|
|
||||||
project = str(issue.project)
|
|
||||||
version = get_version(issue)
|
|
||||||
status_en = str(issue.status)
|
|
||||||
status_ru = STATUS_TRANSLATION.get(status_en, status_en)
|
|
||||||
|
|
||||||
display_project = project if project != prev_project else ""
|
|
||||||
display_version = version if (project != prev_project or version != prev_version) else ""
|
|
||||||
|
|
||||||
rows.append([
|
|
||||||
display_project,
|
|
||||||
display_version,
|
|
||||||
f"{issue.id}. {issue.subject}",
|
|
||||||
status_ru,
|
|
||||||
hours_to_human(hours)
|
|
||||||
])
|
|
||||||
|
|
||||||
prev_project = project
|
|
||||||
prev_version = version
|
|
||||||
|
|
||||||
return tabulate(rows, headers="firstrow", tablefmt="fancy_grid")
|
|
||||||
0
redmine_reporter/formatters/__init__.py
Normal file
0
redmine_reporter/formatters/__init__.py
Normal file
34
redmine_reporter/formatters/base.py
Normal file
34
redmine_reporter/formatters/base.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from typing import Any, List
|
||||||
|
|
||||||
|
from ..types import ReportRow
|
||||||
|
|
||||||
|
|
||||||
|
class Formatter(ABC):
|
||||||
|
"""
|
||||||
|
Абстрактный базовый класс для всех форматтеров.
|
||||||
|
Определяет общий интерфейс для форматирования отчета.
|
||||||
|
|
||||||
|
Контракт:
|
||||||
|
- format() возвращает строку для текстовых форматтеров (CSV, HTML, Markdown, console)
|
||||||
|
и объект OpenDocument для ODTFormatter.
|
||||||
|
- save() сохраняет результат в файл; консольные форматтеры бросают NotImplementedError.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def format(self, rows: List[ReportRow]) -> Any:
|
||||||
|
"""
|
||||||
|
Форматирует список строк отчета в нужный формат.
|
||||||
|
Для текстовых форматтеров возвращает str.
|
||||||
|
Для ODTFormatter возвращает объект OpenDocument.
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
"""
|
||||||
|
Сохраняет отформатированный отчет в файл по указанному пути.
|
||||||
|
Для форматтеров, которые не поддерживают сохранение (например, консольные),
|
||||||
|
бросает NotImplementedError.
|
||||||
|
"""
|
||||||
|
pass
|
||||||
49
redmine_reporter/formatters/console.py
Normal file
49
redmine_reporter/formatters/console.py
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
from typing import List
|
||||||
|
|
||||||
|
from tabulate import tabulate
|
||||||
|
|
||||||
|
from ..types import ReportRow
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class TableFormatter(Formatter):
|
||||||
|
"""Форматтер для вывода красивой таблицы в консоль."""
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
table_rows = [["Проект", "Версия", "Задача", "Статус", "Затрачено"]]
|
||||||
|
for r in rows:
|
||||||
|
time_text = r["time_text"].replace("\n", " / ")
|
||||||
|
table_rows.append(
|
||||||
|
[
|
||||||
|
r["display_project"],
|
||||||
|
r["display_version"],
|
||||||
|
f"{r['issue_id']}. {r['subject']}",
|
||||||
|
r["status_ru"],
|
||||||
|
time_text,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
return tabulate(table_rows, headers="firstrow", tablefmt="fancy_grid")
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
# Консольные форматтеры не умеют сохранять в файл напрямую.
|
||||||
|
# Это делается в CLI.
|
||||||
|
raise NotImplementedError("TableFormatter не поддерживает сохранение в файл.")
|
||||||
|
|
||||||
|
|
||||||
|
class CompactFormatter(Formatter):
|
||||||
|
"""Форматтер для компактного вывода в консоль."""
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
lines = []
|
||||||
|
for r in rows:
|
||||||
|
time_text = r["time_text"].replace("\n", " / ")
|
||||||
|
lines.append(
|
||||||
|
f"{r['display_project']} | {r['display_version']} | "
|
||||||
|
f"{r['issue_id']}. {r['subject']} | {r['status_ru']} | {time_text}"
|
||||||
|
)
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
# Консольные форматтеры не умеют сохранять в файл напрямую.
|
||||||
|
# Это делается в CLI.
|
||||||
|
raise NotImplementedError("CompactFormatter не поддерживает сохранение в файл.")
|
||||||
46
redmine_reporter/formatters/csv.py
Normal file
46
redmine_reporter/formatters/csv.py
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
import csv
|
||||||
|
import io
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from ..types import ReportRow
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class CSVFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта в CSV.
|
||||||
|
|
||||||
|
Использует полные значения project/version (а не display-значения с пустыми
|
||||||
|
ячейками для групп). Каждая строка CSV самодостаточна — это корректно для
|
||||||
|
табличного формата (#31). Файл сохраняется в UTF-8 с BOM (utf-8-sig) для
|
||||||
|
корректного отображения кириллицы в Microsoft Excel (#26).
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, no_time: bool = False, **_kwargs):
|
||||||
|
super().__init__()
|
||||||
|
self.no_time = no_time
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
output = io.StringIO()
|
||||||
|
writer = csv.writer(output, dialect="excel")
|
||||||
|
headers = ["Project", "Version", "Issue ID", "Subject", "Status"]
|
||||||
|
if not self.no_time:
|
||||||
|
headers.append("Spent Time")
|
||||||
|
writer.writerow(headers)
|
||||||
|
for r in rows:
|
||||||
|
time_text = r["time_text"].replace("\n", " / ")
|
||||||
|
data = [
|
||||||
|
r["project"],
|
||||||
|
r["version"],
|
||||||
|
r["issue_id"],
|
||||||
|
r["subject"],
|
||||||
|
r["status_ru"],
|
||||||
|
]
|
||||||
|
if not self.no_time:
|
||||||
|
data.append(time_text)
|
||||||
|
writer.writerow(data)
|
||||||
|
return output.getvalue()
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
content = self.format(rows)
|
||||||
|
with open(output_path, "w", encoding="utf-8-sig", newline="") as f:
|
||||||
|
f.write(content)
|
||||||
61
redmine_reporter/formatters/factory.py
Normal file
61
redmine_reporter/formatters/factory.py
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
from typing import Dict, Optional, Type
|
||||||
|
|
||||||
|
from .base import Formatter
|
||||||
|
from .console import CompactFormatter, TableFormatter
|
||||||
|
from .csv import CSVFormatter
|
||||||
|
from .html import HTMLFormatter
|
||||||
|
from .json import JSONFormatter
|
||||||
|
from .markdown import MarkdownFormatter
|
||||||
|
from .xlsx import XLSXFormatter
|
||||||
|
|
||||||
|
# Словарь для сопоставления расширений файлов с классами форматтеров.
|
||||||
|
# ODT и XLSX намеренно отсутствуют — их импорт отложен (ленивый), так как
|
||||||
|
# odfpy/openpyxl может быть не установлен. См. get_formatter_by_extension.
|
||||||
|
FORMATTER_MAP: Dict[str, Type[Formatter]] = {
|
||||||
|
".csv": CSVFormatter,
|
||||||
|
".json": JSONFormatter,
|
||||||
|
".md": MarkdownFormatter,
|
||||||
|
".html": HTMLFormatter,
|
||||||
|
".xlsx": XLSXFormatter,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Словарь для сопоставления типа вывода (консоль) с классами форматтеров
|
||||||
|
CONSOLE_FORMATTER_MAP: Dict[str, Type[Formatter]] = {
|
||||||
|
"table": TableFormatter,
|
||||||
|
"compact": CompactFormatter,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_formatter_by_extension(extension: str, **kwargs) -> Optional[Formatter]:
|
||||||
|
"""
|
||||||
|
Возвращает экземпляр форматтера по расширению файла.
|
||||||
|
Ключевые аргументы (**kwargs) передаются в конструктор форматтера.
|
||||||
|
Возвращает None для .odt, если odfpy не установлен.
|
||||||
|
"""
|
||||||
|
ext = extension.lower()
|
||||||
|
|
||||||
|
formatter_class = FORMATTER_MAP.get(ext)
|
||||||
|
if formatter_class:
|
||||||
|
return formatter_class(**kwargs)
|
||||||
|
|
||||||
|
# ODT требует odfpy — ленивый импорт, чтобы отсутствие зависимости
|
||||||
|
# не ломало загрузку модуля и другие форматтеры.
|
||||||
|
if ext == ".odt":
|
||||||
|
try:
|
||||||
|
from .odt import ODTFormatter
|
||||||
|
except ImportError:
|
||||||
|
return None
|
||||||
|
return ODTFormatter(**kwargs)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def get_console_formatter(formatter_type: str) -> Optional[Formatter]:
|
||||||
|
"""
|
||||||
|
Возвращает экземпляр консольного форматтера по его типу.
|
||||||
|
"""
|
||||||
|
formatter_class = CONSOLE_FORMATTER_MAP.get(formatter_type.lower())
|
||||||
|
if formatter_class:
|
||||||
|
return formatter_class()
|
||||||
|
return None
|
||||||
85
redmine_reporter/formatters/html.py
Normal file
85
redmine_reporter/formatters/html.py
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
from html import escape
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from ..report_builder import group_rows_by_project_and_version
|
||||||
|
from ..types import ReportRow
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class HTMLFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта отчёта в HTML."""
|
||||||
|
|
||||||
|
def __init__(self, **_kwargs):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
projects = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
lines = [
|
||||||
|
"<!DOCTYPE html>",
|
||||||
|
'<html lang="ru">',
|
||||||
|
"<head>",
|
||||||
|
' <meta charset="utf-8">',
|
||||||
|
"</head>",
|
||||||
|
"<body>",
|
||||||
|
'<table border="1" cellpadding="6" cellspacing="0" style="border-collapse: collapse; font-family: Arial, sans-serif;">',
|
||||||
|
" <thead>",
|
||||||
|
" <tr>",
|
||||||
|
" <th>Наименование Проекта</th>",
|
||||||
|
" <th>Номер версии*</th>",
|
||||||
|
" <th>Задача</th>",
|
||||||
|
" <th>Статус Готовность*</th>",
|
||||||
|
" <th>Затрачено за отчетный период</th>",
|
||||||
|
" </tr>",
|
||||||
|
" </thead>",
|
||||||
|
" <tbody>",
|
||||||
|
]
|
||||||
|
|
||||||
|
for project, versions in projects.items():
|
||||||
|
project_text = escape(project)
|
||||||
|
total_project_rows = sum(len(tasks) for tasks in versions.values())
|
||||||
|
first_version_in_project = True
|
||||||
|
|
||||||
|
for version, task_rows in versions.items():
|
||||||
|
version_text = escape(version)
|
||||||
|
row_span_version = len(task_rows)
|
||||||
|
first_row_in_version = True
|
||||||
|
|
||||||
|
for r in task_rows:
|
||||||
|
task_cell = escape(f"{r['issue_id']}. {r['subject']}")
|
||||||
|
status_text = escape(r["status_ru"])
|
||||||
|
time_text = escape(r["time_text"]).replace("\n", "<br>")
|
||||||
|
lines.append(" <tr>")
|
||||||
|
|
||||||
|
# Ячейка "Проект" - только в первой строке проекта
|
||||||
|
if first_version_in_project and first_row_in_version:
|
||||||
|
lines.append(
|
||||||
|
f' <td rowspan="{total_project_rows}" style="vertical-align: top;">{project_text}</td>'
|
||||||
|
)
|
||||||
|
|
||||||
|
# Ячейка "Версия" - только в первой строке версии
|
||||||
|
if first_row_in_version:
|
||||||
|
lines.append(
|
||||||
|
f' <td rowspan="{row_span_version}" style="vertical-align: top;">{version_text}</td>'
|
||||||
|
)
|
||||||
|
first_row_in_version = False
|
||||||
|
|
||||||
|
# Остальные колонки
|
||||||
|
lines.append(f" <td>{task_cell}</td>")
|
||||||
|
lines.append(f" <td>{status_text}</td>")
|
||||||
|
lines.append(f" <td>{time_text}</td>")
|
||||||
|
|
||||||
|
lines.append(" </tr>")
|
||||||
|
|
||||||
|
first_version_in_project = False
|
||||||
|
|
||||||
|
lines.append(" </tbody>")
|
||||||
|
lines.append("</table>")
|
||||||
|
lines.append("</body>")
|
||||||
|
lines.append("</html>")
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
content = self.format(rows)
|
||||||
|
with open(output_path, "w", encoding="utf-8") as f:
|
||||||
|
f.write(content)
|
||||||
34
redmine_reporter/formatters/json.py
Normal file
34
redmine_reporter/formatters/json.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import json
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from ..types import ReportRow
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class JSONFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта отчёта в JSON."""
|
||||||
|
|
||||||
|
def __init__(self, **_kwargs):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
data = []
|
||||||
|
for r in rows:
|
||||||
|
item = {
|
||||||
|
"project": r["project"],
|
||||||
|
"version": r["version"],
|
||||||
|
"issue_id": r["issue_id"],
|
||||||
|
"subject": r["subject"],
|
||||||
|
"status": r["status_ru"],
|
||||||
|
"time": r["time_text"],
|
||||||
|
}
|
||||||
|
activities = r.get("activities")
|
||||||
|
if activities:
|
||||||
|
item["activities"] = activities
|
||||||
|
data.append(item)
|
||||||
|
return json.dumps(data, ensure_ascii=False, indent=2)
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
content = self.format(rows)
|
||||||
|
with open(output_path, "w", encoding="utf-8") as f:
|
||||||
|
f.write(content)
|
||||||
36
redmine_reporter/formatters/markdown.py
Normal file
36
redmine_reporter/formatters/markdown.py
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
from typing import List
|
||||||
|
|
||||||
|
from ..types import ReportRow
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
def _escape_markdown_table_cell(value: object) -> str:
|
||||||
|
return str(value).replace("\\", "\\\\").replace("|", "\\|").replace("\n", "<br>")
|
||||||
|
|
||||||
|
|
||||||
|
class MarkdownFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта в Markdown."""
|
||||||
|
|
||||||
|
def __init__(self, **_kwargs):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> str:
|
||||||
|
lines = [
|
||||||
|
"| Проект | Версия | Задача | Статус | Затрачено |",
|
||||||
|
"|--------|--------|--------|--------|-----------|",
|
||||||
|
]
|
||||||
|
for r in rows:
|
||||||
|
task_cell = _escape_markdown_table_cell(f"{r['issue_id']}. {r['subject']}")
|
||||||
|
lines.append(
|
||||||
|
f"| {_escape_markdown_table_cell(r['display_project'])} "
|
||||||
|
f"| {_escape_markdown_table_cell(r['display_version'])} "
|
||||||
|
f"| {task_cell} "
|
||||||
|
f"| {_escape_markdown_table_cell(r['status_ru'])} "
|
||||||
|
f"| {_escape_markdown_table_cell(r['time_text'])} |"
|
||||||
|
)
|
||||||
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
content = self.format(rows)
|
||||||
|
with open(output_path, "w", encoding="utf-8") as f:
|
||||||
|
f.write(content)
|
||||||
168
redmine_reporter/formatters/odt.py
Normal file
168
redmine_reporter/formatters/odt.py
Normal file
@@ -0,0 +1,168 @@
|
|||||||
|
from importlib import resources
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from odf.opendocument import OpenDocument, load
|
||||||
|
from odf.style import Style, TableCellProperties, TableColumnProperties
|
||||||
|
from odf.table import CoveredTableCell, Table, TableCell, TableColumn, TableRow
|
||||||
|
from odf.text import P
|
||||||
|
|
||||||
|
from ..report_builder import group_rows_by_project_and_version
|
||||||
|
from ..types import ReportRow
|
||||||
|
from ..utils import get_month_name_from_range
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class ODTFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта в ODT."""
|
||||||
|
|
||||||
|
def __init__(self, author: str = "", from_date: str = "", to_date: str = "", **_kwargs):
|
||||||
|
"""
|
||||||
|
Инициализирует форматтер с параметрами для шапки отчета.
|
||||||
|
"""
|
||||||
|
self.author = author
|
||||||
|
self.from_date = from_date
|
||||||
|
self.to_date = to_date
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> OpenDocument:
|
||||||
|
"""
|
||||||
|
Форматирует данные в объект OpenDocument.
|
||||||
|
"""
|
||||||
|
|
||||||
|
with resources.files("redmine_reporter").joinpath("templates/template.odt").open("rb") as f:
|
||||||
|
doc = load(f)
|
||||||
|
|
||||||
|
# Удаляем все текстовые параграфы из шаблона, оставляя только
|
||||||
|
# структурные элементы (forms, sequence-decls). Это защищает от
|
||||||
|
# артефактов редактирования шаблона в LibreOffice (#42).
|
||||||
|
for child in list(doc.text.childNodes):
|
||||||
|
if child.tagName == "text:p":
|
||||||
|
doc.text.removeChild(child)
|
||||||
|
|
||||||
|
para_style_name = "Standard"
|
||||||
|
|
||||||
|
# Заголовок
|
||||||
|
month_name = get_month_name_from_range(self.from_date, self.to_date)
|
||||||
|
if self.author:
|
||||||
|
header_text = f"{self.author}. Отчет за месяц {month_name}."
|
||||||
|
else:
|
||||||
|
header_text = f"Отчет за месяц {month_name}."
|
||||||
|
doc.text.addElement(P(stylename=para_style_name, text=header_text))
|
||||||
|
doc.text.addElement(P(stylename=para_style_name, text=""))
|
||||||
|
|
||||||
|
# Стиль ячеек
|
||||||
|
cell_style_name = "TableCellStyle"
|
||||||
|
cell_style = Style(name=cell_style_name, family="table-cell")
|
||||||
|
cell_props = TableCellProperties(padding="0.04in", border="0.05pt solid #000000")
|
||||||
|
cell_style.addElement(cell_props)
|
||||||
|
doc.automaticstyles.addElement(cell_style)
|
||||||
|
|
||||||
|
# Таблица
|
||||||
|
table = Table(name="Report")
|
||||||
|
column_widths = ["1.56in", "1.63in", "3.93in", "1.56in", "1.43in"]
|
||||||
|
for width in column_widths:
|
||||||
|
col_style = Style(name=f"col_{width}", family="table-column")
|
||||||
|
col_props = TableColumnProperties(columnwidth=width)
|
||||||
|
col_style.addElement(col_props)
|
||||||
|
doc.automaticstyles.addElement(col_style)
|
||||||
|
table.addElement(TableColumn(stylename=col_style))
|
||||||
|
|
||||||
|
# Заголовки
|
||||||
|
header_row = TableRow()
|
||||||
|
for text in [
|
||||||
|
"Наименование Проекта",
|
||||||
|
"Номер версии*",
|
||||||
|
"Задача",
|
||||||
|
"Статус Готовность*",
|
||||||
|
"Затрачено за отчетный период",
|
||||||
|
]:
|
||||||
|
cell = TableCell(stylename=cell_style_name)
|
||||||
|
cell.addElement(P(stylename=para_style_name, text=text))
|
||||||
|
header_row.addElement(cell)
|
||||||
|
table.addElement(header_row)
|
||||||
|
|
||||||
|
projects = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
# Данные с двухуровневой группировкой и объединением ячеек
|
||||||
|
for project, versions in projects.items():
|
||||||
|
total_project_rows = sum(
|
||||||
|
len(rows_for_version) for rows_for_version in versions.values()
|
||||||
|
)
|
||||||
|
first_version_in_project = True
|
||||||
|
|
||||||
|
for version, rows_for_version in versions.items():
|
||||||
|
row_span_version = len(rows_for_version)
|
||||||
|
first_row_in_version = True
|
||||||
|
|
||||||
|
for r in rows_for_version:
|
||||||
|
row = TableRow()
|
||||||
|
|
||||||
|
# Ячейка "Проект" - только в первой строке всего проекта,
|
||||||
|
# в остальных — covered-cell для валидности ODF (#13)
|
||||||
|
if first_version_in_project and first_row_in_version:
|
||||||
|
cell_project = TableCell(stylename=cell_style_name)
|
||||||
|
cell_project.setAttribute("numberrowsspanned", str(total_project_rows))
|
||||||
|
p = P(stylename=para_style_name, text=project)
|
||||||
|
cell_project.addElement(p)
|
||||||
|
row.addElement(cell_project)
|
||||||
|
else:
|
||||||
|
row.addElement(CoveredTableCell())
|
||||||
|
|
||||||
|
# Ячейка "Версия" - только в первой строке каждой версии,
|
||||||
|
# в остальных — covered-cell для валидности ODF (#13)
|
||||||
|
if first_row_in_version:
|
||||||
|
cell_version = TableCell(stylename=cell_style_name)
|
||||||
|
cell_version.setAttribute("numberrowsspanned", str(row_span_version))
|
||||||
|
p = P(stylename=para_style_name, text=version)
|
||||||
|
cell_version.addElement(p)
|
||||||
|
row.addElement(cell_version)
|
||||||
|
first_row_in_version = False
|
||||||
|
else:
|
||||||
|
row.addElement(CoveredTableCell())
|
||||||
|
|
||||||
|
# Остальные колонки
|
||||||
|
task_cell = TableCell(stylename=cell_style_name)
|
||||||
|
task_text = f"{r['issue_id']}. {r['subject']}"
|
||||||
|
p = P(stylename=para_style_name, text=task_text)
|
||||||
|
task_cell.addElement(p)
|
||||||
|
row.addElement(task_cell)
|
||||||
|
|
||||||
|
status_cell = TableCell(stylename=cell_style_name)
|
||||||
|
p = P(stylename=para_style_name, text=r["status_ru"])
|
||||||
|
status_cell.addElement(p)
|
||||||
|
row.addElement(status_cell)
|
||||||
|
|
||||||
|
time_cell = TableCell(stylename=cell_style_name)
|
||||||
|
time_lines = r["time_text"].split("\n")
|
||||||
|
for i, line in enumerate(time_lines):
|
||||||
|
p = P(stylename=para_style_name, text=line)
|
||||||
|
time_cell.addElement(p)
|
||||||
|
if i < len(time_lines) - 1:
|
||||||
|
time_cell.addElement(P(stylename=para_style_name, text=""))
|
||||||
|
row.addElement(time_cell)
|
||||||
|
|
||||||
|
table.addElement(row)
|
||||||
|
|
||||||
|
first_version_in_project = False
|
||||||
|
|
||||||
|
doc.text.addElement(table)
|
||||||
|
doc.text.addElement(P(stylename=para_style_name, text=""))
|
||||||
|
|
||||||
|
# Справка
|
||||||
|
for line in [
|
||||||
|
"«Наименование Проекта» - Имя собственное устройства или программного обеспечения.",
|
||||||
|
"«Номер версии» - Версия в проекте. Опциональное поле.",
|
||||||
|
"«Задача» - Номер по Redmine и формулировка.",
|
||||||
|
"«Статус» - Актуальное состояние задачи на момент отчета. Статусы: закрыто, в работе, ожидание, решена.",
|
||||||
|
"«Готовность» – Опциональное поле в процентах.",
|
||||||
|
"«Затрачено за отчетный период» - в днях или часах.",
|
||||||
|
]:
|
||||||
|
doc.text.addElement(P(stylename=para_style_name, text=line))
|
||||||
|
|
||||||
|
return doc
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
"""
|
||||||
|
Сохраняет сформированный документ в файл.
|
||||||
|
"""
|
||||||
|
doc = self.format(rows)
|
||||||
|
doc.save(output_path)
|
||||||
214
redmine_reporter/formatters/xlsx.py
Normal file
214
redmine_reporter/formatters/xlsx.py
Normal file
@@ -0,0 +1,214 @@
|
|||||||
|
from typing import Dict, List, Tuple
|
||||||
|
|
||||||
|
from openpyxl import Workbook
|
||||||
|
from openpyxl.styles import Alignment, Border, Font, PatternFill, Side
|
||||||
|
from openpyxl.utils import get_column_letter
|
||||||
|
from openpyxl.worksheet.worksheet import Worksheet
|
||||||
|
|
||||||
|
from ..report_builder import group_rows_by_project_and_version
|
||||||
|
from ..types import ReportRow
|
||||||
|
from ..utils import hours_to_human
|
||||||
|
from .base import Formatter
|
||||||
|
|
||||||
|
|
||||||
|
class XLSXFormatter(Formatter):
|
||||||
|
"""Форматтер для экспорта отчёта в Excel (.xlsx).
|
||||||
|
|
||||||
|
Использует группировку по проекту и версии: объединяет ячейки,
|
||||||
|
добавляет итоги по группам, закрепляет заголовок, включает автофильтр
|
||||||
|
и числовой столбец с часами для удобного суммирования.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_HEADER_FILL = PatternFill(start_color="D9E1F2", end_color="D9E1F2", fill_type="solid")
|
||||||
|
_TOTAL_FILL = PatternFill(start_color="FFF2CC", end_color="FFF2CC", fill_type="solid")
|
||||||
|
_BORDER = Border(
|
||||||
|
left=Side(style="thin"),
|
||||||
|
right=Side(style="thin"),
|
||||||
|
top=Side(style="thin"),
|
||||||
|
bottom=Side(style="thin"),
|
||||||
|
)
|
||||||
|
|
||||||
|
def __init__(self, no_time: bool = False, **_kwargs):
|
||||||
|
super().__init__()
|
||||||
|
self.no_time = no_time
|
||||||
|
|
||||||
|
def format(self, rows: List[ReportRow]) -> Workbook:
|
||||||
|
wb = Workbook()
|
||||||
|
ws = wb.active
|
||||||
|
if ws is None:
|
||||||
|
ws = wb.create_sheet("Report")
|
||||||
|
else:
|
||||||
|
ws.title = "Report"
|
||||||
|
|
||||||
|
headers = ["Project", "Version", "Issue ID", "Subject", "Status", "Hours", "Spent Time"]
|
||||||
|
ws.append(headers)
|
||||||
|
self._style_header_row(ws, headers)
|
||||||
|
|
||||||
|
grouped = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
current_row = 2
|
||||||
|
project_ranges: List[Tuple[int, int]] = []
|
||||||
|
version_ranges: List[Tuple[int, int]] = []
|
||||||
|
project_totals: Dict[str, float] = {}
|
||||||
|
|
||||||
|
for project, versions in grouped.items():
|
||||||
|
project_start_row = current_row
|
||||||
|
|
||||||
|
for version, task_rows in versions.items():
|
||||||
|
version_start_row = current_row
|
||||||
|
|
||||||
|
for r in task_rows:
|
||||||
|
hours = "" if self.no_time else r.get("hours", 0.0)
|
||||||
|
time_text = "" if self.no_time else r["time_text"]
|
||||||
|
ws.append(
|
||||||
|
[
|
||||||
|
project,
|
||||||
|
version,
|
||||||
|
r["issue_id"],
|
||||||
|
r["subject"],
|
||||||
|
r["status_ru"],
|
||||||
|
hours,
|
||||||
|
time_text,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
self._style_data_row(ws, current_row)
|
||||||
|
current_row += 1
|
||||||
|
|
||||||
|
if not self.no_time:
|
||||||
|
version_hours = sum(r.get("hours", 0.0) for r in task_rows)
|
||||||
|
ws.append(
|
||||||
|
[
|
||||||
|
"",
|
||||||
|
f"Total {version}",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
version_hours,
|
||||||
|
hours_to_human(version_hours),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
self._style_total_row(ws, current_row, bold=False)
|
||||||
|
ws.merge_cells(
|
||||||
|
start_row=current_row, start_column=2, end_row=current_row, end_column=5
|
||||||
|
)
|
||||||
|
current_row += 1
|
||||||
|
|
||||||
|
version_end_row = current_row - 1
|
||||||
|
if version_end_row > version_start_row:
|
||||||
|
version_ranges.append((version_start_row, version_end_row))
|
||||||
|
|
||||||
|
if not self.no_time:
|
||||||
|
project_hours = sum(
|
||||||
|
sum(r.get("hours", 0.0) for r in task_rows) for task_rows in versions.values()
|
||||||
|
)
|
||||||
|
ws.append(
|
||||||
|
[
|
||||||
|
f"Total {project}",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
project_hours,
|
||||||
|
hours_to_human(project_hours),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
self._style_total_row(ws, current_row, bold=True)
|
||||||
|
ws.merge_cells(
|
||||||
|
start_row=current_row, start_column=1, end_row=current_row, end_column=5
|
||||||
|
)
|
||||||
|
current_row += 1
|
||||||
|
project_totals[project] = project_hours
|
||||||
|
|
||||||
|
project_end_row = current_row - 1
|
||||||
|
if project_end_row > project_start_row:
|
||||||
|
project_ranges.append((project_start_row, project_end_row))
|
||||||
|
|
||||||
|
if not self.no_time and project_totals:
|
||||||
|
total_hours = sum(project_totals.values())
|
||||||
|
ws.append(
|
||||||
|
[
|
||||||
|
"Total",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
total_hours,
|
||||||
|
hours_to_human(total_hours),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
self._style_total_row(ws, current_row, bold=True)
|
||||||
|
ws.merge_cells(start_row=current_row, start_column=1, end_row=current_row, end_column=5)
|
||||||
|
|
||||||
|
for start, end in project_ranges:
|
||||||
|
ws.merge_cells(start_row=start, start_column=1, end_row=end, end_column=1)
|
||||||
|
cell = ws.cell(row=start, column=1)
|
||||||
|
cell.alignment = Alignment(vertical="top", wrap_text=True)
|
||||||
|
|
||||||
|
for start, end in version_ranges:
|
||||||
|
ws.merge_cells(start_row=start, start_column=2, end_row=end, end_column=2)
|
||||||
|
cell = ws.cell(row=start, column=2)
|
||||||
|
cell.alignment = Alignment(vertical="top", wrap_text=True)
|
||||||
|
|
||||||
|
self._apply_column_widths(ws)
|
||||||
|
if not self.no_time:
|
||||||
|
self._apply_number_format(ws)
|
||||||
|
self._apply_auto_filter(ws, ws.max_row)
|
||||||
|
ws.freeze_panes = "A2"
|
||||||
|
|
||||||
|
return wb
|
||||||
|
|
||||||
|
def save(self, rows: List[ReportRow], output_path: str) -> None:
|
||||||
|
wb = self.format(rows)
|
||||||
|
wb.save(output_path)
|
||||||
|
|
||||||
|
def _style_header_row(self, ws: Worksheet, headers: List[str]) -> None:
|
||||||
|
for col_idx, _ in enumerate(headers, start=1):
|
||||||
|
cell = ws.cell(row=1, column=col_idx)
|
||||||
|
cell.font = Font(bold=True)
|
||||||
|
cell.fill = self._HEADER_FILL
|
||||||
|
cell.border = self._BORDER
|
||||||
|
cell.alignment = Alignment(horizontal="center", vertical="center", wrap_text=True)
|
||||||
|
|
||||||
|
def _style_data_row(self, ws: Worksheet, row: int) -> None:
|
||||||
|
for col_idx in range(1, 8):
|
||||||
|
cell = ws.cell(row=row, column=col_idx)
|
||||||
|
cell.border = self._BORDER
|
||||||
|
if col_idx in (1, 2):
|
||||||
|
cell.alignment = Alignment(vertical="top", wrap_text=True)
|
||||||
|
elif col_idx == 4:
|
||||||
|
cell.alignment = Alignment(vertical="top", wrap_text=True)
|
||||||
|
else:
|
||||||
|
cell.alignment = Alignment(vertical="top")
|
||||||
|
|
||||||
|
def _style_total_row(self, ws: Worksheet, row: int, bold: bool) -> None:
|
||||||
|
for col_idx in range(1, 8):
|
||||||
|
cell = ws.cell(row=row, column=col_idx)
|
||||||
|
cell.border = self._BORDER
|
||||||
|
cell.fill = self._TOTAL_FILL
|
||||||
|
cell.font = Font(bold=bold)
|
||||||
|
cell.alignment = Alignment(vertical="center")
|
||||||
|
|
||||||
|
def _apply_column_widths(self, ws: Worksheet) -> None:
|
||||||
|
# Минимальные ширины по умолчанию
|
||||||
|
widths: Dict[int, float] = {1: 18.0, 2: 16.0, 3: 12.0, 4: 45.0, 5: 14.0, 6: 10.0, 7: 14.0}
|
||||||
|
|
||||||
|
for row in ws.iter_rows(min_row=2, max_row=ws.max_row):
|
||||||
|
for col_idx, cell in enumerate(row, start=1):
|
||||||
|
if cell.value is None:
|
||||||
|
continue
|
||||||
|
text = str(cell.value)
|
||||||
|
# Оценочная ширина: примерно 1.1 символа на единицу ширины Excel
|
||||||
|
estimated = len(text) * 1.1 + 2
|
||||||
|
widths[col_idx] = max(widths[col_idx], min(estimated, 80))
|
||||||
|
|
||||||
|
for col_idx, width in widths.items():
|
||||||
|
ws.column_dimensions[get_column_letter(col_idx)].width = width
|
||||||
|
|
||||||
|
def _apply_number_format(self, ws: Worksheet) -> None:
|
||||||
|
for row in ws.iter_rows(min_row=2, max_row=ws.max_row, min_col=6, max_col=6):
|
||||||
|
for cell in row:
|
||||||
|
if isinstance(cell.value, (int, float)):
|
||||||
|
cell.number_format = "0.00"
|
||||||
|
|
||||||
|
def _apply_auto_filter(self, ws: Worksheet, max_row: int) -> None:
|
||||||
|
ws.auto_filter.ref = f"A1:G{max_row}"
|
||||||
152
redmine_reporter/report_builder.py
Normal file
152
redmine_reporter/report_builder.py
Normal file
@@ -0,0 +1,152 @@
|
|||||||
|
from typing import Dict, List, Optional, Tuple, cast
|
||||||
|
|
||||||
|
from redminelib.resources import Issue
|
||||||
|
|
||||||
|
from .types import ReportRow
|
||||||
|
from .utils import get_version, hours_to_human
|
||||||
|
|
||||||
|
STATUS_TRANSLATION = {
|
||||||
|
"New": "В работе",
|
||||||
|
"In Progress": "В работе",
|
||||||
|
"Feedback": "В работе",
|
||||||
|
"Re-opened": "В работе",
|
||||||
|
"Code Review": "Решена",
|
||||||
|
"Wait Release": "Закрыто",
|
||||||
|
"Pending": "Ожидание",
|
||||||
|
"Resolved": "Решена",
|
||||||
|
"Testing": "Решена",
|
||||||
|
"Confirming": "Ожидание",
|
||||||
|
"Closed": "Закрыто",
|
||||||
|
"Rejected": "Закрыто",
|
||||||
|
"Frozen": "Ожидание",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _format_activities(activities: Dict[str, float]) -> str:
|
||||||
|
"""Форматирует разбивку по активностям в многострочный текст."""
|
||||||
|
if not activities:
|
||||||
|
return ""
|
||||||
|
# Сортируем по убыванию часов, затем по алфавиту для стабильности
|
||||||
|
items = sorted(activities.items(), key=lambda x: (-x[1], x[0]))
|
||||||
|
return "\n".join(f"{hours_to_human(hours)} {name}" for name, hours in items)
|
||||||
|
|
||||||
|
|
||||||
|
def build_grouped_report(
|
||||||
|
issue_hours: List[Tuple[Issue, float, Optional[Dict[str, float]]]],
|
||||||
|
fill_time: bool = True,
|
||||||
|
by_activity: bool = False,
|
||||||
|
) -> List[ReportRow]:
|
||||||
|
"""
|
||||||
|
Преобразует список задач с затраченным временем в плоский список строк отчёта,
|
||||||
|
с учётом группировки по проекту и версии (пустые ячейки для повторяющихся значений).
|
||||||
|
|
||||||
|
Предусловие: issue_hours должен быть отсортирован по (project, version).
|
||||||
|
Функция выполняет сортировку самостоятельно для защиты от несортированного ввода.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Защитная сортировка -- гарантирует корректную группировку независимо от порядка на входе
|
||||||
|
issue_hours = sorted(issue_hours, key=lambda x: (str(x[0].project), get_version(x[0]), x[0].id))
|
||||||
|
|
||||||
|
rows: List[ReportRow] = []
|
||||||
|
prev_project: str = ""
|
||||||
|
prev_version: str = ""
|
||||||
|
|
||||||
|
for issue, hours, *rest in issue_hours:
|
||||||
|
activities: Optional[Dict[str, float]] = rest[0] if rest else None
|
||||||
|
project = str(issue.project)
|
||||||
|
version = get_version(issue)
|
||||||
|
status_en = str(issue.status)
|
||||||
|
status_ru = STATUS_TRANSLATION.get(status_en, status_en)
|
||||||
|
|
||||||
|
if fill_time:
|
||||||
|
if by_activity and activities:
|
||||||
|
time_text = _format_activities(activities)
|
||||||
|
else:
|
||||||
|
time_text = hours_to_human(hours)
|
||||||
|
else:
|
||||||
|
time_text = ""
|
||||||
|
|
||||||
|
display_project = project if project != prev_project else ""
|
||||||
|
display_version = version if (project != prev_project or version != prev_version) else ""
|
||||||
|
|
||||||
|
rows.append(
|
||||||
|
cast(
|
||||||
|
ReportRow,
|
||||||
|
{
|
||||||
|
"project": project,
|
||||||
|
"version": version,
|
||||||
|
"display_project": display_project,
|
||||||
|
"display_version": display_version,
|
||||||
|
"issue_id": issue.id,
|
||||||
|
"subject": issue.subject,
|
||||||
|
"status_ru": status_ru,
|
||||||
|
"time_text": time_text,
|
||||||
|
"hours": round(hours, 2),
|
||||||
|
"activities": activities,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
prev_project = project
|
||||||
|
prev_version = version
|
||||||
|
|
||||||
|
return rows
|
||||||
|
|
||||||
|
|
||||||
|
def calculate_summary(
|
||||||
|
rows: List[ReportRow],
|
||||||
|
by_activity: bool = False,
|
||||||
|
) -> Dict[str, float]:
|
||||||
|
"""Возвращает сводку: общее время, время по проектам, версиям и активностям."""
|
||||||
|
total = 0.0
|
||||||
|
by_project: Dict[str, float] = {}
|
||||||
|
by_project_version: Dict[str, float] = {}
|
||||||
|
by_activity_name: Dict[str, float] = {}
|
||||||
|
|
||||||
|
for r in rows:
|
||||||
|
hours = r.get("hours", 0.0)
|
||||||
|
total += hours
|
||||||
|
by_project[r["project"]] = by_project.get(r["project"], 0.0) + hours
|
||||||
|
key = f"{r['project']}::{r['version']}"
|
||||||
|
by_project_version[key] = by_project_version.get(key, 0.0) + hours
|
||||||
|
|
||||||
|
if by_activity:
|
||||||
|
activities = r.get("activities")
|
||||||
|
if activities:
|
||||||
|
for name, act_hours in activities.items():
|
||||||
|
by_activity_name[name] = by_activity_name.get(name, 0.0) + act_hours
|
||||||
|
|
||||||
|
result: Dict[str, float] = {
|
||||||
|
"total": round(total, 2),
|
||||||
|
**{f"project:{k}": round(v, 2) for k, v in by_project.items()},
|
||||||
|
**{f"version:{k}": round(v, 2) for k, v in by_project_version.items()},
|
||||||
|
}
|
||||||
|
if by_activity:
|
||||||
|
result.update({f"activity:{k}": round(v, 2) for k, v in by_activity_name.items()})
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def group_rows_by_project_and_version(
|
||||||
|
rows: List[ReportRow],
|
||||||
|
) -> Dict[str, Dict[str, List[ReportRow]]]:
|
||||||
|
"""
|
||||||
|
Группирует плоский список строк отчёта в иерархию project → version → [rows].
|
||||||
|
|
||||||
|
Предполагается, что rows уже отсортирован (build_grouped_report это гарантирует).
|
||||||
|
Возвращает обычный dict, сохраняющий порядок вставки (Python 3.7+).
|
||||||
|
Используется форматтерами HTML и ODT для объединения ячеек.
|
||||||
|
"""
|
||||||
|
projects: Dict[str, Dict[str, List[ReportRow]]] = {}
|
||||||
|
for r in rows:
|
||||||
|
project = r["project"]
|
||||||
|
version = r["version"]
|
||||||
|
|
||||||
|
if project not in projects:
|
||||||
|
projects[project] = {}
|
||||||
|
if version not in projects[project]:
|
||||||
|
projects[project][version] = []
|
||||||
|
|
||||||
|
projects[project][version].append(r)
|
||||||
|
|
||||||
|
return projects
|
||||||
BIN
redmine_reporter/templates/template.odt
Normal file
BIN
redmine_reporter/templates/template.odt
Normal file
Binary file not shown.
21
redmine_reporter/types.py
Normal file
21
redmine_reporter/types.py
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
from typing import Dict, Optional, TypedDict
|
||||||
|
|
||||||
|
|
||||||
|
class ReportRowBase(TypedDict):
|
||||||
|
"""Строка итогового отчёта."""
|
||||||
|
|
||||||
|
project: str
|
||||||
|
version: str
|
||||||
|
display_project: str
|
||||||
|
display_version: str
|
||||||
|
issue_id: int
|
||||||
|
subject: str
|
||||||
|
status_ru: str
|
||||||
|
time_text: str
|
||||||
|
hours: float
|
||||||
|
|
||||||
|
|
||||||
|
class ReportRow(ReportRowBase, total=False):
|
||||||
|
"""Строка итогового отчёта с опциональной разбивкой по активностям."""
|
||||||
|
|
||||||
|
activities: Optional[Dict[str, float]]
|
||||||
@@ -1,2 +1,56 @@
|
|||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
|
||||||
|
def get_month_name_from_range(from_date: str, to_date: str) -> str:
|
||||||
|
"""Определяет название месяца по диапазону дат"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
end = datetime.strptime(to_date, "%Y-%m-%d")
|
||||||
|
except ValueError:
|
||||||
|
return "Январь"
|
||||||
|
|
||||||
|
months = [
|
||||||
|
"",
|
||||||
|
"Январь",
|
||||||
|
"Февраль",
|
||||||
|
"Март",
|
||||||
|
"Апрель",
|
||||||
|
"Май",
|
||||||
|
"Июнь",
|
||||||
|
"Июль",
|
||||||
|
"Август",
|
||||||
|
"Сентябрь",
|
||||||
|
"Октябрь",
|
||||||
|
"Ноябрь",
|
||||||
|
"Декабрь",
|
||||||
|
]
|
||||||
|
|
||||||
|
return months[end.month]
|
||||||
|
|
||||||
|
|
||||||
def get_version(issue) -> str:
|
def get_version(issue) -> str:
|
||||||
return str(getattr(issue, 'fixed_version', '<N/A>'))
|
"""Возвращает версию задачи или '<N/A>', если не задана."""
|
||||||
|
version = getattr(issue, "fixed_version", None)
|
||||||
|
if version is None:
|
||||||
|
return "<N/A>"
|
||||||
|
name = getattr(version, "name", None)
|
||||||
|
return str(name) if name else str(version)
|
||||||
|
|
||||||
|
|
||||||
|
def hours_to_human(hours: float) -> str:
|
||||||
|
"""Преобразует часы в человекочитаемый формат: '2ч 30м'."""
|
||||||
|
|
||||||
|
if hours <= 0:
|
||||||
|
return "0ч"
|
||||||
|
|
||||||
|
total_minutes = round(hours * 60)
|
||||||
|
h = total_minutes // 60
|
||||||
|
m = total_minutes % 60
|
||||||
|
parts = []
|
||||||
|
|
||||||
|
if h:
|
||||||
|
parts.append(f"{h}ч")
|
||||||
|
if m:
|
||||||
|
parts.append(f"{m}м")
|
||||||
|
|
||||||
|
return " ".join(parts) if parts else "0ч"
|
||||||
|
|||||||
@@ -1,20 +1,303 @@
|
|||||||
|
import os
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from redmine_reporter.cli import parse_date_range
|
|
||||||
|
from redmine_reporter.cli import main, parse_date_range
|
||||||
|
|
||||||
|
VALID_ENV = {
|
||||||
|
"REDMINE_URL": "https://red.eltex.loc",
|
||||||
|
"REDMINE_API_KEY": "token",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
def test_parse_date_range_valid():
|
@pytest.fixture(autouse=True)
|
||||||
assert parse_date_range("2025-01-01--2025-12-31") == ("2025-01-01", "2025-12-31")
|
def _reset_config_overrides():
|
||||||
|
"""Сбрасывает CLI-переопределения Config перед каждым тестом."""
|
||||||
|
from redmine_reporter.config import Config
|
||||||
|
|
||||||
|
Config.set_redmine_url("")
|
||||||
|
Config.set_redmine_api_key("")
|
||||||
|
yield
|
||||||
|
Config.set_redmine_url("")
|
||||||
|
Config.set_redmine_api_key("")
|
||||||
|
|
||||||
|
|
||||||
def test_parse_date_range_with_spaces():
|
@pytest.mark.parametrize(
|
||||||
assert parse_date_range("2025-01-01 -- 2025-12-31") == ("2025-01-01", "2025-12-31")
|
"date_arg, expected",
|
||||||
|
[
|
||||||
|
("2026-01-01--2026-01-31", ("2026-01-01", "2026-01-31")),
|
||||||
|
(" 2026-01-01 -- 2026-01-31 ", ("2026-01-01", "2026-01-31")),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_parse_date_range_valid(date_arg, expected):
|
||||||
|
assert parse_date_range(date_arg) == expected
|
||||||
|
|
||||||
|
|
||||||
def test_parse_date_range_invalid_no_separator():
|
@pytest.mark.parametrize(
|
||||||
with pytest.raises(ValueError, match="must be in format"):
|
"date_arg",
|
||||||
parse_date_range("2025-01-01")
|
[
|
||||||
|
"20260101-20260131",
|
||||||
|
"2026-1-01--2026-01-31",
|
||||||
|
"2026-02-30--2026-03-01",
|
||||||
|
"2026-02-01--2026-01-31",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_parse_date_range_invalid(date_arg):
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
parse_date_range(date_arg)
|
||||||
|
|
||||||
|
|
||||||
def test_parse_date_range_invalid_parts():
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
with pytest.raises(ValueError, match="Invalid date range format"):
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
parse_date_range("2025-01-01--")
|
def test_cli_returns_zero_on_no_entries(mock_fetch):
|
||||||
|
"""None от fetch (нет time entries) -- выход 0."""
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
assert code == 0
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
def test_cli_config_error():
|
||||||
|
"""Невалидный конфиг -- выход 1."""
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
def test_cli_invalid_date_format():
|
||||||
|
"""Неверный формат даты -- выход 1."""
|
||||||
|
code = main(["--date", "20260101-20260131"])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
|
||||||
|
class _MockIssue:
|
||||||
|
"""Простой mock Redmine Issue для CLI-тестов."""
|
||||||
|
|
||||||
|
def __init__(self, issue_id=1, subject="Task", project="Project", status="New"):
|
||||||
|
self.id = issue_id
|
||||||
|
self.subject = subject
|
||||||
|
self.project = project
|
||||||
|
self.status = status
|
||||||
|
self.fixed_version = None
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_unknown_output_extension(mock_fetch, tmp_path):
|
||||||
|
"""Неизвестное расширение файла -- выход 1."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
output = str(tmp_path / "report.xyz")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--output", output])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_output_without_extension(mock_fetch, tmp_path):
|
||||||
|
"""Файл без расширения -- выход 1 с подсказкой."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
output = str(tmp_path / "report")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--output", output])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
@mock.patch("redmine_reporter.cli.get_formatter_by_extension")
|
||||||
|
def test_cli_odt_missing_odfpy_message(mock_gf, mock_fetch, tmp_path, capsys):
|
||||||
|
"""При запросе .odt без odfpy — выход 1, понятное сообщение про odfpy."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
mock_gf.return_value = None
|
||||||
|
output = str(tmp_path / "report.odt")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--output", output])
|
||||||
|
assert code == 1
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "odfpy" in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
def test_cli_version_flag(capsys):
|
||||||
|
"""--version выводит версию и завершается с 0."""
|
||||||
|
with pytest.raises(SystemExit) as exc_info:
|
||||||
|
main(["--version"])
|
||||||
|
assert exc_info.value.code == 0
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "redmine-reporter" in captured.out
|
||||||
|
from redmine_reporter import __version__
|
||||||
|
|
||||||
|
assert __version__ in captured.out
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_verbose_and_debug_flags_accepted(mock_fetch):
|
||||||
|
"""--verbose и --debug не ломают запуск."""
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--verbose"])
|
||||||
|
assert code == 0
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--debug"])
|
||||||
|
assert code == 0
|
||||||
|
|
||||||
|
|
||||||
|
class _MockIssue:
|
||||||
|
"""Простой mock Redmine Issue для CLI-тестов."""
|
||||||
|
|
||||||
|
def __init__(self, issue_id=1, subject="Task", project="Project", status="New"):
|
||||||
|
self.id = issue_id
|
||||||
|
self.subject = subject
|
||||||
|
self.project = project
|
||||||
|
self.status = status
|
||||||
|
self.fixed_version = None
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_url_and_api_key_override_env(mock_fetch):
|
||||||
|
"""--url и --api-key переопределяют отсутствующие/другие env-переменные."""
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
code = main(
|
||||||
|
[
|
||||||
|
"--date",
|
||||||
|
"2026-01-01--2026-01-31",
|
||||||
|
"--url",
|
||||||
|
"https://other.redmine.loc",
|
||||||
|
"--api-key",
|
||||||
|
"cli-token",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
assert code == 0
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_config_file_loading(mock_fetch, tmp_path):
|
||||||
|
"""--config загружает переменные из указанного .env-файла."""
|
||||||
|
config_path = tmp_path / "custom.env"
|
||||||
|
config_path.write_text(
|
||||||
|
"REDMINE_URL=https://config.redmine.loc\n" "REDMINE_API_KEY=config-token\n",
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31", "--config", str(config_path)])
|
||||||
|
assert code == 0
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_summary_flag_prints_totals(mock_fetch, capsys):
|
||||||
|
"""--summary выводит общее время и разбивку по проектам в stderr."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
main(["--date", "2026-01-01--2026-01-31", "--summary"])
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "Total time" in captured.err
|
||||||
|
assert "Project" in captured.err or "Project" in captured.out
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_total_issues_message_goes_to_stderr(mock_fetch, capsys):
|
||||||
|
"""«Total issues» пишется в stderr, не загрязняя stdout при pipe (#28)."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "Total issues" not in captured.out
|
||||||
|
assert "Total issues" in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_prints_readable_auth_error(mock_fetch, capsys):
|
||||||
|
"""CLI выводит понятное сообщение при ошибке аутентификации."""
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
mock_fetch.side_effect = RedmineAPIError("Authentication failed: bad key")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert code == 1
|
||||||
|
assert "Authentication failed" in captured.err
|
||||||
|
assert "Redmine API error" not in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_prints_readable_forbidden_error(mock_fetch, capsys):
|
||||||
|
"""CLI выводит понятное сообщение при недостаточных правах."""
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
mock_fetch.side_effect = RedmineAPIError("Access denied: no permission")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert code == 1
|
||||||
|
assert "Access denied" in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_prints_readable_timeout_error(mock_fetch, capsys):
|
||||||
|
"""CLI выводит понятное сообщение при таймауте."""
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
mock_fetch.side_effect = RedmineAPIError("Redmine request timed out after 30 seconds")
|
||||||
|
code = main(["--date", "2026-01-01--2026-01-31"])
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert code == 1
|
||||||
|
assert "timed out" in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_no_time_passed_to_formatter(mock_fetch, tmp_path):
|
||||||
|
"""CLI --no-time передаётся в файловый форматтер."""
|
||||||
|
issue = _MockIssue()
|
||||||
|
mock_fetch.return_value = [(issue, 1.0)]
|
||||||
|
|
||||||
|
output = str(tmp_path / "report.xlsx")
|
||||||
|
with mock.patch("redmine_reporter.cli.get_formatter_by_extension") as mock_get_formatter:
|
||||||
|
mock_formatter = mock.MagicMock()
|
||||||
|
mock_get_formatter.return_value = mock_formatter
|
||||||
|
main(["--date", "2026-01-01--2026-01-31", "--output", output, "--no-time"])
|
||||||
|
|
||||||
|
_, kwargs = mock_get_formatter.call_args
|
||||||
|
assert kwargs.get("no_time") is True
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_passes_user_id_to_fetch(mock_fetch):
|
||||||
|
"""CLI --user-id передаётся в fetch_issues_with_spent_time."""
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
main(["--date", "2026-01-01--2026-01-31", "--user-id", "42"])
|
||||||
|
_, kwargs = mock_fetch.call_args
|
||||||
|
assert kwargs["user_id"] == "42"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.cli.fetch_issues_with_spent_time")
|
||||||
|
def test_cli_passes_user_login_to_fetch(mock_fetch):
|
||||||
|
"""CLI --user-login передаётся в fetch_issues_with_spent_time."""
|
||||||
|
mock_fetch.return_value = None
|
||||||
|
main(["--date", "2026-01-01--2026-01-31", "--user-login", "ivanov"])
|
||||||
|
_, kwargs = mock_fetch.call_args
|
||||||
|
assert kwargs["user_id"] == "ivanov"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, VALID_ENV, clear=True)
|
||||||
|
def test_cli_rejects_multiple_user_flags():
|
||||||
|
"""CLI не принимает одновременно несколько флагов пользователя."""
|
||||||
|
code = main(
|
||||||
|
[
|
||||||
|
"--date",
|
||||||
|
"2026-01-01--2026-01-31",
|
||||||
|
"--user-id",
|
||||||
|
"42",
|
||||||
|
"--user-login",
|
||||||
|
"ivanov",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
assert code == 1
|
||||||
|
|||||||
437
tests/test_client.py
Normal file
437
tests/test_client.py
Normal file
@@ -0,0 +1,437 @@
|
|||||||
|
import os
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from redmine_reporter.client import fetch_issues_with_spent_time
|
||||||
|
from redmine_reporter.config import DEFAULT_REDMINE_VERIFY
|
||||||
|
|
||||||
|
PASSWORD_ENV = {
|
||||||
|
"REDMINE_URL": "https://red.eltex.loc",
|
||||||
|
"REDMINE_USER": "user",
|
||||||
|
"REDMINE_PASSWORD": "password",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_current_user(mock_redmine, user_id=1):
|
||||||
|
mock_user = mock.MagicMock()
|
||||||
|
mock_user.id = user_id
|
||||||
|
mock_redmine.user.get.return_value = mock_user
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_aggregates_hours_per_issue(mock_redmine_class):
|
||||||
|
"""Два time entry на одну задачу -- часы суммируются."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine, user_id=123)
|
||||||
|
|
||||||
|
mock_entry1 = mock.MagicMock()
|
||||||
|
mock_entry1.issue.id = 101
|
||||||
|
mock_entry1.hours = 2.0
|
||||||
|
mock_entry2 = mock.MagicMock()
|
||||||
|
mock_entry2.issue.id = 101
|
||||||
|
mock_entry2.hours = 1.5
|
||||||
|
mock_redmine.time_entry.filter.return_value = [mock_entry1, mock_entry2]
|
||||||
|
|
||||||
|
mock_issue = mock.MagicMock()
|
||||||
|
mock_issue.id = 101
|
||||||
|
mock_issue.project = "Проект X"
|
||||||
|
mock_issue.subject = "Тестовая задача"
|
||||||
|
mock_issue.status = "New"
|
||||||
|
mock_redmine.issue.filter.return_value = [mock_issue]
|
||||||
|
|
||||||
|
result = fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
assert result is not None
|
||||||
|
assert len(result) == 1
|
||||||
|
issue, total_hours, _activities = result[0]
|
||||||
|
assert total_hours == 3.5
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_returns_none_when_no_entries(mock_redmine_class):
|
||||||
|
"""Нет time entries -- возвращается None."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
result = fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
assert result is None
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_skips_entries_without_issue(mock_redmine_class):
|
||||||
|
"""Time entry без привязки к задаче игнорируется."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
# entry без issue атрибута
|
||||||
|
entry_no_issue = mock.MagicMock(spec=["hours"]) # нет .issue
|
||||||
|
entry_no_issue.hours = 1.0
|
||||||
|
|
||||||
|
mock_redmine.time_entry.filter.return_value = [entry_no_issue]
|
||||||
|
|
||||||
|
result = fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
assert result is None
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_multiple_issues(mock_redmine_class):
|
||||||
|
"""Несколько задач -- каждая с правильным суммарным временем."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
def make_entry(issue_id, hours):
|
||||||
|
e = mock.MagicMock()
|
||||||
|
e.issue.id = issue_id
|
||||||
|
e.hours = hours
|
||||||
|
return e
|
||||||
|
|
||||||
|
mock_redmine.time_entry.filter.return_value = [
|
||||||
|
make_entry(1, 1.0),
|
||||||
|
make_entry(2, 2.0),
|
||||||
|
make_entry(1, 0.5),
|
||||||
|
]
|
||||||
|
|
||||||
|
mock_issue1 = mock.MagicMock()
|
||||||
|
mock_issue1.id = 1
|
||||||
|
mock_issue1.project = "P"
|
||||||
|
mock_issue2 = mock.MagicMock()
|
||||||
|
mock_issue2.id = 2
|
||||||
|
mock_issue2.project = "P"
|
||||||
|
mock_redmine.issue.filter.return_value = [mock_issue1, mock_issue2]
|
||||||
|
|
||||||
|
result = fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
assert result is not None
|
||||||
|
assert len(result) == 2
|
||||||
|
|
||||||
|
hours_by_id = {issue.id: hours for issue, hours, _ in result}
|
||||||
|
assert hours_by_id[1] == 1.5
|
||||||
|
assert hours_by_id[2] == 2.0
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(
|
||||||
|
os.environ,
|
||||||
|
{
|
||||||
|
"REDMINE_URL": "https://red.eltex.loc",
|
||||||
|
"REDMINE_API_KEY": "api-token",
|
||||||
|
"REDMINE_USER": "user",
|
||||||
|
"REDMINE_PASSWORD": "password",
|
||||||
|
},
|
||||||
|
clear=True,
|
||||||
|
)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_uses_api_key_when_present(mock_redmine_class):
|
||||||
|
"""Если задан API key, он используется вместо логина/пароля."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine_class.call_args
|
||||||
|
assert kwargs["key"] == "api-token"
|
||||||
|
assert kwargs["requests"]["verify"] == DEFAULT_REDMINE_VERIFY
|
||||||
|
assert "username" not in kwargs
|
||||||
|
assert "password" not in kwargs
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_uses_username_password_when_no_api_key(mock_redmine_class):
|
||||||
|
"""Если API key не задан, остаётся старая схема логин/пароль."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine_class.call_args
|
||||||
|
assert kwargs["username"] == "user"
|
||||||
|
assert kwargs["password"] == "password"
|
||||||
|
assert kwargs["requests"]["verify"] == DEFAULT_REDMINE_VERIFY
|
||||||
|
assert "key" not in kwargs
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {**PASSWORD_ENV, "REDMINE_VERIFY": "/tmp/redmine-ca.pem"}, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_uses_custom_verify_path(mock_redmine_class):
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine_class.call_args
|
||||||
|
assert kwargs["requests"]["verify"] == "/tmp/redmine-ca.pem"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_raises_redmine_api_error_on_auth(mock_redmine_class):
|
||||||
|
"""AuthError превращается в RedmineAPIError с понятным сообщением."""
|
||||||
|
from redminelib.exceptions import AuthError
|
||||||
|
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
mock_redmine.user.get.side_effect = AuthError()
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="Authentication failed"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_raises_redmine_api_error_on_forbidden(mock_redmine_class):
|
||||||
|
"""ForbiddenError превращается в RedmineAPIError с понятным сообщением."""
|
||||||
|
from redminelib.exceptions import ForbiddenError
|
||||||
|
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
mock_redmine.user.get.side_effect = ForbiddenError()
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="Access denied"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_raises_redmine_api_error_on_timeout(mock_redmine_class):
|
||||||
|
"""requests Timeout превращается в RedmineAPIError с понятным сообщением."""
|
||||||
|
import requests
|
||||||
|
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
mock_redmine.user.get.side_effect = requests.exceptions.Timeout("timeout")
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="timed out"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_raises_redmine_api_error_on_connection_error(mock_redmine_class):
|
||||||
|
"""ConnectionError превращается в RedmineAPIError с понятным сообщением."""
|
||||||
|
import requests
|
||||||
|
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
mock_redmine.user.get.side_effect = requests.exceptions.ConnectionError("no route")
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="Cannot connect"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_raises_redmine_api_error_on_http_500(mock_redmine_class):
|
||||||
|
"""HTTP 500 превращается в RedmineAPIError с понятным сообщением."""
|
||||||
|
import requests
|
||||||
|
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
response = requests.Response()
|
||||||
|
response.status_code = 500
|
||||||
|
mock_redmine.user.get.side_effect = requests.exceptions.HTTPError(
|
||||||
|
"server error", response=response
|
||||||
|
)
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="server error"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_uses_specified_user_id(mock_redmine_class):
|
||||||
|
"""user_id передаётся в time_entry.filter вместо текущего пользователя."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id=42)
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine.time_entry.filter.call_args
|
||||||
|
assert kwargs["user_id"] == 42
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_resolves_user_login_to_id(mock_redmine_class):
|
||||||
|
"""Строковый логин разрешается в числовой ID."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
mock_user = mock.MagicMock()
|
||||||
|
mock_user.id = 7
|
||||||
|
mock_redmine.user.filter.return_value = [mock_user]
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id="ivanov")
|
||||||
|
|
||||||
|
login_filter_call = mock_redmine.user.filter.call_args_list[0]
|
||||||
|
assert login_filter_call.kwargs == {"login": "ivanov"}
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine.time_entry.filter.call_args
|
||||||
|
assert kwargs["user_id"] == 7
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_resolves_user_name_to_id(mock_redmine_class):
|
||||||
|
"""Строковое имя разрешается в числовой ID, если найден ровно один пользователь."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
mock_redmine.user.filter.side_effect = [
|
||||||
|
[], # поиск по логину не дал результатов
|
||||||
|
[mock.MagicMock(id=9)], # поиск по имени нашёл одного
|
||||||
|
]
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id="Иванов И.И.")
|
||||||
|
|
||||||
|
name_filter_call = mock_redmine.user.filter.call_args_list[1]
|
||||||
|
assert name_filter_call.kwargs == {"name": "Иванов И.И."}
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine.time_entry.filter.call_args
|
||||||
|
assert kwargs["user_id"] == 9
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_rejects_ambiguous_user_name(mock_redmine_class):
|
||||||
|
"""Если по имени найдено несколько пользователей — ошибка с понятным сообщением."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
mock_redmine.user.filter.side_effect = [
|
||||||
|
[], # поиск по логину не дал результатов
|
||||||
|
[mock.MagicMock(id=1), mock.MagicMock(id=2)], # по имени — несколько
|
||||||
|
]
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="Multiple users match"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id="Иванов")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_rejects_unknown_user_login(mock_redmine_class):
|
||||||
|
"""Если пользователь не найден — ошибка с предложением использовать --user-id."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
mock_redmine.user.filter.return_value = []
|
||||||
|
|
||||||
|
from redmine_reporter.client import RedmineAPIError
|
||||||
|
|
||||||
|
with pytest.raises(RedmineAPIError, match="not found"):
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id="unknown")
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_numeric_string_user_id(mock_redmine_class):
|
||||||
|
"""Строка из цифр интерпретируется как числовой ID."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31", user_id="42")
|
||||||
|
|
||||||
|
assert mock_redmine.user.filter.call_count == 0
|
||||||
|
_, kwargs = mock_redmine.time_entry.filter.call_args
|
||||||
|
assert kwargs["user_id"] == 42
|
||||||
|
|
||||||
|
|
||||||
|
# -- #24: Таймаут и retry --
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_sets_timeout_in_requests(mock_redmine_class):
|
||||||
|
"""В requests dict передаётся timeout (#24)."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
_, kwargs = mock_redmine_class.call_args
|
||||||
|
assert "timeout" in kwargs["requests"]
|
||||||
|
assert kwargs["requests"]["timeout"] == 30
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_mounts_retry_adapter(mock_redmine_class):
|
||||||
|
"""На сессию монтируется HTTPAdapter с retry для временных ошибок (#24)."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
mock_redmine.time_entry.filter.return_value = []
|
||||||
|
|
||||||
|
fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
# Проверяем, что engine.session.mount был вызван для http:// и https://
|
||||||
|
mount_calls = mock_redmine.engine.session.mount.call_args_list
|
||||||
|
prefixes = [call.args[0] for call in mount_calls]
|
||||||
|
assert "https://" in prefixes
|
||||||
|
assert "http://" in prefixes
|
||||||
|
|
||||||
|
# Проверяем retry-конфигурацию адаптера
|
||||||
|
https_adapter = next(call.args[1] for call in mount_calls if call.args[0] == "https://")
|
||||||
|
max_retries = https_adapter.max_retries
|
||||||
|
assert max_retries.total == 3
|
||||||
|
assert 429 in max_retries.status_forcelist
|
||||||
|
|
||||||
|
|
||||||
|
# -- #21: Чанкирование issue_ids --
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, PASSWORD_ENV, clear=True)
|
||||||
|
@mock.patch("redmine_reporter.client.Redmine")
|
||||||
|
def test_fetch_chunks_large_issue_count(mock_redmine_class):
|
||||||
|
"""При >100 задач запросы разбиваются на чанки (#21)."""
|
||||||
|
mock_redmine = mock_redmine_class.return_value
|
||||||
|
_configure_current_user(mock_redmine)
|
||||||
|
|
||||||
|
# 250 time entries → 250 уникальных issue_id
|
||||||
|
entries = []
|
||||||
|
for i in range(1, 251):
|
||||||
|
e = mock.MagicMock()
|
||||||
|
e.issue.id = i
|
||||||
|
e.hours = 1.0
|
||||||
|
entries.append(e)
|
||||||
|
mock_redmine.time_entry.filter.return_value = entries
|
||||||
|
|
||||||
|
# issue.filter вызывается с чанками по 100 ID
|
||||||
|
call_chunks = []
|
||||||
|
|
||||||
|
def issue_filter_side_effect(**kwargs):
|
||||||
|
ids_str = kwargs.get("issue_id", "")
|
||||||
|
call_chunks.append(ids_str)
|
||||||
|
ids = [int(x) for x in ids_str.split(",")]
|
||||||
|
return [mock.MagicMock(id=i, project="P", subject="T", status="New") for i in ids]
|
||||||
|
|
||||||
|
mock_redmine.issue.filter.side_effect = issue_filter_side_effect
|
||||||
|
|
||||||
|
result = fetch_issues_with_spent_time("2026-01-01", "2026-01-31")
|
||||||
|
|
||||||
|
# Должно быть 3 вызова (100 + 100 + 50)
|
||||||
|
assert len(call_chunks) == 3
|
||||||
|
assert len(call_chunks[0].split(",")) == 100
|
||||||
|
assert len(call_chunks[1].split(",")) == 100
|
||||||
|
assert len(call_chunks[2].split(",")) == 50
|
||||||
|
assert result is not None
|
||||||
|
assert len(result) == 250
|
||||||
135
tests/test_config.py
Normal file
135
tests/test_config.py
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
import os
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from redmine_reporter.config import DEFAULT_REDMINE_VERIFY, Config
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(
|
||||||
|
os.environ,
|
||||||
|
{
|
||||||
|
"REDMINE_URL": "https://red.eltex.loc/",
|
||||||
|
"REDMINE_USER": "test",
|
||||||
|
"REDMINE_PASSWORD": "secret",
|
||||||
|
},
|
||||||
|
clear=True,
|
||||||
|
)
|
||||||
|
def test_config_valid_with_password_fallback():
|
||||||
|
Config.validate() # не должно быть исключения
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(
|
||||||
|
os.environ,
|
||||||
|
{
|
||||||
|
"REDMINE_URL": "https://red.eltex.loc/",
|
||||||
|
"REDMINE_API_KEY": "token",
|
||||||
|
},
|
||||||
|
clear=True,
|
||||||
|
)
|
||||||
|
def test_config_valid_with_api_key():
|
||||||
|
Config.validate() # не должно быть исключения
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
def test_config_missing_url():
|
||||||
|
with pytest.raises(ValueError, match="REDMINE_URL"):
|
||||||
|
Config.validate()
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {"REDMINE_URL": "https://red.eltex.loc/"}, clear=True)
|
||||||
|
def test_config_missing_auth():
|
||||||
|
with pytest.raises(ValueError, match="REDMINE_API_KEY"):
|
||||||
|
Config.validate()
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {"REDMINE_URL": " https://red.eltex.loc/ "}, clear=True)
|
||||||
|
def test_get_redmine_url_strips_spaces_and_trailing_slash():
|
||||||
|
assert Config.get_redmine_url() == "https://red.eltex.loc"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {"REDMINE_AUTHOR": " Иванов И.И. "}, clear=True)
|
||||||
|
def test_get_author():
|
||||||
|
assert Config.get_author("") == "Иванов И.И."
|
||||||
|
assert Config.get_author("Петров П.П.") == "Петров П.П."
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
def test_get_author_fallback():
|
||||||
|
"""Если ни CLI, ни .env не задали автора -- возвращается пустая строка."""
|
||||||
|
assert Config.get_author("") == ""
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(
|
||||||
|
os.environ,
|
||||||
|
{
|
||||||
|
"DEFAULT_FROM_DATE": "2026-01-01",
|
||||||
|
"DEFAULT_TO_DATE": "2026-01-31",
|
||||||
|
},
|
||||||
|
clear=True,
|
||||||
|
)
|
||||||
|
def test_get_default_date_range_from_env():
|
||||||
|
assert Config.get_default_date_range() == "2026-01-01--2026-01-31"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
def test_get_default_date_range_fallback():
|
||||||
|
"""Если даты не заданы -- используется текущий месяц."""
|
||||||
|
from datetime import date, timedelta
|
||||||
|
|
||||||
|
today = date.today()
|
||||||
|
start = today.replace(day=1)
|
||||||
|
if today.month == 12:
|
||||||
|
next_month = today.replace(year=today.year + 1, month=1, day=1)
|
||||||
|
else:
|
||||||
|
next_month = today.replace(month=today.month + 1, day=1)
|
||||||
|
end = next_month - timedelta(days=1)
|
||||||
|
|
||||||
|
result = Config.get_default_date_range()
|
||||||
|
assert result == f"{start.isoformat()}--{end.isoformat()}"
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {}, clear=True)
|
||||||
|
def test_get_redmine_verify_default():
|
||||||
|
assert Config.get_redmine_verify() == DEFAULT_REDMINE_VERIFY
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("value", ["0", "false", "False", "no", "off"])
|
||||||
|
def test_get_redmine_verify_false_values(value):
|
||||||
|
with mock.patch.dict(os.environ, {"REDMINE_VERIFY": value}, clear=True):
|
||||||
|
assert Config.get_redmine_verify() is False
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("value", ["1", "true", "True", "yes", "on"])
|
||||||
|
def test_get_redmine_verify_true_values(value):
|
||||||
|
with mock.patch.dict(os.environ, {"REDMINE_VERIFY": value}, clear=True):
|
||||||
|
assert Config.get_redmine_verify() is True
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {"REDMINE_VERIFY": "/tmp/redmine-ca.pem"}, clear=True)
|
||||||
|
def test_get_redmine_verify_custom_path():
|
||||||
|
assert Config.get_redmine_verify() == "/tmp/redmine-ca.pem"
|
||||||
|
|
||||||
|
|
||||||
|
# -- #15: .env не должен переопределять переменные окружения --
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch("dotenv.load_dotenv")
|
||||||
|
def test_env_var_takes_priority_over_dotenv(mock_load):
|
||||||
|
"""load_dotenv вызывается с override=False — env vars не перебиваются .env."""
|
||||||
|
import importlib
|
||||||
|
|
||||||
|
from redmine_reporter import config as cfg_mod
|
||||||
|
|
||||||
|
importlib.reload(cfg_mod)
|
||||||
|
|
||||||
|
mock_load.assert_called_once_with(override=False)
|
||||||
|
|
||||||
|
|
||||||
|
# -- #35: get_redmine_password должен делать .strip() --
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch.dict(os.environ, {"REDMINE_PASSWORD": " secret123 "}, clear=True)
|
||||||
|
def test_get_redmine_password_strips_whitespace():
|
||||||
|
"""Пароль обрезается от whitespace, как и все остальные геттеры."""
|
||||||
|
assert Config.get_redmine_password() == "secret123"
|
||||||
546
tests/test_formatters.py
Normal file
546
tests/test_formatters.py
Normal file
@@ -0,0 +1,546 @@
|
|||||||
|
import io
|
||||||
|
import json
|
||||||
|
from typing import List
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from odf.opendocument import OpenDocument, OpenDocumentText
|
||||||
|
|
||||||
|
from redmine_reporter.formatters.console import CompactFormatter, TableFormatter
|
||||||
|
from redmine_reporter.formatters.csv import CSVFormatter
|
||||||
|
from redmine_reporter.formatters.factory import get_formatter_by_extension
|
||||||
|
from redmine_reporter.formatters.html import HTMLFormatter
|
||||||
|
from redmine_reporter.formatters.json import JSONFormatter
|
||||||
|
from redmine_reporter.formatters.markdown import MarkdownFormatter
|
||||||
|
from redmine_reporter.formatters.odt import ODTFormatter
|
||||||
|
from redmine_reporter.formatters.xlsx import XLSXFormatter
|
||||||
|
from redmine_reporter.types import ReportRow
|
||||||
|
|
||||||
|
|
||||||
|
def _make_empty_odt_bytes() -> bytes:
|
||||||
|
"""Создаёт минимальный валидный ODT-документ в памяти."""
|
||||||
|
doc = OpenDocumentText()
|
||||||
|
buf = io.BytesIO()
|
||||||
|
doc.save(buf)
|
||||||
|
return buf.getvalue()
|
||||||
|
|
||||||
|
|
||||||
|
def make_fake_report_rows() -> List[ReportRow]:
|
||||||
|
"""
|
||||||
|
Генерирует фейковый отчёт с полным покрытием логики группировки:
|
||||||
|
- Проект A: версия v1.0 (2 задачи), версия v2.0 (1 задача)
|
||||||
|
- Проект B: версия <N/A> (1 задача)
|
||||||
|
- Проект C: версия v1.0 (1 задача), версия v1.1 (2 задачи)
|
||||||
|
"""
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"project": "Проект A",
|
||||||
|
"version": "v1.0",
|
||||||
|
"display_project": "Проект A",
|
||||||
|
"display_version": "v1.0",
|
||||||
|
"issue_id": 101,
|
||||||
|
"subject": "Реализовать фичу X",
|
||||||
|
"status_ru": "В работе",
|
||||||
|
"time_text": "4ч 30м",
|
||||||
|
"hours": 4.5,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект A",
|
||||||
|
"version": "v1.0",
|
||||||
|
"display_project": "",
|
||||||
|
"display_version": "",
|
||||||
|
"issue_id": 102,
|
||||||
|
"subject": "Исправить баг Y",
|
||||||
|
"status_ru": "Решена",
|
||||||
|
"time_text": "2ч",
|
||||||
|
"hours": 2.0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект A",
|
||||||
|
"version": "v2.0",
|
||||||
|
"display_project": "",
|
||||||
|
"display_version": "v2.0",
|
||||||
|
"issue_id": 103,
|
||||||
|
"subject": "Документация Z",
|
||||||
|
"status_ru": "Ожидание",
|
||||||
|
"time_text": "1ч",
|
||||||
|
"hours": 1.0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект B",
|
||||||
|
"version": "<N/A>",
|
||||||
|
"display_project": "Проект B",
|
||||||
|
"display_version": "<N/A>",
|
||||||
|
"issue_id": 201,
|
||||||
|
"subject": "Обновить README",
|
||||||
|
"status_ru": "Закрыто",
|
||||||
|
"time_text": "0ч",
|
||||||
|
"hours": 0.0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект C",
|
||||||
|
"version": "v1.0",
|
||||||
|
"display_project": "Проект C",
|
||||||
|
"display_version": "v1.0",
|
||||||
|
"issue_id": 301,
|
||||||
|
"subject": "Настроить CI",
|
||||||
|
"status_ru": "В работе",
|
||||||
|
"time_text": "3ч 15м",
|
||||||
|
"hours": 3.25,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект C",
|
||||||
|
"version": "v1.1",
|
||||||
|
"display_project": "",
|
||||||
|
"display_version": "v1.1",
|
||||||
|
"issue_id": 302,
|
||||||
|
"subject": "Добавить тесты",
|
||||||
|
"status_ru": "В работе",
|
||||||
|
"time_text": "5ч",
|
||||||
|
"hours": 5.0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Проект C",
|
||||||
|
"version": "v1.1",
|
||||||
|
"display_project": "",
|
||||||
|
"display_version": "",
|
||||||
|
"issue_id": 303,
|
||||||
|
"subject": "Рефакторинг",
|
||||||
|
"status_ru": "Решена",
|
||||||
|
"time_text": "6ч 45м",
|
||||||
|
"hours": 6.75,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def fake_rows():
|
||||||
|
return make_fake_report_rows()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def odt_formatter():
|
||||||
|
"""ODTFormatter с замоканной загрузкой шаблона."""
|
||||||
|
odt_bytes = _make_empty_odt_bytes()
|
||||||
|
mock_file = mock.MagicMock()
|
||||||
|
mock_file.__enter__ = mock.MagicMock(return_value=io.BytesIO(odt_bytes))
|
||||||
|
mock_file.__exit__ = mock.MagicMock(return_value=False)
|
||||||
|
|
||||||
|
with mock.patch(
|
||||||
|
"redmine_reporter.formatters.odt.resources.files",
|
||||||
|
return_value=mock.MagicMock(
|
||||||
|
joinpath=mock.MagicMock(
|
||||||
|
return_value=mock.MagicMock(open=mock.MagicMock(return_value=mock_file))
|
||||||
|
)
|
||||||
|
),
|
||||||
|
):
|
||||||
|
yield ODTFormatter(author="Тест Автор", from_date="2026-01-01", to_date="2026-01-31")
|
||||||
|
|
||||||
|
|
||||||
|
# -- Тесты упаковки formatters как полноценного пакета --
|
||||||
|
|
||||||
|
|
||||||
|
def test_formatters_is_regular_package():
|
||||||
|
"""redmine_reporter.formatters — полноценный пакет с __init__.py, не namespace."""
|
||||||
|
import redmine_reporter.formatters
|
||||||
|
|
||||||
|
assert hasattr(redmine_reporter.formatters, "__file__")
|
||||||
|
assert redmine_reporter.formatters.__file__.endswith("__init__.py")
|
||||||
|
|
||||||
|
|
||||||
|
def test_formatters_found_by_setuptools():
|
||||||
|
"""setuptools.find_packages находит formatters как полноценный пакет."""
|
||||||
|
import os
|
||||||
|
|
||||||
|
from setuptools import find_packages
|
||||||
|
|
||||||
|
project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||||
|
found = find_packages(where=project_root, include=["redmine_reporter*"])
|
||||||
|
assert "redmine_reporter.formatters" in found
|
||||||
|
|
||||||
|
|
||||||
|
# -- Тесты ленивого импорта ODT (#25) --
|
||||||
|
|
||||||
|
|
||||||
|
def _simulate_missing_odfpy():
|
||||||
|
"""Вспомогательная функция: подготавливает очистку кэша модулей odf и odt.
|
||||||
|
|
||||||
|
Возвращает словарь сохранённых модулей для последующего восстановления.
|
||||||
|
"""
|
||||||
|
import sys
|
||||||
|
|
||||||
|
saved = {}
|
||||||
|
for key in list(sys.modules.keys()):
|
||||||
|
if key == "odf" or key.startswith("odf.") or key == "redmine_reporter.formatters.odt":
|
||||||
|
saved[key] = sys.modules.pop(key)
|
||||||
|
return saved
|
||||||
|
|
||||||
|
|
||||||
|
def _restore_modules(saved):
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.modules.update(saved)
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_formatter_odt_returns_none_without_odfpy():
|
||||||
|
"""Без odfpy — get_formatter_by_extension('.odt') возвращает None, не падает."""
|
||||||
|
import builtins
|
||||||
|
|
||||||
|
from redmine_reporter.formatters.factory import get_formatter_by_extension
|
||||||
|
|
||||||
|
real_import = builtins.__import__
|
||||||
|
|
||||||
|
def blocking_import(name, *args, **kwargs):
|
||||||
|
if name == "odf" or name.startswith("odf."):
|
||||||
|
raise ImportError(f"No module named '{name}'")
|
||||||
|
return real_import(name, *args, **kwargs)
|
||||||
|
|
||||||
|
saved = _simulate_missing_odfpy()
|
||||||
|
try:
|
||||||
|
with mock.patch("builtins.__import__", side_effect=blocking_import):
|
||||||
|
result = get_formatter_by_extension(
|
||||||
|
".odt", author="test", from_date="2026-01-01", to_date="2026-01-31"
|
||||||
|
)
|
||||||
|
assert result is None
|
||||||
|
finally:
|
||||||
|
_restore_modules(saved)
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_formatter_csv_works_without_odfpy():
|
||||||
|
"""Без odfpy — get_formatter_by_extension('.csv') работает нормально."""
|
||||||
|
import builtins
|
||||||
|
|
||||||
|
from redmine_reporter.formatters.factory import get_formatter_by_extension
|
||||||
|
|
||||||
|
real_import = builtins.__import__
|
||||||
|
|
||||||
|
def blocking_import(name, *args, **kwargs):
|
||||||
|
if name == "odf" or name.startswith("odf."):
|
||||||
|
raise ImportError(f"No module named '{name}'")
|
||||||
|
return real_import(name, *args, **kwargs)
|
||||||
|
|
||||||
|
saved = _simulate_missing_odfpy()
|
||||||
|
try:
|
||||||
|
with mock.patch("builtins.__import__", side_effect=blocking_import):
|
||||||
|
result = get_formatter_by_extension(".csv")
|
||||||
|
assert result is not None
|
||||||
|
finally:
|
||||||
|
_restore_modules(saved)
|
||||||
|
|
||||||
|
|
||||||
|
# -- Параметризованные тесты текстовых форматтеров --
|
||||||
|
|
||||||
|
TEXT_FORMATTER_FACTORIES = [
|
||||||
|
("table", lambda: TableFormatter()),
|
||||||
|
("compact", lambda: CompactFormatter()),
|
||||||
|
("csv", lambda: CSVFormatter()),
|
||||||
|
("json", lambda: JSONFormatter()),
|
||||||
|
("markdown", lambda: MarkdownFormatter()),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("name, factory", TEXT_FORMATTER_FACTORIES)
|
||||||
|
def test_text_formatter_returns_nonempty_string(fake_rows, name, factory):
|
||||||
|
"""Текстовые форматтеры возвращают непустую строку."""
|
||||||
|
result = factory().format(fake_rows)
|
||||||
|
assert isinstance(result, str)
|
||||||
|
assert len(result.strip()) > 0
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("name, factory", TEXT_FORMATTER_FACTORIES)
|
||||||
|
def test_text_formatter_contains_key_content(fake_rows, name, factory):
|
||||||
|
"""Вывод содержит ключевые данные из отчёта."""
|
||||||
|
output = factory().format(fake_rows)
|
||||||
|
|
||||||
|
assert "Проект A" in output
|
||||||
|
assert "Проект B" in output
|
||||||
|
assert "В работе" in output
|
||||||
|
assert "<N/A>" in output
|
||||||
|
assert "6ч 45м" in output
|
||||||
|
|
||||||
|
if name == "csv":
|
||||||
|
# В CSV issue_id и subject -- отдельные колонки
|
||||||
|
assert "101" in output
|
||||||
|
assert "Реализовать фичу X" in output
|
||||||
|
elif name == "json":
|
||||||
|
# В JSON issue_id -- число, subject -- отдельное поле
|
||||||
|
assert '"issue_id": 101' in output
|
||||||
|
assert "Реализовать фичу X" in output
|
||||||
|
else:
|
||||||
|
assert "101. Реализовать фичу X" in output
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("name, factory", TEXT_FORMATTER_FACTORIES)
|
||||||
|
def test_text_formatter_empty_rows(name, factory):
|
||||||
|
"""Форматтер не падает на пустом списке строк."""
|
||||||
|
result = factory().format([])
|
||||||
|
assert isinstance(result, str)
|
||||||
|
|
||||||
|
|
||||||
|
# -- Тесты консольных форматтеров --
|
||||||
|
|
||||||
|
|
||||||
|
def test_table_formatter_save_raises(fake_rows):
|
||||||
|
with pytest.raises(NotImplementedError):
|
||||||
|
TableFormatter().save(fake_rows, "/dev/null")
|
||||||
|
|
||||||
|
|
||||||
|
def test_compact_formatter_save_raises(fake_rows):
|
||||||
|
with pytest.raises(NotImplementedError):
|
||||||
|
CompactFormatter().save(fake_rows, "/dev/null")
|
||||||
|
|
||||||
|
|
||||||
|
def test_csv_save_writes_utf8_bom(fake_rows, tmp_path):
|
||||||
|
"""CSV-файл начинается с UTF-8 BOM для корректного открытия в Excel (#26)."""
|
||||||
|
output = tmp_path / "report.csv"
|
||||||
|
CSVFormatter().save(fake_rows, str(output))
|
||||||
|
content = output.read_bytes()
|
||||||
|
assert content[:3] == b"\xef\xbb\xbf" # UTF-8 BOM
|
||||||
|
|
||||||
|
|
||||||
|
def test_csv_uses_full_values_not_display(fake_rows):
|
||||||
|
"""CSV экспортирует полные project/version, а не display-значения (#31).
|
||||||
|
|
||||||
|
В отличие от консольных и Markdown форматтеров (display_*), CSV содержит
|
||||||
|
полные значения в каждой строке — это корректно для табличного формата.
|
||||||
|
"""
|
||||||
|
output = CSVFormatter().format(fake_rows)
|
||||||
|
lines = output.strip().split("\n")
|
||||||
|
# Header + 7 data rows = 8 lines
|
||||||
|
assert len(lines) == 8
|
||||||
|
# Вторая строка данных (lines[2]) имеет display_project="" и display_version="",
|
||||||
|
# но CSV должен содержать полные значения
|
||||||
|
assert "Проект A" in lines[2]
|
||||||
|
assert "v1.0" in lines[2]
|
||||||
|
|
||||||
|
|
||||||
|
def test_json_save_writes_parsable_data(fake_rows, tmp_path):
|
||||||
|
"""JSON-файл содержит валидный JSON со всеми строками отчёта."""
|
||||||
|
output = tmp_path / "report.json"
|
||||||
|
JSONFormatter().save(fake_rows, str(output))
|
||||||
|
data = json.loads(output.read_text(encoding="utf-8"))
|
||||||
|
assert len(data) == len(fake_rows)
|
||||||
|
assert data[0]["project"] == "Проект A"
|
||||||
|
assert data[0]["issue_id"] == 101
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_formatter_by_extension_json():
|
||||||
|
"""get_formatter_by_extension('.json') возвращает JSONFormatter."""
|
||||||
|
formatter = get_formatter_by_extension(".json")
|
||||||
|
assert isinstance(formatter, JSONFormatter)
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_formatter_by_extension_xlsx():
|
||||||
|
"""get_formatter_by_extension('.xlsx') возвращает XLSXFormatter."""
|
||||||
|
formatter = get_formatter_by_extension(".xlsx")
|
||||||
|
assert isinstance(formatter, XLSXFormatter)
|
||||||
|
|
||||||
|
|
||||||
|
def test_xlsx_save_creates_valid_file(fake_rows, tmp_path):
|
||||||
|
"""XLSX-файл сохраняется и содержит корректные данные."""
|
||||||
|
from openpyxl import load_workbook
|
||||||
|
|
||||||
|
output = tmp_path / "report.xlsx"
|
||||||
|
XLSXFormatter().save(fake_rows, str(output))
|
||||||
|
|
||||||
|
wb = load_workbook(str(output))
|
||||||
|
ws = wb.active
|
||||||
|
assert ws.title == "Report"
|
||||||
|
assert ws["A1"].value == "Project"
|
||||||
|
assert ws["A2"].value == "Проект A"
|
||||||
|
assert ws["C2"].value == 101
|
||||||
|
assert ws["F2"].value == 4.5
|
||||||
|
assert ws["G2"].value == "4ч 30м"
|
||||||
|
# header + 7 data rows + 5 version totals + 3 project totals + 1 grand total
|
||||||
|
assert ws.max_row == 17
|
||||||
|
|
||||||
|
|
||||||
|
def test_xlsx_has_merged_cells(fake_rows, tmp_path):
|
||||||
|
"""XLSX содержит объединённые ячейки по проектам и версиям."""
|
||||||
|
from openpyxl import load_workbook
|
||||||
|
|
||||||
|
output = tmp_path / "report.xlsx"
|
||||||
|
XLSXFormatter().save(fake_rows, str(output))
|
||||||
|
|
||||||
|
wb = load_workbook(str(output))
|
||||||
|
ws = wb.active
|
||||||
|
merged_ranges = [str(r) for r in ws.merged_cells.ranges]
|
||||||
|
# Проект A: 3 строки данных + 2 итога по версиям + 1 итог по проекту = строки 2-7
|
||||||
|
assert any("A2:A7" in r for r in merged_ranges)
|
||||||
|
# Версия v1.0 проекта A: 2 строки данных + 1 итог по версии = строки 2-4
|
||||||
|
assert any("B2:B4" in r for r in merged_ranges)
|
||||||
|
|
||||||
|
|
||||||
|
def test_xlsx_has_totals(fake_rows, tmp_path):
|
||||||
|
"""XLSX содержит итоги по версиям, проектам и общий итог."""
|
||||||
|
from openpyxl import load_workbook
|
||||||
|
|
||||||
|
output = tmp_path / "report.xlsx"
|
||||||
|
XLSXFormatter().save(fake_rows, str(output))
|
||||||
|
|
||||||
|
wb = load_workbook(str(output))
|
||||||
|
ws = wb.active
|
||||||
|
|
||||||
|
total_values = [ws.cell(row=r, column=6).value for r in range(2, ws.max_row + 1)]
|
||||||
|
# Проект A всего: 4.5 + 2 + 1 = 7.5
|
||||||
|
assert 7.5 in total_values
|
||||||
|
# Общий итог: 4.5 + 2 + 1 + 0 + 3.25 + 5 + 6.75 = 22.5
|
||||||
|
assert 22.5 in total_values
|
||||||
|
# Проверим числовой формат
|
||||||
|
assert ws["F2"].number_format == "0.00"
|
||||||
|
|
||||||
|
|
||||||
|
def test_xlsx_no_time_keeps_columns_empty_and_skips_totals(fake_rows, tmp_path):
|
||||||
|
"""XLSX с no_time: колонки времени пустые, итогов нет."""
|
||||||
|
from openpyxl import load_workbook
|
||||||
|
|
||||||
|
output = tmp_path / "report.xlsx"
|
||||||
|
XLSXFormatter(no_time=True).save(fake_rows, str(output))
|
||||||
|
|
||||||
|
wb = load_workbook(str(output))
|
||||||
|
ws = wb.active
|
||||||
|
|
||||||
|
# header + 7 data rows
|
||||||
|
assert ws.max_row == 8
|
||||||
|
|
||||||
|
# Колонки времени пустые для всех строк данных
|
||||||
|
for row in range(2, ws.max_row + 1):
|
||||||
|
assert ws.cell(row=row, column=6).value in (None, "")
|
||||||
|
assert ws.cell(row=row, column=7).value in (None, "")
|
||||||
|
|
||||||
|
# Итоговых строк нет
|
||||||
|
for row in range(2, ws.max_row + 1):
|
||||||
|
assert not str(ws.cell(row=row, column=1).value or "").startswith("Total")
|
||||||
|
assert not str(ws.cell(row=row, column=2).value or "").startswith("Total")
|
||||||
|
|
||||||
|
# Автофильтр и freeze panes на месте
|
||||||
|
assert ws.freeze_panes == "A2"
|
||||||
|
assert ws.auto_filter.ref == "A1:G8"
|
||||||
|
|
||||||
|
|
||||||
|
def test_markdown_formatter_escapes_table_cells():
|
||||||
|
rows = make_fake_report_rows()
|
||||||
|
rows[0]["project"] = "A|B"
|
||||||
|
rows[0]["display_project"] = "A|B"
|
||||||
|
rows[0]["subject"] = "Fix | split\nline"
|
||||||
|
|
||||||
|
output = MarkdownFormatter().format(rows)
|
||||||
|
|
||||||
|
assert "A\\|B" in output
|
||||||
|
assert "101. Fix \\| split<br>line" in output
|
||||||
|
|
||||||
|
|
||||||
|
def test_html_formatter_escapes_cells():
|
||||||
|
rows = make_fake_report_rows()
|
||||||
|
rows[0]["project"] = 'A&B "<Project>"'
|
||||||
|
rows[0]["display_project"] = rows[0]["project"]
|
||||||
|
rows[0]["subject"] = "Fix <tag> & attrs"
|
||||||
|
|
||||||
|
output = HTMLFormatter().format(rows)
|
||||||
|
|
||||||
|
assert "A&B "<Project>"" in output
|
||||||
|
assert "101. Fix <tag> & attrs" in output
|
||||||
|
assert "Fix <tag>" not in output
|
||||||
|
|
||||||
|
|
||||||
|
def test_html_output_has_doctype_and_charset(fake_rows):
|
||||||
|
"""HTML-отчёт содержит DOCTYPE и meta charset для корректной кодировки (#27)."""
|
||||||
|
output = HTMLFormatter().format(fake_rows)
|
||||||
|
assert "<!DOCTYPE html>" in output
|
||||||
|
assert '<meta charset="utf-8">' in output
|
||||||
|
|
||||||
|
|
||||||
|
# -- Тесты ODT форматтера --
|
||||||
|
|
||||||
|
|
||||||
|
def test_odt_formatter_returns_opendocument(fake_rows, odt_formatter):
|
||||||
|
"""ODTFormatter.format() возвращает объект OpenDocument."""
|
||||||
|
result = odt_formatter.format(fake_rows)
|
||||||
|
assert isinstance(result, OpenDocument)
|
||||||
|
|
||||||
|
|
||||||
|
def test_odt_empty_author_no_garbage_in_header(fake_rows):
|
||||||
|
"""При пустом авторе заголовок не содержит мусорных символов (#30)."""
|
||||||
|
odt_bytes = _make_empty_odt_bytes()
|
||||||
|
mock_file = mock.MagicMock()
|
||||||
|
mock_file.__enter__ = mock.MagicMock(return_value=io.BytesIO(odt_bytes))
|
||||||
|
mock_file.__exit__ = mock.MagicMock(return_value=False)
|
||||||
|
|
||||||
|
with mock.patch(
|
||||||
|
"redmine_reporter.formatters.odt.resources.files",
|
||||||
|
return_value=mock.MagicMock(
|
||||||
|
joinpath=mock.MagicMock(
|
||||||
|
return_value=mock.MagicMock(open=mock.MagicMock(return_value=mock_file))
|
||||||
|
)
|
||||||
|
),
|
||||||
|
):
|
||||||
|
formatter = ODTFormatter(author="", from_date="2026-01-01", to_date="2026-01-31")
|
||||||
|
doc = formatter.format(fake_rows)
|
||||||
|
|
||||||
|
from odf.text import P
|
||||||
|
|
||||||
|
paragraphs = doc.text.getElementsByType(P)
|
||||||
|
header_text = paragraphs[0].firstChild.data
|
||||||
|
|
||||||
|
assert not header_text.startswith(".")
|
||||||
|
assert "Отчет за месяц" in header_text
|
||||||
|
|
||||||
|
|
||||||
|
def test_odt_formatter_save_creates_valid_file(fake_rows, tmp_path):
|
||||||
|
"""ODT можно сохранить -- файл валиден (сигнатура ZIP)."""
|
||||||
|
odt_bytes = _make_empty_odt_bytes()
|
||||||
|
mock_file = mock.MagicMock()
|
||||||
|
mock_file.__enter__ = mock.MagicMock(return_value=io.BytesIO(odt_bytes))
|
||||||
|
mock_file.__exit__ = mock.MagicMock(return_value=False)
|
||||||
|
|
||||||
|
with mock.patch(
|
||||||
|
"redmine_reporter.formatters.odt.resources.files",
|
||||||
|
return_value=mock.MagicMock(
|
||||||
|
joinpath=mock.MagicMock(
|
||||||
|
return_value=mock.MagicMock(open=mock.MagicMock(return_value=mock_file))
|
||||||
|
)
|
||||||
|
),
|
||||||
|
):
|
||||||
|
formatter = ODTFormatter(author="Тест", from_date="2026-01-01", to_date="2026-01-31")
|
||||||
|
output_file = tmp_path / "report.odt"
|
||||||
|
formatter.save(fake_rows, str(output_file))
|
||||||
|
|
||||||
|
assert output_file.exists()
|
||||||
|
assert output_file.read_bytes()[:2] == b"PK" # сигнатура ZIP
|
||||||
|
|
||||||
|
|
||||||
|
def test_odt_has_covered_cells_for_spans(fake_rows):
|
||||||
|
"""ODT содержит covered-table-cell для замещённых ячеек при объединении (#13).
|
||||||
|
|
||||||
|
Тестовые данные (fake_rows):
|
||||||
|
Проект A: v1.0(2 задачи), v2.0(1) → project span=3
|
||||||
|
row1: project+version (0 covered)
|
||||||
|
row2: covered project + covered version (2)
|
||||||
|
row3: covered project + new version cell (1)
|
||||||
|
Проект B: <N/A>(1) → span=1, нет covered
|
||||||
|
Проект C: v1.0(1), v1.1(2) → project span=3
|
||||||
|
row5: project+version (0 covered)
|
||||||
|
row6: covered project + new version cell (1)
|
||||||
|
row7: covered project + covered version (2)
|
||||||
|
Итого: 6 covered cells
|
||||||
|
"""
|
||||||
|
odt_bytes = _make_empty_odt_bytes()
|
||||||
|
mock_file = mock.MagicMock()
|
||||||
|
mock_file.__enter__ = mock.MagicMock(return_value=io.BytesIO(odt_bytes))
|
||||||
|
mock_file.__exit__ = mock.MagicMock(return_value=False)
|
||||||
|
|
||||||
|
with mock.patch(
|
||||||
|
"redmine_reporter.formatters.odt.resources.files",
|
||||||
|
return_value=mock.MagicMock(
|
||||||
|
joinpath=mock.MagicMock(
|
||||||
|
return_value=mock.MagicMock(open=mock.MagicMock(return_value=mock_file))
|
||||||
|
)
|
||||||
|
),
|
||||||
|
):
|
||||||
|
formatter = ODTFormatter(author="Тест", from_date="2026-01-01", to_date="2026-01-31")
|
||||||
|
doc = formatter.format(fake_rows)
|
||||||
|
|
||||||
|
from odf.table import CoveredTableCell
|
||||||
|
|
||||||
|
covered_cells = doc.getElementsByType(CoveredTableCell)
|
||||||
|
assert len(covered_cells) == 6
|
||||||
279
tests/test_report_builder.py
Normal file
279
tests/test_report_builder.py
Normal file
@@ -0,0 +1,279 @@
|
|||||||
|
from redmine_reporter.report_builder import (
|
||||||
|
STATUS_TRANSLATION,
|
||||||
|
build_grouped_report,
|
||||||
|
calculate_summary,
|
||||||
|
group_rows_by_project_and_version,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class MockIssue:
|
||||||
|
def __init__(self, project, subject, status, fixed_version=None, issue_id=999):
|
||||||
|
self.id = issue_id
|
||||||
|
self.project = project
|
||||||
|
self.subject = subject
|
||||||
|
self.status = status
|
||||||
|
if fixed_version is not None:
|
||||||
|
self.fixed_version = fixed_version
|
||||||
|
|
||||||
|
|
||||||
|
# -- Таблица переводов статусов --
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_translation():
|
||||||
|
assert STATUS_TRANSLATION["Closed"] == "Закрыто"
|
||||||
|
assert STATUS_TRANSLATION["New"] == "В работе"
|
||||||
|
assert STATUS_TRANSLATION["Resolved"] == "Решена"
|
||||||
|
assert STATUS_TRANSLATION["Pending"] == "Ожидание"
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_translation_unknown_passthrough():
|
||||||
|
"""Неизвестный статус возвращается как есть."""
|
||||||
|
from redmine_reporter.report_builder import STATUS_TRANSLATION
|
||||||
|
|
||||||
|
assert "SomeNewStatus" not in STATUS_TRANSLATION
|
||||||
|
# build_grouped_report вернёт оригинальное значение
|
||||||
|
issue = MockIssue("P", "S", "SomeNewStatus", "v1.0", 1)
|
||||||
|
rows = build_grouped_report([(issue, 1.0)])
|
||||||
|
assert rows[0]["status_ru"] == "SomeNewStatus"
|
||||||
|
|
||||||
|
|
||||||
|
# -- Основная логика группировки --
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_grouping():
|
||||||
|
issues = [
|
||||||
|
(MockIssue("Камеры", "Фича A", "New", "v2.5.0", 101), 2.0),
|
||||||
|
(MockIssue("Камеры", "Баг B", "Resolved", "v2.5.0", 102), 1.5),
|
||||||
|
(MockIssue("ПО", "Доки", "Pending", None, 201), 4.0),
|
||||||
|
]
|
||||||
|
rows = build_grouped_report(issues)
|
||||||
|
|
||||||
|
assert len(rows) == 3
|
||||||
|
# Первая строка -- полное название проекта и версии
|
||||||
|
assert rows[0]["display_project"] == "Камеры"
|
||||||
|
assert rows[0]["display_version"] == "v2.5.0"
|
||||||
|
# Вторая -- пустые display_* из-за совпадения проекта+версии
|
||||||
|
assert rows[1]["display_project"] == ""
|
||||||
|
assert rows[1]["display_version"] == ""
|
||||||
|
# Третья -- новый проект
|
||||||
|
assert rows[2]["display_project"] == "ПО"
|
||||||
|
assert rows[2]["display_version"] == "<N/A>"
|
||||||
|
|
||||||
|
assert rows[0]["status_ru"] == "В работе"
|
||||||
|
assert rows[0]["time_text"] == "2ч"
|
||||||
|
assert rows[0]["hours"] == 2.0
|
||||||
|
assert rows[1]["time_text"] == "1ч 30м"
|
||||||
|
assert rows[1]["hours"] == 1.5
|
||||||
|
|
||||||
|
|
||||||
|
# -- #22: Сводка по времени --
|
||||||
|
|
||||||
|
|
||||||
|
def test_calculate_summary_totals():
|
||||||
|
"""Сводка содержит общее время и разбивку по проектам/версиям."""
|
||||||
|
rows = [
|
||||||
|
{
|
||||||
|
"project": "Камеры",
|
||||||
|
"version": "v2.5.0",
|
||||||
|
"issue_id": 101,
|
||||||
|
"subject": "Фича A",
|
||||||
|
"status_ru": "В работе",
|
||||||
|
"time_text": "2ч",
|
||||||
|
"hours": 2.0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "Камеры",
|
||||||
|
"version": "v2.5.0",
|
||||||
|
"issue_id": 102,
|
||||||
|
"subject": "Баг B",
|
||||||
|
"status_ru": "Решена",
|
||||||
|
"time_text": "1ч 30м",
|
||||||
|
"hours": 1.5,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "ПО",
|
||||||
|
"version": "<N/A>",
|
||||||
|
"issue_id": 201,
|
||||||
|
"subject": "Доки",
|
||||||
|
"status_ru": "Ожидание",
|
||||||
|
"time_text": "4ч",
|
||||||
|
"hours": 4.0,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
summary = calculate_summary(rows)
|
||||||
|
|
||||||
|
assert summary["total"] == 7.5
|
||||||
|
assert summary["project:Камеры"] == 3.5
|
||||||
|
assert summary["project:ПО"] == 4.0
|
||||||
|
assert summary["version:Камеры::v2.5.0"] == 3.5
|
||||||
|
assert summary["version:ПО::<N/A>"] == 4.0
|
||||||
|
|
||||||
|
|
||||||
|
def test_calculate_summary_empty():
|
||||||
|
"""Сводка для пустого списка -- только total = 0."""
|
||||||
|
summary = calculate_summary([])
|
||||||
|
assert summary == {"total": 0.0}
|
||||||
|
|
||||||
|
|
||||||
|
# -- #19: Общая функция группировки --
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_new_version_same_project():
|
||||||
|
"""Смена версии внутри одного проекта -- display_project пустой, display_version новая."""
|
||||||
|
issues = [
|
||||||
|
(MockIssue("Камеры", "Задача 1", "New", "v1.0", 1), 1.0),
|
||||||
|
(MockIssue("Камеры", "Задача 2", "New", "v2.0", 2), 1.0),
|
||||||
|
]
|
||||||
|
rows = build_grouped_report(issues)
|
||||||
|
assert rows[0]["display_project"] == "Камеры"
|
||||||
|
assert rows[0]["display_version"] == "v1.0"
|
||||||
|
assert rows[1]["display_project"] == ""
|
||||||
|
assert rows[1]["display_version"] == "v2.0"
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_sorts_input():
|
||||||
|
"""Несортированный вход -- результат всё равно корректно сгруппирован."""
|
||||||
|
issues = [
|
||||||
|
(MockIssue("ПО", "Задача B", "New", "v1.0", 2), 1.0),
|
||||||
|
(MockIssue("Камеры", "Задача A", "New", "v1.0", 1), 2.0),
|
||||||
|
]
|
||||||
|
rows = build_grouped_report(issues)
|
||||||
|
# После сортировки "Камеры" < "ПО" (лексикографически по кириллице)
|
||||||
|
assert rows[0]["project"] == "Камеры"
|
||||||
|
assert rows[1]["project"] == "ПО"
|
||||||
|
# Оба display_project непустые -- разные проекты
|
||||||
|
assert rows[0]["display_project"] == "Камеры"
|
||||||
|
assert rows[1]["display_project"] == "ПО"
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_empty():
|
||||||
|
"""Пустой вход -- пустой результат, без исключений."""
|
||||||
|
rows = build_grouped_report([])
|
||||||
|
assert rows == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_no_time():
|
||||||
|
"""fill_time=False -- time_text пустой для всех строк."""
|
||||||
|
issues = [(MockIssue("P", "S", "New", "v1.0", 1), 3.5)]
|
||||||
|
rows = build_grouped_report(issues, fill_time=False)
|
||||||
|
assert rows[0]["time_text"] == ""
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_preserves_issue_id_and_subject():
|
||||||
|
issues = [(MockIssue("P", "Моя задача", "Closed", "v1.0", 42), 0.5)]
|
||||||
|
rows = build_grouped_report(issues)
|
||||||
|
assert rows[0]["issue_id"] == 42
|
||||||
|
assert rows[0]["subject"] == "Моя задача"
|
||||||
|
|
||||||
|
|
||||||
|
def test_build_grouped_report_deterministic_order_within_group():
|
||||||
|
"""Задачи в одной группе проект+версия упорядочены по issue.id
|
||||||
|
независимо от порядка на входе (#33)."""
|
||||||
|
issues = [
|
||||||
|
(MockIssue("P", "Task C", "New", "v1.0", 103), 1.0),
|
||||||
|
(MockIssue("P", "Task A", "New", "v1.0", 101), 1.0),
|
||||||
|
(MockIssue("P", "Task B", "New", "v1.0", 102), 1.0),
|
||||||
|
]
|
||||||
|
rows = build_grouped_report(issues)
|
||||||
|
assert [r["issue_id"] for r in rows] == [101, 102, 103]
|
||||||
|
|
||||||
|
|
||||||
|
# -- #19: Общая функция группировки --
|
||||||
|
|
||||||
|
|
||||||
|
def test_group_rows_basic():
|
||||||
|
"""Два проекта, в одном две версии — структура корректна."""
|
||||||
|
rows = [
|
||||||
|
{
|
||||||
|
"project": "A",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 1,
|
||||||
|
"subject": "T1",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "1ч",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "A",
|
||||||
|
"version": "v2",
|
||||||
|
"issue_id": 2,
|
||||||
|
"subject": "T2",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "2ч",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "B",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 3,
|
||||||
|
"subject": "T3",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "3ч",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
grouped = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
assert list(grouped.keys()) == ["A", "B"]
|
||||||
|
assert list(grouped["A"].keys()) == ["v1", "v2"]
|
||||||
|
assert list(grouped["B"].keys()) == ["v1"]
|
||||||
|
assert len(grouped["A"]["v1"]) == 1
|
||||||
|
assert len(grouped["A"]["v2"]) == 1
|
||||||
|
assert len(grouped["B"]["v1"]) == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_group_rows_multiple_tasks_per_version():
|
||||||
|
"""Несколько задач в одной версии — все попадают в список."""
|
||||||
|
rows = [
|
||||||
|
{
|
||||||
|
"project": "A",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 1,
|
||||||
|
"subject": "T1",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "1ч",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "A",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 2,
|
||||||
|
"subject": "T2",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "2ч",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"project": "A",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 3,
|
||||||
|
"subject": "T3",
|
||||||
|
"status_ru": "S",
|
||||||
|
"time_text": "3ч",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
grouped = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
assert len(grouped["A"]["v1"]) == 3
|
||||||
|
assert [r["issue_id"] for r in grouped["A"]["v1"]] == [1, 2, 3]
|
||||||
|
|
||||||
|
|
||||||
|
def test_group_rows_preserves_row_data():
|
||||||
|
"""Строки в группировке — те же объекты, без потери данных."""
|
||||||
|
rows = [
|
||||||
|
{
|
||||||
|
"project": "P",
|
||||||
|
"version": "v1",
|
||||||
|
"issue_id": 42,
|
||||||
|
"subject": "Task",
|
||||||
|
"status_ru": "Готово",
|
||||||
|
"time_text": "5ч",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
grouped = group_rows_by_project_and_version(rows)
|
||||||
|
|
||||||
|
row = grouped["P"]["v1"][0]
|
||||||
|
assert row["issue_id"] == 42
|
||||||
|
assert row["subject"] == "Task"
|
||||||
|
assert row["status_ru"] == "Готово"
|
||||||
|
assert row["time_text"] == "5ч"
|
||||||
|
|
||||||
|
|
||||||
|
def test_group_rows_empty():
|
||||||
|
"""Пустой список — пустой словарь."""
|
||||||
|
assert group_rows_by_project_and_version([]) == {}
|
||||||
112
tests/test_utils.py
Normal file
112
tests/test_utils.py
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
from redmine_reporter.utils import (
|
||||||
|
get_month_name_from_range,
|
||||||
|
get_version,
|
||||||
|
hours_to_human,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_hours_to_human_zero():
|
||||||
|
assert hours_to_human(0) == "0ч"
|
||||||
|
assert hours_to_human(-1) == "0ч"
|
||||||
|
|
||||||
|
|
||||||
|
def test_hours_to_human_whole_hours():
|
||||||
|
assert hours_to_human(1.0) == "1ч"
|
||||||
|
assert hours_to_human(8.0) == "8ч"
|
||||||
|
|
||||||
|
|
||||||
|
def test_hours_to_human_minutes_only():
|
||||||
|
assert hours_to_human(0.75) == "45м"
|
||||||
|
assert hours_to_human(0.5) == "30м"
|
||||||
|
|
||||||
|
|
||||||
|
def test_hours_to_human_mixed():
|
||||||
|
assert hours_to_human(2.5) == "2ч 30м"
|
||||||
|
assert hours_to_human(1.5) == "1ч 30м"
|
||||||
|
|
||||||
|
|
||||||
|
def test_hours_to_human_rounding():
|
||||||
|
assert hours_to_human(3.1666) == "3ч 10м" # 190 минут -> 3ч 10м
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_month_name_from_range():
|
||||||
|
assert get_month_name_from_range("2026-01-01", "2026-01-31") == "Январь"
|
||||||
|
assert get_month_name_from_range("2025-12-01", "2026-02-15") == "Февраль"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_month_name_from_range_all_months():
|
||||||
|
months = [
|
||||||
|
"Январь",
|
||||||
|
"Февраль",
|
||||||
|
"Март",
|
||||||
|
"Апрель",
|
||||||
|
"Май",
|
||||||
|
"Июнь",
|
||||||
|
"Июль",
|
||||||
|
"Август",
|
||||||
|
"Сентябрь",
|
||||||
|
"Октябрь",
|
||||||
|
"Ноябрь",
|
||||||
|
"Декабрь",
|
||||||
|
]
|
||||||
|
for i, name in enumerate(months, start=1):
|
||||||
|
to_date = f"2026-{i:02d}-01"
|
||||||
|
assert get_month_name_from_range("2026-01-01", to_date) == name
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_month_name_from_range_invalid_fallback():
|
||||||
|
"""Невалидная дата -- возвращается 'Январь'."""
|
||||||
|
assert get_month_name_from_range("invalid", "also_invalid") == "Январь"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_version_with_attribute():
|
||||||
|
class MockIssue:
|
||||||
|
fixed_version = "v2.5.0"
|
||||||
|
|
||||||
|
assert get_version(MockIssue()) == "v2.5.0"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_version_without_attribute():
|
||||||
|
class MockIssue:
|
||||||
|
pass
|
||||||
|
|
||||||
|
assert get_version(MockIssue()) == "<N/A>"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_version_none_attribute():
|
||||||
|
class MockIssue:
|
||||||
|
fixed_version = None
|
||||||
|
|
||||||
|
assert get_version(MockIssue()) == "<N/A>"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_version_with_redminelib_version_object():
|
||||||
|
"""redminelib Version: str() возвращает ID, .name — человекочитаемое имя."""
|
||||||
|
|
||||||
|
class MockVersion:
|
||||||
|
"""Имитирует redminelib.resources.Version — str() даёт ID."""
|
||||||
|
|
||||||
|
def __init__(self, vid, name):
|
||||||
|
self.id = vid
|
||||||
|
self.name = name
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
return str(self.id)
|
||||||
|
|
||||||
|
class MockIssue:
|
||||||
|
fixed_version = MockVersion(42, "v2.5.0")
|
||||||
|
|
||||||
|
assert get_version(MockIssue()) == "v2.5.0"
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_version_falls_back_to_str_when_no_name():
|
||||||
|
"""Если у объекта версии нет .name — fallback на str()."""
|
||||||
|
|
||||||
|
class MockVersionNoName:
|
||||||
|
def __str__(self):
|
||||||
|
return "fallback-id"
|
||||||
|
|
||||||
|
class MockIssue:
|
||||||
|
fixed_version = MockVersionNoName()
|
||||||
|
|
||||||
|
assert get_version(MockIssue()) == "fallback-id"
|
||||||
Reference in New Issue
Block a user