Merge pull request #941 from mtmail/parameter-parser-tests2

PHP tests for ParameterParser

diff --git a/lib/ParameterParser.php b/lib/ParameterParser.php
index 2eed1629b04742ad274c6ac9f5cf8d9bf1ebfbd3..c9a97c25c5f6b0f29f0e9cb3b139b32e8f9d2841 100644 (file)
--- a/lib/ParameterParser.php
+++ b/lib/ParameterParser.php
@@ -23,7 +23,7 @@ class ParameterParser
 
     public function getInt($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
+        if (!isset($this->aParams[$sName])) {
             return $bDefault;
         }
 
@@ -36,7 +36,7 @@ class ParameterParser
 
     public function getFloat($sName, $bDefault = false)
     {
-        if (!isset($this->aParams[$sName]) || strlen($this->aParams[$sName]) == 0) {
+        if (!isset($this->aParams[$sName])) {
             return $bDefault;
         }
 
@@ -74,7 +74,8 @@ class ParameterParser
         $sValue = $this->getString($sName);
 
         if ($sValue) {
-            return explode(',', $sValue);
+            // removes all NULL, FALSE and Empty Strings but leaves 0 (zero) values
+            return array_values(array_filter(explode(',', $sValue), 'strlen'));
         }
 
         return $aDefault;

diff --git a/test/php/Nominatim/ParameterParserTest.php b/test/php/Nominatim/ParameterParserTest.php
new file mode 100644 (file)
index 0000000..4265cff
--- /dev/null
+++ b/test/php/Nominatim/ParameterParserTest.php
@@ -0,0 +1,217 @@
+<?php
+
+namespace Nominatim;
+
+use Exception;
+
+require_once('../../lib/ParameterParser.php');
+
+
+function userError($sError)
+{
+    throw new Exception($sError);
+}
+
+class ParameterParserTest extends \PHPUnit_Framework_TestCase
+{
+
+
+    public function testGetBool()
+    {
+        $oParams = new ParameterParser([
+                                        'bool1' => '1',
+                                        'bool2' => '0',
+                                        'bool3' => 'true',
+                                        'bool4' => 'false',
+                                        'bool5' => ''
+                                       ]);
+
+        $this->assertSame(false, $oParams->getBool('non-exists'));
+        $this->assertSame(true, $oParams->getBool('non-exists', true));
+        $this->assertSame(true, $oParams->getBool('bool1'));
+        $this->assertSame(false, $oParams->getBool('bool2'));
+        $this->assertSame(true, $oParams->getBool('bool3'));
+        $this->assertSame(true, $oParams->getBool('bool4'));
+        $this->assertSame(false, $oParams->getBool('bool5'));
+    }
+
+
+    public function testGetInt()
+    {
+        $oParams = new ParameterParser([
+                                        'int1' => '5',
+                                        'int2' => '-1',
+                                        'int3' => 0
+                                       ]);
+
+        $this->assertSame(false, $oParams->getInt('non-exists'));
+        $this->assertSame(999, $oParams->getInt('non-exists', 999));
+        $this->assertSame(5, $oParams->getInt('int1'));
+
+        $this->assertSame(-1, $oParams->getInt('int2'));
+        $this->assertSame(0, $oParams->getInt('int3'));
+    }
+
+
+    public function testGetIntWithNonNumber()
+    {
+        $this->setExpectedException(Exception::class, "Integer number expected for parameter 'int4'");
+        (new ParameterParser(['int4' => 'a']))->getInt('int4');
+    }
+
+
+    public function testGetIntWithEmpytString()
+    {
+        $this->setExpectedException(Exception::class, "Integer number expected for parameter 'int5'");
+        (new ParameterParser(['int5' => '']))->getInt('int5');
+    }
+
+
+    public function testGetFloat()
+    {
+
+        $oParams = new ParameterParser([
+                                        'float1' => '1.0',
+                                        'float2' => '-5',
+                                        'float3' => 0
+                                       ]);
+
+        $this->assertSame(false, $oParams->getFloat('non-exists'));
+        $this->assertSame(999, $oParams->getFloat('non-exists', 999));
+        $this->assertSame(1.0, $oParams->getFloat('float1'));
+        $this->assertSame(-5.0, $oParams->getFloat('float2'));
+        $this->assertSame(0.0, $oParams->getFloat('float3'));
+    }
+
+    public function testGetFloatWithEmptyString()
+    {
+        $this->setExpectedException(Exception::class, "Floating-point number expected for parameter 'float4'");
+        (new ParameterParser(['float4' => '']))->getFloat('float4');
+    }
+
+    public function testGetFloatWithTextString()
+    {
+        $this->setExpectedException(Exception::class, "Floating-point number expected for parameter 'float5'");
+        (new ParameterParser(['float5' => 'a']))->getFloat('float5');
+    }
+
+
+    public function testGetFloatWithInvalidNumber()
+    {
+        $this->setExpectedException(Exception::class, "Floating-point number expected for parameter 'float6'");
+        (new ParameterParser(['float6' => '-55.']))->getFloat('float6');
+    }
+
+
+    public function testGetString()
+    {
+        $oParams = new ParameterParser([
+                                        'str1' => 'abc',
+                                        'str2' => '',
+                                        'str3' => '0'
+                                       ]);
+
+        $this->assertSame(false, $oParams->getString('non-exists'));
+        $this->assertSame('default', $oParams->getString('non-exists', 'default'));
+        $this->assertSame('abc', $oParams->getString('str1'));
+        $this->assertSame(false, $oParams->getStringList('str2'));
+        $this->assertSame(false, $oParams->getStringList('str3')); // sadly PHP magic treats 0 as false when returned
+    }
+
+
+    public function testGetSet()
+    {
+        $oParams = new ParameterParser([
+                                        'val1' => 'foo',
+                                        'val2' => '',
+                                        'val3' => 0
+                                       ]);
+
+        $this->assertSame(false, $oParams->getSet('non-exists', ['foo', 'bar']));
+        $this->assertSame('default', $oParams->getSet('non-exists', ['foo', 'bar'], 'default'));
+        $this->assertSame('foo', $oParams->getSet('val1', ['foo', 'bar']));
+
+        $this->assertSame(false, $oParams->getSet('val2', ['foo', 'bar']));
+        $this->assertSame(0, $oParams->getSet('val3', ['foo', 'bar']));
+    }
+
+
+    public function testGetSetWithValueNotInSet()
+    {
+        $this->setExpectedException(Exception::class, "Parameter 'val4' must be one of: foo, bar");
+        (new ParameterParser(['val4' => 'faz']))->getSet('val4', ['foo', 'bar']);
+    }
+
+
+    public function testGetStringList()
+    {
+        $oParams = new ParameterParser([
+                                        'list1' => ',a,b,c,,c,d',
+                                        'list2' => 'a',
+                                        'list3' => '',
+                                        'list4' => '0'
+                                       ]);
+
+        $this->assertSame(false, $oParams->getStringList('non-exists'));
+        $this->assertSame(['a', 'b'], $oParams->getStringList('non-exists', ['a', 'b']));
+        $this->assertSame(['a', 'b', 'c', 'c', 'd'], $oParams->getStringList('list1'));
+        $this->assertSame(['a'], $oParams->getStringList('list2'));
+        $this->assertSame(false, $oParams->getStringList('list3'));
+        $this->assertSame(false, $oParams->getStringList('list4'));
+    }
+
+
+    public function testGetPreferredLanguages()
+    {
+        $oParams = new ParameterParser(['accept-language' => '']);
+        $this->assertSame([
+                           'short_name:default' => 'short_name:default',
+                           'name:default' => 'name:default',
+                           'short_name' => 'short_name',
+                           'name' => 'name',
+                           'brand' => 'brand',
+                           'official_name:default' => 'official_name:default',
+                           'official_name' => 'official_name',
+                           'ref' => 'ref',
+                           'type' => 'type'
+                          ], $oParams->getPreferredLanguages('default'));
+
+        $oParams = new ParameterParser(['accept-language' => 'de,en']);
+        $this->assertSame([
+                           'short_name:de' => 'short_name:de',
+                           'name:de' => 'name:de',
+                           'short_name:en' => 'short_name:en',
+                           'name:en' => 'name:en',
+                           'short_name' => 'short_name',
+                           'name' => 'name',
+                           'brand' => 'brand',
+                           'official_name:de' => 'official_name:de',
+                           'official_name:en' => 'official_name:en',
+                           'official_name' => 'official_name',
+                           'ref' => 'ref',
+                           'type' => 'type'
+                          ], $oParams->getPreferredLanguages('default'));
+
+        $oParams = new ParameterParser(['accept-language' => 'fr-ca,fr;q=0.8,en-ca;q=0.5,en;q=0.3']);
+        $this->assertSame([
+                           'short_name:fr-ca' => 'short_name:fr-ca',
+                           'name:fr-ca' => 'name:fr-ca',
+                           'short_name:fr' => 'short_name:fr',
+                           'name:fr' => 'name:fr',
+                           'short_name:en-ca' => 'short_name:en-ca',
+                           'name:en-ca' => 'name:en-ca',
+                           'short_name:en' => 'short_name:en',
+                           'name:en' => 'name:en',
+                           'short_name' => 'short_name',
+                           'name' => 'name',
+                           'brand' => 'brand',
+                           'official_name:fr-ca' => 'official_name:fr-ca',
+                           'official_name:fr' => 'official_name:fr',
+                           'official_name:en-ca' => 'official_name:en-ca',
+                           'official_name:en' => 'official_name:en',
+                           'official_name' => 'official_name',
+                           'ref' => 'ref',
+                           'type' => 'type',
+                          ], $oParams->getPreferredLanguages('default'));
+    }
+}