Перейти к содержанию

🚀 Руководство по скриптам JXCT

Версия: 3.11.0 Дата: Июль 2025

📋 Обзор

В проекте JXCT используются автоматические и интерактивные скрипты для автоматизации разработки и CI/CD. Все скрипты приведены в папке scripts/.

  • 🔄 Автоматические — работают без ожидания ввода пользователя
  • 💬 Интерактивные — требуют ручного подтверждения

🔄 Автоматические скрипты

1. deploy.ps1 — Гибридный деплой (автоматический и интерактивный режим)

# Автоматический режим
./scripts/deploy.ps1 -Auto

# С кастомным сообщением
./scripts/deploy.ps1 -Auto -CommitMessage "Обновление API документации"

# Интерактивный режим (по умолчанию)
./scripts/deploy.ps1

Что делает: - ✅ Автоматически коммитит незакоммиченные изменения - ✅ Генерирует документацию через MkDocs - ✅ Проверяет корректность сборки - ✅ Отправляет изменения в Git - ✅ Не требует ручного ввода (в режиме -Auto)

2. run_simple_tests.py — Полный прогон тестов

python scripts/run_simple_tests.py

3. ultra_quick_test.py — Ультра-быстрый smoke-тест

python scripts/ultra_quick_test.py

4. run_clang_tidy_analysis.py — Статический анализ

python scripts/run_clang_tidy_analysis.py

5. format_code.py — Универсальное форматирование кода

python scripts/format_code.py

6. auto_format.py — Удаление trailing whitespace и поиск длинных строк

python scripts/auto_format.py

7. pre-commit.py — Pre-commit хуки

python scripts/pre-commit.py

8. release.ps1 и release_manager.py — Управление версиями и релизами

./scripts/release.ps1 version -Type patch
./scripts/release.ps1 release -Version "3.10.1" -Message "Новые функции"
или 
python scripts/release_manager.py version --type patch
python scripts/release_manager.py release --version "3.10.1"

🧪 Тестовые скрипты

Python скрипты для тестирования

# Полные тесты
python scripts/run_simple_tests.py

# Ультра-быстрый smoke-тест
python scripts/ultra_quick_test.py

# E2E тесты
python scripts/run_e2e_tests.py

# Performance тесты
python scripts/run_performance_tests.py

# Комплексные тесты (расширенное покрытие)
python scripts/run_comprehensive_tests.py

🛠️ Форматирование кода

Универсальный форматтер

python scripts/format_code.py

Удаление trailing whitespace

python scripts/auto_format.py

⚡ Быстрые команды

🚀 Основные команды

⚡ Ультра-быстрое тестирование (рекомендуется)

python scripts/ultra_quick_test.py
Время: ~5 секунд | Зависания: НЕТ

📋 Полное тестирование

python scripts/run_simple_tests.py
Время: ~2 минуты | Зависания: НЕТ

🧪 Отдельные тесты

Python тесты

python -m pytest test/test_validation.py test/test_compensation_formulas.py -v

Тесты с моками

python test/test_mock_coverage.py

🔨 Сборка

ESP32 сборка

pio run -e esp32dev

Production сборка

pio run -e esp32dev-production

🔍 Анализ кода

Быстрый clang-tidy

python scripts/run_clang_tidy_analysis.py

Форматирование кода

python scripts/format_code.py

🚨 Решение проблем

Если тесты зависают

  1. Используйте ultra_quick_test.py - самый надежный
  2. Проверьте подключение к интернету
  3. Перезапустите терминал

Если сборка падает

  1. pio run -t clean
  2. pio run -e esp32dev

Если тесты падают

  1. Проверьте Python версию (3.8+)
  2. Установите зависимости: pip install pytest
  3. Запустите ultra_quick_test.py

📈 Рекомендации

  • Для ежедневной работы: ultra_quick_test.py
  • Для полной проверки: run_simple_tests.py
  • Для отладки: отдельные тесты

🎯 Цели качества

  • ✅ Все тесты проходят
  • ✅ Покрытие >85%
  • ✅ Сборка успешна
  • ✅ Нет критических предупреждений

🧑‍💻 Рекомендации по использованию

Для разработки:

  • Используйте deploy.ps1 для деплоя документации (с параметром -Auto для автоматизации)
  • Запускайте тесты перед каждым коммитом
  • Используйте format_code.py для форматирования кода

Для CI/CD:

  • Используйте только актуальные скрипты, перечисленные выше
  • Все тесты и анализы должны запускаться автоматически через GitHub Actions

⚠️ Удалённые/устаревшие скрипты

  • auto_deploy.ps1 (заменён на deploy.ps1)
  • format_all.ps1 (заменён на format_code.py)
  • run_all_tests.py (дублирует run_simple_tests.py)
  • fix_anchors*.py, remove_duplicate_toc.py (устарели)
  • run_clang_tidy_analysis_original.py (устарел)
  • quick-test.yml, docs.yml.disabled (workflow удалены)

📝 История изменений

  • 2025-07-17: Глобальный рефакторинг инфраструктуры, удалены дублирующие и устаревшие скрипты, обновлено руководство.