4.3.10: Fix docker-compose postgres network name. Add jacoco and spotbugs gradle multi-project build configs. Versions upgrade: power mock -> 2.0.0, jruby -> 9.2.5.0, gradle -> 5.1

Author: daggerok

.travis.yml

@@ -35,6 +35,7 @@ before_install:
 script:
 # jgiven tests and docs
 - ./gradlew -S -Pdebug clean test jgiven build documentation >/dev/null
+- ./gradlew check jacocoTestReport jacocoTestCoverageVerification
 - ./gradlew -S -Pdebug clean check build >/dev/null
 
 - export APP_UPLOAD_PATH="/tmp/file-storage"

README.md

@@ -1,7 +1,5 @@
-streaming-file-server [![build](https://travis-ci.org/daggerok/streaming-file-server.svg?branch=master)](https://travis-ci.org/daggerok/streaming-file-server)
-=====================
-
-_latest VERSION: 3.4.9_
+# streaming-file-server [![build](https://travis-ci.org/daggerok/streaming-file-server.svg?branch=master)](https://travis-ci.org/daggerok/streaming-file-server)
+_version: 4.3.10_
 
 full-stack java file server based on spring-boot / spring-* with no limitation for upload and download files
 
@@ -13,22 +11,28 @@ Read [reference documentation](http://daggerok.github.io/streaming-file-server)
 
 [**try it locally**](https://github.com/daggerok/streaming-file-server/releases)
 
+available commands:
+
+- start: `<application> start <storage>`
+- stop: `<application> stop`
+- clean: `<application> clean <storage>`
+
 ### Installation
 
 **with postgres in docker**
 
 ```bash
 # database
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/docker-compose.yml
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/docker-compose.yml
 docker-compose -f docker-compose.yml up -d
 
 # file-items data service
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-items-service-3.4.9.jar
-bash file-items-service-3.4.9.jar --spring.profiles.active=db-pg
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-items-service-4.3.10.jar
+bash file-items-service-4.3.10.jar --spring.profiles.active=db-pg
 
 # file server
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-server-3.4.9.jar
-bash file-server-3.4.9.jar --app.upload.path=./path/to/file-storage
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-server-4.3.10.jar
+bash file-server-4.3.10.jar --app.upload.path=./path/to/file-storage
 
 # cleanup
 docker-compose -f docker-compose.yml down -v
@@ -37,7 +41,7 @@ docker-compose -f docker-compose.yml down -v
 **or simply using shell-script**
 
 ```bash
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application.bash
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application.bash
 
 # start
 bash application.bash start ./path/to/file-storage
@@ -53,7 +57,7 @@ bash application.bash clean ./path/to/file-storage
 
 installed binaries: `wget`, `docker-compose`, `bash` and of course `java` are required
 
-**for windows use https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application.cmd**
+**for windows use https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application.cmd**
 
 ```cmd
 @rem start
@@ -73,18 +77,18 @@ installed binaries: `which`, `wget`, `docker-compose`, `taskkill`, `mkdir` and o
 **with h2 in-memory database**
 
 ```bash
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-items-service-3.4.9.jar
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-server-3.4.9.jar
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-items-service-4.3.10.jar
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-server-4.3.10.jar
 
-# bash file-items-service-3.4.9.jar --spring.profiles.active=db-h2 # or just:
-bash file-items-service-3.4.9.jar
-bash file-server-3.4.9.jar --app.upload.path=./path/to/file-storage
+# bash file-items-service-4.3.10.jar --spring.profiles.active=db-h2 # or just:
+bash file-items-service-4.3.10.jar
+bash file-server-4.3.10.jar --app.upload.path=./path/to/file-storage
 ```
 
 **or simply shell script for h2**
 
 ```bash
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application-h2.bash
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application-h2.bash
 
 # start
 bash application-h2.bash start ./path/to/file-storage
@@ -96,7 +100,7 @@ bash application-h2.bash stop
 bash application-h2.bash clean ./path/to/file-storage
 ```
 
-**for windows use https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application-h2.cmd**
+**for windows use https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application-h2.cmd**
 
 ```cmd
 @rem start
@@ -168,12 +172,32 @@ for image in $(docker images -qa) ; do docker rmi -f $image ; done
 docker system prune -af --volumes
 ```
 
+### spotbugs
+
+```bash
+./gradlew check
+# or:
+./gradlew spotbugsMain spotbugsTest
+
+tree ./build/spotbugs
+```
+
+### jacoco
+
+```bash
+#./gradlew build
+# or:
+./gradlew check jacocoTestReport jacocoTestCoverageVerification
+
+open ./build/jacoco/modules-apps-file-server/index.html
+```
+
 ### version
 
 #### set version
 
 ```bash
-./mvnw versions:set -DnewVersion=3.4.9
+./mvnw versions:set -DnewVersion=4.3.10
 ```
 
 #### process versions substitution
@@ -188,6 +212,12 @@ docker system prune -af --volumes
 ./mvnw
 ```
 
+### all together
+
+```bash
+./mvnw versions:set -DnewVersion=... ; ./mvnw -Pversions ; ./mvnw 
+```
+
 <!--
 
 ### known issues (deprecations)

RELEASE.md

@@ -1,18 +1,20 @@
 # streaming-file-server
-
-_version: 3.4.9_
+_version: 4.3.10_
 
 ## Java file server 
 
 **Java file server** based on *spring-boot* with no memory, upload or download files size limitations
 
+- fix docker-compose postgres network name
+- add jacoco and spotbugs gradle multi-project build configs
 - versions upgrade:
 
-  |   dependency | version  |
-  |-------------:|:---------|
-  |        maven | 3.6.0    |
-  |       gradle | 5.1-rc-3 |
-  | font-awesome | 5.6.1    |
+  |             dependency | version |
+  |-----------------------:|:--------|
+  |             power mock | 2.0.0   |
+  |                  jruby | 9.2.5.0 |
+  |                 gradle | 5.1     |
+  | spotbugs-gradle-plugin | 1.6.9   |
 
 ## Installation
 
@@ -22,16 +24,16 @@ _version: 3.4.9_
 
 ```bash
 # docker compose file for postgres database
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/docker-compose.yml
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/docker-compose.yml
 docker-compose up -d
 
 # file-items data service
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-items-service-3.4.9.jar
-java -jar file-items-service-3.4.9.jar --spring.profiles.active=db-pg
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-items-service-4.3.10.jar
+java -jar file-items-service-4.3.10.jar --spring.profiles.active=db-pg
 
 # file server
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-server-3.4.9.jar
-java -jar file-server-3.4.9.jar --app.upload.path=./path/to/file-storage
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-server-4.3.10.jar
+java -jar file-server-4.3.10.jar --app.upload.path=./path/to/file-storage
 
 # cleanup
 docker-compose down -v
@@ -41,7 +43,7 @@ docker-compose down -v
 
 ```bash
 # bash script
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application.bash
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application.bash
 
 # start
 bash application.bash start ./path/to/file-storage
@@ -61,7 +63,7 @@ binaries: `wget`, `docker-compose`, `bash` and of course `java` are required
 
 ```cmd
 @rem batch shell-script
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application.cmd
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application.cmd
 
 @rem start
 application.cmd start path\to\file-storage
@@ -82,18 +84,18 @@ binaries: `which`, `wget`, `docker-compose`, `taskkill`, `mkdir` and of course j
 #### manual setup
 
 ```bash
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-items-service-3.4.9.jar
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/file-server-3.4.9.jar
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-items-service-4.3.10.jar
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/file-server-4.3.10.jar
 
-bash file-items-service-3.4.9.jar --spring.profiles.active=db-h2
-bash file-server-3.4.9.jar --app.upload.path=./path/to/file-storage
+bash file-items-service-4.3.10.jar --spring.profiles.active=db-h2
+bash file-server-4.3.10.jar --app.upload.path=./path/to/file-storage
 ```
 
 #### or for simplicity use special h2 automation shell-script
 
 ```bash
 # bash shell script
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application-h2.bash
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application-h2.bash
 
 # start
 bash application-h2.bash start ./path/to/file-storage
@@ -109,7 +111,7 @@ bash application-h2.bash clean ./path/to/file-storage
 
 ```cmd
 @rem cmd script
-wget https://github.com/daggerok/streaming-file-server/releases/download/3.4.9/application-h2.cmd
+wget https://github.com/daggerok/streaming-file-server/releases/download/4.3.10/application-h2.cmd
 
 @rem start
 application-h2.cmd start path\to\file-storage

build.gradle

@@ -13,9 +13,12 @@ buildscript {
     slf4jVersion = '1.7.25'
     vavrVersion = '0.9.2'
 
+    toolVersion = '3.1.10'
+    spotbugsVersion = '1.6.9'
+
     jgivenVersion = '0.17.0'
     selenideVersion = '5.1.0'
-    powermockitoVersion = '2.0.0-RC.4'
+    powermockitoVersion = '2.0.0'
 
     popperVersion = '1.14.6'
     jqueryVersion = '3.3.1-1'
@@ -27,7 +30,7 @@ buildscript {
 
   dependencies {
     classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16'
-    classpath 'org.jruby:jruby-complete:9.2.4.1' /* 9.1.13.0 */ 
+    classpath 'org.jruby:jruby-complete:9.2.5.0' /* 9.1.13.0 */ 
   }
 
   configurations.all {
@@ -38,6 +41,7 @@ buildscript {
 }
 
 plugins {
+  id 'com.github.spotbugs' version '1.6.9'
   id 'net.saliman.properties' version '1.4.6'
   id 'com.github.ben-manes.versions' version '0.20.0'
 
@@ -50,9 +54,9 @@ plugins {
   id 'com.ewerk.gradle.plugins.querydsl' version '1.0.10' apply false
   id 'io.spring.dependency-management' version '1.0.6.RELEASE' apply false
 
-  id 'com.github.breadmoirai.github-release' version '2.2.1' apply false
+  id 'com.github.breadmoirai.github-release' version '2.2.3' apply false
   id 'org.ajoberstar.git-publish' version '2.0.0' /* '2.0.0-rc.2' *//* +0.3.0 +0.2.2 | -0.4.1 */ apply false
-  id 'org.asciidoctor.convert' version '1.5.9.1' apply false // on windows my fail: instead use 1.5.8.1
+  id 'org.asciidoctor.convert' version '1.5.9.1' apply false // on windows my fail use instead: 1.5.8.1
   id 'com.avast.gradle.docker-compose' version '0.7.1' apply false // fail with 0.8.9 + asciidoctor ruby
 }
 

gradle.properties

@@ -1 +1 @@
-ogr.gradle.project.version = 3.4.9
+ogr.gradle.project.version = 4.3.10

gradle/jacoco.gradle

@@ -0,0 +1,48 @@
+// read more: https://docs.gradle.org/current/userguide/jacoco_plugin.html
+// Also got some thoughts from here: https://gist.github.com/aalmiray/e6f54aa4b3803be0bcac
+
+allprojects {
+  apply plugin: 'java'
+  apply plugin: 'jacoco'
+
+  jacoco {
+    toolVersion = '0.8.2'
+  }
+
+  jacocoTestReport {
+    def jacocoPath = "$rootProject.buildDir.absolutePath/jacoco"
+    def projectPath = project.path.replaceAll(':', '-').replaceFirst('-', '')
+    reports {
+      xml.enabled = false
+      csv.enabled = false
+      html.enabled = true
+      html.destination file("$jacocoPath/$projectPath")
+    }
+  }
+  build.dependsOn(jacocoTestReport)
+  jacocoTestReport.mustRunAfter(test)
+
+  jacocoTestCoverageVerification {
+    violationRules {
+      rule {
+        limit {
+          minimum = 0.2 // very low coverage, only 20%... try achieve at least 0.5
+        }
+      }
+
+      rule {
+        enabled = false
+        element = 'CLASS'
+        includes = ['org.gradle.*']
+
+        limit {
+          counter = 'LINE'
+          value = 'TOTALCOUNT'
+          maximum = 0.3
+        }
+      }
+    }
+  }
+  build.dependsOn(jacocoTestCoverageVerification)
+  jacocoTestCoverageVerification.mustRunAfter(test)
+}