Changeset 1319

Timestamp:

03/28/09 14:15:26 (3 years ago)

Author:

amandel

Message:

#2 Quick implementation to detect new findings. The new findings will
get an increased severity level.

Location:

trunk

Files:

• config/build-report.xml (modified) (3 diffs)
• config/jcoderz-report-filter.xsl (modified) (1 diff)
• src/java/org/jcoderz/phoenix/report/JcReportAntTask.java (modified) (8 diffs)
• src/java/org/jcoderz/phoenix/report/ReportMerger.java (modified) (7 diffs)
• src/java/org/jcoderz/phoenix/report/Severity.java (modified) (2 diffs)
• src/xml/schema/report-types.xsd (modified) (1 diff)

trunk/config/build-report.xml

@@ -94 +94 @@
       </path>
 
+          
+        
       <delete dir="${base.dir}/build/jcreport"/>
       <jcreport name="fawkez"
@@ -106 +108 @@
                 maxheap="128"
                 encoding="US-ASCII"
-                cpus="0"> <!-- Increase to speed up -->
+                cpus="0"
+                oldReportFile="${env.CRUISECONTROL_HOME}/artifacts/${name}/global/jcoderz-report.xml"> 
          <classpath refid="jcreport.classpath"/>
          <reports>   
@@ -152 +155 @@
          </filters>
       </jcreport>   
+        <!-- TODO: Only do this on the cc machine. -->
+        <copy 
+        file="${base.dir}/build/doc/findings-report/jcoderz-report.xml"
+        tofile="${env.CRUISECONTROL_HOME}/artifacts/${name}/global/jcoderz-report.xml" />
    </target>   
 

trunk/config/jcoderz-report-filter.xsl

@@ -267 +267 @@
    </xs:template>
 
+   <xs:template
+      match="/report/file[@classname = 'LogViewer'][@package = 'org.jcoderz.commons.logging']/
+              item[@finding-type = 'SMII_STATIC_METHOD_INSTANCE_INVOCATION']">
+      <item>
+         <xs:apply-templates select="@*"/>
+         <xs:attribute name="severity">filtered</xs:attribute>
+         <xs:attribute name="severity-reason">Intended use of return value.</xs:attribute>
+      </item>
+   </xs:template>
 
 </xs:stylesheet>

trunk/src/java/org/jcoderz/phoenix/report/JcReportAntTask.java

@@ -94 +94 @@
    private String mName = null;
    private File mDest = null;
+   private File mOldReportFile = null;
    private String mWikiBase = null;
    private String mWebRcsBase = null;
@@ -120 +121 @@
     }
 
-
     /**
      * @param cpus the cpus to set
@@ -129 +129 @@
     }
 
-
-/**
+    /**
      * @return the sourceEncoding
      */
@@ -137 +136 @@
         return mSourceEncoding.name();
     }
