Merge pull request #151 from itsallcode/fix_sonar_and_coverity_warnings

Fix sonar and coverity warnings

Author: kaklakariada

README.md

@@ -77,6 +77,7 @@ The list below show all build time dependencies in alphabetical order. Note that
 | [JUnit](https://junit.org/junit4/index.html)                                 | Unit testing framework                                 | Eclipse Public License 1.0    |
 | [Mockito](http://site.mockito.org/)                                          | Mocking framework                                      | MIT License                   |
 | [System rules](https://stefanbirkner.github.io/system-rules/)                | JUnit rules for testing `STDOUT`, `STDIN` and `STDERR` | Common Public License 1.0     |
+| [Pitest](http://pitest.org/)                                                 | Mutation testing                                       | Apache License 2.0            |
 
 ### Essential Build Steps
 
@@ -105,6 +106,25 @@ We use [`java.util.logging`](https://docs.oracle.com/javase/8/docs/technotes/gui
 mvn license:update-project-license license:update-file-header
 ```
 
+### Run local sonar analysis
+
+```bash
+mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar \
+    -Dsonar.host.url=https://sonarcloud.io \
+    -Dsonar.organization=itsallcode \
+    -Dsonar.login=[token]
+```
+
+See analysis results at https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace
+
+### Run [mutation testing](http://pitest.org)
+
+```bash
+mvn org.pitest:pitest-maven:mutationCoverage
+# speed up repeated analysis with history
+mvn -DwithHistory org.pitest:pitest-maven:mutationCoverage
+```
+
 ### Publishing to JCenter
 
 1. Add the following to your `~/.m2/settings.xml`:

pom.xml

@@ -6,6 +6,12 @@
     <version>0.6.0</version>
     <name>OpenFastTrace</name>
     <description>Free requirement tracking suite</description>
+    <url>https://github.com/itsallcode/openfasttrace</url>
+    <scm>
+        <connection>scm:git:https://github.com/itsallcode/openfasttrace.git</connection>
+        <developerConnection>scm:git:https://github.com/itsallcode/openfasttrace.git</developerConnection>
+        <url>https://github.com/itsallcode/openfasttrace</url>
+    </scm>
 
     <repositories>
         <repository>
@@ -185,6 +191,11 @@
                     <commandlineArgs>trace doc src/main/java src/test/java</commandlineArgs>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.pitest</groupId>
+                <artifactId>pitest-maven</artifactId>
+                <version>1.4.0</version>
+            </plugin>
         </plugins>
         <pluginManagement>
             <plugins>

src/main/java/org/itsallcode/openfasttrace/cli/ArgumentValidator.java

@@ -25,6 +25,7 @@
 import static java.util.Arrays.asList;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 import org.itsallcode.openfasttrace.cli.commands.ConvertCommand;
@@ -60,24 +61,24 @@ public ArgumentValidator(final CliArguments arguments)
 
     private boolean validate()
     {
-        final String command = this.arguments.getCommand();
+        final Optional<String> command = this.arguments.getCommand();
         boolean ok = false;
-        if (command == null)
+        if (!command.isPresent())
         {
             this.error = "Missing command";
             this.suggestion = "Add one of " + listCommands();
         }
-        else if (TraceCommand.COMMAND_NAME.equals(command))
+        else if (TraceCommand.COMMAND_NAME.equals(command.get()))
         {
             ok = validateTraceCommand();
         }
-        else if (ConvertCommand.COMMAND_NAME.equals(command))
+        else if (ConvertCommand.COMMAND_NAME.equals(command.get()))
         {
             ok = validateConvertCommand();
         }
         else
         {
-            this.error = "'" + command + "' is not an OFT command.";
+            this.error = "'" + command.orElse(null) + "' is not an OFT command.";
             this.suggestion = "Choose one of " + listCommands() + ".";
         }
 

src/main/java/org/itsallcode/openfasttrace/cli/CliArguments.java

@@ -92,13 +92,13 @@ public void setF(final String outputFile)
      * 
      * @return the OFT command
      */
-    public String getCommand()
+    public Optional<String> getCommand()
     {
         if (this.unnamedValues == null || this.unnamedValues.isEmpty())
         {
-            return null;
+            return Optional.empty();
         }
-        return this.unnamedValues.get(0);
+        return Optional.of(this.unnamedValues.get(0));
     }
 
     /**
@@ -141,17 +141,18 @@ public String getOutputFormat()
     {
         if (this.outputFormat == null)
         {
-            if (this.getCommand().equals(TraceCommand.COMMAND_NAME))
+            final Optional<String> command = this.getCommand();
+            if (command.isPresent() && command.get().equals(TraceCommand.COMMAND_NAME))
             {
                 return ReportConstants.DEFAULT_REPORT_FORMAT;
             }
-            else if (this.getCommand().equals(ConvertCommand.COMMAND_NAME))
+            else if (command.isPresent() && command.get().equals(ConvertCommand.COMMAND_NAME))
             {
                 return ExporterConstants.DEFAULT_OUTPUT_FORMAT;
             }
             else
             {
-                throw new IllegalStateException("Illegal command \"" + this.getCommand()
+                throw new IllegalStateException("Illegal command \"" + command
                         + "\" encountered trying to set default output format.");
             }
         }

src/main/java/org/itsallcode/openfasttrace/cli/CliStarter.java

@@ -1,5 +1,7 @@
 package org.itsallcode.openfasttrace.cli;
 
+import java.util.Optional;
+
 /*-
  * #%L
  * OpenFastTrace
@@ -63,7 +65,12 @@ private static void printToStdError(final String message)
     void run()
     {
         Performable performable = null;
-        switch (this.arguments.getCommand())
+        final Optional<String> command = this.arguments.getCommand();
+        if (!command.isPresent())
+        {
+            throw new IllegalStateException("Command missing trying to execute OFT mode.");
+        }
+        switch (command.get())
         {
         case ConvertCommand.COMMAND_NAME:
             performable = new ConvertCommand(this.arguments);
@@ -72,7 +79,8 @@ void run()
             performable = new TraceCommand(this.arguments);
             break;
         default:
-            throw new IllegalStateException("Command missing trying to execute OFT mode.");
+            throw new IllegalStateException(
+                    "Unknown command '" + command.get() + "' trying to execute OFT mode.");
         }
         final ExitStatus status = ExitStatus.fromBoolean(performable.run());
         exit(status);

src/main/java/org/itsallcode/openfasttrace/exporter/ExporterContext.java

@@ -28,6 +28,8 @@
  * Context for {@link ExporterFactory}. Currently only used to satisfy
  * {@link Initializable} interface.
  */
+// Class is empty by intention
+@SuppressWarnings("squid:S2094")
 public class ExporterContext
 {
 

src/main/java/org/itsallcode/openfasttrace/importer/markdown/MarkdownImporter.java

@@ -230,7 +230,7 @@ private void informListenerAboutNewItem()
         final SpecificationItemId id = new SpecificationItemId.Builder(idText).build();
         this.listener.beginSpecificationItem();
         this.listener.setId(id);
-        this.listener.setLocation(this.file.getPath().toString(), this.lineNumber);
+        this.listener.setLocation(this.file.getPath(), this.lineNumber);
         if(this.lastTitle != null)
         {
             this.listener.setTitle(this.lastTitle);

src/main/java/org/itsallcode/openfasttrace/importer/markdown/MarkdownImporterStateMachine.java

@@ -39,7 +39,8 @@
  */
 public class MarkdownImporterStateMachine
 {
-    private static Logger LOG = Logger.getLogger(MarkdownImporterStateMachine.class.getName());
+    private static final Logger LOG = Logger
+            .getLogger(MarkdownImporterStateMachine.class.getName());
 
     private State state = State.START;
     private String lastToken = "";

src/main/java/org/itsallcode/openfasttrace/importer/specobject/SpecobjectImporter.java

@@ -68,7 +68,7 @@ public void runImport()
             final SpecDocumentHandlerBuilder config = new SpecDocumentHandlerBuilder(this.file,
                     this.listener);
             final TreeContentHandler treeContentHandler = config.build();
-            new ContentHandlerAdapter(this.file.getPath().toString(), xmlReader,
+            new ContentHandlerAdapter(this.file.getPath(), xmlReader,
                     new TreeBuildingContentHandler(treeContentHandler)).registerListener();
             final InputSource input = new InputSource(reader);
             xmlReader.parse(input);

src/main/java/org/itsallcode/openfasttrace/importer/specobject/handler/SpecObjectsHandlerBuilder.java

@@ -60,7 +60,7 @@ private void handleStartElement(final TreeElement elem)
     {
         this.listener.beginSpecificationItem();
         this.locationBuilder = new Location.Builder() //
-                .path(this.file.getPath().toString()) //
+                .path(this.file.getPath()) //
                 .line(elem.getLocation().getLine());
         this.idBuilder = new SpecificationItemId.Builder() //
                 .artifactType(this.defaultDoctype);