X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/fd9345cda3745d026597e7b42edcd196e82dc6bb..67462e095319038fa53636decb69dcf40f0c6dee:/test/php/Nominatim/ParameterParserTest.php

diff --git a/test/php/Nominatim/ParameterParserTest.php b/test/php/Nominatim/ParameterParserTest.php
index ec9e3fea..82716d4d 100644
--- a/test/php/Nominatim/ParameterParserTest.php
+++ b/test/php/Nominatim/ParameterParserTest.php
@@ -1,214 +1,248 @@
 <?php
+/**
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ * This file is part of Nominatim. (https://nominatim.org)
+ *
+ * Copyright (C) 2022 by the Nominatim developer community.
+ * For a full list of authors see the git log.
+ */
 
 namespace Nominatim;
 
-use Exception;
-
-require_once('../../lib/ParameterParser.php');
+require_once(CONST_LibDir.'/ParameterParser.php');
 
 
 function userError($sError)
 {
-    throw new Exception($sError);
+    throw new \Exception($sError);
 }
 
-class ParameterParserTest extends \PHPUnit_Framework_TestCase
+class ParameterParserTest extends \PHPUnit\Framework\TestCase
 {
 
 
-    protected function setUp()
-    {
-    }
-
-
     public function testGetBool()
     {
-        $oParams = new ParameterParser([
+        $oParams = new ParameterParser(array(
                                         'bool1' => '1',
                                         'bool2' => '0',
                                         'bool3' => 'true',
                                         'bool4' => 'false',
                                         'bool5' => ''
-                                       ]);
-
-        $this->assertEquals(false, $oParams->getBool('non-exists'));
-        $this->assertEquals(true, $oParams->getBool('non-exists', true));
-        $this->assertEquals(true, $oParams->getBool('bool1'));
-        $this->assertEquals(false, $oParams->getBool('bool2'));
-        $this->assertEquals(true, $oParams->getBool('bool3'));
-        $this->assertEquals(true, $oParams->getBool('bool4'));
-        $this->assertEquals(false, $oParams->getBool('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([
+        $oParams = new ParameterParser(array(
                                         'int1' => '5',
-                                        'int2' => 'a',
-                                        'int3' => '-1',
-                                        'int4' => '',
-                                        'int5' => 0
-                                       ]);
-
-        $this->assertEquals(false, $oParams->getInt('non-exists'));
-        $this->assertEquals(999, $oParams->getInt('non-exists', 999));
-        $this->assertEquals(5, $oParams->getInt('int1'));
-
-        try {
-            $this->assertEquals(false, $oParams->getInt('int2'));
-        } catch (Exception $e) {
-            $this->assertEquals($e->getMessage(), "Integer number expected for parameter 'int2'");
-        }
-        $this->assertEquals(-1, $oParams->getInt('int3'));
-        $this->assertEquals(false, $oParams->getInt('int4'));
-        $this->assertEquals(false, $oParams->getInt('int5')); // FIXME: should be 0 instead?
+                                        '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->expectException(\Exception::class);
+        $this->expectExceptionMessage("Integer number expected for parameter 'int4'");
+
+        (new ParameterParser(array('int4' => 'a')))->getInt('int4');
+    }
+
+
+    public function testGetIntWithEmpytString()
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage("Integer number expected for parameter 'int5'");
+
+        (new ParameterParser(array('int5' => '')))->getInt('int5');
     }
 
 
     public function testGetFloat()
     {
-        $oParams = new ParameterParser([
+
+        $oParams = new ParameterParser(array(
                                         'float1' => '1.0',
                                         'float2' => '-5',
-                                        'float3' => '-55.',
-                                        'float4' => 'a',
-                                        'float5' => '',
-                                        'float6' => 0
-                                       ]);
-
-        $this->assertEquals(false, $oParams->getFloat('non-exists'));
-        $this->assertEquals(999, $oParams->getFloat('non-exists', 999));
-        $this->assertEquals(1, $oParams->getFloat('float1'));
-        $this->assertEquals(-5, $oParams->getFloat('float2'));
-
-        try {
-            $this->assertEquals(false, $oParams->getFloat('float3'));
-        } catch (Exception $e) {
-            $this->assertEquals($e->getMessage(), "Floating-point number expected for parameter 'float3'");
-        }
-
-        try {
-            $this->assertEquals(false, $oParams->getFloat('float4'));
-        } catch (Exception $e) {
-            $this->assertEquals($e->getMessage(), "Floating-point number expected for parameter 'float4'");
-        }
-        $this->assertEquals(false, $oParams->getFloat('float5'));
-        $this->assertEquals(false, $oParams->getFloat('float6')); // FIXME: should be 0 instead?
+                                        '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->expectException(\Exception::class);
+        $this->expectExceptionMessage("Floating-point number expected for parameter 'float4'");
+
+        (new ParameterParser(array('float4' => '')))->getFloat('float4');
+    }
+
+    public function testGetFloatWithTextString()
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage("Floating-point number expected for parameter 'float5'");
+
+        (new ParameterParser(array('float5' => 'a')))->getFloat('float5');
     }
 
 
+    public function testGetFloatWithInvalidNumber()
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage("Floating-point number expected for parameter 'float6'");
+
+        (new ParameterParser(array('float6' => '-55.')))->getFloat('float6');
+    }
+
 
     public function testGetString()
     {
-        $oParams = new ParameterParser([
+        $oParams = new ParameterParser(array(
                                         'str1' => 'abc',
                                         'str2' => '',
                                         'str3' => '0'
-                                       ]);
+                                       ));
 
-        $this->assertEquals(false, $oParams->getString('non-exists'));
-        $this->assertEquals('default', $oParams->getString('non-exists', 'default'));
-        $this->assertEquals('abc', $oParams->getString('str1'));
-        $this->assertEquals(false, $oParams->getStringList('str2'));
-        $this->assertEquals(false, $oParams->getStringList('str3')); // FIXME: should be 0 instead?
+        $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([
+        $oParams = new ParameterParser(array(
                                         'val1' => 'foo',
-                                        'val2' => 'FOO',
-                                        'val3' => '',
-                                        'val4' => 0
-                                       ]);
-
-        $this->assertEquals(false, $oParams->getSet('non-exists', ['foo', 'bar']));
-        // FIXME: unclear if the default value has to be part of the set
-        $this->assertEquals('default', $oParams->getSet('non-exists', ['foo', 'bar'], 'default'));
-        $this->assertEquals('foo', $oParams->getSet('val1', ['foo', 'bar']));
-
-        try {
-            $this->assertEquals(false, $oParams->getSet('val2', ['foo', 'bar']));
-        } catch (Exception $e) {
-            $this->assertEquals($e->getMessage(), "Parameter 'val2' must be one of: foo, bar");
-        }
-        $this->assertEquals(false, $oParams->getSet('val3', ['foo', 'bar']));
-        $this->assertEquals(false, $oParams->getSet('val4', ['foo', 'bar']));
+                                        'val2' => '',
+                                        'val3' => 0
+                                       ));
+
+        $this->assertSame(false, $oParams->getSet('non-exists', array('foo', 'bar')));
+        $this->assertSame('default', $oParams->getSet('non-exists', array('foo', 'bar'), 'default'));
+        $this->assertSame('foo', $oParams->getSet('val1', array('foo', 'bar')));
+
+        $this->assertSame(false, $oParams->getSet('val2', array('foo', 'bar')));
+        $this->assertSame(false, $oParams->getSet('val3', array('foo', 'bar')));
+    }
+
+
+    public function testGetSetWithValueNotInSet()
+    {
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage("Parameter 'val4' must be one of: foo, bar");
+
+        (new ParameterParser(array('val4' => 'faz')))->getSet('val4', array('foo', 'bar'));
     }
 
 
     public function testGetStringList()
     {
-        $oParams = new ParameterParser([
+        $oParams = new ParameterParser(array(
                                         'list1' => ',a,b,c,,c,d',
                                         'list2' => 'a',
                                         'list3' => '',
                                         'list4' => '0'
-                                       ]);
-
-        $this->assertEquals(false, $oParams->getStringList('non-exists'));
-        $this->assertEquals(['a', 'b'], $oParams->getStringList('non-exists', ['a', 'b']));
-        // FIXME: unclear if empty string items should be removed
-        $this->assertEquals(['', 'a', 'b', 'c', '', 'c', 'd'], $oParams->getStringList('list1'));
-        $this->assertEquals(['a'], $oParams->getStringList('list2'));
-        $this->assertEquals(false, $oParams->getStringList('list3'));
-        $this->assertEquals(false, $oParams->getStringList('list4'));
+                                       ));
+
+        $this->assertSame(false, $oParams->getStringList('non-exists'));
+        $this->assertSame(array('a', 'b'), $oParams->getStringList('non-exists', array('a', 'b')));
+        $this->assertSame(array('a', 'b', 'c', 'c', 'd'), $oParams->getStringList('list1'));
+        $this->assertSame(array('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->assertEquals([
-                             'brand' => 'brand',
-                             'ref' => 'ref',
-                             'type' => 'type',
-                             'name' => 'name',
-                             'name:default' => 'name:default',
-                             'short_name' => 'short_name',
-                             'short_name:default' => 'short_name:default',
-                             'official_name' => 'official_name',
-                             'official_name:default' => 'official_name:default',
-                            ], $oParams->getPreferredLanguages('default'));
-
-        $oParams = new ParameterParser(['accept-language' => 'de,en']);
-        $this->assertEquals([
-                             'brand' => 'brand',
-                             'ref' => 'ref',
-                             'type' => 'type',
-                             'name' => 'name',
-                             'name:de' => 'name:de',
-                             'name:en' => 'name:en',
-                             'short_name' => 'short_name',
-                             'short_name:de' => 'short_name:de',
-                             'short_name:en' => 'short_name:en',
-                             'official_name' => 'official_name',
-                             'official_name:de' => 'official_name:de',
-                             'official_name:en' => 'official_name:en',
-                            ], $oParams->getPreferredLanguages('default'));
-
-        $oParams = new ParameterParser(['accept-language' => 'fr-ca,fr;q=0.8,en-ca;q=0.5,en;q=0.3']);
-        $this->assertEquals([
-                             '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'));
+        $oParams = new ParameterParser(array('accept-language' => ''));
+        $this->assertSame(array(
+                           'name:default' => 'name:default',
+                           '_place_name:default' => '_place_name:default',
+                           'name' => 'name',
+                           '_place_name' => '_place_name'
+                          ), array_slice($oParams->getPreferredLanguages('default'), 0, 4));
+
+        $oParams = new ParameterParser(array('accept-language' => 'de,en'));
+        $this->assertSame(array(
+                           'name:de' => 'name:de',
+                           '_place_name:de' => '_place_name:de',
+                           'name:en' => 'name:en',
+                           '_place_name:en' => '_place_name:en',
+                           'name' => 'name',
+                           '_place_name' => '_place_name'
+                          ), array_slice($oParams->getPreferredLanguages('default'), 0, 6));
+
+        $oParams = new ParameterParser(array('accept-language' => 'fr-ca,fr;q=0.8,en-ca;q=0.5,en;q=0.3'));
+        $this->assertSame(array(
+                           'name:fr-ca' => 'name:fr-ca',
+                           '_place_name:fr-ca' => '_place_name:fr-ca',
+                           'name:fr' => 'name:fr',
+                           '_place_name:fr' => '_place_name:fr',
+                           'name:en-ca' => 'name:en-ca',
+                           '_place_name:en-ca' => '_place_name:en-ca',
+                           'name:en' => 'name:en',
+                           '_place_name:en' => '_place_name:en',
+                           'name' => 'name',
+                           '_place_name' => '_place_name'
+                          ), array_slice($oParams->getPreferredLanguages('default'), 0, 10));
+
+        $oParams = new ParameterParser(array('accept-language' => 'ja_rm,zh_pinyin'));
+        $this->assertSame(array(
+                           'name:ja_rm' => 'name:ja_rm',
+                           '_place_name:ja_rm' => '_place_name:ja_rm',
+                           'name:zh_pinyin' => 'name:zh_pinyin',
+                           '_place_name:zh_pinyin' => '_place_name:zh_pinyin',
+                           'name:ja' => 'name:ja',
+                           '_place_name:ja' => '_place_name:ja',
+                           'name:zh' => 'name:zh',
+                           '_place_name:zh' => '_place_name:zh',
+                           'name' => 'name',
+                           '_place_name' => '_place_name'
+                          ), array_slice($oParams->getPreferredLanguages('default'), 0, 10));
+    }
+
+    public function testHasSetAny()
+    {
+        $oParams = new ParameterParser(array(
+                                        'one' => '',
+                                        'two' => 0,
+                                        'three' => '0',
+                                        'four' => '1',
+                                        'five' => 'anystring'
+        ));
+        $this->assertFalse($oParams->hasSetAny(array()));
+        $this->assertFalse($oParams->hasSetAny(array('')));
+        $this->assertFalse($oParams->hasSetAny(array('unknown')));
+        $this->assertFalse($oParams->hasSetAny(array('one', 'two', 'three')));
+        $this->assertTrue($oParams->hasSetAny(array('one', 'four')));
+        $this->assertTrue($oParams->hasSetAny(array('four')));
+        $this->assertTrue($oParams->hasSetAny(array('five')));
     }
 }