Skip to content

Commit

Permalink
Added swagger and code coverage to report
Browse files Browse the repository at this point in the history
  • Loading branch information
walker2 committed Dec 24, 2017
1 parent 1343570 commit 7287c62
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 2 deletions.
Binary file added java_report/codecov.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified java_report/java_report.pdf
Binary file not shown.
27 changes: 25 additions & 2 deletions java_report/java_report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -224,16 +224,32 @@ \subsection{Backend}
\end{itemize}
\end{enumerate}

Для более наглядной и функциональной документации API был использованы \textbf{Swagger} и \textbf{ReDoc}.

\begin{figure}[H]
\begin{flushleft} \centerline{\includegraphics[scale=0.4]{swagger.png}}
\caption{Документация api}
\end{flushleft}
\end{figure}

\subsubsection{Тестирование}
Для тестирования был использованы библиотеки \textbf{Spring Test} и \textbf{JUnit 4}. Были написаны тестирующие программы для всех основных задач api, а именно регистрацию, авторизацию, принятие и отправку сообщений. Для создания имитационных объектов (mock objects) был использован фреймворк \textbf{Mockito}.

Покрытие кода выведено с помощью \textbf{Jacoco}.

\begin{figure}[H]
\begin{flushleft} \centerline{\includegraphics[scale=0.4]{codecov.png}}
\caption{Покрытие тестами кода}
\end{flushleft}
\end{figure}

\subsection{Mail Server}
Для корректной работы приложения, а именно для базовой авторизации, необходимо было предоставить место для хранения данных пользователей. И, так как почтовый сервер необходимо было разместить на компьютере с открытыми необходимыми портами для различных почтовых протоколов. Было решено использовать реляционную базу данных на основе системы управления базами данных \textbf{MariaDB}. \\

Схема базы данных mail приведена ниже:
\begin{figure}[H]
\begin{flushleft} \centerline{\includegraphics[scale=0.4]{scheme2.png}}
\caption{Взаимодействие составляющих проекта}
\caption{Схема базы данных}
\end{flushleft}
\end{figure}

Expand Down Expand Up @@ -426,8 +442,15 @@ \subsection{Отправка сообщения}
\caption{Уведомление об отправке сообщения}
\end{flushleft}
\end{figure}

\newpage

\section{Заключение}
Итак, разработав почтовый сервис, включающий в себя веб-приложение, серверное приложение и почтовый сервер, мы проделали большую исследовательскую и производственную работу. \\

Был получен глубокий взгляд на разработку веб-приложений, а именно на RESTfull архитектуру. \\

Получены навыки работы с облачными серверами, а также получены базовые знания о работе реалиционных базах данны. Была разработана инфраструктура для запуска почтового сервиса на основе docker-compose. Также была исследована работа различных протоколов связи (SMTP, IMAP) и общая структура почтовой связи. \\

Получены навыки работы в команде: обсуждение, брейн-шторминг, тайм и таск менеджмент, использована система контроля версий git для кооперирования разработки. Были изучены и имплементированы базовые навыки test driven development.

\end{document}
Binary file added java_report/swagger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7287c62

Please sign in to comment.