Badge Generator

badge-generator is a reactive SVG badge generator able to produce both static badges and dynamically rendered quality/coverage badges from a private Sonar server.

Configuration

You must include the following properties in the application.yml file:

sonar:
  username: user
  password: password
  uri: https://definitely-my-sonar-server.com

Usage

Run the badge-generator with mvnw spring-boot:run. Once the application is up and running, you can query the APIs specified in the openapi.yaml specification file in order to generate static/dynamic badges.

Examples

Generating a Static Badge

http://localhost:8080/badges/my-message?label=my-label&labelColor=GREY&messageColor=BLUE

Generating a Dynamic Sonar Quality Badge

http://localhost:8080/badges/quality/sonarProjectKey

Generating a Dynamic Sonar Coverage Badge

http://localhost:8080/badges/coverage/sonarProjectKey

Testing

Run the Unit Tests with mvnw verify.

Run all tests, including Integration Tests, with mvnw verify -PtestIT.

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring cache abstraction

Guides

The following guides illustrate how to use some features concretely:

• Caching Data with Spring