Система управления проектами

Технические требования

Основные блоки и функции, которые необходимо реализовать в программе:

• Управление сотрудниками компании
• Управление проектами и их жизненным циклом
• Управление задачами внутри проекта и их жизненным циклом
• Управление командами внутри проекта
• Аутентификация в системе

Подробный список требований представлен по _ссылке_.

Реализация

ВАЖНО

Читайте *.md файлы на gitHub. Иначе не будут видны вставленные изображения.

Стэк

OpenJDK 18, Spring framework (Boot, Web, Security, Data JPA), Hibernate, Liquibase, Lombok, Logback, Slf4j, PostgreSQL, Docker, Swagger, RabbitMQ.

Структура проекта

Проект состоит из 7 логических модулей:

• _./app_ - конфигурация и запуск приложения
• _./auth_ - аутентификация, валидация, авторизация пользователей программы, работа с jwt токеном
• _./controller_ - обработка JSON/HTTP запросов пользователя
• _./dto_ - dto и исключения
• _./model_ - сущности
• _./repository_ - работа с базой данных
• _./service_ - бизнес логика

И 3 папок:

• _./dock_ - документация по проекту
• _./docker-compose_ - непрерывная сборка и развертывание программы в docker
• _./logs_ - логи

Структура папок:

dock:

• _./dock/adr_ - архитектурные решения принятые в проекте
• _./doc/arch_ - диаграммы архитектуры проекта (.drawio, .png)
• _./doc/image_ - скриншоты
• _./doc/questions_ - вопросы куратору
• _./doc/remarks_ - замечания от куратора и идеи по улучшению проекта
• _./doc/test-case_ - функциональные текст-кейсы. Составлены и реализованы (*.md)

docker-compose:

• _./docker-compose/app_ - создание образа - Dockerfile. Запуск CI-CD - run-app.sh
• _./docker-compose/imports_ - создание базы данных project в PostgreSQL - init.sh, при развертывании контейнера базы данных
• _./docker-compose/liquibase_ - файлы миграции базы данных
• _./docker-compose/docker-compose.yml_ - развертывание программы в docker

logs:

• _./logs/auth_ - логи аутентификации, включая исключения
• _./logs/email_ - логи сборки и отправки email уведомления на почту, включая исключения
• _./logs/exception - логи исключений обрабатываемые в GlobalExceptionHandler_, кроме исключений auth и email
• _./logs/service_ - логи работы всех сервисов

Архитектура:

Для описания архитектуры программы применены 5 диаграмм: 2 UML, 2 C4, 1 Physical model.

_(первый вариант архитектуры)_

UML:

• use case diagram - применено для отображения функциональных возможностей программы для пользователя
• sequence diagram - применено для пояснения работы отдельных модулей программы

C4:

• container diagram - применено для отображения развертываемых элементов программы и их взаимодействия между собой
• deployment diagram - применено для пояснения развертывания элементов программы на сервере

Physical model:

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

Use case diagram

Отображены функциональные возможности программы для пользователей согласно основным требованиям.

Container diagram

Отображены основные модули программы и их взаимодействие между собой. Отображена легенда в левом верхнем углу схемы.

Дополнительно отображены контроллеры, которые поясняют основную функциональность программы более детально.

• auth - аутентификация пользователя в системе
• employee - управление сотрудниками компании
• project - управление проектами и их жизненным циклом
• task - управление задачами внутри проекта и их жизненным циклом
• team - управление командами внутри проекта

Deployment diagram

Отображено развертывание программы на сервере. В качестве сервера выступает мой рабочий компьютер. Пояснение по диаграмме: х1 значит 1 докер контейнер.

Physical model

Отображена структура основных таблицы в которых хранятся данные из программы и связи между этими таблицами. Посмотреть краткое описание таблиц и их атрибутов можно _тут_.

Права доступа пользователей

Доступ к ресурсам программы зависит от роли пользователя:

• /api/v1/employee/** - роль ADMIN
• /api/v1/project/** - роль MANAGER
• /api/v1/team/** - роль MANAGER
• /api/v1/task/** - роль USER
• /api/v1/auth/** - доступно всем пользователям
• /swagger-ui/** - доступно всем пользователям

Метод deleteById() требует наличие роли ADMIN среди эндпоинтов:

• /api/v1/employee/**
• /api/v1/project/**
• /api/v1/team/**
• /api/v1/task/**

Удалить данные можно только через панель администратора.

Дополнительный функционал

OpenApi

Для просмотра документации по проекту необходимо:

• Запустить программу с помощью CI-CD скрипта _run-app.sh_. Команда запуска из командной строки: bash run-app.sh. При запуске из командной строки необходимо находиться в папке расположения файла run-app.sh.
• В браузере перейти по ссылке: http://localhost:8080/pms/swagger-ui/index.html

Log

Программа пишет логи в консоль и в файлы. Файлы расположены в папке _./logs_.

Email

При назначении исполнителя на задачу, программа асинхронно, с помощью rabbitMQ, отправит email уведомление сотруднику которому была поставлена задача:

Пример уведомления:

Тесты

Произведено функциональное тестирование программы согласно концепциям черного и белого ящика на соответсвие требованиям из ТЗ.

Черный ящик

Составлено и реализовано 160 _тест-кейсов_ для ручного тестирования API с помощью программы postman. Тест-кейсы имеют определенную структуру и скриншоты ожидаемого результата.

Белый ящик

Написаны _модульные и интеграционные тесты_ для автоматизированной проверки функционала каждой из сущностей. Для выполнения интеграционных тестов создается отдельный докер контейнер с базой данных из образа postgres.

Запуск приложения

Файл CI-CD программы _run-app.sh расположен в папке ./docker-compose/app_. Команда запуска из командной строки: bash run-app.sh. При запуске из командной строки необходимо находиться в папке расположения файла run-app.sh.

Во время запуска:

• Выполняться модульные и интеграционные тесты
• Создасться архив приложения pms-instance-exec.jar
• Создасться docker образ приложения pms-app:latest
• Запуститься docker-compose файл
• Создасться контейнер базы данных postgres, контейнер системы миграции liqubase (выполнит миграцию базы данных в контейнер с базой данных postgres), контейнер очереди RabbitMQ, контейнер приложения pms-app,

Параметры запуска:

• На локальной машине должен быть установлен docker, maven, git bash
• Версия java, которую использует maven, должна быть 18.0.2.1. Убедитесь, что в переменной среды JAVA_HOME указана именно эта версия. Иначе проект не скомпилируется, так как maven берет значение из этой переменной.