Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.15 KB

README.md

File metadata and controls

51 lines (34 loc) · 2.15 KB
Raw

OSAHFT REST API

Build & Run

Requirements

  • JDK 11 or higher
  • Maven 3.5.0 or higher

Build

  • JAR: mvn clean package -DskipTests=true
  • Docker Image: docker build . -t ${IMAGE_TAG}

Run

  • JAR: java -jar api.jar --spring.config.location=classpath:/application.properties,${PATH_TO_API_PROPERTIES}/api.properties
  • Docker Image: docker run --name=${CONTAINER_NAME_OF_CHOICE} --mount type=bind,source=${PATH_TO_API_PROPERTIES}/api.properties,target=/etc/osahft/api.properties ${IMAGE_TAG}

Run tests

  1. start elasticsearch (e.g.docker run --name elasticsearch -e "discovery.type=single-node" -p 9200:9200 elasticsearch:7.14.2)
  2. create an test.properties file from packages/api/src/test/resources/test.properties.example and store it at packages/api/src/test/resources/test.properties
  3. run mvn test

How to generate assertions for tests

  1. open pom.xml
  2. set the parameter skip of the configuration section of the assertj-assertions-generator-maven-plugin to false
  3. run mvn clean package -DskipTests=true && mvn assertj:generate-assertions
  4. copy the newly generated assertions from target/generated-test-sources/assertj-assertions/com/osahft/api/internal/assertion to src/test/java/com/osahft/api/internal/assertion (Make sure you only copy the missing ones)
  5. set the parameter skip of the configuration section of the assertj-assertions-generator-maven-plugin to true (restore original state)
  6. open src/test/java/com/osahft/api/internal/assertion/Assertions.java and add the assertThat methods representing the asserts you just generated / copied
  7. run mvn clean package -DskipTests=true to make sure that nothing went wrong

Adding https-support

To run the api with https use the following tutorial
https://www.baeldung.com/spring-boot-https-self-signed-certificate

Additional notes

  • if you get an error similar to No qualifying bean of type 'org.springframework.boot.info.BuildProperties' available you should delegate IDE build/run actions to maven (Intellij: Settings > Build, Execution, Deployment > Build Tools > Maven > Runner > check Delegate IDE build/run actions to Maven)