Merge pull request #2075 from vladak/jacoco-coveralls

run Jacoco and publish the results to Coveralls.io

Author: tarzanek

.travis.yml

@@ -39,7 +39,8 @@ env:
 # in 'script' no matter if an individual command fails or not. This kludgy
 # looking shell incantation takes care of that.
 #
-script: "mvn -B -V verify"
+script:
+ - mvn -B -V verify jacoco:report org.eluder.coveralls:coveralls-maven-plugin:report
 
 addons:
   coverity_scan:

README.md

@@ -1,8 +1,10 @@
 
-Copyright (c) 2006, 2017 Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2006, 2018 Oracle and/or its affiliates. All rights reserved.
 
 
-# OpenGrok - a wicked fast source browser [![Build Status](https://travis-ci.org/oracle/opengrok.svg?branch=master)](https://travis-ci.org/oracle/opengrok)
+# OpenGrok - a wicked fast source browser
+[![Build Status](https://travis-ci.org/oracle/opengrok.svg?branch=master)](https://travis-ci.org/oracle/opengrok)
+[![Coverage Status](https://coveralls.io/repos/oracle/opengrok/badge.svg?branch=master)](https://coveralls.io/r/oracle/opengrok?branch=master)
 
 1.  [Introduction](#1-introduction)
 2.  [Requirements](#2-requirements)

doc/release.txt

@@ -4,7 +4,7 @@ Release criteria
 Ideally, the following minimum criteria should be fulfilled before a new
 final (i.e. non-prerelease) version is released:
 
-  - The code coverage for blocks must be at least 80%
+  - The overall code coverage must be at least 70%
   - No findbugs warnings
   - No stoppers
   - All bugs and enhancements must be evaluated
@@ -19,7 +19,7 @@ Checklist for releasing OpenGrok:
 
 1) sanity check:
 
-   - index
+   - index fairly large code base, ideally multiple projects
    - deploy webapp
    - check UI:
      - history view
@@ -30,13 +30,9 @@ Checklist for releasing OpenGrok:
        - check sorting using multiple criteria
      - perform search using multiple fields across multiple projects
 
-2) check all tests, tests code coverage:
-   junit, pmd, findbugs, checkstyle, emma, jdepend
+2) check all tests pass, test code coverage is above given threshold
 
-   emma reports should be based according to what is set for the release,
-   usually it's overall coverage above 80%.
-
-   Jenkins can help here.
+   Additional tools to use: pmd, findbugs, checkstyle, jdepend
 
    The release is OK, once above is fulfilled to our satisfaction.
 
@@ -60,4 +56,5 @@ Checklist for releasing OpenGrok:
    of the release, e.g. adding list of issues fixed, whether complete reindex
    is necessary etc.
 
-5) Send announcement to [email protected], Slack channel etc.
+5) Send announcement to [email protected],
+   the #opengrok Slack channel etc.

opengrok-indexer/pom.xml

@@ -435,6 +435,7 @@ Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
                         <!-- Test helper class with name that confuses surefire -->
                         <exclude>**/TestRepository.java</exclude>
                     </excludes>
+		    <argLine>${surefireArgLine}</argLine>
                 </configuration>
             </plugin>
 

plugins/pom.xml

@@ -58,6 +58,7 @@ Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
                   <systemPropertyVariables>
                       <junit-force-all>true</junit-force-all>
                   </systemPropertyVariables>
+	          <argLine>${surefireArgLine}</argLine>
               </configuration>
           </plugin>
         </plugins>

pom.xml

@@ -159,18 +159,47 @@ Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
                 <version>3.6.1</version>
             </plugin>
             <plugin>
+		<!-- UNIT TEST RUNNER -->
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <configuration>
                         <forkCount>1</forkCount>
                         <reuseForks>false</reuseForks>
                 </configuration>
                 <version>2.20</version>
+		<executions>
+			<execution>
+				<id>run-unit-tests</id>
+				<goals>
+					<goal>test</goal>
+				</goals>
+			</execution>
+		</executions>
             </plugin>
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
                 <version>0.7.9</version>
+                <executions>
+			<!-- Prepare execution with Surefire -->
+			<execution>
+				<id>pre-unit-test</id>
+				<goals>
+					<goal>prepare-agent</goal>
+				</goals>
+				<configuration>
+					<propertyName>surefireArgLine</propertyName>
+				</configuration>
+			</execution>
+			<!-- Generate report after tests are run -->
+			<execution>
+				<id>post-unit-test</id>
+				<phase>test</phase>
+				<goals>
+					<goal>report</goal>
+				</goals>
+			</execution>
+                </executions>
             </plugin>
 	    <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -260,7 +289,16 @@ Portions Copyright (c) 2018, Chris Fraire <[email protected]>.
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-report-plugin</artifactId>
                 <version>2.20</version>
+		<configuration>
+			<argLine>${surefireArgLine}</argLine>
+		</configuration>
             </plugin>
+	    <!-- CODE COVERAGE PUBLISHER -->
+	    <plugin>
+		<groupId>org.eluder.coveralls</groupId>
+		<artifactId>coveralls-maven-plugin</artifactId>
+		<version>3.1.0</version>
+	    </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jxr-plugin</artifactId>