generate jacoco and checkstyle reports

Author: Tue Ton

.github/workflows/ci-build.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   build_linux:
-    name: Build and test in Linux environment
+    name: Build and unit test in Linux environment
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -43,17 +43,37 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
-      - name: Build all artefacts
+      - name: Build all artifacts
         run: ./gradlew --no-daemon buildAll
 
+      - name: Archive build artifacts (built in linux and by Java 8 only)
+          if: ${{ matrix.java-version == 8 }}
+        uses: actions/upload-artifact@v1
+        with:
+          name: build-artifacts-linux-java${{ matrix.java-version }}
+          path: build\distributions
+
       - name: Run unit tests, excluding the Ldap*Test classes
         run: ./gradlew --no-daemon test -PexcludeTests=**/Ldap*Test.class
 
+      - name: Archive test reports, excluding the Ldap*Test classes
+        uses: actions/upload-artifact@v1
+        with:
+          name: test-reports-no-LdapTests-linux-java${{ matrix.java-version }}
+          path: build\reports\tests
+
       - name: Run only the Ldap*Test unit tests
         run: ./gradlew --no-daemon test --tests *Ldap*Test
 
+      - name: Archive test report for the Ldap*Test
+        uses: actions/upload-artifact@v1
+        with:
+          name: test-report-for-LdapTests-linux-java${{ matrix.java-version }}
+          path: build\reports\tests
+
+
   build_windows:
-    name: Build and test in Windows environment
+    name: Build and unit test in Windows environment
     runs-on: windows-latest
     strategy:
       matrix:
@@ -83,12 +103,38 @@ jobs:
           java -version
           javac -version
 
-      - name: Build all artefacts
+      - name: Build all artifacts
         run: .\gradlew.bat --no-daemon buildAll
 
       - name: Run unit tests, excluding the LdapPublicKeyManagerTest class
         run: .\gradlew.bat --no-daemon test -PexcludeTests=**/LdapPublicKeyManagerTest.class
 
+      - name: Archive test reports, excluding LdapPublicKeyManagerTest
+        uses: actions/upload-artifact@v1
+        with:
+          name: test-reports-no-LdapPublicKeyManagerTest-windows-java${{ matrix.java-version }}
+          path: build\reports\tests
+
+      - name: Archive code coverage reports, excluding LdapPublicKeyManagerTest
+          if: ${{ matrix.java-version == 8 }}
+        uses: actions/upload-artifact@v1
+        with:
+          name: code-coverage-reports-windows-java${{ matrix.java-version }}
+          path: build\reports\jacoco
+
       - name: Run only the LdapPublicKeyManagerTest unit test class
         run: .\gradlew.bat --no-daemon test --tests *LdapPublicKeyManagerTest
 
+      - name: Archive test report for LdapPublicKeyManagerTest
+        uses: actions/upload-artifact@v1
+        with:
+          name: test-report-for-LdapPublicKeyManagerTest-windows-java${{ matrix.java-version }}
+          path: build\reports\tests
+
+      - name: Archive code coverage report for LdapPublicKeyManagerTest
+          if: ${{ matrix.java-version == 8 }}
+        uses: actions/upload-artifact@v1
+        with:
+          name: code-coverage-report-for-LdapPublicKeyManagerTest-windows-java${{ matrix.java-version }}
+          path: build\reports\jacoco
+

build.gradle

@@ -12,10 +12,12 @@ group = 'com.gitblit'
 version = '1.9.2-SNAPSHOT'
 description = 'Gitblit'
 
-//compiles build artefacts to
-//run under Java 1.8 and later versions
-sourceCompatibility = JavaVersion.VERSION_1_8
-targetCompatibility = JavaVersion.VERSION_1_8
+java {
+    //compiles build artifacts to
+    //run under Java 1.8 and later versions
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
 
 ext {
     // Project Metadata
@@ -107,10 +109,19 @@ sourceSets {
 }
 
 test {
-    //Dynamic exclude some unit tests through property defined in the command line
+    //Dynamically exclude some unit tests through a property defined at runtime
     if (project.hasProperty('excludeTests')) {
         exclude project.property('excludeTests')
     }
+    finalizedBy jacocoTestReport //generate JaCoCo code coverage report after unit test run
+}
+
+jacocoTestReport {
+    //code coverage reports will be generated in the default build/reports/jacoco directory
+    reports {
+        xml.enabled true
+        html.enabled true
+    }
 }
 
 task copyToRunDir(type: Copy) {
@@ -248,12 +259,42 @@ dependencies {
 
 checkstyle {
     configFile = file('src/main/config/checkstyle.xml')
-    ignoreFailures = true
     //sourceSets = [sourceSets.main, sourceSets.test]
-    //showViolations = true
-    //reportsDir = file("$project.buildDir/checkstyleReports")
-    dependencies {
-        checkstyle 'com.puppycrawl.tools:checkstyle:8.20'
+    ignoreFailures = true
+    showViolations = true
+    toolVersion = '8.32'
+}
+tasks.withType(Checkstyle) {
+    //disable the default HTML reporting (but leave the XML reporting on);
+    //instead, HTML reports are produced by the custom task checkstyleHtmlReports below
+    reports.html.enabled false
+}
+
+task checkstyleHtmlReports {
+	description = 'Run checkstyle tasks and generate their HTML reports'
+    group = 'verification'
+
+    //depends on checkstyle tasks as specified by checkstyle.sourceSets property
+    dependsOn {
+        project.tasks.withType(Checkstyle).matching { task ->
+            checkstyle.sourceSets.any { sourceSet ->
+                task.name.equalsIgnoreCase('checkstyle'+sourceSet.name)
+            }
+        }
+    }
+    doLast {
+        //generate HTML reports from all checkstyle tasks' XML reports
+        //to be in the default build/reports/checkstyle directory 
+        //and separately in each sourceSet's subdirectory
+        checkstyle.sourceSets.each { sourceSet ->
+            ant.xslt(
+                style: 'src/main/config/checkstyle-frames-errors.xsl',
+                in: "${checkstyle.reportsDir}/${sourceSet.name}.xml",
+                out: "${checkstyle.reportsDir}/${sourceSet.name}.html") {
+                    param (name: 'output.dir',
+                           expression: "${checkstyle.reportsDir}/${sourceSet.name}")
+            }
+        }
     }
 }
 
@@ -682,8 +723,7 @@ task jarGitblitApiClasses(type: Jar) {
             'Implementation-Version': version,
             'Created-By': 'Gradle ' + getGradle().getGradleVersion(),
             'Build-Date': snapshotDate,
-            'Build-Jdk': System.getProperty('java.version'),
-            //'Main-Class': 'com.gitblit.client.GitblitClient'
+            'Build-Jdk': System.getProperty('java.version')
         )
     }