1 | # -*- coding: UTF-8 -*- |
---|
2 | # |
---|
3 | # Copyright (C) 2007-2010 Edgewall Software |
---|
4 | # Copyright (C) 2007 Wei Zhuo <weizhuo@gmail.com> |
---|
5 | # All rights reserved. |
---|
6 | # |
---|
7 | # This software is licensed as described in the file COPYING, which |
---|
8 | # you should have received as part of this distribution. The terms |
---|
9 | # are also available at http://bitten.edgewall.org/wiki/License. |
---|
10 | |
---|
11 | import os |
---|
12 | import shutil |
---|
13 | import tempfile |
---|
14 | import unittest |
---|
15 | |
---|
16 | from bitten.build import phptools |
---|
17 | from bitten.recipe import Context, Recipe |
---|
18 | |
---|
19 | class PhpCodeSnifferTestCase(unittest.TestCase): |
---|
20 | |
---|
21 | def setUp(self): |
---|
22 | self.basedir = os.path.realpath(tempfile.mkdtemp()) |
---|
23 | self.ctxt = Context(self.basedir) |
---|
24 | self.summary = open(os.path.join(self.basedir, '.phpcs'), 'w') |
---|
25 | |
---|
26 | def tearDown(self): |
---|
27 | shutil.rmtree(self.basedir) |
---|
28 | |
---|
29 | def test_missing_param_file(self): |
---|
30 | self.summary.close() |
---|
31 | self.assertRaises(AssertionError, phptools.phpcs, self.ctxt) |
---|
32 | |
---|
33 | def test_empty_summary(self): |
---|
34 | self.summary.close() |
---|
35 | phptools.phpcs(self.ctxt, file_=self.summary.name) |
---|
36 | type, category, generator, xml = self.ctxt.output.pop() |
---|
37 | self.assertEqual(Recipe.REPORT, type) |
---|
38 | self.assertEqual('lint', category) |
---|
39 | self.assertEqual(0, len(xml.children)) |
---|
40 | |
---|
41 | def test_summary_format(self): |
---|
42 | # thoroughly check on report line |
---|
43 | self.summary.write(""" |
---|
44 | FILE: %s/module/file1.php |
---|
45 | ------------------------------------------------------------------------------- |
---|
46 | FOUND 1 ERROR(S) AND 1 WARNING(S) AFFECTING 2 LINE(S) |
---|
47 | ------------------------------------------------------------------------------- |
---|
48 | 1 | ERROR | You must use "/**" style comments for a file comment |
---|
49 | 15 | WARNING | Line exceeds 85 characters; contains 118 characters |
---|
50 | ------------------------------------------------------------------------------- |
---|
51 | |
---|
52 | """ % (self.ctxt.basedir,)) |
---|
53 | self.summary.close() |
---|
54 | phptools.phpcs(self.ctxt, file_=self.summary.name) |
---|
55 | type, category, generator, xml = self.ctxt.output.pop() |
---|
56 | self.assertEqual(Recipe.REPORT, type) |
---|
57 | self.assertEqual('lint', category) |
---|
58 | self.assertEqual(2, len(xml.children)) |
---|
59 | |
---|
60 | child = xml.children[0] |
---|
61 | self.assertEqual('problem', child.name) |
---|
62 | self.assertEqual('module/file1.php', child.attr['file']) |
---|
63 | self.assertEqual('error', child.attr['category']) |
---|
64 | self.assertEqual(1, child.attr['line']) |
---|
65 | self.assertEqual(1, len(child.children)) |
---|
66 | msg = child.children[0] |
---|
67 | self.assertEqual('msg', msg.name) |
---|
68 | self.assertEqual(1, len(msg.children)) |
---|
69 | self.assertEqual('You must use "/**" style comments for a ' |
---|
70 | 'file comment', msg.children[0]) |
---|
71 | |
---|
72 | child = xml.children[1] |
---|
73 | self.assertEqual('problem', child.name) |
---|
74 | self.assertEqual('module/file1.php', child.attr['file']) |
---|
75 | self.assertEqual('warning', child.attr['category']) |
---|
76 | self.assertEqual(15, child.attr["line"]) |
---|
77 | self.assertEqual(1, len(child.children)) |
---|
78 | msg = child.children[0] |
---|
79 | self.assertEqual('msg', msg.name) |
---|
80 | self.assertEqual(1, len(msg.children)) |
---|
81 | self.assertEqual('Line exceeds 85 characters; contains 118 characters' |
---|
82 | , msg.children[0]) |
---|
83 | |
---|
84 | def test_summary_with_absolute_path(self): |
---|
85 | # One posix + one windows path to normalize |
---|
86 | self.summary.write(""" |
---|
87 | FILE: %s/module/file1.php |
---|
88 | ------------------------------------------------------------------------------- |
---|
89 | FOUND 1 ERROR(S) AFFECTING 1 LINE(S) |
---|
90 | ------------------------------------------------------------------------------- |
---|
91 | 1 | ERROR | You must use "/**" style comments for a file comment |
---|
92 | ------------------------------------------------------------------------------- |
---|
93 | |
---|
94 | FILE: %s\\module\\file2.php |
---|
95 | ------------------------------------------------------------------------------- |
---|
96 | FOUND 1 WARNING(S) AFFECTING 1 LINE(S) |
---|
97 | ------------------------------------------------------------------------------- |
---|
98 | 15 | WARNING | Line exceeds 85 characters; contains 118 characters |
---|
99 | ------------------------------------------------------------------------------- |
---|
100 | |
---|
101 | """ % (self.ctxt.basedir, self.ctxt.basedir)) |
---|
102 | self.summary.close() |
---|
103 | phptools.phpcs(self.ctxt, file_=self.summary.name) |
---|
104 | type, category, generator, xml = self.ctxt.output.pop() |
---|
105 | self.assertEqual(Recipe.REPORT, type) |
---|
106 | self.assertEqual('lint', category) |
---|
107 | self.assertEqual(2, len(xml.children)) |
---|
108 | child = xml.children[0] |
---|
109 | self.assertEqual('problem', child.name) |
---|
110 | self.assertEqual('module/file1.php', child.attr['file']) |
---|
111 | child = xml.children[1] |
---|
112 | self.assertEqual('problem', child.name) |
---|
113 | self.assertEqual('module/file2.php', child.attr['file']) |
---|
114 | |
---|
115 | def test_summary_with_relative_path(self): |
---|
116 | # One posix + one windows path to normalize |
---|
117 | self.summary.write(""" |
---|
118 | FILE: module/file1.php |
---|
119 | ------------------------------------------------------------------------------- |
---|
120 | FOUND 1 ERROR(S) AFFECTING 1 LINE(S) |
---|
121 | ------------------------------------------------------------------------------- |
---|
122 | 1 | ERROR | You must use "/**" style comments for a file comment |
---|
123 | ------------------------------------------------------------------------------- |
---|
124 | |
---|
125 | FILE: module\\file2.php |
---|
126 | ------------------------------------------------------------------------------- |
---|
127 | FOUND 1 WARNING(S) AFFECTING 1 LINE(S) |
---|
128 | ------------------------------------------------------------------------------- |
---|
129 | 15 | WARNING | Line exceeds 85 characters; contains 118 characters |
---|
130 | ------------------------------------------------------------------------------- |
---|
131 | |
---|
132 | """) |
---|
133 | self.summary.close() |
---|
134 | phptools.phpcs(self.ctxt, file_=self.summary.name) |
---|
135 | type, category, generator, xml = self.ctxt.output.pop() |
---|
136 | self.assertEqual(Recipe.REPORT, type) |
---|
137 | self.assertEqual('lint', category) |
---|
138 | self.assertEqual(2, len(xml.children)) |
---|
139 | child = xml.children[0] |
---|
140 | self.assertEqual('problem', child.name) |
---|
141 | self.assertEqual('module/file1.php', child.attr['file']) |
---|
142 | child = xml.children[1] |
---|
143 | self.assertEqual('problem', child.name) |
---|
144 | self.assertEqual('module/file2.php', child.attr['file']) |
---|
145 | |
---|
146 | |
---|
147 | class PhpUnitTestCase(unittest.TestCase): |
---|
148 | |
---|
149 | def setUp(self): |
---|
150 | self.basedir = os.path.realpath(tempfile.mkdtemp()) |
---|
151 | self.ctxt = Context(self.basedir) |
---|
152 | |
---|
153 | def tearDown(self): |
---|
154 | shutil.rmtree(self.basedir) |
---|
155 | |
---|
156 | def test_missing_param_file(self): |
---|
157 | self.assertRaises(AssertionError, phptools.phpunit, self.ctxt) |
---|
158 | |
---|
159 | def test_sample_unit_test_result(self): |
---|
160 | phpunit_xml = file(self.ctxt.resolve('phpunit.xml'), 'w') |
---|
161 | phpunit_xml.write("""<?xml version="1.0" encoding="UTF-8"?> |
---|
162 | <testsuites> |
---|
163 | <testsuite name="FooTest" file="FooTest.php" tests="2" failures="1" errors="0" time="0.147397"> |
---|
164 | <testcase name="testBar" class="FooTest" time="0.122265"> |
---|
165 | <failure message="expected same: <1> was not: <2>" type="PHPUnit2_Framework_AssertionFailedError"> |
---|
166 | ... |
---|
167 | </failure> |
---|
168 | </testcase> |
---|
169 | <testcase name="testBar2" class="FooTest" time="0.025132"/> |
---|
170 | </testsuite> |
---|
171 | <testsuite name="BarTest" file="BarTest.php" tests="1" failures="0" errors="0" time="0.050713"> |
---|
172 | <testcase name="testFoo" class="BarTest" time="0.026046"/> |
---|
173 | </testsuite> |
---|
174 | </testsuites>""") |
---|
175 | phpunit_xml.close() |
---|
176 | phptools.phpunit(self.ctxt, file_='phpunit.xml') |
---|
177 | type, category, generator, xml = self.ctxt.output.pop() |
---|
178 | self.assertEqual(Recipe.REPORT, type) |
---|
179 | self.assertEqual('test', category) |
---|
180 | |
---|
181 | tests = list(xml.children) |
---|
182 | self.assertEqual(3, len(tests)) |
---|
183 | self.assertEqual('FooTest', tests[0].attr['fixture']) |
---|
184 | self.assertEqual('testBar', tests[0].attr['name']) |
---|
185 | self.assertEqual('failure', tests[0].attr['status']) |
---|
186 | self.assert_('FooTest.php' in tests[0].attr['file']) |
---|
187 | |
---|
188 | self.assertEqual('FooTest', tests[1].attr['fixture']) |
---|
189 | self.assertEqual('testBar2', tests[1].attr['name']) |
---|
190 | self.assertEqual('success', tests[1].attr['status']) |
---|
191 | |
---|
192 | self.assertEqual('BarTest', tests[2].attr['fixture']) |
---|
193 | self.assertEqual('testFoo', tests[2].attr['name']) |
---|
194 | self.assertEqual('success', tests[2].attr['status']) |
---|
195 | |
---|
196 | class PhpCodeCoverageTestCase(unittest.TestCase): |
---|
197 | |
---|
198 | def setUp(self): |
---|
199 | self.basedir = os.path.realpath(tempfile.mkdtemp()) |
---|
200 | self.ctxt = Context(self.basedir) |
---|
201 | |
---|
202 | def tearDown(self): |
---|
203 | shutil.rmtree(self.basedir) |
---|
204 | |
---|
205 | def test_missing_param_file(self): |
---|
206 | self.assertRaises(AssertionError, phptools.coverage, self.ctxt) |
---|
207 | |
---|
208 | def test_sample_phing_code_coverage(self): |
---|
209 | coverage_xml = file(self.ctxt.resolve('phpcoverage.xml'), 'w') |
---|
210 | coverage_xml.write("""<?xml version="1.0" encoding="UTF-8"?> |
---|
211 | <snapshot methodcount="4" methodscovered="2" statementcount="11" statementscovered="5" totalcount="15" totalcovered="7"> |
---|
212 | <package name="default" methodcount="4" methodscovered="2" statementcount="11" statementscovered="5" totalcount="15" totalcovered="7"> |
---|
213 | <class name="Foo" methodcount="1" methodscovered="1" statementcount="7" statementscovered="3" totalcount="8" totalcovered="4"> |
---|
214 | <sourcefile name="Foo.php" sourcefile="xxxx/Foo.php"> |
---|
215 | ... |
---|
216 | </sourcefile> |
---|
217 | </class> |
---|
218 | <class name="Foo2" methodcount="2" methodscovered="1" statementcount="4" statementscovered="2" totalcount="6" totalcovered="3"> |
---|
219 | <sourcefile name="Foo.php" sourcefile="xxxx/Foo.php"> |
---|
220 | ... |
---|
221 | </sourcefile> |
---|
222 | </class> |
---|
223 | <class name="Bar" methodcount="1" methodscovered="0" statementcount="0" statementscovered="0" totalcount="1" totalcovered="0"> |
---|
224 | <sourcefile name="Bar.php" sourcefile="xxxx/Bar.php"> |
---|
225 | ... |
---|
226 | </sourcefile> |
---|
227 | </class> |
---|
228 | </package> |
---|
229 | </snapshot>""") |
---|
230 | coverage_xml.close() |
---|
231 | phptools.coverage(self.ctxt, file_='phpcoverage.xml') |
---|
232 | type, category, generator, xml = self.ctxt.output.pop() |
---|
233 | self.assertEqual(Recipe.REPORT, type) |
---|
234 | self.assertEqual('coverage', category) |
---|
235 | |
---|
236 | coverage = list(xml.children) |
---|
237 | self.assertEqual(3, len(coverage)) |
---|
238 | self.assertEqual(7, coverage[0].attr['lines']) |
---|
239 | self.assertEqual('Foo', coverage[0].attr['name']) |
---|
240 | self.assert_('xxxx/Foo.php' in coverage[0].attr['file']) |
---|
241 | |
---|
242 | self.assertEqual(4, coverage[1].attr['lines']) |
---|
243 | self.assertEqual(50.0, coverage[1].attr['percentage']) |
---|
244 | self.assertEqual('Foo2', coverage[1].attr['name']) |
---|
245 | self.assert_('xxxx/Foo.php' in coverage[1].attr['file']) |
---|
246 | |
---|
247 | self.assertEqual(0, coverage[2].attr['lines']) |
---|
248 | self.assertEqual(100.0, coverage[2].attr['percentage']) |
---|
249 | self.assertEqual('Bar', coverage[2].attr['name']) |
---|
250 | self.assert_('xxxx/Bar.php' in coverage[2].attr['file']) |
---|
251 | |
---|
252 | def test_sample_phpunit_code_coverage(self): |
---|
253 | coverage_xml = file(self.ctxt.resolve('phpcoverage.xml'), 'w') |
---|
254 | coverage_xml.write("""<?xml version="1.0" encoding="UTF-8"?> |
---|
255 | <coverage generated="1248813201" phpunit="3.3.17"> |
---|
256 | <project name="All Tests" timestamp="1248813201"> |
---|
257 | <file name="%s/Foo/classes/Foo.php"> |
---|
258 | <class name="Foo" namespace="global"> |
---|
259 | <metrics methods="0" coveredmethods="0" statements="0" |
---|
260 | coveredstatements="0" elements="0" coveredelements="0"/> |
---|
261 | </class> |
---|
262 | <line num="3" type="stmt" count="1"/> |
---|
263 | <line num="6" type="stmt" count="1"/> |
---|
264 | <metrics loc="5" ncloc="3" classes="1" methods="0" coveredmethods="0" |
---|
265 | statements="2" coveredstatements="2" elements="2" coveredelements="2"/> |
---|
266 | </file> |
---|
267 | <file name="%s/Foo/tests/environment.config.php"> |
---|
268 | <line num="0" type="stmt" count="2"/> |
---|
269 | <line num="4" type="stmt" count="2"/> |
---|
270 | <line num="5" type="stmt" count="2"/> |
---|
271 | <metrics loc="6" ncloc="6" classes="0" methods="0" coveredmethods="0" |
---|
272 | statements="3" coveredstatements="3" elements="3" coveredelements="3"/> |
---|
273 | </file> |
---|
274 | <file name="%s/Foo/tests/Foo/AllTests.php"> |
---|
275 | <class name="All_Foo_Tests" namespace="global" fullPackage="All.Foo"> |
---|
276 | <metrics methods="2" coveredmethods="0" statements="4" |
---|
277 | coveredstatements="0" elements="6" coveredelements="0"/> |
---|
278 | </class> |
---|
279 | <line num="7" type="method" count="0"/> |
---|
280 | <line num="9" type="stmt" count="0"/> |
---|
281 | <line num="10" type="stmt" count="0"/> |
---|
282 | <line num="12" type="method" count="0"/> |
---|
283 | <line num="14" type="stmt" count="0"/> |
---|
284 | <line num="15" type="stmt" count="0"/> |
---|
285 | <line num="16" type="stmt" count="0"/> |
---|
286 | <metrics loc="19" ncloc="19" classes="1" methods="2" coveredmethods="0" |
---|
287 | statements="5" coveredstatements="0" elements="7" coveredelements="0"/> |
---|
288 | </file> |
---|
289 | <file name="%s/Foo/tests/AllTests.php"> |
---|
290 | <class name="AllTests" namespace="global"> |
---|
291 | <metrics methods="2" coveredmethods="0" statements="5" |
---|
292 | coveredstatements="0" elements="7" coveredelements="0"/> |
---|
293 | </class> |
---|
294 | <line num="8" type="method" count="0"/> |
---|
295 | <line num="10" type="stmt" count="0"/> |
---|
296 | <line num="11" type="stmt" count="0"/> |
---|
297 | <line num="13" type="method" count="0"/> |
---|
298 | <line num="15" type="stmt" count="0"/> |
---|
299 | <line num="16" type="stmt" count="0"/> |
---|
300 | <line num="17" type="stmt" count="0"/> |
---|
301 | <line num="18" type="stmt" count="0"/> |
---|
302 | <metrics loc="22" ncloc="22" classes="1" methods="2" coveredmethods="0" |
---|
303 | statements="6" coveredstatements="0" elements="8" coveredelements="0"/> |
---|
304 | </file> |
---|
305 | <file name="%s/Foo/tests/Bar/AllTests.php"> |
---|
306 | <class name="All_Bar_Tests" namespace="global" fullPackage="All.Bar"> |
---|
307 | <metrics methods="2" coveredmethods="0" statements="5" |
---|
308 | coveredstatements="0" elements="7" coveredelements="0"/> |
---|
309 | </class> |
---|
310 | <line num="8" type="method" count="0"/> |
---|
311 | <line num="10" type="stmt" count="0"/> |
---|
312 | <line num="11" type="stmt" count="0"/> |
---|
313 | <line num="13" type="method" count="0"/> |
---|
314 | <line num="15" type="stmt" count="0"/> |
---|
315 | <line num="16" type="stmt" count="0"/> |
---|
316 | <line num="17" type="stmt" count="0"/> |
---|
317 | <line num="18" type="stmt" count="0"/> |
---|
318 | <metrics loc="20" ncloc="20" classes="1" methods="2" coveredmethods="0" |
---|
319 | statements="6" coveredstatements="0" elements="8" coveredelements="0"/> |
---|
320 | </file> |
---|
321 | <file name="%s/Foo/tests/Bar/Nested/AllTests.php"> |
---|
322 | <class name="All_Bar_Nested_Tests" namespace="global" fullPackage="All.Bar.Nested"> |
---|
323 | <metrics methods="2" coveredmethods="0" statements="5" |
---|
324 | coveredstatements="0" elements="7" coveredelements="0"/> |
---|
325 | </class> |
---|
326 | <line num="8" type="method" count="0"/> |
---|
327 | <line num="10" type="stmt" count="0"/> |
---|
328 | <line num="11" type="stmt" count="0"/> |
---|
329 | <line num="13" type="method" count="0"/> |
---|
330 | <line num="15" type="stmt" count="0"/> |
---|
331 | <line num="16" type="stmt" count="0"/> |
---|
332 | <line num="17" type="stmt" count="0"/> |
---|
333 | <line num="18" type="stmt" count="0"/> |
---|
334 | <metrics loc="21" ncloc="21" classes="1" methods="2" coveredmethods="0" |
---|
335 | statements="6" coveredstatements="0" elements="8" coveredelements="0"/> |
---|
336 | </file> |
---|
337 | <file name="Foo/classes/Bar.php"> |
---|
338 | <class name="Bar" namespace="global"> |
---|
339 | <metrics methods="0" coveredmethods="0" statements="0" |
---|
340 | coveredstatements="0" elements="0" coveredelements="0"/> |
---|
341 | </class> |
---|
342 | <line num="3" type="stmt" count="1"/> |
---|
343 | <line num="6" type="stmt" count="1"/> |
---|
344 | <metrics loc="5" ncloc="3" classes="1" methods="0" coveredmethods="0" |
---|
345 | statements="2" coveredstatements="2" elements="2" coveredelements="2"/> |
---|
346 | </file> |
---|
347 | <metrics files="7" loc="98" ncloc="94" classes="6" methods="8" coveredmethods="0" |
---|
348 | statements="30" coveredstatements="7" elements="38" coveredelements="7"/> |
---|
349 | </project> |
---|
350 | </coverage>""" % ((self.basedir,)*6)) # One relative path, remaining is absolute |
---|
351 | coverage_xml.close() |
---|
352 | phptools.coverage(self.ctxt, file_='phpcoverage.xml') |
---|
353 | type, category, generator, xml = self.ctxt.output.pop() |
---|
354 | self.assertEqual(Recipe.REPORT, type) |
---|
355 | self.assertEqual('coverage', category) |
---|
356 | |
---|
357 | coverage = list(xml.children) |
---|
358 | self.assertEqual(6, len(coverage)) |
---|
359 | |
---|
360 | self.assertEqual(27, sum([int(c.attr['lines']) for c in coverage])) |
---|
361 | self.assertEqual(['Foo', 'All_Foo_Tests', 'AllTests', 'All_Bar_Tests', |
---|
362 | 'All_Bar_Nested_Tests', 'Bar'], |
---|
363 | [c.attr['name'] for c in coverage]) |
---|
364 | self.assertEqual(['Foo/classes/Foo.php', |
---|
365 | 'Foo/tests/Foo/AllTests.php', |
---|
366 | 'Foo/tests/AllTests.php', |
---|
367 | 'Foo/tests/Bar/AllTests.php', |
---|
368 | 'Foo/tests/Bar/Nested/AllTests.php', |
---|
369 | 'Foo/classes/Bar.php'], |
---|
370 | [c.attr['file'] for c in coverage]) |
---|
371 | self.assertEqual([100, 0, 0, 0, 0, 100], |
---|
372 | [c.attr['percentage'] for c in coverage]) |
---|
373 | |
---|
374 | def suite(): |
---|
375 | suite = unittest.TestSuite() |
---|
376 | suite.addTest(unittest.makeSuite(PhpUnitTestCase, 'test')) |
---|
377 | suite.addTest(unittest.makeSuite(PhpCodeCoverageTestCase, 'test')) |
---|
378 | suite.addTest(unittest.makeSuite(PhpCodeSnifferTestCase, 'test')) |
---|
379 | return suite |
---|
380 | |
---|
381 | if __name__ == '__main__': |
---|
382 | unittest.main(defaultTest='suite') |
---|