composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-22 10:08:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Advanced Search: Smart conversion

Browse Source 
SVN:b1162[5413]
This commit is contained in:
Eric Espié
2018-03-13 11:15:29 +00:00
parent e2174b9ad4
commit 6d13dac2c3
4 changed files with 316 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
sources/application/search/criterionconversion/criteriontosearchform.class.inc.php
View File

@@ -54,6 +54,11 @@ class CriterionToSearchForm extends CriterionConversionAbstract
}
}
// Regroup criterion by variable name
usort($aAndCriterion, function ($a, $b) {
return strcmp($a['ref'], $b['ref']);
});
return $aAndCriterion;
}

2
sources/application/search/searchform.class.inc.php
View File

@@ -251,7 +251,7 @@ class SearchForm
}
/**
* @param DBObjectSearch $oSearch
* @param \DBSearch $oSearch
*/
public function GetCriterion($oSearch)
{

574
test/application/search/CriterionConversionTest.php
View File

@@ -1,284 +1,290 @@
<?php
/**
* Copyright (C) 2010-2018 Combodo SARL
*
* This file is part of iTop.
*
* iTop is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* iTop is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with iTop. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Created by PhpStorm.
* User: Eric
* Date: 08/03/2018
* Time: 16:46
*/
namespace Combodo\iTop\Test\UnitTest\Application\Search;
use Combodo\iTop\Application\Search\CriterionConversion\CriterionToOQL;
use Combodo\iTop\Application\Search\CriterionConversion\CriterionToSearchForm;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
class CriterionConversionTest extends ItopDataTestCase
{
/**
* @throws Exception
*/
protected function setUp()
{
parent::setUp();
require_once(APPROOT."sources/application/search/criterionconversionabstract.class.inc.php");
}
/**
* @dataProvider ToOqlProvider
*/
public function testToOql($sJSONCriterion, $sExpectedOQL)
{
$sOql = CriterionToOQL::Convert(
json_decode($sJSONCriterion, true)
);
$this->debug($sOql);
$this->assertEquals($sExpectedOQL, $sOql);
}
public function ToOqlProvider()
{
return array(
'>' => array(
'{
"ref": "UserRequest.start_date",
"values": [
{
"value": "2017-01-01",
"label": "2017-01-01 00:00:00"
}
],
"operator": ">",
"oql": ""
}',
"(`UserRequest`.`start_date` > '2017-01-01')"
),
'contains' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "contains",
"oql": ""
}',
"(`Contact`.`name` LIKE '%toto%')"
),
'starts_with' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "starts_with",
"oql": ""
}',
"(`Contact`.`name` LIKE 'toto%')"
),
'ends_with' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "ends_with",
"oql": ""
}',
"(`Contact`.`name` LIKE '%toto')"
),
'empty' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "empty",
"oql": ""
}',
"(`Contact`.`name` = '')"
),
'not_empty' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "not_empty",
"oql": ""
}',
"(`Contact`.`name` != '')"
),
);
}
/**
* @dataProvider ToSearchFormProvider
*/
function testToSearchForm($aCriterion, $sExpectedOperator)
{
$aRes = CriterionToSearchForm::Convert($aCriterion);
$this->debug($aRes);
$this->assertEquals($sExpectedOperator, $aRes[0]['operator']);
}
function ToSearchFormProvider()
{
return array(
'=' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "=",
"oql": "(`Contact`.`name` = \'toto\')"
}
]', true),
'='
),
'starts_with' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "toto%",
"label": "toto%"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'toto%\')"
}
]', true),
'starts_with'
),
'ends_with' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "%toto",
"label": "%toto"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'%toto\')"
}
]', true),
'ends_with'
),
'contains' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "%toto%",
"label": "%toto%"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'%toto%\')"
}
]', true),
'contains'
),
'empty1' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'\')"
}
]', true),
'empty'
),
'empty2' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "=",
"oql": "(`Contact`.`name` = \'\')"
}
]', true),
'empty'
),
'not_empty' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "!=",
"oql": "(`Contact`.`name` != \'\')"
}
]', true),
'not_empty'
),
);
}
}
<?php
/**
* Copyright (C) 2010-2018 Combodo SARL
*
* This file is part of iTop.
*
* iTop is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* iTop is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with iTop. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Created by PhpStorm.
* User: Eric
* Date: 08/03/2018
* Time: 16:46
*/
namespace Combodo\iTop\Test\UnitTest\Application\Search;
use Combodo\iTop\Application\Search\CriterionConversion\CriterionToOQL;
use Combodo\iTop\Application\Search\CriterionConversion\CriterionToSearchForm;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
class CriterionConversionTest extends ItopDataTestCase
{
/**
* @throws \Exception
*/
protected function setUp()
{
parent::setUp();
require_once(APPROOT."sources/application/search/criterionconversionabstract.class.inc.php");
}
/**
* @dataProvider ToOqlProvider
*
* @param $sJSONCriterion
* @param $sExpectedOQL
*/
public function testToOql($sJSONCriterion, $sExpectedOQL)
{
$sOql = CriterionToOQL::Convert(
json_decode($sJSONCriterion, true)
);
$this->debug($sOql);
$this->assertEquals($sExpectedOQL, $sOql);
}
public function ToOqlProvider()
{
return array(
'>' => array(
'{
"ref": "UserRequest.start_date",
"values": [
{
"value": "2017-01-01",
"label": "2017-01-01 00:00:00"
}
],
"operator": ">",
"oql": ""
}',
"(`UserRequest`.`start_date` > '2017-01-01')"
),
'contains' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "contains",
"oql": ""
}',
"(`Contact`.`name` LIKE '%toto%')"
),
'starts_with' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "starts_with",
"oql": ""
}',
"(`Contact`.`name` LIKE 'toto%')"
),
'ends_with' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "ends_with",
"oql": ""
}',
"(`Contact`.`name` LIKE '%toto')"
),
'empty' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "empty",
"oql": ""
}',
"(`Contact`.`name` = '')"
),
'not_empty' => array(
'{
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "not_empty",
"oql": ""
}',
"(`Contact`.`name` != '')"
),
);
}
/**
* @dataProvider ToSearchFormProvider
*
* @param $aCriterion
* @param $sExpectedOperator
*/
function testToSearchForm($aCriterion, $sExpectedOperator)
{
$aRes = CriterionToSearchForm::Convert($aCriterion);
$this->debug($aRes);
$this->assertEquals($sExpectedOperator, $aRes[0]['operator']);
}
function ToSearchFormProvider()
{
return array(
'=' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "toto",
"label": "toto"
}
],
"operator": "=",
"oql": "(`Contact`.`name` = \'toto\')"
}
]', true),
'='
),
'starts_with' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "toto%",
"label": "toto%"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'toto%\')"
}
]', true),
'starts_with'
),
'ends_with' => array(
json_decode('[
{
"ref": "Contact.name",
"widget": "string",
"values": [
{
"value": "%toto",
"label": "%toto"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'%toto\')"
}
]', true),
'ends_with'
),
'contains' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "%toto%",
"label": "%toto%"
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'%toto%\')"
}
]', true),
'contains'
),
'empty1' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "LIKE",
"oql": "(`Contact`.`name` LIKE \'\')"
}
]', true),
'empty'
),
'empty2' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "=",
"oql": "(`Contact`.`name` = \'\')"
}
]', true),
'empty'
),
'not_empty' => array(
json_decode('[
{
"widget": "string",
"ref": "Contact.name",
"values": [
{
"value": "",
"label": ""
}
],
"operator": "!=",
"oql": "(`Contact`.`name` != \'\')"
}
]', true),
'not_empty'
),
);
}
}

