From 72c1255dc69f31492d5a25a5c9f3c7a8e95f97d6 Mon Sep 17 00:00:00 2001
From: Johannes Meyer <johannes.meyer@netways.de>
Date: Thu, 6 Jun 2013 15:41:47 +0200
Subject: [PATCH] Rewrite php test-runner.

--include and --exclude will affect group annotations.
(See: http://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.group)

refs #4244
---
 test/php/phpunit.xml |  23 +--------
 test/php/runtests    | 111 +++++++++++++++++++++++++++++++++++++++++++
 test/php/runtests.sh |  26 ----------
 3 files changed, 113 insertions(+), 47 deletions(-)
 create mode 100755 test/php/runtests
 delete mode 100755 test/php/runtests.sh

diff --git a/test/php/phpunit.xml b/test/php/phpunit.xml
index f685c4ff0..c268aedca 100644
--- a/test/php/phpunit.xml
+++ b/test/php/phpunit.xml
@@ -1,24 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<phpunit backupGlobals="true"
-         backupStaticAttributes="true"
-         colors="false"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         forceCoversAnnotation="false"
-         processIsolation="false"
-         stopOnError="false"
-         stopOnFailure="false"
-         stopOnIncomplete="false"
-         stopOnSkipped="false"
-         strict="false"
-         verbose="false">
-
-    <logging>
-        <log type="coverage-clover" target="../../build/log/phpunit_coverage.xml"/>
-        <log type="junit" target="../../build/log/phpunit_results.xml" logIncompleteSkipped="true"/>
-    </logging>
-
+<phpunit>
     <testsuites>
         <!--
             Unit testing
@@ -36,4 +17,4 @@
             <directory>regression/</directory>
         </testsuite>
     </testsuites>
-</phpunit>
\ No newline at end of file
+</phpunit>
diff --git a/test/php/runtests b/test/php/runtests
new file mode 100755
index 000000000..9294f63f9
--- /dev/null
+++ b/test/php/runtests
@@ -0,0 +1,111 @@
+#!/usr/bin/env python
+
+import os
+import sys
+import subprocess
+from optparse import OptionParser, BadOptionError, AmbiguousOptionError
+
+
+APPLICATION = 'phpunit'
+DEFAULT_ARGS = ['--strict', '--static-backup']
+
+REPORT_DIRECTORY = '../../build/log'
+
+
+class PassThroughOptionParser(OptionParser):
+    """
+    An unknown option pass-through implementation of OptionParser.
+
+    When unknown arguments are encountered, bundle with largs and try again,
+    until rargs is depleted.
+
+    sys.exit(status) will still be called if a known argument is passed
+    incorrectly (e.g. missing arguments or bad argument types, etc.)
+
+    Borrowed from: http://stackoverflow.com/a/9307174
+    """
+    def _process_args(self, largs, rargs, values):
+        while rargs:
+            try:
+                OptionParser._process_args(self, largs, rargs, values)
+            except (BadOptionError, AmbiguousOptionError), error:
+                largs.append(error.opt_str)
+
+
+def execute_command(command, return_output=False, shell=False):
+    prog = subprocess.Popen(command, shell=shell,
+                            stdout=subprocess.PIPE
+                                   if return_output
+                                   else None)
+    return prog.wait() if not return_output else \
+           prog.communicate()[0]
+
+
+def get_report_directory():
+    path = os.path.abspath(REPORT_DIRECTORY)
+
+    try:
+        os.makedirs(REPORT_DIRECTORY)
+    except OSError:
+        pass
+
+    return path
+
+
+def get_script_directory():
+    return os.path.dirname(os.path.abspath(sys.argv[0]))
+
+
+def parse_commandline():
+    parser = PassThroughOptionParser(usage='%prog [options] [additional arguments'
+                                           ' for {0}]'.format(APPLICATION))
+    parser.add_option('-b', '--build', action='store_true',
+                      help='Enable reporting.')
+    parser.add_option('-v', '--verbose', action='store_true',
+                      help='Be more verbose.')
+    parser.add_option('-i', '--include', metavar='PATTERN', action='append',
+                      help='Include only specific files/test cases.'
+                           ' (Can be supplied multiple times.)')
+    parser.add_option('-e', '--exclude', metavar='PATTERN', action='append',
+                      help='Exclude specific files/test cases. '
+                           '(Can be supplied multiple times.)')
+    return parser.parse_args()
+
+
+def main():
+    options, arguments = parse_commandline()
+
+    # Environment preparation and verification
+    os.chdir(get_script_directory())
+    application_path = execute_command('which {0}'.format(APPLICATION),
+                                       True, True).strip()
+    if not application_path:
+        print 'ERROR: {0} not found!'.format(APPLICATION)
+        return 2
+
+    # Commandline preparation
+    command_options = []
+    if options.verbose:
+        command_options.append('--verbose')
+    if options.build:
+        report_directory = get_report_directory()
+        command_options.append('--log-junit')
+        command_options.append(os.path.join(report_directory,
+                                            'phpunit_results.xml'))
+        command_options.append('--coverage-clover')
+        command_options.append(os.path.join(report_directory,
+                                            'phpunit_coverage.xml'))
+    if options.include:
+        command_options.extend(['--group', ','.join(options.include)])
+    if options.exclude:
+        command_options.extend(['--exclude-group',
+                                ','.join(options.exclude)])
+
+    # Application invocation..
+    execute_command([application_path] + DEFAULT_ARGS +
+                    command_options + arguments)
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())
diff --git a/test/php/runtests.sh b/test/php/runtests.sh
deleted file mode 100755
index 42f07b82e..000000000
--- a/test/php/runtests.sh
+++ /dev/null
@@ -1,26 +0,0 @@
-#!/bin/sh
-
-set -o nounset
-
-SCRIPTNAME=$(readlink -f $0)
-DIR=$(dirname $SCRIPTNAME)
-PHPUNIT=$(which phpunit)
-
-if [[ ! -x $PHPUNIT ]]; then
-    echo "PHPUnit not found!"
-    exit 1
-fi
-
-# Make sure that the destination directory for logs and reports exists
-mkdir -p $DIR/../../build/log
-
-cd $DIR
-
-if [[ ! -x ./bin/extcmd_test ]]; then
-    make
-fi;
-
-
-$PHPUNIT "$@" 
-
-exit 0