composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/support/3.0' into develop

Browse Source 
# Conflicts:
#	tests/php-unit-tests/unitary-tests/webservices/RestTest.php
This commit is contained in:
Molkobain
2023-04-18 22:37:59 +02:00
parent 60ae3621c5 778118cfb4
commit 6fbe66d2ec
2 changed files with 45 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
tests/php-unit-tests/unitary-tests/webservices/RestTest.php
View File

@@ -4,6 +4,8 @@ namespace Combodo\iTop\Test\UnitTest\Webservices;
use Combodo\iTop\Test\UnitTest\ItopDataTestCase; use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
use Exception; use Exception;
use MetaModel;
use utils;
/** /**
@@ -19,14 +21,16 @@ class RestTest extends ItopDataTestCase
{ {
const USE_TRANSACTION = false; const USE_TRANSACTION = false;
const MODE = [ 'JSONDATA_AS_STRING' => 0, 'JSONDATA_AS_FILE' => 1 , 'NO_JSONDATA' => 2 ]; const ENUM_JSONDATA_AS_STRING = 0;
const ENUM_JSONDATA_AS_FILE = 1;
const ENUM_JSONDATA_NONE = 2;
private $sTmpFile = ""; private $sTmpFile = "";
private $sUrl; private $sUrl;
private $sLogin; private $sLogin;
private $sPassword = "Iuytrez9876543ç_è-("; private $sPassword = "Iuytrez9876543ç_è-(";
/** @var int $iJsonDataMode */ /** @var int $iJsonDataMode */
private int $iJsonDataMode; private int $iJsonDataMode = self::ENUM_JSONDATA_AS_STRING;
/** /**
* @throws Exception * @throws Exception
@@ -42,10 +46,10 @@ class RestTest extends ItopDataTestCase
unlink($this->sTmpFile); unlink($this->sTmpFile);
} }
$this->sUrl = \MetaModel::GetConfig()->Get('app_root_url'); $this->sUrl = MetaModel::GetConfig()->Get('app_root_url');
$oRestProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'REST Services User'), true); $oRestProfile = MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'REST Services User'), true);
$oAdminProfile = \MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'Administrator'), true); $oAdminProfile = MetaModel::GetObjectFromOQL("SELECT URP_Profiles WHERE name = :name", array('name' => 'Administrator'), true);
if (is_object($oRestProfile) && is_object($oAdminProfile)) { if (is_object($oRestProfile) && is_object($oAdminProfile)) {
$oUser = $this->CreateUser($this->sLogin, $oRestProfile->GetKey(), $this->sPassword); $oUser = $this->CreateUser($this->sLogin, $oRestProfile->GetKey(), $this->sPassword);
@@ -53,6 +57,28 @@ class RestTest extends ItopDataTestCase
} }
} }
public function testJSONPCallback()
{
$sCallbackName = 'fooCallback';
$sJsonData = <<<JSON
{
"operation": "list_operations"
}
JSON;
// Test regular JSON result
$sJSONResult = $this->CallRestApi($sJsonData);
// - Try to decode JSON to array to check if it is well-formed
$aJSONResultAsArray = json_decode($sJSONResult, true);
if (false === is_array($aJSONResultAsArray)) {
$this->fail('JSON result could not be decoded as array, it might be malformed');
}
// Test JSONP with callback by checking that it is the same as the regular JSON but within the JS callback
$sJSONPResult = $this->CallRestApi($sJsonData, $sCallbackName);
$this->assertEquals($sCallbackName.'('.$sJSONResult.');', $sJSONPResult, 'JSONP response callback does not match expected result');
}
/** /**
* @dataProvider BasicProvider * @dataProvider BasicProvider
* @param int $iJsonDataMode * @param int $iJsonDataMode
@@ -68,7 +94,7 @@ class RestTest extends ItopDataTestCase
$aJson = json_decode($sOutputJson, true); $aJson = json_decode($sOutputJson, true);
$this->assertNotNull($aJson, "Cannot decode returned JSON : $sOutputJson"); $this->assertNotNull($aJson, "Cannot decode returned JSON : $sOutputJson");
if ($this->iJsonDataMode === self::MODE['NO_JSONDATA']){ if ($this->iJsonDataMode === static::ENUM_JSONDATA_NONE){
$this->assertStringContainsString("3", "".$aJson['code'], $sOutputJson); $this->assertStringContainsString("3", "".$aJson['code'], $sOutputJson);
$this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOutputJson); $this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOutputJson);
return; return;
@@ -124,7 +150,7 @@ JSON;
$aJson = json_decode($sOuputJson, true); $aJson = json_decode($sOuputJson, true);
$this->assertNotNull($aJson, 'json_decode() on the REST API response returned null :('); $this->assertNotNull($aJson, 'json_decode() on the REST API response returned null :(');
if ($this->iJsonDataMode === self::MODE['NO_JSONDATA']){ if ($this->iJsonDataMode === static::ENUM_JSONDATA_NONE){
$this->assertStringContainsString("3", "".$aJson['code'], $sOuputJson); $this->assertStringContainsString("3", "".$aJson['code'], $sOuputJson);
$this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOuputJson); $this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOuputJson);
return; return;
@@ -165,7 +191,7 @@ JSON;
$aJson = json_decode($sOuputJson, true); $aJson = json_decode($sOuputJson, true);
$this->assertNotNull($aJson, 'json_decode() on the REST API response returned null :('); $this->assertNotNull($aJson, 'json_decode() on the REST API response returned null :(');
if ($this->iJsonDataMode === self::MODE['NO_JSONDATA']){ if ($this->iJsonDataMode === static::ENUM_JSONDATA_NONE){
$this->assertStringContainsString("3", "".$aJson['code'], $sOuputJson); $this->assertStringContainsString("3", "".$aJson['code'], $sOuputJson);
$this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOuputJson); $this->assertStringContainsString("Error: Missing parameter 'json_data'", "".$aJson['message'], $sOuputJson);
return; return;
@@ -203,9 +229,9 @@ JSON;
public function BasicProvider(){ public function BasicProvider(){
return [ return [
'call rest call' => [ 'sJsonDataMode' => self::MODE['JSONDATA_AS_STRING']], 'call rest call' => [ 'sJsonDataMode' => static::ENUM_JSONDATA_AS_STRING],
'pass json_data as file' => [ 'sJsonDataMode' => self::MODE['JSONDATA_AS_FILE']], 'pass json_data as file' => [ 'sJsonDataMode' => static::ENUM_JSONDATA_AS_FILE],
'no json data' => [ 'sJsonDataMode' => self::MODE['NO_JSONDATA']] 'no json data' => [ 'sJsonDataMode' => static::ENUM_JSONDATA_NONE]
]; ];
} }
@@ -251,7 +277,7 @@ JSON;
} }
private function CallRestApi($sJsonDataContent){ private function CallRestApi(string $sJsonDataContent, string $sCallbackName = null){
$ch = curl_init(); $ch = curl_init();
$aPostFields = [ $aPostFields = [
'version' => '1.3', 'version' => '1.3',
@@ -259,16 +285,20 @@ JSON;
'auth_pwd' => $this->sPassword, 'auth_pwd' => $this->sPassword,
]; ];
if ($this->iJsonDataMode === self::MODE['JSONDATA_AS_STRING']){ if ($this->iJsonDataMode === static::ENUM_JSONDATA_AS_STRING) {
$this->sTmpFile = tempnam(sys_get_temp_dir(), 'jsondata_'); $this->sTmpFile = tempnam(sys_get_temp_dir(), 'jsondata_');
file_put_contents($this->sTmpFile, $sJsonDataContent); file_put_contents($this->sTmpFile, $sJsonDataContent);
$oCurlFile = curl_file_create($this->sTmpFile); $oCurlFile = curl_file_create($this->sTmpFile);
$aPostFields['json_data'] = $oCurlFile; $aPostFields['json_data'] = $oCurlFile;
}else if ($this->iJsonDataMode === self::MODE['JSONDATA_AS_FILE']){ } else if ($this->iJsonDataMode === static::ENUM_JSONDATA_AS_FILE) {
$aPostFields['json_data'] = $sJsonDataContent; $aPostFields['json_data'] = $sJsonDataContent;
} }
if (utils::IsNotNullOrEmptyString($sCallbackName)) {
$aPostFields['callback'] = $sCallbackName;
}
curl_setopt($ch, CURLOPT_URL, "$this->sUrl/webservices/rest.php"); curl_setopt($ch, CURLOPT_URL, "$this->sUrl/webservices/rest.php");
curl_setopt($ch, CURLOPT_POST, 1);// set post data to true curl_setopt($ch, CURLOPT_POST, 1);// set post data to true
curl_setopt($ch, CURLOPT_POSTFIELDS, $aPostFields); curl_setopt($ch, CURLOPT_POSTFIELDS, $aPostFields);

2
webservices/rest.php
View File

@@ -260,7 +260,6 @@ $sCallback = utils::ReadParam('callback', null);
if ($sCallback == null) if ($sCallback == null)
{ {
$oP = new JsonPage(); $oP = new JsonPage();
$oP->SetOutputDataOnly(true);
} }
else else
{ {
@@ -268,6 +267,7 @@ else
} }
$oP->add_header('Access-Control-Allow-Origin: *'); $oP->add_header('Access-Control-Allow-Origin: *');
$oP->SetData(json_decode($sResponse, true)); $oP->SetData(json_decode($sResponse, true));
$oP->SetOutputDataOnly(true);
$oP->Output(); $oP->Output();
// Log usage // Log usage