25
test/application/search/SearchFormTest.php
View File

@@ -40,25 +40,39 @@ class SearchFormTest extends ItopDataTestCase
}
/**
* @throws \OQLException
*/
public function testGetFields()
{
$aFields = SearchForm::GetFields('Contact', 'Contact');
$oSearchForm = new SearchForm();
$aFields = $oSearchForm->GetFields('Contact', 'Contact');
$this->debug(json_encode($aFields, JSON_PRETTY_PRINT));
$this->assertCount(7, $aFields);
$this->assertCount(7, $aFields['zlist']);
$oSearch = \DBSearch::FromOQL("SELECT Contact AS C WHERE C.status = 'active'");
$aFields = SearchForm::GetFields($oSearch->GetClass(), $oSearch->GetClassAlias());
$aFields = $oSearchForm->GetFields($oSearch->GetClass(), $oSearch->GetClassAlias());
$this->debug(json_encode($aFields, JSON_PRETTY_PRINT));
}
/**
* @dataProvider GetCriterionProvider
* @throws \OQLException
*
* @param $sOQL
* @param $iOrCount
*
*/
public function testGetCriterion($sOQL, $iOrCount)
{
$aCriterion = SearchForm::GetCriterion(\DBObjectSearch::FromOQL($sOQL));
$oSearchForm = new SearchForm();
try
{
$aCriterion = $oSearchForm->GetCriterion(\DBSearch::FromOQL($sOQL));
} catch (\OQLException $e)
{
$this->assertTrue(false);
return;
}
$aRes = array('base_oql' => $sOQL, 'criterion' => $aCriterion);
$this->debug(json_encode($aRes));
$this->debug($sOQL);
@@ -78,6 +92,7 @@ class SearchFormTest extends ItopDataTestCase
array('OQL' => "SELECT Contact WHERE status = 'active' OR name LIKE 'toto%'", 2),
array('OQL' => "SELECT UserRequest WHERE DATE_SUB(NOW(), INTERVAL 14 DAY) < start_date", 1),
array('OQL' => "SELECT UserRequest WHERE start_date > '2017-01-01' AND '2018-01-01' >= start_date", 1),
array('OQL' => "SELECT UserRequest WHERE start_date > '2017-01-01' AND status = 'active' AND org_id = 3 AND '2018-01-01' >= start_date", 1),
);
}
}