changelog

Author: s2oBCN

CHANGELOG.md

@@ -1,7 +1,11 @@
 # Changelog
 
 ## Unreleased
-
+- Use Markdown Architectural Decision Records https://adr.github.io/madr/
+- Improve maintainability by adding SpringBoot framework
+- Added IT (Docker tests)
+- Added performance tests
+- logback.xml can be overridden from command line
 
 ## [4.0] - 2021-18-11
 

build.gradle

@@ -12,14 +12,6 @@ buildscript {
     if (!no_nexus && (nexus_url == "null" || nexus_user == "null" || nexus_pw == "null")) {
       throw new GradleException("property no_nexus='false' (or not defined) but at least one of the properties nexus_url, nexus_user or nexus_pw is not configured. Please configure those properties!")
     }
-
-    def folderRel = (String)("${project.findProperty('nexus_folder_releases') ?: System.getenv('NEXUS_FOLDER_RELEASES')}")
-    nexusFolderReleases = folderRel == "null" ? "maven-releases" : folderRel
-
-    def folderSnaps = (String)("${project.findProperty('nexus_folder_snapshots') ?: System.getenv('NEXUS_FOLDER_SNAPSHOTS')}")
-    nexusFolderSnapshots = folderSnaps == "null" ? "maven-snapshots" : folderSnaps
-
-    snippetsDir = file('build/generated-snippets')
   }
 
   repositories {
@@ -58,14 +50,14 @@ buildscript {
 
 plugins {
   id "groovy"
-  id 'application'
-  id "com.github.johnrengelman.shadow" version "7.1.1"
-  id "com.google.osdetector" version "1.7.0"
   id 'com.adarshr.test-logger' version '3.1.0'
   id 'jacoco'
   id 'org.springframework.boot' version "${springbootVersion}"
   id 'com.bmuschko.docker-spring-boot-application' version '7.1.0'
+  id "io.gatling.gradle" version "3.7.3"
 }
+// related to gatling and Springboot
+ext['netty.version'] = '4.0.51.Final'
 
 repositories {
   mavenCentral()
@@ -102,7 +94,6 @@ repositories {
 
 group = 'org.ods'
 version = '1.0'
-mainClassName = "org.ods.document.generation.svc.App"
 
 java {
   toolchain {
@@ -148,9 +139,12 @@ dependencies {
   testImplementation "org.spockframework:spock-spring:${spockCoreVersion}"
   testImplementation "org.springframework.boot:spring-boot-starter-test:${springbootVersion}"
 
-  testImplementation "com.github.stefanbirkner:system-rules:1.19.0" // for managing environment variables
-  testImplementation 'com.github.tomakehurst:wiremock:2.27.2'       // for mocking HTTP server reponses
-  testImplementation 'io.rest-assured:rest-assured:4.4.0'           // for validating REST services
+  testImplementation "com.github.stefanbirkner:system-rules:1.19.0"
+  testImplementation 'com.github.tomakehurst:wiremock:2.27.2'
+  testImplementation 'io.rest-assured:rest-assured:4.4.0'
+
+  gatlingImplementation 'org.awaitility:awaitility:4.1.1'
+  gatlingImplementation 'io.rest-assured:rest-assured:4.4.0'
 }
 
 test {
@@ -161,28 +155,42 @@ test {
   filter {
     includeTestsMatching "*Spec"
   }
+  systemProperty 'com.athaydes.spockframework.report.outputDir', 'build/reports/spock'
   useJUnitPlatform()
 
   finalizedBy jacocoTestReport
 }
 
 task dockerTest(type: Test) {
+  dependsOn(test)
   group("verification")
   filter {
     includeTestsMatching "*IT"
   }
+  systemProperty 'com.athaydes.spockframework.report.outputDir', 'build/reports/spock'
   useJUnitPlatform()
 }
 
 jacocoTestReport {
   reports {
     xml.enabled true
+    html.enabled true
+  }
+  finalizedBy jacocoTestCoverageVerification
+}
+
+jacocoTestCoverageVerification {
+  violationRules {
+    rule {
+      limit {
+        minimum = 0.7
+      }
+    }
   }
 }
 
 import com.bmuschko.gradle.docker.tasks.image.*
 task buildImage(type: DockerBuildImage) {
- // dependsOn createDockerfile
   inputDir = file("src/main/resources")
   images.add('docgen-base:latest')
 }
@@ -194,4 +202,31 @@ docker {
     images = ['docgen:latest']
     jvmArgs = ['-Dspring.profiles.active=production', '-Xmx2048m']
   }
-}
+}
+buildImage.dependsOn(bootJar)
+dockerBuildImage.dependsOn(buildImage)
+dockerTest.dependsOn(dockerBuildImage)
+
+import com.bmuschko.gradle.docker.tasks.container.*
+
+task createDocGenServer(type: DockerCreateContainer) {
+  dependsOn dockerBuildImage
+  targetImageId dockerBuildImage.getImageId()
+  hostConfig.portBindings = ['8080:8080']
+  hostConfig.autoRemove = true
+}
+
+task startDocGenServer(type: DockerStartContainer) {
+  dependsOn createDocGenServer
+  targetContainerId createDocGenServer.getContainerId()
+}
+
+task stopDocGenServer(type: DockerStopContainer) {
+  targetContainerId createDocGenServer.getContainerId()
+}
+
+gatlingRun.group("verification")
+gatlingRun.dependsOn(dockerTest, startDocGenServer)
+gatlingRun.finalizedBy(stopDocGenServer)
+
+check.dependsOn(gatlingRun)

docker/Dockerfile

@@ -6,15 +6,16 @@
 
 ## Context and Problem Statement
 
-In order to evolve DocGen service to migrate here the LevaDoc feature, initially implemented
+In order to evolve DocGen service and migrate here the LevaDoc feature, initially implemented
 in the SharedLib, we need to improve LevaDoc architecture to make it more maintainable.
 
 ## Decision Drivers
 
 * Maintainability: speed up the development with better modularization of the code
 * Testability.
 * Extensibility.
-* Performance: this is not a big problem. As the API will be executed from a batch, we don't care if the response takes 2 seconds more or less
+* Performance (of course we should take care of Performance, but as the API will be executed from a batch, 
+we don't care if the response takes 2 seconds more or less)
 
 ## Considered Options
 
@@ -25,9 +26,9 @@ in the SharedLib, we need to improve LevaDoc architecture to make it more mainta
 ## Decision Outcome
 
 Chosen option: "SpringFramework", because:
+- It has the best integration with more frameworks, means also better extensibility
 - There's a lot of documentation and examples. Easy to solve problems
 - There's a bigger community of users: easy to involve new developers
-- Better integration with more frameworks, means also better extensibility
 
 ### Negative Consequences 
 

docs/decisions/0001-use-spring-framework.md

@@ -1,31 +1,26 @@
 # {short title of solved problem and solution}
 
-* Status: {proposed | rejected | accepted | deprecated | … | superseded by [ADR-0005](0005-example.md)} <!-- optional -->
-* Deciders: {list everyone involved in the decision} <!-- optional -->
-* Date: {YYYY-MM-DD when the decision was last updated} <!-- optional -->
-
-Technical Story: {description | ticket/issue URL} <!-- optional -->
+* Status: accepted
+* Deciders: Sergio Sacristán
+* Date: 2021-12-22
 
 ## Context and Problem Statement
 
-{Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.}
-
-## Decision Drivers <!-- optional -->
+When unit testing a service, the standard unit is usually the service class, simple as that. The test will mock out the layer underneath  in this case the DAO/DAL layer and verify the interactions on it. Exact same thing for the DAO layer  mocking out the interactions with the database (HibernateTemplate in this example) and verifying the interactions with that.
 
-* {driver 1, e.g., a force, facing concern, …}
-* {driver 2, e.g., a force, facing concern, …}
-* … <!-- numbers of drivers can vary -->
+This is a valid approach, but it leads to brittle tests  adding or removing a layer almost always means rewriting the tests entirely. This happens because the tests rely on the exact structure of the layers, and a change to that means a change to the tests.
+To avoid this kind of inflexibility, we can grow the scope of the unit test by changing the definition of the unit  we can look at a persistent operation as a unit, from the Service Layer through the DAO and all the way day to the raw persistence  whatever that is. Now, the unit test will consume the API of the Service Layer and will have the raw persistence mocked out  in this case, the "templates.repository"
 
-## Considered Options
+## Decision Drivers 
 
-* {option 1}
-* {option 2}
-* {option 3}
-* … <!-- numbers of options can vary -->
+* Optimize testing effort
+* Improve test quality
 
 ## Decision Outcome
 
-Chosen option: "{option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
+https://github.com/portainer/portainer
+https://localhost:9443/
+admin 12345678
 
 ### Positive Consequences <!-- optional -->
 
@@ -72,9 +67,8 @@ Chosen option: "{option 1}", because {justification. e.g., only option, which me
 * … <!-- numbers of links can vary -->
 
 <!-- markdownlint-disable-file MD013 -->
-https://examples.javacodegeeks.com/spring-boot-mockmvc-tutorial/
 
-When unit testing a service, the standard unit is usually the service class, simple as that. The test will mock out the layer underneath  in this case the DAO/DAL layer and verify the interactions on it. Exact same thing for the DAO layer  mocking out the interactions with the database (HibernateTemplate in this example) and verifying the interactions with that.
 
-This is a valid approach, but it leads to brittle tests  adding or removing a layer almost always means rewriting the tests entirely. This happens because the tests rely on the exact structure of the layers, and a change to that means a change to the tests.
-To avoid this kind of inflexibility, we can grow the scope of the unit test by changing the definition of the unit  we can look at a persistent operation as a unit, from the Service Layer through the DAO and all the way day to the raw persistence  whatever that is. Now, the unit test will consume the API of the Service Layer and will have the raw persistence mocked out  in this case, the HibernateTemplate:
+
+
+

docs/decisions/0002-testing-strategy.md

@@ -0,0 +1,13 @@
+package org.ods.doc.gen;
+
+import io.gatling.app.Gatling;
+import io.gatling.core.config.GatlingPropertiesBuilder;
+
+public class GatlingRunner {
+    public static void main(String[] args) {
+        GatlingPropertiesBuilder props = new GatlingPropertiesBuilder();
+        props.simulationClass(LoadSimulation.class.getName());
+        props.resultsDirectory("build/reports/gatling");
+        Gatling.fromMap(props.build());
+    }
+}

src/gatling/java/org/ods/doc/gen/GatlingRunner.java

@@ -0,0 +1,56 @@
+package org.ods.doc.gen;
+
+import io.gatling.javaapi.core.ScenarioBuilder;
+import io.gatling.javaapi.core.Simulation;
+import io.restassured.http.ContentType;
+import org.awaitility.Awaitility;
+
+import java.util.concurrent.TimeUnit;
+
+import static io.gatling.javaapi.core.CoreDsl.atOnceUsers;
+import static io.gatling.javaapi.core.CoreDsl.exec;
+import static io.gatling.javaapi.core.CoreDsl.global;
+import static io.gatling.javaapi.core.CoreDsl.scenario;
+import static io.gatling.javaapi.http.HttpDsl.http;
+import static io.gatling.javaapi.http.HttpDsl.status;
+import static io.restassured.RestAssured.given;
+
+public class LoadSimulation extends Simulation {
+
+    public static final String HEALTH = "http://localhost:8080/health";
+    // TODO -> change POST_PDF by "http://localhost:8080/document" and test a big doc
+    public static final String POST_PDF = "http://localhost:8080/health";
+    public static final int STATUS_CODE_OK = 200;
+
+    public static final int EXECUTION_TIMES = 100;
+
+    // Assertions: https://gatling.io/docs/gatling/reference/current/core/assertions/
+    public static final double SUCCESSFUL_REQUEST_PERCENT = 100.0;
+    public static final int MAX_RESPONSE_TIME = 400;
+    public static final int MEAN_RESPONSE_TIME = 245;
+
+    ScenarioBuilder scn = scenario( "postPDF").repeat(EXECUTION_TIMES).on(
+            exec(
+                http("POST_PDF")
+                    .get(POST_PDF)
+                    .asJson()
+                    .check(status().is(STATUS_CODE_OK))
+            ).pause(1)
+    );
+
+    {
+        waitUntilDocGenIsUp();
+        setUp(scn.injectOpen(atOnceUsers(1))).assertions(
+                global().successfulRequests().percent().is(SUCCESSFUL_REQUEST_PERCENT),
+                global().responseTime().max().lt(MAX_RESPONSE_TIME),
+                global().responseTime().mean().lt(MEAN_RESPONSE_TIME)
+        );;
+    }
+
+    private void waitUntilDocGenIsUp() {
+        Awaitility.await().atMost(60, TimeUnit.SECONDS).pollInterval(5, TimeUnit.SECONDS).until(() ->
+        {
+            return given().contentType(ContentType.JSON).when().get(HEALTH).getStatusCode() == STATUS_CODE_OK;
+        });
+    }
+}

src/gatling/java/org/ods/doc/gen/LoadSimulation.java

@@ -9,10 +9,11 @@
     </layout>
   </appender>
 
-  <logger name="org.ods" level="trace" additivity="false">
+  <!-- https://logback.qos.ch/manual/configuration.html#defaultValuesForVariables -->
+  <logger name="org.ods" level="${ODS_LOG_LEVEL:-INFO}" additivity="false">
     <appender-ref ref="STDOUT"/>
   </logger>
-  <root level="INFO">
+  <root level="${ROOT_LOG_LEVEL:-INFO}">
     <appender-ref ref="STDOUT" />
   </root>
 </configuration>

src/main/resources/logback.xml

@@ -1,7 +1,9 @@
 package org.ods.doc.gen
 
+import groovy.util.logging.Slf4j
 import io.restassured.http.ContentType
 import org.testcontainers.containers.GenericContainer
+import org.testcontainers.containers.output.Slf4jLogConsumer
 import org.testcontainers.spock.Testcontainers
 import org.testcontainers.utility.DockerImageName
 import spock.lang.Shared
@@ -10,17 +12,22 @@ import spock.lang.Specification
 import static io.restassured.RestAssured.given
 import static org.hamcrest.Matchers.equalTo
 
+@Slf4j
 @Testcontainers
 class DocGenDockerIT extends Specification {
 
     static final DockerImageName DOCGEN_IMAGE = DockerImageName.parse("docgen:latest");
 
     @Shared
-    GenericContainer<?> docGenContainer = new GenericContainer<>(DOCGEN_IMAGE).withExposedPorts(8080);
+    GenericContainer<?> docGenContainer = new GenericContainer<>(DOCGEN_IMAGE)
+            .withExposedPorts(8080)
+            .withEnv("ROOT_LOG_LEVEL", "TRACE")
 
     def "docgen is running in docker"() {
         given:
         def port = docGenContainer.firstMappedPort
+        Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(log)
+        docGenContainer.followOutput(logConsumer)
 
         expect:
         given()