[JENKINS-23086] Cppcheck plugin shall display verbose information

mixalturek · mixalturek · commit 6fb2c2372d2e · 2014-05-18T13:39:56.000+02:00
- Parsing and storing of the verbose attribute implemented.
- If the value is the same as msg, it will be ignored.
- Verbose information is displayed inside the tooltip on page with source code listing and on the page with all violations.
diff --git a/src/main/java/com/thalesgroup/hudson/plugins/cppcheck/CppcheckSource.java b/src/main/java/com/thalesgroup/hudson/plugins/cppcheck/CppcheckSource.java
@@ -150,8 +150,20 @@ private void splitSourceFile(final String sourceFile) {
         output.append("\">\n");
 
         output.append("<div tooltip=\"");
-        outputEscaped(output, cppcheckFile.getCppCheckId() + ": " + cppcheckFile.getMessage());
-        output.append("\" nodismiss=\"\">\n");
+
+        outputEscaped(output, "<h3>");
+        outputEscaped(output, cppcheckFile.getCppCheckId());
+        output.append(": ");
+        outputEscaped(output, cppcheckFile.getMessage());
+        outputEscaped(output, "</h3>");
+
+        if(cppcheckFile.getVerbose() != null) {
+            outputEscaped(output, "<p style=\"white-space: pre-wrap;\">");
+            outputEscaped(output, cppcheckFile.getVerbose());
+            outputEscaped(output, "</p>");
+        }
+
+        output.append("\">\n");
         output.append("<code><b>\n");
 
         //The current line error
diff --git a/src/main/java/com/thalesgroup/hudson/plugins/cppcheck/model/CppcheckFile.java b/src/main/java/com/thalesgroup/hudson/plugins/cppcheck/model/CppcheckFile.java
@@ -34,7 +34,7 @@
 @ExportedBean(defaultVisibility = 999)
 public class CppcheckFile implements ModelObject, Serializable {
 
-    private static final long serialVersionUID = 2L;
+    private static final long serialVersionUID = 3L;
 
     private Integer key;
 
@@ -48,8 +48,11 @@ public class CppcheckFile implements ModelObject, Serializable {
 
     private String message;
 
+    /** Verbose message, optional. */
+    private String verbose = null;
+    
     /** The issue may be false positive. */
-    private boolean inconclusive;
+    private boolean inconclusive = false;
 
     @Exported
     public String getFileName() {
@@ -136,6 +139,19 @@ public void setKey(Integer key) {
         this.key = key;
     }
 
+    @Exported
+    public String getVerbose() {
+        return verbose;
+    }
+    
+    public String getVerboseHtml() {
+        return StringEscapeUtils.escapeHtml(verbose);
+    }
+
+    public void setVerbose(String verbose) {
+        this.verbose = verbose;
+    }
+
     @Exported
     public boolean isInconclusive() {
         return inconclusive;
diff --git a/src/main/java/org/jenkinsci/plugins/cppcheck/parser/CppcheckParser.java b/src/main/java/org/jenkinsci/plugins/cppcheck/parser/CppcheckParser.java
@@ -146,6 +146,13 @@ private CppcheckReport getReportVersion2(Results results) {
                 cppcheckFile.setInconclusive((error.getInconclusive() != null)
                         ? error.getInconclusive() : false);
 
+                // msg and verbose items have often the same text in XML report,
+                // there is no need to store duplications
+                if(error.getVerbose() != null
+                        && !error.getMsg().equals(error.getVerbose())) {
+                    cppcheckFile.setVerbose(error.getVerbose());
+                }
+
                 if ("warning".equals(cppcheckFile.getSeverity())) {
                     warningSeverityList.add(cppcheckFile);
                 } else if ("style".equals(cppcheckFile.getSeverity())) {
diff --git a/src/main/resources/org/jenkinsci/plugins/cppcheck/CppcheckSourceAll/index.jelly b/src/main/resources/org/jenkinsci/plugins/cppcheck/CppcheckSourceAll/index.jelly
@@ -18,6 +18,7 @@
             .cppcheck .lineNumber { color: gray; }
             .cppcheck .highlighted { line-height: 2.1em; background-color: #FCAF3E; font-weight: bold; }
             .cppcheck .header { font-weight: bold; }
+            .cppcheck .verbose { white-space: pre-wrap; }
             </style>
 
             <h1>${%Cppcheck Results}</h1>
@@ -27,7 +28,7 @@
                 <j:if test="${file.cppcheckFile.inconclusive}">
                     <j:set var="inconclusiveCss" value="inconclusiveCppcheck"/>
                 </j:if>
-                
+
                 <div class="cppcheck ${file.diffState.css}Cppcheck ${inconclusiveCss}">
                     <h2>${file.cppcheckFile.messageHtml}</h2>
 
@@ -51,11 +52,15 @@
                     <div><span class="header">${%State:}&amp;nbsp;</span>${file.diffState.text}</div>
                     <div><span class="header">${%Severity:}&amp;nbsp;</span>${file.cppcheckFile.severity}</div>
                     <div><span class="header">${%Type:}&amp;nbsp;</span>${file.cppcheckFile.cppCheckId}</div>
-                    
+
                     <j:if test="${file.cppcheckFile.inconclusive}">
                         <div><span class="header">${%Inconclusive:}&amp;nbsp;</span>${file.cppcheckFile.inconclusive}</div>
                     </j:if>
-                    
+
+                    <j:if test="${file.cppcheckFile.verbose != null}">
+                        <p class="verbose">${file.cppcheckFile.verboseHtml}</p>
+                    </j:if>
+
                     <j:if test="${not file.sourceIgnored}">
                         <code>
                             ${it.getSourceCode(file)}
diff --git a/src/main/resources/org/jenkinsci/plugins/cppcheck/cppcheck-2.0.xsd b/src/main/resources/org/jenkinsci/plugins/cppcheck/cppcheck-2.0.xsd
@@ -19,6 +19,7 @@
             <xs:attribute name="id" type="xs:string" use="required"/>
             <xs:attribute name="severity" type="xs:string" use="required"/>
             <xs:attribute name="msg" type="xs:string" use="required"/>
+            <xs:attribute name="verbose" type="xs:string" use="optional"/>
             <xs:attribute name="inconclusive" type="xs:boolean" use="optional"/>
         </xs:complexType>
     </xs:element>
