1 Introduction

This repository contains the source code for the Metal Release Butler microservice. The service is a Groovy based Spring Boot application.

It collects information about announced album releases of metal bands from external sources. This information is persisted in a database and made available through a REST endpoint.

2 Download source code

Clone the source code via:

git clone https://github.com/MetalDetectorRocks/metal-release-butler.git

3 Run application locally

To start the application locally, the following preparatory actions are necessary:

1. Install Java 17

2. Install Groovy (v3.0.x)

3. Install Docker CE

4. Run docker-compose up -d --no-recreate from the root directory of the project. This starts all peripheral docker containers that are needed locally to run the Metal Release Butler Application.

5. Define the data source connection details in file application.yml:

   • spring.datasource.username (you have to use user postgres)
   • spring.datasource.password (password from docker-compose.yml)
   • spring.datasource.url (jdbc:postgresql://localhost:5432/metal-release-butler, the database name must match POSTGRES_DB of service butler-db from docker-compose.yml file)

6. Add the following snippet to /etc/hosts:

# Metal Release Butler
127.0.0.1 auth-app

It is also possible to define all mentioned connection details and secrets as environment variables. In this case no variables in application.yml need to be changed. The names of the environment variables are already in the application.yml file. You can define the environment variables for example within a Run Configuration in IntelliJ (other IDEs have similar possibilities).

4 Start the application

via gradle

• Execute command ./gradlew bootRun in root directory

via your IDE

• Execute main class rocks.metaldetector.butler.MetalReleaseButlerApplication

5 Getting access tokens

The application is secured via oauth2, so to access the api you need to fetch an access token first. The auth service in the docker-compose.yml provides these. Tools like Postman offer support for doing this automatically. The required information to get an access token are:

• Grant Type: Client Credentials
• Access Token Url: http://localhost:9000/oauth2/token
• Client ID: from docker-compose.yml
• Client Secret: from docker-compose.yml
• Scope: admin or user depending on client used

The client authentication has to be sent as basic authentication and the authorization data returned has to be added as a request header.

6 Execute tests locally

via gradle

• Execute command ./gradlew clean check in root directory

via your IDE

• Execute the task check from folder verification
• Please note: You might get the message "Test events were not received" if you do this via IntelliJ. This is intentional behaviour of gradle. If nothing changes in the tests themselves, they will not be executed repeatedly. If you still want to run the tests, you have to execute clean before.

---

Supported by JetBrains