mateuszjanczak/barrels-of-beer-kotlin

Engineering thesis

Barrels of Beer

Engineering thesis (work in progress)

Prerequisites

• Java 8 + Kotlin
• Maven 3.8.1 or later
• MongoDB database
• Front-end application

Configuration

The configuration file can be found in the application.yml

Setting up project

1. Ensure that sensors are available on your network and IP is correct
2. Make sure the mongodb database is running and configured
3. Download project dependencies by command:

mvn install

4. Copy the front-end application build to (src/main/resources/static)
5. Run server (by default on port 8080)

mvn spring-boot:run

Running tests

Unit tests

mvn test

Integration tests

mvn integration-test

OpenAPI Specification

The documentation file can be found in the api.yaml

barrels-of-beer-kotlin's Issues

Set up application monitoring and error tracking on Sentry

DoD:

• logs and metrics are available in Sentry

Create tap service

DoD:

• there are methods to manage the tap and its contents

Add content statistics

Add removing taps to admin dashboard

Automatically resize the barrel when it overflows

Create admin dashboard and add to it tap management

Refactor code in the security package

Add REST controllers

Fix for id's in events entities

Fix refresh token

Detect counter reset and empty the barrel

Add check if user has access to the system and is enabled

Change default barrel capacity to 30 L after automatic resizing

Update API documentation

Set up unit tests with Spock and Groovy

DoD:

• the project allows you to write tests in Groovy and Spock
• unit tests are running

Fix that other sensors always reset the first sensor

Do not save duplicate reports

Add checking if user/tap already exist

Create Spring project with Kotlin

DoD:

• the project allows you to write in Kotlin
• the project has all necessary dependencies to develop Spring application

Create mapper for sensor data to proper form

DoD:

• temperature and current liquid level are extracted from the sensor data
• unit tests confirm the correctness of this converter

Improve JWT filter

Create a service for collecting data from the sensor and set up the scheduler

DoD:

• synchronization tap with sensor data

Add missing unit tests in AdminService

Fix for multiple annotations in credentials

Add forms validation

Enable CrossOrigin

Fix running tests from Inteliji

This guide may be helpful
https://tipsfordev.com/no-tests-were-found-when-running-individual-test-in-intellij-with-spock-and-spring-boot

Configure Spring to self-host React app

Increase logging in the system

Export events to .csv

Move security configuration to the main package

Add resetting database to admin dashboard

Upgrade Spring Boot to v2.6.1

Create OpenAPI Specification in v3.0

Create tap history/logs

DoD:

• every action with taps is logged
• the same readings are not recorded

Set up connection with sensors

DoD:

• there are methods to connect to sensors over HTTP
• unit tests verify the correctness of the code
• integration tests check possible response cases from external services

Add users service and spring security

Set up integration tests with WireMock

DoD:

• integration tests can use mock requests

Configure authentication based on JSON Web Tokens

Set up database MongoDB

DoD:

• project connects to the MongoDB database

Change tap details properties

Create domain entities and configure MongoDB repositories

DoD:

• there are entities for the tap and its action/temperature
• there are repositories for these entities
• the database can be tested in integration tests and is separated from the production database

Update Kotlin to 1.6

Set up continuous integration on Travis

DoD:

• tests are run on every commit automatically

Create readme