Merge pull request #199 from itsallcode/develop

Release 2.1.0

Author: kaklakariada

.codecov.yml

@@ -0,0 +1,4 @@
+coverage:
+  range: 70..95
+  round: down
+  precision: 2

.travis.yml

@@ -5,27 +5,27 @@ env:
     - secure: "BpZB7xQ/TQEM79gN6CPkZ5t/xlw+BWLn5TjAS7DzmNAy2UNka/apr6AbFcampUSJaxvPjl4zkqatlRjEjGvv3O/SIFZRP1x0GQsVoGvpC6xbTTgPohJ1wRkkQQrlGONOr+SpNNBT7kgZAZPKuZ7k4lBvngYwPzgpfxxgzkiIZzqxuY5dGaohIpzmdcHFSzw6XOowxeRLr+pN2ELzuA69bA7mp82euyL9JxUhrAAY0pTezMJF3NXLswPNZTtVMajDIm+7reL2JX0CyNaCsgKgv727x4mMOKkJN4tsCsNAw0BmYlaVGSVkWfPvLjvya7zq/kn6v9yglwSYBYuZteQ9p0oGvmEPOx1mQlevt46KSz0Wl+mE+gTUlwR10dcJOzTc3TBYbqUDkMawIsyWznMrojG4VPmdVHzi9MnHLU1RrRBAv7e348UTHLUb89nKWLh2ot6RVxocbEDZtJVGX1zPkpDWt3bSvxOnNdxb18u4cB1eNS+AM7tQaox48G7bMpFUPJWwXWuZbbVA8UH9bZu/d82V9lIm/IO2RALRm0zZFfC1+w40b58NzMJ8SIXaH8QDdIOAYYuuIJZGyiNz/oKT7ssOEfNy6IIM4HiaMNZ2zAhnEJoEwTXax4qAkm16mvxYGv16G0WZZGYPu0oZjPIHgjJUaTM4MbzC2uOZ2oOLhBg="
 
 jdk:
-  - oraclejdk8
-  - openjdk10
+  - openjdk8
 
 cache:
   directories:
   - $HOME/.m2
   - $HOME/.sonar/cache
 
 before_script:
-  - pip install --user codecov
   - version=$(grep -oP '(?<=^    <version>)[^<]*' pom.xml)
+  # Required for sonar to provide blame information
+  - git fetch --unshallow
 
 before_install:
   - echo -n | openssl s_client -connect scan.coverity.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' | sudo tee -a /etc/ssl/certs/ca-
 
 script:
   - echo "Parsed the version $version from pom.xml" 
-  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install
+  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install sonar:sonar
 
 after_success:
