added tests for parser

Author: Raaghu

.travis.yml

@@ -5,6 +5,7 @@ php:
   - '5.6'
   - '7.0'
   - '7.1'
+  - '7.2'
   - 'nightly'
 
 before_script:

phpunit.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 
-<phpunit colors="true" bootstrap="vendor/autoload.php" >
+<phpunit colors="true" bootstrap="tests/autoload.php" >
     <testsuites>
         <testsuite name="php-platform/search-query-params">
             <directory suffix=".php">./tests</directory>

src/SearchQueryParser/Parser.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace ICircle\Accounts\Services\Utils;
+namespace PhpPlatform\SearchQueryParser;
 
 use PhpPlatform\RESTFul\HTTPRequest;
 use PhpPlatform\Errors\Exceptions\Http\_4XX\BadRequest;
@@ -9,7 +9,6 @@
 use PhpPlatform\Persist\Field;
 use PhpPlatform\Errors\Exceptions\Application\BadInputException;
 use PhpPlatform\Persist\RelationalMappingUtil;
-use PhpPlatform\SearchQueryParser\FindParams;
 
 class Parser {
 
@@ -19,8 +18,10 @@ class Parser {
 	 * @param HTTPRequest $request is the HTTPRequest object received in the rest service 
 	 * @param string $modelClassName is the full name of the Model which is served as REST Resource 
 	 * @param string[] $excludeFromFullTextSearch is the array of fields which needs to be excluded from performing full text search 
+	 * 
+	 * @return FindParams
 	 */
-	static public function parse($request,$modelClassName,$excludeFromFullTextSearch){
+	static public function parse($request,$modelClassName,$excludeFromFullTextSearch = array()){
 		$findParams = new FindParams();
 		try{
 			// full text search query
@@ -31,10 +32,13 @@ static public function parse($request,$modelClassName,$excludeFromFullTextSearch
 		}catch (\Exception $e){
 			throw new BadRequest("Bad Search Params");
 		}
-		$findParams;
+		return $findParams;
 	}
 
 	private static function parseFullTextSearch($request,$modelClassName,$excludeFromFullTextSearch){
+		if(!is_array($excludeFromFullTextSearch)){
+			$excludeFromFullTextSearch = array();
+		}
 		$whereExpression = null;
 		$fullTextSearchQuery = $request->getQueryParam('q');
 		if($fullTextSearchQuery != null){
@@ -66,7 +70,7 @@ private static function parseFilters($request,$modelClassName){
 
 			foreach ($classList as $className=>$class){
 				foreach ($class['fields'] as $fieldName=>$field){
-					if(RelationalMappingUtil::_isGet($field) && in_array($fieldName, $fieldSpecificFilters)){
+					if(RelationalMappingUtil::_isGet($field) && array_key_exists($fieldName, $fieldSpecificFilters)){
 						$filterValue = $fieldSpecificFilters[$fieldName];
 						if(is_scalar($filterValue)){
 							$filters[$fieldName]=$filterValue;

tests/SearchQueryParser/Models/M1.php

@@ -0,0 +1,43 @@
+<?php
+namespace PhpPlatform\Tests\SearchQueryParser\Models;
+
+/**
+ * @tableName M1
+ * @prefix m1
+ */
+class M1 {
+	
+	/**
+     * @columnName ID
+     * @type bigint
+     * @primary
+     * @autoIncrement
+     * @get
+     */
+    private $id = null;
+
+    /**
+     * @columnName NAME
+     * @type varchar
+     * @set
+     * @get
+     */
+    private $name = null;
+
+    /**
+     * @columnName USER_NAME
+     * @type varchar
+     * @set
+     * @get
+     */
+    private $userName = null;
+    
+    /**
+     * @columnName PASSWORD
+     * @type varchar
+     * @set
+     */
+    private $password = null;
+	
+	
+}

tests/SearchQueryParser/TestParser.php

@@ -0,0 +1,73 @@
+<?php
+namespace PhpPlatform\Tests\SearchQueryParser;
+
+
+use PhpPlatform\RESTFul\HTTPRequest;
+use PhpPlatform\SearchQueryParser\FindParams;
+use PhpPlatform\SearchQueryParser\Parser;
+
+class TestParser extends \PHPUnit_Framework_TestCase{
+	
+	/**
+	 * @dataProvider parseDataProvider
+	 * 
+	 * @param HTTPRequest|callable $request
+	 * @param string $modelClassName
+	 * @param string[] $excludeFromFullTextSearch
+	 * @param array $expectedFindParams
+	 * @param string $expectedException
+	 */
+	function testParse($request,$modelClassName, $excludeFromFullTextSearch, $expectedFindParams,$expectedException = null){
+		if(is_callable($request)){
+			$request = call_user_func($request);
+		}
+		try{
+			$findParams = Parser::parse($request, $modelClassName, $excludeFromFullTextSearch);
+			
+			$this->assertEquals($expectedFindParams['filters'], $findParams->filters);
+			$this->assertEquals($expectedFindParams['sort'], $findParams->sort);
+			$this->assertEquals($expectedFindParams['pagination'], $findParams->pagination);
+			$this->assertEquals($expectedFindParams['where'], $findParams->where);
+			
+		}catch (\Exception $e){
+			$this->assertEquals($expectedException, $e->getMessage());
+		}
+	}
+	
+	function parseDataProvider(){
+		return [
+			"without any search params"=>[
+				$this->getHttpRequestWithQueryParameters([
+						
+				]),
+				'PhpPlatform\Tests\SearchQueryParser\Models\M1',
+				null,
+				['filters'=>[],'sort'=>[],'pagination'=>null,'where'=>null]
+			],
+			"with filters"=>[
+				$this->getHttpRequestWithQueryParameters([
+					'f'=>base64_encode(json_encode(['name'=>'myName']))
+				]),
+				'PhpPlatform\Tests\SearchQueryParser\Models\M1',
+				null,
+				['filters'=>['name'=>'myName'],'sort'=>[],'pagination'=>null,'where'=>null]
+			]
+		];
+	}
+	
+	/**
+	 * @param string[][] $queryParams
+	 * 
+	 * @return HTTPRequest
+	 */
+	private function getHttpRequestWithQueryParameters($queryParams){
+		
+		$httpRequestStaticInstance = new \ReflectionProperty('PhpPlatform\RESTFul\HTTPRequest', 'instance');
+		$httpRequestStaticInstance->setAccessible(true);
+		$httpRequestStaticInstance->setValue(null, null);
+		
+		$_GET = $queryParams;
+		return HTTPRequest::getInstance();
+	}
+	
+}

tests/autoload.php

@@ -0,0 +1,11 @@
+<?php
+
+include_once dirname(__FILE__).'/../vendor/autoload.php';
+
+// getallheaders method will not be present when running php from shell
+// so mocking this function
+if(!function_exists('getallheaders')){
+	function getallheaders(){
+		return [];
+	}
+}