Project

General

Profile

Actions

Надо сделать #163

closed

Доработка и улучшения

Added by Александр Александров about 5 years ago. Updated about 5 years ago.

Status:
Закрыта
Priority:
Нормальный
Category:
Прочее
Target version:
Start date:
11/09/2019
Due date:
12/31/2019
% Done:

100%

Estimated time:
50:00 h
Spent time:
Issue closed :
11/19/2019

Description

Выполнить различные доработки и улучшения согласно списку задач. Данный список будет пополняться по мере необходимости.

  1. Вынести настройки базы данных PostgreSQL во внешний файл - для более гибкой настройки желательно вынести настройки подключения к БД во внешний файл и подгружать его во время запуска программы.
  2. Режимы запуска программы:
    1. Режим demo - в данном режиме программа запускается со встроенное БД H2 с заранее инициализированным набором данных. Данный режим предоставляет возможность ознакомиться с работой программы.
    2. Режим production - в данном режиме программе необходим доступ к БД PostgreSQL, для этого нужно указать параметры подключения к БД.
    3. Отладочный режим - в данном режиме будет выводиться более подробная информация по совершаемым действиям в программе. Этот режим является опцией для основных режимов demo и production.
  3. Доработать веб-страницу - доработать главную веб страницу.
    1. Добавить описание работы программы.
    2. Добавить информацию о возможных REST запросах, формате входных и выходных данных, примеры запросов.
  4. Проинспектировать код, добавить комментарии где это необходимо.
  5. Настроить логирование в зависимости от выбранного профиля - необходимо более тонко настроить работу логирования. Пройтись по коду и определить что нужно помещать в лог.
  6. Дополнить информацию в wiki
  7. Добавить недостающие обработчики ошибок возникающие в контроллерах
  8. Переделать скрипты запуска программы - данные скрипты создаются во время автоматической сборки. Есть два варианта запуска скриптов под linux и windows

Checklist

  • Вынести настройки базы данных PostgreSQL во внешний файл
  • Режимы запуска программы
  • Доработать веб-страницу
  • Проинспектировать код, добавить комментарии где это необходимо
  • Настроить логирование в зависимости от выбранного профиля
  • Дополнить информацию в wiki
  • Добавить недостающие обработчики ошибок возникающие в контроллерах
  • Переделать скрипты запуска программы
Actions #1

Updated by Александр Александров about 5 years ago

  • Description updated (diff)
Actions #2

Updated by Александр Александров about 5 years ago

  • Status changed from Новая to В работе
Actions #3

Updated by Александр Александров about 5 years ago

  • Description updated (diff)
Actions #4

Updated by Александр Александров about 5 years ago

  • Description updated (diff)
Actions #5

Updated by Александр Александров about 5 years ago

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

  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.
Actions #6

Updated by Александр Александров about 5 years ago

  • Description updated (diff)
Actions #8

Updated by Александр Александров about 5 years ago

  • Status changed from В работе to Закрыта
Actions #9

Updated by Александр Александров about 5 years ago

Итоги

  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. Была доработана стартовая веб-страница в которой выводится информация по тестовому заданию. Так же создана дополнительная страница, которая выводит сообщение в случае неправильного запроса.
Actions

Also available in: Atom PDF

Go to top