Implemented phpunit test for language agnostic test cases

Reorganised test folder
Fixed string argv input bug to allow new test cases to run

Author: shabbyrobe

src/docopt.php

@@ -694,9 +694,14 @@ class TokenStream extends \ArrayIterator
 
         public function __construct($source, $error)
         {
-            if (!is_array($source))
-                $source = preg_split('/\s+/', trim($source));
-
+            if (!is_array($source)) {
+                $source = trim($source);
+                if ($source)
+                    $source = preg_split('/\s+/', $source);
+                else
+                    $source = array();
+            }
+            
             parent::__construct($source);
 
             $this->error = $error; 

test/config.php

@@ -0,0 +1,113 @@
+<?php
+namespace Docopt\Test;
+
+class LanguageAgnosticTest implements \PHPUnit_Framework_Test, \PHPUnit_Framework_SelfDescribing
+{
+	public static function createSuite($testFile)
+	{
+		if (!file_exists($testFile))
+			throw new \InvalidArgumentException("Test file $testFile does not exist");
+		
+		$suite = new \PHPUnit_Framework_TestSuite;
+		
+		$raw = file_get_contents($testFile);
+		$raw = trim(preg_replace("/#.*$/m", "", $raw));
+		if (strpos($raw, '"""')===0) {
+			$raw = substr($raw, 3);
+		}
+		
+		$idx = 1;
+		foreach (explode('r"""', $raw) as $fixture) {
+			if (!$fixture) {
+				continue;
+			}
+			
+			$name = '';
+			$nIdx = 1;
+			
+			list ($doc, $body) = explode('"""', $fixture, 2);
+			$cases = array();
+			foreach (array_slice(explode('$', $body), 1) as $case) {
+				$case = trim($case);
+				list ($argv, $expect) = explode("\n", $case, 2);
+				$expect = json_decode($expect, true);
+				
+				$argx = explode(' ', $argv, 2);
+				$prog = $argx[0];
+				$argv = isset($argx[1]) ? $argx[1] : "";
+				
+				$tName = $name ? ($name.$nIdx) : 'unnamed'.$idx;
+				$suite->addTest(new static($tName, $doc, $prog, $argv, $expect));
+				$idx++;
+			}
+		}
+		
+		return $suite;
+	}
+	
+	public function __construct($name, $doc, $prog, $argv, $expect)
+	{
+		$this->doc = $doc;
+		$this->name = $name;
+		$this->prog = $prog;
+		$this->argv = $argv;
+		
+		if ($expect == "user-error")
+			$expect = array('user-error');
+		
+		$this->expect = $expect;
+	}
+	
+	public function run(\PHPUnit_Framework_TestResult $result=null)
+    {
+        if (!$result)
+            $result = new \PHPUnit_Framework_TestResult();
+        
+        $opt = null;
+		
+		\PHP_Timer::start();
+		$result->startTest($this);
+		
+		try {
+		    $opt = \Docopt::handle($this->doc, array('argv'=>$this->argv, 'exit'=>false));
+		}
+		catch (\Exception $ex) {
+			// gulp
+		}
+		
+		$found = null;
+		if ($opt) {
+		    if (!$opt->success) {
+		        $found = array('user-error');
+		    }
+		    elseif (empty($opt->args)) {
+		        $found = [];
+		    }
+		    else {
+		        $found = $opt->args;
+		    }
+		}
+		
+		$time = \PHP_Timer::stop();
+		try {
+        	\PHPUnit_Framework_Assert::assertEquals($this->expect, $found);
+		}
+        catch (\PHPUnit_Framework_AssertionFailedError $e) {
+            $result->addFailure($this, $e, $time);
+        }
+        
+		$result->endTest($this, $time);
+
+        return $result;
+    }
+    
+    public function count()
+    {
+        return 1;
+    }
+    
+    public function toString()
+    {
+    	return __CLASS__.'::'.$this->name.' - "'.$this->prog.($this->argv ? ' '.$this->argv : '').'"';
+    }
+}

test/lib/LanguageAgnosticTest.php

@@ -12,7 +12,7 @@
 use Docopt\TokenStream;
 use Docopt\Command;
 
-class DocoptTest extends \PHPUnit_Framework_TestCase
+class PythonPortedTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * The arguments from the docopt test file are the other way around.

test/DocoptTest.php test/lib/PythonPortedTest.phptest/DocoptTest.php renamed to test/lib/PythonPortedTest.php

@@ -0,0 +1,33 @@
+<?php
+$basePath = __DIR__;
+require $basePath.'/../src/docopt.php';
+require_once 'PHPUnit/Autoload.php';
+
+require $basePath.'/lib/PythonPortedTest.php';
+require $basePath.'/lib/LanguageAgnosticTest.php';
+
+$options = array(
+    'py'=>getenv('DOCOPT_PYTHON_PATH'),
+    'filter'=>null,
+);
+$options = array_merge(
+    $options,
+    getopt('', array('py:', 'filter:'))
+);
+
+if (!$options['py']) {
+    die(
+        "Please ensure the --py option or the DOCOPT_PYTHON_PATH environment\n".
+        "variable point to the path of the python port"
+    );
+}
+
+$suite = new PHPUnit_Framework_TestSuite();
+$suite->addTest(new PHPUnit_Framework_TestSuite('Docopt\Test\PythonPortedTest'));
+$suite->addTest(Docopt\Test\LanguageAgnosticTest::createSuite($options['py'].'/testcases.docopt'));
+
+$runner = new PHPUnit_TextUI_TestRunner();
+$runner->doRun($suite, array(
+    'filter'=>$options['filter'],
+    'strict'=>true,
+));