Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spt-development/spt-development-demo
Demonstrates the use of a number of the spt-development projects related to logging and auditing.
https://github.com/spt-development/spt-development-demo
auditing logging microservices spring-boot spring-jms spring-mvc
Last synced: 3 days ago
JSON representation
Demonstrates the use of a number of the spt-development projects related to logging and auditing.
- Host: GitHub
- URL: https://github.com/spt-development/spt-development-demo
- Owner: spt-development
- License: apache-2.0
- Created: 2021-09-01T19:27:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T12:26:14.000Z (7 months ago)
- Last Synced: 2024-04-06T13:30:01.394Z (7 months ago)
- Topics: auditing, logging, microservices, spring-boot, spring-jms, spring-mvc
- Language: Java
- Homepage:
- Size: 239 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
````
____ ____ _____ ____ _ _
/ ___|| _ \_ _| | _ \ _____ _____| | ___ _ __ _ __ ___ ___ _ __ | |_
\___ \| |_) || | | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __|
___) | __/ | | | |_| | __/\ V / __/ | (_) | |_) | | | | | | __/ | | | |_
|____/|_| |_| |____/ \___| \_/ \___|_|\___/| .__/|_| |_| |_|\___|_| |_|\__|
|_|
demo----------------------------------------------------------------------------
````
[](https://github.com/spt-development/spt-development-demo/actions)
A simple demo project demonstrating how to integrate the following open source projects into a Spring Boot application,
through the use of the corresponding Spring Boot starters.
* [spt-development/spt-development-audit-spring](https://github.com/spt-development/spt-development-audit-spring)
* [spt-development/spt-development-cid-jms-spring](https://github.com/spt-development/spt-development-cid-jms-spring)
* [spt-development/spt-development-cid-web](https://github.com/spt-development/spt-development-cid-web)
* [spt-development/spt-development-logging-spring](https://github.com/spt-development/spt-development-logging-spring)
The project provides a simple 'books' REST API backed by a postgres database (see below), that shows how the use of these
projects can be used to quickly and easily add production grade logging to your Spring Boot projects. The project also
integrates [spt-development/spt-development-audit-spring](https://github.com/spt-development/spt-development-audit-spring)
demonstrating how to use simple annotations to capture audit information. The auditing is configured to use the
recommended approach of writing the audit records to a JMS queue and processing them asynchronously.
Building locally
================
To build the project and run the integration tests, run the following Maven command:
```shell
$ ./mvnw clean install
```
The integration tests use [Testcontainers](https://www.testcontainers.org/) therefore docker must be installed on the
machine the build is run on.
**NOTE** To update `mvnw` run `mvn wrapper:wrapper`.
Running the demo
================
The best way to understand how things are working is to run and debug the integration tests in your favourite IDE. However,
to run the demo project from the command line, the easiest way is to use the Spring Boot plugin (the project currently requires
JDK 17 or above).
```shell
$ ./mvnw spring-boot:run
```
This will also use the [docker-compose.yml](./docker-compose.yml) file to start up postgres and ActiveMQ in docker containers
through the user of Spring Boot's
[docker compose support](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.docker-compose).
Alternatively, and more akin to how you would run the application in production, you can run the application with java overriding the
`spring.datasource.*` and `spring.activemq.*` properties to point at an already running postgres database. The example below does this
through the use of environment variables to point at a postgres database running in Docker.
```shell
$ SPRING_DATASOURCE_URL=jdbc:postgresql://127.0.0.1:59314/spt-recruitment-demo \
SPRING_DATASOURCE_USERNAME=postgres \
SPRING_DATASOURCE_PASSWORD=p@ssw0rd \
SPRING_ACTIVEMQ_BROKER_URL=tcp://localhost:59313 \
java -jar target/spt-development-demo-0.0.1-SNAPSHOT.jar
```
Once the application is running, the REST API can then be exercised with cURL as follows:
```shell
$ curl -v -u bob:password123! --header "Content-Type: application/json" \
--request POST \
--data '{"title":"My Book","blurb":"My blurb","author":"Me","rrp":1000}' \
http://localhost:8080/api/v1.0/books
```
```shell
$ curl -v -u bob:password123! --header "Content-Type: application/json" \
--request PUT \
--data '{"id":4, "title":"My Book - updated","blurb":"My blurb - updated","author":"Me","rrp":1000}' \
http://localhost:8080/api/v1.0/books/4
```
```shell
$ curl -v -u bob:password123! http://localhost:8080/api/v1.0/books
```
```shell
$ curl -v -u bob:password123! http://localhost:8080/api/v1.0/books/4
```
```shell
$ curl -v -u bob:password123! -X DELETE http://localhost:8080/api/v1.0/books/4
```
Running the demo in docker
==========================
There are multiple ways to [build a docker image](https://www.baeldung.com/spring-boot-docker-images) for Spring Boot
applications. The simplest way is to use Buildpacks.
```shell
$ ./mvnw spring-boot:build-image
```
The [docker-compose.service.yml](./docker-compose.service.yml) can then be used to run the image along with
[docker-compose.yml](./docker-compose.yml) to start up Postgres and ActiveMQ.
```shell
$ docker compose -f docker-compose.yml -f docker-compose.service.yml up -d
```
The cURL commands above can again be used to test the API.