aosolorzano / city-tasks-spring-boot-oauth2 Goto Github PK

• Author: Andres Solorzano.
• Level: Advanced.
• Technologies: Java 17, Spring Boot 3, Spring Native, Spring WebFlux, Spring OAuth2, Quartz, Flyway, Testcontainers, Postgres, DynamoDB and Docker Compose.

You can read the full article on my Medium Blog for more details.

This project uses the Spring Boot Framework to manage Quartz Jobs in a Spring Native microservice with the use of reactive programing using Spring WebFlux. The Quartz library is configured for clustered environments, so its needs the help of Postgres database to manage the cron Jobs execution. When a Job is executed, the calling method retrieves the Device item from DynamoDB to change its state. To perform these activities, the users must be logged into the OIDC Service that its deployed using the AWS Cognito service. All test cases using the TDD methodology from the beginning of the development phase, and only Integration Tests are executed with the support of Testcontainers because Unit Testing does not cover real world scenarios. This project also uses Docker Compose to deploy a local cluster alongside the other required services by the Spring Boot application.

Only need to execute the following command from the project's root folder:

docker compose up --build

Execute the following command:

aws dynamodb scan         \
  --table-name Devices    \
  --endpoint-url http://localhost:4566

Use this option if you want to explore more features such as running your tests in a native image. IMPORTANT: The GraalVM native-image compiler should be installed and configured on your machine.

Deploy the required services using Docker Compose command:

docker compose up tasks-postgres tasks-localstack

Open a new terminal window and export the following environment variables:

export CITY_TASKS_DB_CLUSTER_SECRET='{"dbClusterIdentifier":"hiperium-city-tasks-db-cluster","password":"postgres123","dbname":"CityTasksDB","engine":"postgres","port":5432,"host":"localhost","username":"postgres"}'
export CITY_IDP_ENDPOINT='https://cognito-idp.us-east-1.amazonaws.com/<cognito_user_pool_id>'
export CITY_TASKS_TIME_ZONE_ID='-05:00'
export AWS_DEFAULT_REGION='ap-southeast-2'
export AWS_ACCESS_KEY_ID='DUMMY'
export AWS_SECRET_ACCESS_KEY='DUMMY'
export AWS_ENDPOINT_OVERRIDE='http://localhost:4566'

Then, create and run the native executable from the project's root directory:

$ ./mvnw clean native:compile -Pnative spring-boot:run

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• GraalVM Native Image Support
• Testcontainers
• Testcontainers Postgres Module Reference Guide
• Spring Reactive Web
• Spring Data JPA
• OAuth2 Resource Server
• Quartz Scheduler
• Flyway Migration

The following guides illustrate how to use some features concretely:

• Building a Reactive RESTful Web Service
• Validation
• Accessing Data with JPA

These additional references should also help you:

• Configure AOT settings in Build Plugin

This project has been configured to let you generate either a lightweight container or a native executable. It is also possible to run your tests in a native image.

If you're already familiar with Spring Boot container images support, this is the easiest way to get started. Docker should be installed and configured on your machine prior to creating the image.

To create the image, run the following goal:

$ ./mvnw spring-boot:build-image -Pnative

Then, you can run the app like any other container:

$ docker run --rm city-tasks-spring-boot-oauth2:1.4.0

Use this option if you want to explore more options such as running your tests in a native image. The GraalVM native-image compiler should be installed and configured on your machine.

NOTE: GraalVM 22.3+ is required.

To create the executable, run the following goal:

$ ./mvnw native:compile -Pnative

Then, you can run the app as follows:

$ target/city-tasks-spring-boot-oauth2

You can also run your existing tests suite in a native image. This is an efficient way to validate the compatibility of your application.

To run your existing tests in a native image, run the following goal:

$ ./mvnw test -PnativeTest