Merge lp:~stevanr/linaro-license-protection/autorun-php-unittests into lp:~linaro-automation/linaro-license-protection/trunk

[Stevan Radaković]

Add new test module with a single test which runs the PHP unit tests and check for failures or errors.
It uses phpunit 'write results to XML' feature, then parses the XML file for results.

[Данило Шеган (danilo)]

У пет, 11. 05 2012. у 15:51 +0000, Stevan Radaković пише:
> Stevan Radaković has proposed merging lp:~stevanr/linaro-license-protection/autorun-php-unittests into lp:linaro-license-protection.
>
> Requested reviews:
> Данило Шеган (danilo): code
>
> For more details, see:
> https://code.launchpad.net/~stevanr/linaro-license-protection/autorun-php-unittests/+merge/105498
>
> Add new test module with a single test which runs the PHP unit tests and check for failures or errors.
> It uses phpunit 'write results to XML' feature, then parses the XML file for results.
> разлике међу датотекама прилог (review-diff.txt)
> === modified file 'README'
> --- README 2012-05-11 12:20:01 +0000
> +++ README 2012-05-11 15:50:28 +0000
> @@ -104,5 +104,4 @@
> $ sudo pear install pear.phpunit.de/PHPUnit
>
> Then to run the test from the 'testing' directory:
> - $ cd testing/
> - $ phpunit LicenseHelperTest
> + $ phpunit testing/LicenseHelperTest

Since we are going to be automatically running these tests using 'testr
run', perhaps it would be good to change the narrative to say something
like: To run only the PHP tests using phpunit directly, do the
following. Though, we might as well remove the entire paragraph, but
I'd rather not until we improve the Python integration to output the
actual failures properly.

> === added file 'testing/test_php_unit.py'
> --- testing/test_php_unit.py 1970-01-01 00:00:00 +0000
> +++ testing/test_php_unit.py 2012-05-11 15:50:28 +0000
> @@ -0,0 +1,33 @@
> +#!/usr/bin/env python

I don't think you need this line.

> +
> +import os
> +import subprocess
> +import xml.etree.ElementTree as etree

It's not customary to rename imported classes/modules, unless they
conflict with a class in the file. FWIW, someone used to the
ElementTree might confuse the etree for the module instead of the class
and try to do etree.ElementTree inside the code: this adds nothing but
confusion, imho.

Not a big deal, but just thought I'd note my personal opinion.

> +from testtools import TestCase
> +from testtools.matchers import Equals
> +
> +class PhpUnitTest(TestCase):
> + '''Tests for executing the PHP Unit tests'''
> +
> + def setUp(self):
> + super(PhpUnitTest, self).setUp()
> + self.xml_path = "testing/php_unit_test_result.xml"

As you already know, I hate it when we are writing stuff to the code
directory. FWIW, one should be able to run tests on a read-only
location, though this project already fails that assumption. For
example, this is very useful for rolling out to production machines,
where IS can trust us not to introduce a bunch of temporary/transient
files in the production location.

> + if subprocess.Popen(['phpunit', '--log-junit',
> + self.xml_path, 'testing/LicenseHelperTest'],
> + stdout=open('/dev/null', 'w'),
> + stderr=subprocess.STDOUT).wait():
> + raise CommandNotFoundException("phpunit command not found. Please "
> + "install phpunit package and rerun tests.")
> + self.xml_data = etree.parse(self.xml_path)

This is good, though I have a feeling it would have been cheaper to
parse JSON, which php...

review: Approve

[lp:~stevanr/linaro-license-protection/autorun-php-unittests]

74. By Stevan Radaković on 2012-05-14

Small updates from danilos code review.

=== modified file 'README'
--- README	2012-05-11 12:20:01 +0000
+++ README	2012-05-14 10:42:20 +0000
@@ -103,6 +103,5 @@
   $ sudo pear config-set auto_discover 1
   $ sudo pear install pear.phpunit.de/PHPUnit
 
-Then to run the test from the 'testing' directory:
-  $ cd testing/
-  $ phpunit LicenseHelperTest
+PHPUnit tests execution is already included in the python integration tests, but if you wish to run unit tests separately, do the following:
+  $ phpunit testing/LicenseHelperTest

=== modified file 'testing/LicenseHelperTest.php'
--- testing/LicenseHelperTest.php	2012-05-09 07:53:36 +0000
+++ testing/LicenseHelperTest.php	2012-05-14 10:42:20 +0000
@@ -1,6 +1,6 @@
 <?php
 
-require_once("../licenses/LicenseHelper.php");
+require_once("licenses/LicenseHelper.php");
 
 class LicenseHelperTest extends PHPUnit_Framework_TestCase
 {

=== modified file 'testing/__init__.py'
--- testing/__init__.py	2012-05-11 12:23:43 +0000
+++ testing/__init__.py	2012-05-14 10:42:20 +0000
@@ -8,6 +8,7 @@
     module_names = [
         'testing.test_click_through_license.TestLicense',
         'testing.test_publish_to_snapshots.TestSnapshotsPublisher',
+        'testing.test_php_unit.PhpUnitTest',
         ]
     loader = unittest.TestLoader()
     suite = loader.loadTestsFromNames(module_names)

=== added file 'testing/test_php_unit.py'
--- testing/test_php_unit.py	1970-01-01 00:00:00 +0000
+++ testing/test_php_unit.py	2012-05-14 10:42:20 +0000
@@ -0,0 +1,36 @@
+import os
+import tempfile
+import subprocess
+import xml.etree.ElementTree
+
+from testtools import TestCase
+from testtools.matchers import Equals
+from testtools.matchers import AllMatch
+
+class PhpUnitTest(TestCase):
+    '''Tests for executing the PHP Unit tests'''
+
+    def setUp(self):
+        super(PhpUnitTest, self).setUp()
+        self.xml_path = tempfile.mkstemp()[1]
+        if subprocess.Popen(['phpunit', '--log-junit',
+                             self.xml_path, 'testing/LicenseHelperTest'],
+                stdout=open('/dev/null', 'w'),
+                stderr=subprocess.STDOUT).wait():
+            raise CommandNotFoundException("phpunit command not found. Please "
+                "install phpunit package and rerun tests.")
+        self.xml_data = xml.etree.ElementTree.parse(self.xml_path)
+
+    def tearDown(self):
+        super(PhpUnitTest, self).tearDown()
+        if os.path.exists(self.xml_path):
+            os.unlink(self.xml_path)
+
+    def test_run_php_unit_tests(self):
+        self.assertThat(
+            [
+            self.xml_data.getroot()[0].attrib['failures'],
+            self.xml_data.getroot()[0].attrib['errors']
+            ],
+            AllMatch(Equals("0"))
+        )