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

Разработка

Если вы уже склонировали репозиторий и уверены, что хотите погрузить в код, вам пригодятся эти гайдлайны для настройки окружения.

Commits

Когда вы делаете коммиты, пожалуйста, используйте соглашение о семантическом именовании.

Формат: <type>(<scope>): <subject>

Где <scope> необязателен.

feat: add synchronous RabbitMQ wrapper
^--^  ^------------^
|     |
|     +-> Краткое именование
|
+-------> Типы: chore, docs, feat, fix, refactor, style, or test.

Больше примеров:

  • feat: (Новый функционал для пользователей)
  • fix: (Багфикс в рамках функционала)
  • docs: (Изменения в документации)
  • style: (Formatting, linting)
  • refactor: (Рефакторинг кода, например изменение названий переменных)
  • test: (Добавление или рефакторинг тестов)
  • chore: ("обслуживающие" коммиты - повышение версии, апдейт зависимостей и т.д.)

Материалы по теме:

Создайте окружение venv

Как и любой python проект, Propan лучше разрабатывать в отдельном окружении. Вы можете создать его с пумощью встроенного в python модуля venv:

python -m venv venv

Эта команда создаст директорию ./venv/, куда вы сможете изолированно установить все зависимости проекта.

Активируйте окружение

Активируйте созданное окружение следующей командой:

source ./venv/bin/activate

И удостоверьтесь, что вы используете последнюю версию pip'а

python -m pip install --upgrade pip

pip

После активации окружения установите все зависимости проекта, необходимые для разработки

pip install -e ".[dev]"

Используйте ваш локальный Propan

Если вы создадите новый Python файл и импортируете там Propan, он будет использовать Propan из вашей локальной директории проекта.

И, если вы обновите код вашего локального Propan, изменения будут отражены в работе вашего локального Python файла, т.к. проект был установлен с флагом -e.

Таким образом, вам не нужно "устанавливать" локальную версию фреймворка после каждого изменения в его репозитории.

Для использования локального CLI необходима следующая команда:

python -m propan ...

Тестирование

Pytest

Для запуска тестов с вашим текущим Python и окружением используйте стандартный pytest или один из заготовленных скриптов

pytest tests
# or
bash ./scripts/test.sh
# with coverage output
bash ./scripts/test-cov.sh

В проекте используется нескольо pytest marks:

  • slow
  • rabbit
  • nats
  • sqs
  • kafka
  • redis
  • all

Больше узнать про маркировку тестов вы можете здесь

По умолчанию pytest запускается с тегом "not slow".

Для запуска всех тестов используйте:

pytest -m 'all'

Если вы не запустили RabbiMQ и NATS у себя локально, вы можеет запустить тесты без этих зависимостей:

pytest -m 'not rabbit and not nats'

Для запуска всех тестов со всеми зависимостями, сначала запустите docker-compose.yml

docker compose up -d

со следующим содержанием

version: "3"

services:
  rabbit:
    image: rabbitmq:3
    ports:
      - 5672:5672

  redis:
    image: redis:alpine3.18
    ports:
      - 6379:6379

  nats:
    image: nats
    command: -js
    ports:
      - 4222:4222
      - 8222:8222  # management

  kafka:
    image: bitnami/kafka:3.5.0
    ports:
      - 9092:9092
    environment:
      - KAFKA_ENABLE_KRAFT=yes
      - KAFKA_CFG_NODE_ID=1
      - KAFKA_CFG_PROCESS_ROLES=broker,controller
      - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093
      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT
      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://127.0.0.1:9092
      - KAFKA_BROKER_ID=1
      - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=1@kafka:9093
      - ALLOW_PLAINTEXT_LISTENER=yes

  sqs:
    image: softwaremill/elasticmq-native
    ports:
      - 9324:9324

Hatch

Если вы используете hatch для управления окружением, в проекте есть несколько команда для него:

TEST

Это окружение запускает тесты на всех поддерживаемых версиях python: 3.7-3.11

Note

Все версии языка должны быть установлены на вашей системе

# Запустить минимальный набор тестов на python3.7-3.11
hatch run test:run

# Запустить все тесты на python3.7-3.11
hatch run test:run-all
TEST-LAST

Это окружение запускает тесты на версии python 3.11

# Запустить минимальный набор тестов на python3.11
hatch run test-last:run

# Запустить все тесты на python3.11
hatch run test-last:run-all

# Запустить все тесты на python3.11 с измерением покрытия
hatch run test-last:cov