Merge pull request #166 from adangel:issue-109-report-duplicated-entries

Fix duplicate entries in reports (#109) #166

Author: adangel

ReleaseNotes.md

@@ -15,6 +15,8 @@ This is a minor release.
 
 ### Fixed Issues
 
+*   [#109](https://github.com/pmd/pmd-eclipse-plugin/issues/109): Duplicate entries in reports
+
 ### API Changes
 
 ### External Contributions

net.sourceforge.pmd.eclipse.plugin.test/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/RenderReportCmdTest.java

@@ -5,9 +5,12 @@
 package net.sourceforge.pmd.eclipse.runtime.cmd;
 
 import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
 
 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IFolder;
+import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
@@ -17,8 +20,12 @@
 import org.junit.Test;
 
 import net.sourceforge.pmd.eclipse.EclipseUtils;
+import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
+import net.sourceforge.pmd.eclipse.runtime.properties.IProjectProperties;
+import net.sourceforge.pmd.eclipse.util.internal.IOUtil;
 import net.sourceforge.pmd.renderers.HTMLRenderer;
+import net.sourceforge.pmd.renderers.TextRenderer;
 
 /**
  * Test the report rendering
@@ -42,6 +49,11 @@ public void setUp() throws Exception {
         try (InputStream is = EclipseUtils.getResourceStream(this.testProject, "/src/Test.java")) {
             Assert.assertNotNull("Cannot find the test source file", is);
         }
+
+        // 3. Enable PMD for the test project
+        IProjectProperties properties = PMDPlugin.getDefault().getPropertiesManager()
+                .loadProjectProperties(testProject);
+        properties.setPmdEnabled(true);
     }
 
     @After
@@ -59,14 +71,14 @@ public void tearDown() throws Exception {
     }
 
     /**
-     * Test the basic usage of the report rendering command
-     * 
+     * Test the basic usage of the report rendering command.
      */
     @Test
     public void testRenderReportCmdBasic() throws CoreException {
         final ReviewCodeCmd reviewCmd = new ReviewCodeCmd();
         reviewCmd.addResource(this.testProject);
         reviewCmd.performExecute();
+        reviewCmd.join();
 
         final RenderReportsCmd cmd = new RenderReportsCmd();
         cmd.setProject(this.testProject);
@@ -91,6 +103,58 @@ public void testRenderReportCmdBasic() throws CoreException {
         }
     }
 
+    /**
+     * Test text format renderer.
+     */
+    @Test
+    public void testRenderReportCmdText() throws Exception {
+        final ReviewCodeCmd reviewCmd = new ReviewCodeCmd();
+        reviewCmd.addResource(this.testProject);
+        reviewCmd.performExecute();
+        reviewCmd.join();
+
+        IMarker[] markers = this.testProject.findMarkers(PMDRuntimeConstants.PMD_MARKER, true, IResource.DEPTH_INFINITE);
+        Assert.assertEquals(14, markers.length);
+
+        final RenderReportsCmd cmd = new RenderReportsCmd();
+        cmd.setProject(this.testProject);
+        cmd.registerRenderer(new TextRenderer(), PMDRuntimeConstants.TXT_REPORT_NAME);
+        cmd.performExecute();
+        cmd.join();
+
+        final IFolder reportFolder = this.testProject.getFolder(PMDRuntimeConstants.REPORT_FOLDER);
+        Assert.assertTrue(reportFolder.exists());
+
+        final IFile reportFile = reportFolder.getFile(PMDRuntimeConstants.TXT_REPORT_NAME);
+        Assert.assertTrue(reportFile.exists());
+        try (Reader reader = new InputStreamReader(reportFile.getContents(), reportFile.getCharset())) {
+            String report = IOUtil.toString(reader);
+            Assert.assertEquals(1, countMatches(report, "src/Test.java:5:\tNoPackage:\tNoPackage: All classes, interfaces, enums and annotations must belong to a named package"));
+            String[] lines = report.split("\r\n|\n");
+            Assert.assertEquals(markers.length, lines.length);
+        }
+
+        this.testProject.deleteMarkers(PMDRuntimeConstants.PMD_MARKER, true, IResource.DEPTH_INFINITE);
+
+        if (reportFile.exists()) {
+            reportFile.delete(true, false, null);
+        }
+
+        if (reportFolder.exists()) {
+            reportFolder.delete(true, false, null);
+        }
+    }
+
+    private static int countMatches(String s, String pattern) {
+        int count = 0;
+        int index = s.indexOf(pattern);
+        while (index != -1) {
+            count++;
+            index = s.indexOf(pattern, index + pattern.length());
+        }
+        return count;
+    }
+
     /**
      * Test robustness #1
      */

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/builder/MarkerUtil.java

@@ -238,7 +238,7 @@ public static void deleteMarkersIn(IResource resource, String[] markerTypes) thr
     }
 
     public static IMarker[] findAllMarkers(IResource resource) throws CoreException {
-        return findMarkers(resource, PMDRuntimeConstants.ALL_MARKER_TYPES);
+        return findMarkers(resource, PMDRuntimeConstants.PMD_MARKER);
     }
 
     public static IMarker[] findMarkers(IResource resource, String markerType) throws CoreException {