Update gradle build configuration to support multi-project build (#42)

* Update dependencies and gradle wrapper
* Initial restructure for multiproject gradle build
* Update Travis-CI to use JDK11 but also build against early access
* Update to using Java 11 options in Dockerfile
* Stop logging of query string as it is unsafe, instead use spring actuator /actuator/httptrace endpoint
* Run sonarqube in after_success phase in test stage

Author: bhavikkumar

.travis.yml

@@ -1,7 +1,7 @@
 language: java
 jdk:
-- openjdk8
 - openjdk11
+- openjdk-ea
 env:
   global:
   # Following encrypted environment variables must be present for successful deployment
@@ -21,15 +21,14 @@ cache:
   directories:
   - "$HOME/.gradle/caches/"
   - "$HOME/.gradle/wrapper/"
-  - "$HOME/.local"
-script:
-- ./gradlew check sonarqube
 jobs:
   include:
   - stage: test
+    after_success:
+      - ./gradlew sonarqube
   - stage: deploy to development
     if: env(DEV_ACCOUNT_ID) is present
-    jdk: openjdk8
+    jdk: openjdk11
     env:
     - CLUSTER_NAME=
     - SERVICE_NAME=
@@ -46,13 +45,14 @@ jobs:
         branch: master
   - stage: deploy to production
     if: env(PROD_ACCOUNT_ID) is present
-    jdk: openjdk8
+    jdk: openjdk11
     env:
     - CLUSTER_NAME=
     - SERVICE_NAME=
     - AWS_ACCESS_KEY_ID=$PROD_ACCESS_KEY_ID
     - AWS_SECRET_ACCESS_KEY=$PROD_SECRET_ACCESS_KEY
     - REPOSITORY_URI=$PROD_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$ECR_REPOSITORY_NAME
+    script: skip
     before_deploy: deployment/scripts/common/push-docker-image.sh
     deploy:
       skip_cleanup: true
@@ -61,8 +61,7 @@ jobs:
       on:
         branch: master
   allow_failures:
-  - jdk: openjdk10
-  - jdk: openjdk11
+  - jdk: openjdk-ea
   fast_finish: true
 notifications:
   slack:

README.md

@@ -6,20 +6,7 @@
 
 ## How tos
 
-### Build and Test
-For IDEs run one of the following commands before importing into your IDE.
-
-#### IntelliJ
-```bash
-./gradlew idea
-```
-
-#### Eclipse
-```bash
-./gradlew eclipse
-```
-
-#### Build & Test
+### Build & Test
 ```bash
 ./gradlew clean assemble check
 ```
@@ -37,22 +24,14 @@ docker run -p 8080:8080 -i -t -e JAVA_OPTS="-agentlib:jdwp=transport=dt_socket,s
 ### Enabling New Relic
 New relic can be enabled by providing the following `JAVA_OPTS` environment variable. Ensure to provide the correct `newrelic.environment` system property. To configure New Relic add/update the Application Environments section in `newrelic.yml`, more information can be found [here](https://docs.newrelic.com/docs/agents/java-agent/configuration/java-agent-configuration-config-file). 
 ```base
-docker run -p 8080:8080 -i -t -e JAVA_OPTS="-javaagent:newrelic/newrelic.jar -Dnewrelic.environment=${environment} -Dnewrelic.config.file=newrelic/newrelic.yml" spring-boot-java-base
+docker run -p 8080:8080 -i -t -e JAVA_OPTS="-javaagent:newrelic/newrelic.jar -Dnewrelic.environment=development -Dnewrelic.config.file=newrelic/newrelic.yml" spring-boot-java-base
 ```
 
 ### How to: Build production equivalent container
 ```bash
 ./gradlew clean assemble check docker dockerTag -PTAG=$(git rev-parse --verify HEAD --short) -PREPOSITORY_URI=${DOCKER_REPO}${IMAGE_NAME}
 ```
 
-#### Recommended JAVA_OPTS
-It is strongly recommended that the following Java Options are set when running the service in production.
-
-**-XX:MaxRAMFraction=n** should only be set to 1 for containers with only 1 processes running. Setting the value will set the heap to 100% of the memory in the container.
-```base
-JAVA_OPTS="-XX:MaxRAMFraction=2 -XX:+UseG1GC -XX:+AlwaysPreTouch -XX:+UseStringDeduplication -XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap -javaagent:newrelic/newrelic.jar -Dnewrelic.environment=${environment} -Dnewrelic.config.file=newrelic/newrelic.yml -Djava.security.egd=file:/dev/./urandom"
-```
-
 ## For more tasks run
 ```bash
 ./gradlew tasks

build.gradle

@@ -1,116 +1,70 @@
 plugins {
-    id 'java'
-    id 'jacoco'
-    id 'checkstyle'
     id 'eclipse'
     id 'idea'
-    id "com.github.spotbugs" version "1.6.6"
-    id "org.springframework.boot" version "2.1.1.RELEASE"
-    id "io.spring.dependency-management" version "1.0.6.RELEASE"
-    id "com.palantir.docker" version "0.20.1"
-    id "org.sonarqube" version "2.6.2"
-    id "com.gorylenko.gradle-git-properties" version "1.5.2"
+    id "org.sonarqube" version "2.7" apply false
+    id "com.github.spotbugs" version "1.6.9" apply false
 }
 
-
-group = 'com.bnc'
-version = '0.0.1-SNAPSHOT'
-
-sourceCompatibility = 1.8
-targetCompatibility = 1.8
-
-compileJava.options.encoding = "UTF-8"
-
-repositories {
-    mavenCentral()
-    maven { url "https://repo.spring.io/milestone" }
-}
-
-spotbugs {
-    toolVersion = '3.1.10'
-}
-
-jacoco {
-    toolVersion = "0.8.2"
-}
-
-checkstyle {
-    toolVersion '8.15'
-}
-
-springBoot {
-    buildInfo()
-}
-
-tasks.withType(com.github.spotbugs.SpotBugsTask) {
-    reports {
-        xml.enabled = false
-        html.enabled = true
+allprojects {
+    apply plugin: 'java'
+    apply plugin: 'jacoco'
+    apply plugin: 'checkstyle'
+    apply plugin: 'com.github.spotbugs'
+    apply plugin: 'org.sonarqube'
+
+    group = 'com.bnc'
+    version = '0.0.1-SNAPSHOT'
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
+    compileJava.options.encoding = "UTF-8"
+
+    repositories {
+        mavenCentral()
+        jcenter()
     }
-}
 
-jacocoTestReport {
-    reports {
-        xml.enabled true
-        html.enabled true
-        csv.enabled false
+    spotbugs {
+        toolVersion = '3.1.12'
+        tasks.withType(com.github.spotbugs.SpotBugsTask) {
+            reports {
+                xml.enabled = false
+                html.enabled = true
+            }
+        }
     }
-}
 
-sonarqube {
-    properties {
-        property "sonar.projectKey", "${project.name}"
-        property "sonar.coverage.exclusions", "**/configuration/*"
-        property "sonar.cpd.exclusions", "**/model/api/*,**/model/entity/*"
+    jacoco {
+        toolVersion = "0.8.3"
     }
-}
 
-test {
-    useJUnitPlatform()
-    testLogging {
-        events "passed", "skipped", "failed"
+    checkstyle {
+        toolVersion '8.19'
+        tasks.withType(Checkstyle) {
+            reports {
+                xml.enabled false
+                html.enabled true
+            }
+        }
     }
 
-    jacoco {
-        excludes += [ '**/configuration/**' ]
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events "passed", "skipped", "failed"
+        }
     }
-    finalizedBy jacocoTestReport
-}
-
-if (!project.hasProperty("REPOSITORY_URI")) {
-    ext.REPOSITORY_URI = jar.baseName
-}
 
-if (!project.hasProperty("TAG")) {
-    ext.TAG = jar.version
-}
-
-docker {
-    name project.hasProperty("REPOSITORY_URI") ? "${REPOSITORY_URI}" : "${project.name}"
-    tags "${TAG}", 'latest'
-    files bootJar.archivePath, "${project.projectDir.absolutePath}/config/newrelic/newrelic.yml"
-    buildArgs(['JAR_FILE': "${bootJar.archiveName}"])
-}
-
-dependencyManagement {
-    imports {
-        mavenBom "org.springframework.cloud:spring-cloud-sleuth:2.1.0.M2"
+    dependencies {
+        testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter', version: '5.4.1'
+        testImplementation group: 'org.assertj', name: 'assertj-core', version: '3.12.2'
+        testImplementation group: 'org.mockito', name: 'mockito-core', version: '2.26.0'
+        testImplementation group: 'org.mockito', name: 'mockito-junit-jupiter', version: '2.26.0'
+        testRuntime group: 'org.junit.platform', name: 'junit-platform-launcher', version: '1.4.1'
     }
 }
 
-dependencies {
-    implementation group: 'org.springframework.boot', name: 'spring-boot-starter-web'
-    implementation group: 'org.springframework.boot', name: 'spring-boot-starter-actuator'
-    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-sleuth'
-    implementation group: 'com.github.spotbugs', name: 'spotbugs-annotations', version: '3.1.10'
-    implementation group: 'io.micrometer', name: 'micrometer-registry-new-relic', version: '1.1.1'
-    runtime group: 'org.postgresql', name: 'postgresql', version: '42.2.5'
-
-    testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-test'
-    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.3.2'
-    testImplementation group: 'org.assertj', name: 'assertj-core', version: '3.11.1'
-    testImplementation group: 'org.mockito', name: 'mockito-core', version: '2.23.4'
-    testImplementation group: 'org.mockito', name: 'mockito-junit-jupiter', version: '2.23.4'
-    testRuntime group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.3.2'
-    testRuntime group: 'com.h2database', name: 'h2', version: '1.4.197'
+sonarqube {
+    properties {
+        property "sonar.projectKey", "${rootProject.name}"
+    }
 }

client/build.gradle

@@ -0,0 +1,9 @@
+jar {
+    baseName = rootProject.name + "-" + project.name
+}
+
+sonarqube {
+    properties {
+        property "sonar.projectKey", "${rootProject.name}:${project.name}"
+    }
+}

deployment/templates/service.yaml

@@ -91,13 +91,13 @@ Parameters:
   MemoryReservation:
     Description: The memory reservation for the task, this is the expected upper limit during normal operations.
     Type: Number
-    Default: 768
+    Default: 512
     AllowedValues: [16, 32, 64, 128, 256, 512, 768, 1024, 1280, 1536, 1792, 2048, 2304, 2560, 2816, 3072, 3328, 3584, 3840, 4096]
 
   MemoryLimit:
     Description: The memory limit for the task, when reached the task will be automatically terminated
     Type: Number
-    Default: 768
+    Default: 512
     AllowedValues: [16, 32, 64, 128, 256, 512, 768, 1024, 1280, 1536, 1792, 2048, 2304, 2560, 2816, 3072, 3328, 3584, 3840, 4096]
 
   SplunkToken:

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.3.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -1,16 +1,16 @@
-FROM openjdk:8u181-jre-slim
+FROM openjdk:11.0.3-jre-slim
 
 ARG JAR_FILE
 
 RUN  apt-get update && apt-get install -y wget
 
 COPY ${JAR_FILE} app.jar
-RUN mkdir newrelic && wget https://download.newrelic.com/newrelic/java-agent/newrelic-agent/4.4.0/newrelic-agent-4.4.0.jar -O newrelic/newrelic.jar
+RUN mkdir newrelic && wget https://download.newrelic.com/newrelic/java-agent/newrelic-agent/4.12.1/newrelic-agent-4.12.1.jar -O newrelic/newrelic.jar
 COPY newrelic.yml newrelic/newrelic.yml
 
 EXPOSE 8080
 
-ENTRYPOINT exec java $JAVA_OPTS -jar app.jar
+ENTRYPOINT exec java -XX:MaxRAMPercentage=80 -XX:+AlwaysPreTouch -XX:+UseStringDeduplication -Djava.security.egd=file:/dev/./urandom $JAVA_OPTS -jar app.jar
 
 HEALTHCHECK --start-period=300s \
   CMD wget --quiet --tries=1 --spider --timeout=30 http://localhost:8080/actuator/health || exit 1

Dockerfile service/Dockerfile

@@ -0,0 +1,51 @@
+plugins {
+    id "org.springframework.boot" version "2.1.4.RELEASE"
+    id "io.spring.dependency-management" version "1.0.7.RELEASE"
+    id "com.palantir.docker" version "0.21.0"
+    id "com.gorylenko.gradle-git-properties" version "2.0.0"
+}
+
+jar {
+    baseName = rootProject.name + "-" + project.name
+}
+
+springBoot {
+    buildInfo()
+}
+
+sonarqube {
+    properties {
+        property "sonar.projectKey", "${rootProject.name}:${project.name}"
+        property "sonar.coverage.exclusions", "**/configuration/*"
+        property "sonar.cpd.exclusions", "**/model/api/*,**/model/entity/*"
+    }
+}
+
+if (!project.hasProperty("REPOSITORY_URI")) {
+    ext.REPOSITORY_URI = jar.baseName
+}
+
+if (!project.hasProperty("TAG")) {
+    ext.TAG = jar.version
+}
+
+docker {
+    name "${REPOSITORY_URI}"
+    tags "${TAG}", 'latest'
+    files bootJar.archivePath, "${project.projectDir.absolutePath}/config/newrelic/newrelic.yml"
+    buildArgs(['JAR_FILE': "${bootJar.archiveName}"])
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.cloud:spring-cloud-sleuth:2.1.1.RELEASE"
+    }
+}
+
+dependencies {
+    implementation group: 'org.springframework.boot', name: 'spring-boot-starter-web'
+    implementation group: 'org.springframework.boot', name: 'spring-boot-starter-actuator'
+    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-sleuth'
+    implementation group: 'io.micrometer', name: 'micrometer-registry-new-relic', version: '1.1.4'
+    testImplementation group: 'org.springframework.boot', name: 'spring-boot-starter-test'
+}

service/build.gradle

@@ -1,22 +1,19 @@
 package com.bnc.sbjb.rest;
 
-import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 @RequestMapping("${resource.path}")
 public class Controller {
 
-    @RequestMapping("/hello-error")
-    @ResponseStatus(HttpStatus.OK)
+    @GetMapping("/hello-error")
     public String notYetWorld() {
         throw new IllegalStateException("Hello World");
     }
 
-    @RequestMapping("/hello")
-    @ResponseStatus(HttpStatus.OK)
+    @GetMapping("/hello")
     public String helloWorld() {
         return "Hello World";
     }