phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

pmd: fix #1076 Report.treeIterator() does not return all violations

Browse Source 
The cause of the bug was the implementation of
ViolationNode.equalsNode(otherNode) which returned true when two
different violations start on the same line.

Note: this change also adds a maven dependency on Mockito 1.9.5 (scope:
test). Mockito helps creating mock objects and makes the test more
readable.
This commit is contained in:
Philip Graf 2013-03-24 17:53:40 +01:00 committed by Andreas Dangel
parent fddccb5030
commit 4569842965
3 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pmd/pom.xml
View File

@ -610,6 +610,12 @@
<artifactId>commons-io</artifactId>
<version>2.2</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-all</artifactId>
<version>1.9.5</version>
<scope>test</scope>
</dependency>
</dependencies>
<reporting>

3
pmd/src/main/java/net/sourceforge/pmd/lang/dfa/report/ViolationNode.java
View File

@ -23,6 +23,9 @@ public class ViolationNode extends AbstractReportNode {
return rv.getFilename().equals(getRuleViolation().getFilename()) &&
rv.getBeginLine() == getRuleViolation().getBeginLine() &&
rv.getBeginColumn() == getRuleViolation().getBeginColumn() &&
rv.getEndLine() == getRuleViolation().getEndLine() &&
rv.getEndColumn()== getRuleViolation().getEndColumn() &&
rv.getVariableName().equals(getRuleViolation().getVariableName());
}

99
pmd/src/test/java/net/sourceforge/pmd/lang/dfa/report/ViolationNodeTest.java Normal file
View File

@ -0,0 +1,99 @@
package net.sourceforge.pmd.lang.dfa.report;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import net.sourceforge.pmd.RuleViolation;
import org.junit.Test;
/**
* @author Philip Graf
*/
public final class ViolationNodeTest {
/**
* Verifies that two violations nodes with equal {@code filename, beginLine, endLine, beginColumn, endColumn} and
* {@code variableName} are equal.
*/
@Test
public void testEqualsNodeWithTwoEqualViolations() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
final ViolationNode node2 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
assertTrue("Two equal violations should result in equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations nodes with different {@code filename} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentFilename() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
final ViolationNode node2 = createViolationNode("Bar.java", 1, 1, 5, 15, "");
assertFalse("Two violations with different filename should result in not equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations nodes with different {@code beginLine} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentBeginLine() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 2, 5, 15, "");
final ViolationNode node2 = createViolationNode("Foo.java", 2, 2, 5, 15, "");
assertFalse("Two violations with different beginLine should result in not equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations nodes with different {@code endLine} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentEndLine() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
final ViolationNode node2 = createViolationNode("Foo.java", 1, 2, 5, 15, "");
assertFalse("Two violations with different endLine should result in not equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations nodes with different {@code beginColumn} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentBeginColumn() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
final ViolationNode node2 = createViolationNode("Foo.java", 1, 1, 7, 15, "");
assertFalse("Two violations with different beginColumn should result in not equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations nodes with different {@code endColumn} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentEndColumn() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "");
final ViolationNode node2 = createViolationNode("Foo.java", 1, 1, 5, 17, "");
assertFalse("Two violations with different end column should result in not equal nodes", node1.equalsNode(node2));
}
/**
* Verifies that two violations with different {@code variableName} are not equal.
*/
@Test
public void testEqualsNodeWithTwoDifferentViolationsDifferentVariableName() {
final ViolationNode node1 = createViolationNode("Foo.java", 1, 1, 5, 15, "a");
final ViolationNode node2 = createViolationNode("Foo.java", 1, 1, 5, 15, "b");
assertFalse("Two violations with different variableName should result in not equal nodes", node1.equalsNode(node2));
}
private ViolationNode createViolationNode(final String filename, final int beginLine, final int endLine,
final int beginColumn, final int endColumn, final String variableName) {
final RuleViolation violation = mock(RuleViolation.class);
when(violation.getFilename()).thenReturn(filename);
when(violation.getBeginLine()).thenReturn(beginLine);
when(violation.getEndLine()).thenReturn(endLine);
when(violation.getBeginColumn()).thenReturn(beginColumn);
when(violation.getEndColumn()).thenReturn(endColumn);
when(violation.getVariableName()).thenReturn(variableName);
return new ViolationNode(violation);
}
}