-  - codecov
+  - bash <(curl -s https://codecov.io/bash)
 
 addons:
   coverity_scan:
@@ -40,4 +40,4 @@ addons:
   sonarcloud:
     organization: "itsallcode"
     token:
-      secure: "stET2mlxtWuTjhrgBC1xO77FHuyF7E7tf+9CY9W9TEUS5UlTNVr9/gzu3p4VeWU7knpiq4PuPabPCAFfbZaPF9vMP0lO6qKvsrd0RBnCIYn2l6AEMKzd0M1yksSBvUnS+7LoT8+qkJ7hPxzSkgM7oWCsHzp//gFvr7r1+n2B9QxrsjpAPqmZlU+0cthX4cy6yIVgMG6T1TlBORcNx9TTZ+ppGLoBJ7PTL04R1GNbNy0IExlegO6JRGo6T2uURr5UkrWeKVlRZY0u3VDs6OUahE3g2srJZPruedX9KRa4XLztTLXYmOUO/6XFxxfx/eqpWqD68Eal/IguTVibPiU0dCpXsTvWE/bO1dDolBxu9afKI7ntNWmIbfKpIT0bRypz+Ss12A9cw3bNJYRXkbA4sfsMmI4kcAhdl+P0bgfyWlmwXE8z+akOOEzkHZ2vT28WVZ27KkByTtl64uWqweeAwPLQN3ORcilyt9Ip+u1Z/sZUaRuXFMi5pciB3lfLq5Bm1bu2VDep2XLQnZD+KPp5+YHCxVrXBy0quDMNYU18R/OSWfqkCOPkklopG02ngvQAYHeezJILqnlS7bD6ujdthv/97LM39W8heFxxUOQiXKw+zWccFTS+lMChX+8n5+xFoJV1NjlGv1rz5PAcUCudCTHu5Pk/2H6XFcTq9/6Ysds="
+      secure: "OtSONb6/yeCjs+50b0qFn+MDge71d5Z8fQyJoDNyip0OBrwdYeU8iqglILN3RhVo0VGfvRiT4t4dqtjRChONHOdBUoYzKqFV4dYc+PCkr0rD0NllzZ3HDpS1qzgMGjyZvQ31i4Uc7/xb5/2lyUDSThNA1/3BIJJWzXYDfSS5J8eNXWobdRQ2YbFfl4Np50gGHtUwROZroLuHU3sc0yYJilAP/iffWtyt+x/TH5fdEdeJPjRYUykX4cij8fT8ZQp2o/Ds84jHQnbd+k6KG/HRk5ndUcx7AoBkZRdgYz+zD06BkM0GbYdOvsUNiPgi6VS7EIofmUbxGbzB285ju/SexRHwpXW+CKDnrVtGmcjzD3+fm5p/PhBEdyS7/IA/tfK1Ap5HsgmeAbuykqgDAN4F0AfZxMSVhUG38LiMoWt/rzmOIRFVvFb02Ai9OUT/yy/FaVn6HgFOAelZpMmvG0/6IIec21prDIrFfer79OudGAQd222QdkyqVuxNOo/WBhIXcPONJ47BfL+1ZE9VpzGOclwV9ewc0xdzzvTejBFk92QlZq+9DPE2x5QV6NTxMdmqjm0woDTN+BhyTdT3XB0htiSy0Eo5SNN0Aldjrtiz3LlEkw9nzrVyAEkjjHKC7tb5sknb4K+s/r1/JzHVrNdlBSLVq0U+onAI6UBK/DTzlq8="

README.md

@@ -17,17 +17,17 @@ You can learn more about requirement tracing and how to use OpenFastTrace in the
 
 Sonarcloud status:
 
-[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=bugs)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Code smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=code_smells)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=coverage)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Duplicated Lines](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=ncloc)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=security_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Technical Dept](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=sqale_index)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace%3Adevelop&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
+[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=alert_status)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=bugs)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Code smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=code_smells)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=coverage)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Duplicated Lines](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=ncloc)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=security_rating)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Technical Dept](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=sqale_index)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace)
 
 * [Blog](https://blog.itsallcode.org/)
 * [Contributing guide](CONTRIBUTING.md)
@@ -41,7 +41,7 @@ Sonarcloud status:
 
 Download the executable jar at [jcenter](https://jcenter.bintray.com/org/itsallcode/openfasttrace/):
 
-* [openfasttrace-1.2.1.jar](https://jcenter.bintray.com/org/itsallcode/openfasttrace/1.2.1/openfasttrace-1.2.1.jar)
+* [openfasttrace-2.1.0.jar](https://jcenter.bintray.com/org/itsallcode/openfasttrace/2.1.0/openfasttrace-2.1.0.jar)
 
 ### Maven
 
@@ -52,7 +52,7 @@ To use OpenFastTrace as a dependency in your maven project add this to your `pom
     <dependency>
         <groupId>org.itsallcode</groupId>
         <artifactId>openfasttrace</artifactId>
-        <version>1.2.1</version>
+        <version>2.1.0</version>
         <scope>compile</scope>
     </dependency>
 </dependencies>
@@ -67,7 +67,7 @@ repositories {
     jcenter()
 }
 dependencies {
-    compile "org.itsallcode:openfasttrace:1.2.1"
+    compile "org.itsallcode:openfasttrace:2.1.0"
 }
 ```
 

doc/usage.txt

@@ -8,7 +8,7 @@ Commands:
   convert                      Convert to a different requirements format
 
 Tracing options:
-  -o, --output-format          Report format, one of "plain"
+  -o, --output-format          Report format, one of "plain", "html"
                                Defaults to "plain"
   -v, --verbosity-level        Set how verbose the output is. Ranges from
                                "quiet" to "all".

launch/OFT - Run all test.launch launch/OFT run all tests.launchlaunch/OFT - Run all test.launch renamed to launch/OFT run all tests.launch

@@ -7,8 +7,13 @@
 <listEntry value="4"/>
 </listAttribute>
 <listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.eclemma.ui.launchGroup.coverage"/>
 <listEntry value="org.eclipse.debug.ui.launchGroup.run"/>
 </listAttribute>
+<listAttribute key="org.eclipse.eclemma.core.SCOPE_IDS">
+<listEntry value="=openfasttrace/src\/main\/resources"/>
+<listEntry value="=openfasttrace/src\/main\/java"/>
+</listAttribute>
 <stringAttribute key="org.eclipse.jdt.junit.CONTAINER" value="=openfasttrace"/>
 <booleanAttribute key="org.eclipse.jdt.junit.KEEPRUNNING_ATTR" value="false"/>
 <stringAttribute key="org.eclipse.jdt.junit.TESTNAME" value=""/>

pom.xml

@@ -3,14 +3,15 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.itsallcode</groupId>
     <artifactId>openfasttrace</artifactId>
-    <version>2.0.2</version><!-- PRODUCT VERSION: do not remove this comment! -->
+    <version>2.1.0</version><!-- PRODUCT VERSION: do not remove this comment! -->
     <name>OpenFastTrace</name>
     <description>Free requirement tracking suite</description>
     <url>https://github.com/itsallcode/openfasttrace</url>
     <properties>
         <java.version>1.8</java.version>
         <junit.version>5.3.1</junit.version>
         <junit.platform.version>1.3.1</junit.platform.version>
+        <maven.surefire.version>2.22.1</maven.surefire.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
     <licenses>
@@ -27,12 +28,6 @@
             <organization>itsallcode</organization>
             <organizationUrl>https://github.com/itsallcode</organizationUrl>
         </developer>
-        <developer>
-            <id>sascha15432</id>
-            <url>https://github.com/sascha15432</url>
-            <organization>itsallcode</organization>
-            <organizationUrl>https://github.com/itsallcode</organizationUrl>
-        </developer>
         <developer>
             <id>kaklakariada</id>
             <url>https://github.com/kaklakariada</url>
@@ -73,6 +68,12 @@
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>${junit.version}</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.junit.platform</groupId>
             <artifactId>junit-platform-launcher</artifactId>
@@ -82,7 +83,8 @@
         <dependency>
             <groupId>org.junit-pioneer</groupId>
             <artifactId>junit-pioneer</artifactId>
-            <version>0.2.2</version>
+            <version>0.3.0</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.hamcrest</groupId>
@@ -111,7 +113,7 @@
         <dependency>
             <groupId>nl.jqno.equalsverifier</groupId>
             <artifactId>equalsverifier</artifactId>
-            <version>2.4.6</version>
+            <version>3.0.2</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -120,7 +122,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.7.0</version>
+                <version>3.8.0</version>
                 <configuration>
                     <source>${java.version}</source>
                     <target>${java.version}</target>
@@ -141,11 +143,14 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>2.22.1</version>
+                <version>${maven.surefire.version}</version>
                 <configuration>
                     <systemPropertyVariables>
                         <java.util.logging.config.file>${basedir}/src/test/resources/logging.properties</java.util.logging.config.file>
                     </systemPropertyVariables>
+                    <!-- Workaround for failing tests on Circle CI with Surefire -->
+                    <!-- ${argLine} is required to inject default arguments for jacoco -->
+                    <argLine>${argLine} -Djdk.net.URLClassPath.disableClassPathURLCheck=true</argLine>
                 </configuration>
             </plugin>
             <plugin>
@@ -177,14 +182,14 @@
                     <charset>UTF-8</charset>
                     <doclint></doclint>
                     <serialwarn>true</serialwarn>
-                    <failOnError>false</failOnError>
-                    <failOnWarnings>false</failOnWarnings>
+                    <failOnError>true</failOnError>
+                    <failOnWarnings>true</failOnWarnings>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.1</version>
+                <version>0.8.2</version>
                 <executions>
                     <execution>
                         <goals>
@@ -333,7 +338,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-report-plugin</artifactId>
-                <version>2.21.0</version>
+                <version>${maven.surefire.version}</version>
             </plugin>
         </plugins>
     </reporting>

src/main/java/org/itsallcode/openfasttrace/ExportSettings.java

@@ -72,6 +72,8 @@ public static ExportSettings createDefault()
 
     /**
      * Create an export settings builder
+     * 
+     * @return export settings builder
      */
     public static Builder builder()
     {

src/main/java/org/itsallcode/openfasttrace/FilterSettings.java

@@ -100,7 +100,7 @@ public boolean isAnyCriteriaSet()
         return isArtifactTypeCriteriaSet() || isTagCriteriaSet();
     }
 
-    @Generated(value = "org.eclipse.Eclipse")
+    @Generated("org.eclipse.Eclipse")
     @Override
     public int hashCode()
     {
@@ -113,7 +113,7 @@ public int hashCode()
         return result;
     }
 
-    @Generated(value = "org.eclipse.Eclipse")
+    @Generated("org.eclipse.Eclipse")
     @Override
     public boolean equals(final Object obj)
     {
@@ -208,7 +208,7 @@ public Builder tags(final Set<String> tags)
         /**
          * Configure if filter allows items that have no tags.
          * 
-         * @param withoutTags
+         * @param noTags
          *            <code>true</code> to match items without any tags
          * @return <code>this</code> for fluent programming
          */

src/main/java/org/itsallcode/openfasttrace/ImportSettings.java

@@ -83,7 +83,9 @@ public static ImportSettings createDefault()
     }
 
     /**
-     * Create an export settings builder
+     * Create an import settings builder
+     * 
+     * @return import settings builder
      */
     public static Builder builder()
     {

src/main/java/org/itsallcode/openfasttrace/Oft.java

@@ -92,6 +92,9 @@ public void exportToPath(final List<SpecificationItem> items, final Path path,
 
     /**
      * Generate a report with default settings
+     * 
+     * @param trace
+     *            trace from which the report is generated
      */
     public void reportToStdOut(Trace trace);
 
@@ -115,9 +118,6 @@ public void exportToPath(final List<SpecificationItem> items, final Path path,
      * @param outputPath
      *            path the report should be written to (or file in case this is
      *            a single-file report)
-     *
-     * @param settings
-     *            report settings
      */
     public void reportToPath(Trace trace, Path outputPath);
 
@@ -138,6 +138,8 @@ public void exportToPath(final List<SpecificationItem> items, final Path path,
 
     /**
      * Create a new instance of a object implementing the {@link Oft} interface
+     * 
+     * @return object implementing {@link Oft} interface
      */
     public static Oft create()
     {