def test_quality(self, process_patcher):
"""Integration test."""
# Patch the output of `checkstyle`
process_patcher((
dedent("""
[WARN] ../new_file.java:1:1: Line contains a tab character.
[WARN] ../new_file.java:13: 'if' construct must use '{}'s.
""").strip().encode("ascii"),
"",
))
expected_violations = [
Violation(1, "Line contains a tab character."),
Violation(13, "'if' construct must use '{}'s."),
]
# Parse the report
quality = QualityReporter(checkstyle_driver)
# Expect that the name is set
assert quality.name() == "checkstyle"
# Measured_lines is undefined for a
# quality reporter since all lines are measured
assert not quality.measured_lines("../new_file.java")
# Expect that we get violations for file1.java only
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations("../new_file.java")
assert len(actual_violations) == len(expected_violations)
for expected in expected_violations:
assert expected in actual_violations
def test_quality(self):
"""Integration test."""
# Patch the output of `checkstyle`
_setup_patch((
dedent("""
[WARN] ../new_file.java:1:1: Line contains a tab character.
[WARN] ../new_file.java:13: 'if' construct must use '{}'s.
""").strip().encode('ascii'), ''
))
expected_violations = [
Violation(1, 'Line contains a tab character.'),
Violation(13, "'if' construct must use '{}'s."),
]
# Parse the report
quality = QualityReporter(checkstyle_driver)
# Expect that the name is set
self.assertEqual(quality.name(), 'checkstyle')
# Measured_lines is undefined for a
# quality reporter since all lines are measured
self.assertEqual(quality.measured_lines('../new_file.java'), None)
# Expect that we get violations for file1.java only
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations('../new_file.java')
self.assertEqual(len(actual_violations), len(expected_violations))
for expected in expected_violations:
self.assertIn(expected, actual_violations)
def test_quality_pregenerated_report(self):
# When the user provides us with a pre-generated checkstyle report
# then use that instead of calling checkstyle directly.
checkstyle_reports = [
BytesIO(
dedent("""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="8.0">
<file name="path/to/file.java">
<error line="1" severity="error" message="Missing docstring"/>
<error line="57" severity="warning" message="TODO the name of this method is a little bit confusing"/>
</file>
<file name="another/file.java">
<error line="41" severity="error" message="Specify string format arguments as logging function parameters"/>
<error line="175" severity="error" message="Operator not preceded by a space"/>
<error line="259" severity="error" message="Invalid name '' for type variable (should match [a-z_][a-z0-9_]{2,30}$)"/>
</file>
</checkstyle>
""").strip().encode("utf-8")),
BytesIO(
dedent("""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="8.0">
<file name="path/to/file.java">
<error line="183" severity="error" message="Invalid name '' for type argument (should match [a-z_][a-z0-9_]{2,30}$)"/>
</file>
<file name="another/file.java">
<error line="183" severity="error" message="Missing docstring"/>
</file>
</checkstyle>
""").strip().encode("utf-8")),
]
# Generate the violation report
quality = QualityReporter(CheckstyleXmlDriver(),
reports=checkstyle_reports)
# Expect that we get the right violations
expected_violations = [
Violation(1, "error: Missing docstring"),
Violation(
57,
"warning: TODO the name of this method is a little bit confusing"
),
Violation(
183,
"error: Invalid name '' for type argument (should match [a-z_][a-z0-9_]{2,30}$)",
),
]
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations("path/to/file.java")
self.assertEqual(len(actual_violations), len(expected_violations))
for expected in expected_violations:
self.assertIn(expected, actual_violations)
def test_quality_pregenerated_report(self):
# When the user provides us with a pre-generated findbugs report
# then use that instead of calling findbugs directly.
pmd_reports = [
BytesIO(
dedent(
"""
<?xml version="1.0" encoding="UTF-8"?>
<pmd version="5.6.1" timestamp="2019-06-24T15:47:13.429">
<file name="path/to/file.java">
<violation beginline="21" endline="118" begincolumn="8" endcolumn="1" rule="ClassMustHaveAuthorRule" ruleset="AlibabaJavaComments" package="com.huifu.devops.application.component" class="LingeringInputFilter" priority="3">
must have @author comment
</violation>
</file>
<file name="path/to/file.java">
<violation beginline="10" endline="10" begincolumn="29" endcolumn="63" rule="AbstractMethodOrInterfaceMethodMustUseJavadocRule" ruleset="AlibabaJavaComments" package="com.huifu.devops.application.component" class="PipelineExecutionStepVoConverter" method="convert" priority="3">
interface method must include javadoc comment
</violation>
</file>
</pmd>
"""
)
.strip()
.encode("utf-8")
)
]
pmd_xml_driver = PmdXmlDriver()
# Generate the violation report
quality = QualityReporter(pmd_xml_driver, reports=pmd_reports)
# Expect that pmd is not installed
self.assertFalse(pmd_xml_driver.installed())
# Expect that we get the right violations
expected_violations = [
Violation(21, "ClassMustHaveAuthorRule: must have @author comment"),
Violation(
10,
"AbstractMethodOrInterfaceMethodMustUseJavadocRule: interface method must include javadoc comment",
),
]
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations("path/to/file.java")
self.assertEqual(len(actual_violations), len(expected_violations))
for expected in expected_violations:
self.assertIn(expected, actual_violations)
def test_quality(self):
# Patch the output of `checkstyle`
_setup_patch(
(
dedent(
"""
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle version="8.0">
<file name="file1.java">
<error line="1" severity="error" message="Missing docstring"/>
<error line="2" severity="error" message="Unused variable 'd'"/>
<error line="2" severity="warning" message="TODO: Not the real way we'll store usages!"/>
<error line="579" severity="error" message="Unable to import 'rooted_paths'"/>
<error line="113" severity="error" message="Unused argument 'cls'"/>
<error line="150" severity="error" message="error while code parsing ([Errno 2] No such file or directory)"/>
<error line="149" severity="error" message="Comma not followed by a space"/>
</file>
<file name="path/to/file2.java">
<error line="100" severity="error" message="Access to a protected member"/>
</file>
</checkstyle>
"""
)
.strip()
.encode("ascii"),
"",
)
)
expected_violations = [
Violation(1, "error: Missing docstring"),
Violation(2, "error: Unused variable 'd'"),
Violation(2, "warning: TODO: Not the real way we'll store usages!"),
Violation(579, "error: Unable to import 'rooted_paths'"),
Violation(
150,
"error: error while code parsing ([Errno 2] No such file or directory)",
),
Violation(149, "error: Comma not followed by a space"),
Violation(113, "error: Unused argument 'cls'"),
]
# Parse the report
quality = QualityReporter(CheckstyleXmlDriver())
# Expect that the name is set
self.assertEqual(quality.name(), "checkstyle")
# Measured_lines is undefined for a
# quality reporter since all lines are measured
self.assertIsNone(quality.measured_lines("file1.java"))
# Expect that we get violations for file1.java only
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations("file1.java")
self.assertEqual(len(actual_violations), len(expected_violations))
for expected in expected_violations:
self.assertIn(expected, actual_violations)
def test_quality_pregenerated_report(self):
# When the user provides us with a pre-generated findbugs report
# then use that instead of calling findbugs directly.
findbugs_reports = [
BytesIO(dedent("""
<?xml version="1.0" encoding="UTF-8"?>
<BugCollection sequence="0" release="" analysisTimestamp="1512755361404" version="3.0.1" timestamp="1512755226000">
<BugInstance instanceOccurrenceNum="0" instanceHash="1967bf8c4d25c6b964f30356014aa9fb" rank="20" abbrev="Dm" category="I18N" priority="3" type="DM_CONVERT_CASE" instanceOccurrenceMax="0">
<ShortMessage>Consider using Locale parameterized version of invoked method</ShortMessage>
<LongMessage>Use of non-localized String.toUpperCase() or String.toLowerCase() in org.opensource.sample.file$1.isMultipart(HttpServletRequest)</LongMessage>
<Class classname="org.opensource.sample.file$1" primary="true">
<SourceLine classname="org.opensource.sample.file$1" start="94" end="103" sourcepath="path/to/file.java" sourcefile="file.java">
<Message>At file.java:[lines 94-103]</Message>
</SourceLine>
<Message>In class org.opensource.sample.file$1</Message>
</Class>
<Method isStatic="false" classname="org.opensource.sample.file$1" signature="(Ljavax/servlet/http/HttpServletRequest;)Z" name="isMultipart" primary="true">
<SourceLine endBytecode="181" classname="org.opensource.sample.file$1" start="97" end="103" sourcepath="file1.java" sourcefile="file1.java" startBytecode="0" />
<Message>In method org.opensource.sample.file$1.isMultipart(HttpServletRequest)</Message>
</Method>
<SourceLine endBytecode="6" classname="org.opensource.sample.file$1" start="97" end="97" sourcepath="path/to/file.java" sourcefile="file.java" startBytecode="6" primary="true">
<Message>At file.java:[line 97]</Message>
</SourceLine>
<SourceLine role="SOURCE_LINE_ANOTHER_INSTANCE" endBytecode="55" classname="org.opensource.sample.file$1" start="103" end="104" sourcepath="another/file.java" sourcefile="file.java" startBytecode="55">
<Message>Another occurrence at file.java:[line 103, 104]</Message>
</SourceLine>
</BugInstance>
</BugCollection>
""").strip().encode('utf-8')),
BytesIO(dedent("""
<?xml version="1.0" encoding="UTF-8"?>
<BugCollection sequence="0" release="" analysisTimestamp="1512755361404" version="3.0.1" timestamp="1512755226000">
<BugInstance instanceOccurrenceNum="0" instanceHash="1967bf8c4d25c6b964f30356014aa9fb" rank="20" abbrev="Dm" category="I18N" priority="3" type="DM_CONVERT_CASE" instanceOccurrenceMax="0">
<ShortMessage>Consider using Locale parameterized version of invoked method</ShortMessage>
<LongMessage>Use of non-localized String.toUpperCase() or String.toLowerCase() in org.opensource.sample.file$1.isMultipart(HttpServletRequest)</LongMessage>
<Class classname="org.opensource.sample.file$1" primary="true">
<SourceLine classname="org.opensource.sample.file$1" start="94" end="103" sourcepath="path/to/file.java" sourcefile="file.java">
<Message>At file.java:[lines 94-103]</Message>
</SourceLine>
<Message>In class org.opensource.sample.file$1</Message>
</Class>
<Method isStatic="false" classname="org.opensource.sample.file$1" signature="(Ljavax/servlet/http/HttpServletRequest;)Z" name="isMultipart" primary="true">
<SourceLine endBytecode="181" classname="org.opensource.sample.file$1" start="97" end="103" sourcepath="file1.java" sourcefile="file1.java" startBytecode="0" />
<Message>In method org.opensource.sample.file$1.isMultipart(HttpServletRequest)</Message>
</Method>
<SourceLine endBytecode="6" classname="org.opensource.sample.file$1" start="183" end="183" sourcepath="path/to/file.java" sourcefile="file.java" startBytecode="6" primary="true">
<Message>At file.java:[line 97]</Message>
</SourceLine>
<SourceLine role="SOURCE_LINE_ANOTHER_INSTANCE" endBytecode="55" classname="org.opensource.sample.file$1" start="183" end="183" sourcepath="another/file.java" sourcefile="file.java" startBytecode="55">
<Message>Another occurrence at file.java:[line 183]</Message>
</SourceLine>
</BugInstance>
</BugCollection>
""").strip().encode('utf-8')),
# this is a violation which is not bounded to a specific line. We'll skip those
BytesIO(dedent("""
<?xml version="1.0" encoding="UTF-8"?>
<BugCollection sequence="0" release="" analysisTimestamp="1512755361404" version="3.0.1" timestamp="1512755226000">
<BugInstance instanceOccurrenceNum="0" instanceHash="2820338ec68e2e75a81848c95d31167f" rank="19" abbrev="Se" category="BAD_PRACTICE" priority="3" type="SE_BAD_FIELD" instanceOccurrenceMax="0">
<ShortMessage>Non-transient non-serializable instance field in serializable class</ShortMessage>
<LongMessage>Class org.opensource.sample.file defines non-transient non-serializable instance field</LongMessage>
<SourceLine synthetic="true" classname="org.opensource.sample.file" sourcepath="path/to/file.java" sourcefile="file.java">
<Message>In file.java</Message>
</SourceLine>
</BugInstance>
</BugCollection>
""").strip().encode('utf-8'))
]
# Generate the violation report
quality = QualityReporter(FindbugsXmlDriver(), reports=findbugs_reports)
# Expect that we get the right violations
expected_violations = [
Violation(97, 'I18N: Consider using Locale parameterized version of invoked method'),
Violation(183, 'I18N: Consider using Locale parameterized version of invoked method')
]
# We're not guaranteed that the violations are returned
# in any particular order.
actual_violations = quality.violations('path/to/file.java')
self.assertEqual(len(actual_violations), len(expected_violations))
for expected in expected_violations:
self.assertIn(expected, actual_violations)
class CloverXmlCoverageReporterTest(unittest.TestCase):
MANY_VIOLATIONS = set([
Violation(3, None),
Violation(7, None),
Violation(11, None),
Violation(13, None)
])
FEW_MEASURED = set([2, 3, 5, 7, 11, 13])
FEW_VIOLATIONS = set([Violation(3, None), Violation(11, None)])
MANY_MEASURED = set([2, 3, 5, 7, 11, 13, 17])
ONE_VIOLATION = set([Violation(11, None)])
VERY_MANY_MEASURED = set([2, 3, 5, 7, 11, 13, 17, 23, 24, 25, 26, 26, 27])
def setUp(self):
# Paths generated by git_path are always the given argument
_git_path_mock = patch(
'diff_cover.violationsreporters.java_violations_reporter.GitPathTool'
).start()
_git_path_mock.relative_path = lambda path: path
_git_path_mock.absolute_path = lambda path: path
def tearDown(self):
patch.stopall()
def test_violations(self):
# Construct the XML report
file_paths = ['file1.java', 'subdir/file2.java']
violations = self.MANY_VIOLATIONS
measured = self.FEW_MEASURED
xml = self._coverage_xml(file_paths, violations, measured)
# Parse the report
coverage = CloverXmlCoverageReporter(xml)
# Expect that the name is set
self.assertEqual(coverage.name(), "XML")
# By construction, each file has the same set
# of covered/uncovered lines
self.assertEqual(violations, coverage.violations('file1.java'))
self.assertEqual(measured, coverage.measured_lines('file1.java'))
# Try getting a smaller range
result = coverage.violations('subdir/file2.java')
self.assertEqual(result, violations)
# Once more on the first file (for caching)
result = coverage.violations('file1.java')
self.assertEqual(result, violations)
def test_two_inputs_first_violate(self):
# Construct the XML report
file_paths = ['file1.java']
violations1 = self.MANY_VIOLATIONS
violations2 = self.FEW_VIOLATIONS
measured1 = self.FEW_MEASURED
measured2 = self.MANY_MEASURED
xml = self._coverage_xml(file_paths, violations1, measured1)
xml2 = self._coverage_xml(file_paths, violations2, measured2)
# Parse the report
coverage = CloverXmlCoverageReporter([xml, xml2])
# By construction, each file has the same set
# of covered/uncovered lines
self.assertEqual(violations1 & violations2,
coverage.violations('file1.java'))
self.assertEqual(measured1 | measured2,
coverage.measured_lines('file1.java'))
def test_two_inputs_second_violate(self):
# Construct the XML report
file_paths = ['file1.java']
violations1 = self.MANY_VIOLATIONS
violations2 = self.FEW_VIOLATIONS
measured1 = self.FEW_MEASURED
measured2 = self.MANY_MEASURED
xml = self._coverage_xml(file_paths, violations1, measured1)
xml2 = self._coverage_xml(file_paths, violations2, measured2)
# Parse the report
coverage = CloverXmlCoverageReporter([xml2, xml])
# By construction, each file has the same set
# of covered/uncovered lines
self.assertEqual(violations1 & violations2,
coverage.violations('file1.java'))
self.assertEqual(measured1 | measured2,
coverage.measured_lines('file1.java'))
def test_three_inputs(self):
# Construct the XML report
file_paths = ['file1.java']
violations1 = self.MANY_VIOLATIONS
violations2 = self.FEW_VIOLATIONS
violations3 = self.ONE_VIOLATION
measured1 = self.FEW_MEASURED
measured2 = self.MANY_MEASURED
measured3 = self.VERY_MANY_MEASURED
xml = self._coverage_xml(file_paths, violations1, measured1)
xml2 = self._coverage_xml(file_paths, violations2, measured2)
xml3 = self._coverage_xml(file_paths, violations3, measured3)
# Parse the report
coverage = CloverXmlCoverageReporter([xml2, xml, xml3])
# By construction, each file has the same set
# of covered/uncovered lines
self.assertEqual(violations1 & violations2 & violations3,
coverage.violations('file1.java'))
self.assertEqual(measured1 | measured2 | measured3,
coverage.measured_lines('file1.java'))
def test_different_files_in_inputs(self):
# Construct the XML report
xml_roots = [
self._coverage_xml(['file.java'], self.MANY_VIOLATIONS,
self.FEW_MEASURED),
self._coverage_xml(['other_file.java'], self.FEW_VIOLATIONS,
self.MANY_MEASURED)
]
# Parse the report
coverage = CloverXmlCoverageReporter(xml_roots)
self.assertEqual(self.MANY_VIOLATIONS,
coverage.violations('file.java'))
self.assertEqual(self.FEW_VIOLATIONS,
coverage.violations('other_file.java'))
def test_empty_violations(self):
"""
Test that an empty violations report is handled properly
"""
# Construct the XML report
file_paths = ['file1.java']
violations1 = self.MANY_VIOLATIONS
violations2 = set()
measured1 = self.FEW_MEASURED
measured2 = self.MANY_MEASURED
xml = self._coverage_xml(file_paths, violations1, measured1)
xml2 = self._coverage_xml(file_paths, violations2, measured2)
# Parse the report
coverage = CloverXmlCoverageReporter([xml2, xml])
# By construction, each file has the same set
# of covered/uncovered lines
self.assertEqual(violations1 & violations2,
coverage.violations('file1.java'))
self.assertEqual(measured1 | measured2,
coverage.measured_lines('file1.java'))
def test_no_such_file(self):
# Construct the XML report with no source files
xml = self._coverage_xml([], [], [])
# Parse the report
coverage = CloverXmlCoverageReporter(xml)
# Expect that we get no results
result = coverage.violations('file.java')
self.assertEqual(result, set([]))
def _coverage_xml(self, file_paths, violations, measured):
"""
Build an XML tree with source files specified by `file_paths`.
Each source fill will have the same set of covered and
uncovered lines.
`file_paths` is a list of path strings
`line_dict` is a dictionary with keys that are line numbers
and values that are True/False indicating whether the line
is covered
This leaves out some attributes of the Cobertura format,
but includes all the elements.
"""
root = etree.Element('coverage')
root.set('clover', '4.2.0')
project = etree.SubElement(root, 'project')
package = etree.SubElement(project, 'package')
violation_lines = set(violation.line for violation in violations)
for path in file_paths:
src_node = etree.SubElement(package, 'file')
src_node.set('path', path)
# Create a node for each line in measured
for line_num in measured:
is_covered = line_num not in violation_lines
line = etree.SubElement(src_node, 'line')
hits = 1 if is_covered else 0
line.set('count', str(hits))
line.set('num', str(line_num))
line.set('type', 'stmt')
return root