Skip to content
Micro Service baseline: Jetty, Jersey, SLF4j, TestNG, Docker as Deployment unit
Java Python Shell Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Docker
src
.editorconfig
.gitignore
Jenkinsfile
LICENSE
README.md
pom.xml
renovate.json
versions-rules.xml

README.md

microservice-baseline

Build Status Quality Gate Status Coverage Technical Debt

This project serves as a baseline when you wish to begin a new micro service exposing HTTP endpoints.

It is set up with the following dependencies/frameworks:

Health endpoint

The application includes a simple health-endpoint, reachable at /health.

Example response:

{
  "service": "microservice-baseline",
  "timestamp": "2018-10-15T17:28:00.164Z",
  "runningSince": "2018-10-15T17:27:56.516Z",
  "version": "0.1-SNAPSHOT"
}

Endpoint tests

HealthEndpointTest.java showcases how a reusable TestServer is started, and the endpoint tested using REST-assured.

It is achieved by extending AbstractEndpointTest.

Properties

This baseline is set up without Spring, Constretto or similar tools. Instead the properties are read through the class PropertiesHelper in the Main class.

Properties are read from the following locations, in the following order:

  1. application.properties from classpath (resources/application.properties).
  2. config_override/application.properties file.

Dependency Injection to Endpoint Constructors

See JerseyConfig for example on how the property secured.endpoint.message is passed to the SecuredEndpoint constructor, and registered with Jersey.

It is only required to register the endpoint if you have special constructors. E.g. HealthEndpoint is registered through the line: packages("no.capraconsulting");

Logback

The default logback.xml in this repository only appends statements to STDOUT. This is intended, and covers the two main use cases:

If you wish to run the application with logging to file, you should use a properly set up file appender:

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds">
  <property name="LOG_DIR" value="logs/"/>
  <property name="appName" value="app"/>
  <appender name="logfile" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_DIR}/${appName}.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${LOG_DIR}/${appName}-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <maxHistory>7</maxHistory>
      <totalSizeCap>250MB</totalSizeCap>
      <timeBasedFileNamingAndTriggeringPolicy
        class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>50MB</maxFileSize>
      </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder>
      <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
  <logger name="org.eclipse.jetty" level="WARN"/>
  <logger name="no.capraconsulting" level="INFO"/>
  <root level="info">
    <appender-ref ref="logfile"/>
  </root>
</configuration>
You can’t perform that action at this time.