Linkchecker (тестовое задание)

Промежуточные итоги:

1. Режимы запуска программы:
   1. DEMO - в данном режиме используется встроенная база данных H2, она инициализирована и заполнена тестовыми данными. Этот режим полезен для демонстрации возможности работы программы.
   2. PRODUCTION - в данном режиме для работы программы нужен PostgreSQL. Для удобства настройки подключения к БД были вынесены во внешний файл, который пользователь может самостоятельно настроить.
   3. TEST - используется для юнит-тестов.
2. Так же к основным режимам программы есть опциональный - это отладочный режим. В данном режиме в лог выводится более расширенная информация, в том числе sql запросы и метрика выполнения запросов к БД.
3. Был проинспектирован код, добавлены недостающие комментарии к коду, удалены лишние.
4. Так же в зависимости от выбранного профиля используется разный уровень логгирования.
5. Для POST запросов создания графа в целом, вершины или ребра графа был изменён путь. Например было POST .../rest/v1/graph стало POST .../rest/v1/graph/create
6. Для gitlab ci на стадии сборки был расширен функционал. Теперь артефакт представляет собой не одиночный файл, каталог в котором помимо основной программы находится файл настройки подключения к БД и ряд скрпитов для запуска программы в различных режимах и под различные платформы (windows и linux).

• linkchecker.jar - сама программа
• application-production.properties - внешний файл настройки для подключения к БД, в файле необходимо только внести данные по подключению к БД
• linkchecker_linux_demo.sh, linkchecker_linux_demo_debug.sh - скрипты для запуска программ под linux в демо-режиме в обычном и отладочном режиме.
• linkchecker_linux_production.sh, linkchecker_linux_production_debug.sh - запуск программы в режиме работы с PostgreSQL, для этого необходимо заполнить файл настроек для подключения к БД.
• linkchecker_win_*.bat - скрипты по для работы с windows, режимы запуска как linux.

Полезные ссылки:

1. How to load external property files into Spring Boot application?
2. [SOF] Spring boot external configuration of property file
3. 24.3 Application property files
4. Advanced Bash-Scripting Guide Искусство программирования на языке сценариев командной оболочки
5. Как вывести многострочную строку в Bash?
6. CASE — Оператор Выбора в Bash [Пример]
7. Получение данных, вводимых пользователем
8. CMD/BAT - Расширение возможностей Echo
9. Командная оболочка bat/cmd
10. Windows Batch Scripting
11. Batch File Command Скрыть Пароль
12. Batch file – Programming tutorial
13. Guide to Windows Batch Scripting
14. Spring Boot - Using ErrorAttributes in our custom ErrorController
15. Exception Handling in Spring MVC
16. Spring Boot REST API – обработка исключений

Итоги

1. Программа работает в двух режимах - это DEMO и PRODUCTION + возможность вывода отладочной информации для этих двух режимов если использовать ключ DEBUG режима.
2. Файл конфигурации для подключения к БД PostgreSQL в режиме работы программы PRODUCTION вынесен во внешний файл.
3. Были переработаны скрипты запуска программы, теперь их всего два один под linux linkchecker_linux.sh, второй под windows linkchecker_win.bat. Скрипты можно запустить со следующими ключами:
   1. --demo - запуск программы в DEMO режиме.
   2. --production - запуск программы в PRODUCTION режиме.
   3. --debug - дополнительный ключ для запуска программы в отладочном режиме.
   4. --help - вывод информационного сообщения.
4. Была доработана стартовая веб-страница в которой выводится информация по тестовому заданию. Так же создана дополнительная страница, которая выводит сообщение в случае неправильного запроса.