-
 
     /**
@@ -147 +145 @@
     }
 
-
-/**
+    /**
     * Returns the working directory.
     *
@@ -157 +154 @@
       return mWorkingDir;
    }
-
 
    /**
@@ -223 +219 @@
    }
 
+   public void setOldReportsFile (String oldReportsFile)
+   {
+      mOldReportFile = new File(oldReportsFile);
+   }
 
    /**
@@ -594 +594 @@
          final NestedFilterElement filterElement = filterIter.next();
          merger.addFilter(filterElement.getFile());
+      }
+      if (mOldReportFile != null)
+      {
+          merger.setOldFile(mOldReportFile);
       }
       merger.merge();

trunk/src/java/org/jcoderz/phoenix/report/ReportMerger.java

@@ -52 +52 @@
 
 import org.jcoderz.commons.ArgumentMalformedException;
+import org.jcoderz.commons.util.Assert;
 import org.jcoderz.commons.util.FileUtils;
 import org.jcoderz.commons.util.IoUtil;
 import org.jcoderz.commons.util.LoggingUtils;
+import org.jcoderz.phoenix.report.jaxb.Item;
 import org.jcoderz.phoenix.report.jaxb.ObjectFactory;
 import org.jcoderz.phoenix.report.jaxb.Report;
@@ -85 +87 @@
    private final List<File> mFilters = new ArrayList<File>();
 
+   /** The old Report. */
+   private File mOldReport;
+
 
    /**
@@ -135 +140 @@
            logger.log(Level.FINE, "Filter: " + filterFile);
            final TransformerFactory tFactory
-           = TransformerFactory.newInstance();
-
-           final Transformer transformer = tFactory.newTransformer(
-               new StreamSource(filterFile));
-
-           final File tempOutputFile = new File(
-               mOutFile.getCanonicalPath() + ".tmp");
+               = TransformerFactory.newInstance();
+
+           final Transformer transformer 
+               = tFactory.newTransformer(new StreamSource(filterFile));
+
+           final File tempOutputFile 
+               = new File(mOutFile.getCanonicalPath() + ".tmp");
            tempOutputFile.createNewFile();
 
@@ -153 +158 @@
    }
 
-
    /**
+    * Searches for new findings based on the old jcReport and increases the
+    * severity of such findings to NEW. 
+    */
+   public void flagNewFindings () 
+       throws JAXBException, FileNotFoundException
+   {
+       logger.log(Level.FINE, "Searching for NEW findings...");
+       final Report currentReport 
+           = (Report) new ObjectFactory().createUnmarshaller().unmarshal(mOutFile);
+       final Report oldReport 
+           = (Report) new ObjectFactory().createUnmarshaller().unmarshal(mOldReport);
+       for(org.jcoderz.phoenix.report.jaxb.File newFile : 
+           (List<org.jcoderz.phoenix.report.jaxb.File>) currentReport.getFile())
+       {
+           final org.jcoderz.phoenix.report.jaxb.File oldFile 
+               = findFile(newFile, oldReport);
+           for(Item item:(List<Item>) newFile.getItem())
+           {
+               if (findItem(item, oldFile) == null)
+               {
+                   flagAsNew(item);
+               }
+           }
+       }
+       
+       final FileOutputStream out = new FileOutputStream(mOutFile);
+       try
+       {
+           new ObjectFactory().createMarshaller().marshal(currentReport, out);
+       }
+       finally
+       {
+           IoUtil.close(out);
+       }
+   }
+
+    // be more smart in finding matching items... (eg if the file was edited)
+    private Item findItem (
+        Item newItem, org.jcoderz.phoenix.report.jaxb.File oldFile)
+    {
+        Item result = null;
+        for(Item item:(List<Item>) oldFile.getItem())
+        {
+            if (item.getLine() == newItem.getLine()
+                && item.getColumn() == newItem.getColumn()
+                && item.getFindingType().equals(newItem.getFindingType())
+                && item.getCounter() <= newItem.getCounter())
+            {
+                result = item;
+                break;
+            }
+        }
+        return result;
+    }
+
+
+    private void flagAsNew (Item item)
+    {
+        final Severity oldSeverity = item.getSeverity();
+        item.setSeverity(Severity.NEW);
+        item.setMessage(
+            item.getMessage() + " Severity " + oldSeverity + ".");
+    }
+
+
+// This could be done faster, might be restructure the data first for 
+   // faster lookup.
+   private org.jcoderz.phoenix.report.jaxb.File findFile (
+       org.jcoderz.phoenix.report.jaxb.File newFile, Report oldReport)
+   {
+       final String className = newFile.getClassname();
+       final String packageName = newFile.getPackage();
+       final String fileName = newFile.getName();
+       org.jcoderz.phoenix.report.jaxb.File result = null;
+       for(org.jcoderz.phoenix.report.jaxb.File file : 
+           (List<org.jcoderz.phoenix.report.jaxb.File>) oldReport.getFile())
+       {
+           if (file.getName().equals(fileName) 
+               || (file.getClassname().equals(className) 
+                   && file.getPackage().equals(packageName)))
+           {
+               result = file;
+               break;
+           }
+       }
+       return result;
+   }
+
+
+/**
     * Parses the arguments.
     *
@@ -175 +269 @@
             {
                addFilter(new File(args[i + 1]));
+            }
+            else if ("-old".equals(args[i]))
+            {
+               setOldFile(new File(args[i + 1]));
             }
             else if ("-loglevel".equals(args[i]))
@@ -210 +308 @@
    }
 
-
    /**
     * The main method.
@@ -280 +377 @@
 
     /**
+     * Set the old report to compare with.
+     * @param file old report file.
+     */
+    public void setOldFile (File file)
+        throws IOException
+    {
+        Assert.notNull(file, "file");
+        if (mOldReport != null)
+        {
+            throw new ArgumentMalformedException("old", file,
+                "Old Report File has already set to '" + mOldReport + "'.");
+        }
+        mOldReport = file.getCanonicalFile();
+    }
+    
+    /**
      * Sets the out file.
      *

trunk/src/java/org/jcoderz/phoenix/report/Severity.java

@@ -172 +172 @@
     public static final Severity ERROR = new Severity("error", 100);
 
+    /**
+     * New findings of this build.
+     * <p>Findings of this level are new in this build and because of that
+     * rated at higher severity level in this one build.</p>
+     * <p>A severity of this level marks 10 lines as bad.</p>
+     */
+    public static final Severity NEW = new Severity("new", 100);
+    
     /** 
      * The maximum possible severity. 
-     * Is {@link #ERROR}.
-     */
-    public static final Severity MAX_SEVERITY = ERROR;
+     * Is {@link #NEW}.
+     */
+    public static final Severity MAX_SEVERITY = NEW;
 
     /** The maximum possible severity as int. */
-    public static final int MAX_SEVERITY_INT = ERROR.toInt();
+    public static final int MAX_SEVERITY_INT = MAX_SEVERITY.toInt();
 
     /** Internal list of all available severities. */
@@ -192 +200 @@
         Severity.WARNING,
         Severity.CPD,
-        Severity.ERROR
+        Severity.ERROR,
+        Severity.NEW
     };
 

trunk/src/xml/schema/report-types.xsd

@@ -28 +28 @@
          <xsd:enumeration value='cpd'/>
          <xsd:enumeration value='error'/>
+         <xsd:enumeration value='new'/>
       </xsd:restriction>
    </xsd:simpleType>