archive/salesagility_SuiteCRM
0
0
Fork 0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2024-12-27 22:47:48 +00:00
Code Issues Projects Releases Wiki Activity
master
salesagility_SuiteCRM/tests/api/v8/ModulesMetaCest.php
Clemente Raposo ceb55e18b5 Run rector on tests folder
2023-07-18 15:53:47 +01:00

493 lines
18 KiB
PHP
Raw Permalink Blame History

<?php
/**
* Class ModulesMetaCest
* Tests /api/v8/modules API
* @see https://tools.ietf.org/html/rfc7519
*/
#[\AllowDynamicProperties]
class ModulesMetaCest
{
public const RESOURCE = '/api/v8/modules/Accounts';
private static $RECORD = '11111111-1111-1111-1111-111111111111';
private static $RECORD_TYPE = 'Accounts';
private static $FAVORITE_RESOURCE = '/api/v8/modules/Favorites';
private static $ALL_FAVORITE_RESOURCE = '/api/v8/modules/favorites';
/** @var Faker\Generator $fakeData */
protected $fakeData;
/** @var integer $fakeDataSeed */
protected $fakeDataSeed;
/**
* @param AcceptanceTester $I
*/
public function _before(AcceptanceTester $I)
{
if (!$this->fakeData) {
$this->fakeData = Faker\Factory::create();
$this->fakeDataSeed = mt_rand(0, 2048);
}
$this->fakeData->seed($this->fakeDataSeed);
}
/**
* Get list of modules
* @param ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-meta
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/language
*
*/
public function TestScenarioGetModuleMetaLanguages(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$url = $I->getInstanceURL() . self::RESOURCE . '/meta/language';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('Accounts', $decodedResponse['meta']);
$I->assertArrayHasKey('language', $decodedResponse['meta']['Accounts']);
$I->assertNotEmpty($decodedResponse['meta']['Accounts']['language']);
}
/**
* Get list of fields/attributes of a given module
* @param ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-meta
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/attributes
*
*/
public function TestScenarioGetModuleMetaAttributes(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$url = $I->getInstanceURL() . self::RESOURCE . '/meta/attributes';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$I->seeJsonApiContentNegotiation();
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('Accounts', $decodedResponse['meta']);
$I->assertArrayHasKey('attributes', $decodedResponse['meta']['Accounts']);
$I->assertNotEmpty($decodedResponse['meta']['Accounts']['attributes']);
}
/**
* Get menu metadata of a given module
* @param ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-meta
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/menu
*
*/
public function TestScenarioGetModuleMetaMenu(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$url = $I->getInstanceURL() . self::RESOURCE . '/meta/menu';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('Accounts', $decodedResponse['meta']);
$I->assertArrayHasKey('menu', $decodedResponse['meta']['Accounts']);
$I->assertNotEmpty($decodedResponse['meta']['Accounts']['menu']);
$I->assertArrayHasKey(0, $decodedResponse['meta']['Accounts']['menu']);
$I->assertArrayHasKey('href', $decodedResponse['meta']['Accounts']['menu'][0]);
$I->assertArrayHasKey('label', $decodedResponse['meta']['Accounts']['menu'][0]);
$I->assertArrayHasKey('action', $decodedResponse['meta']['Accounts']['menu'][0]);
$I->assertArrayHasKey('module', $decodedResponse['meta']['Accounts']['menu'][0]);
$I->assertArrayHasKey('query', $decodedResponse['meta']['Accounts']['menu'][0]);
$I->assertArrayHasKey('module', $decodedResponse['meta']['Accounts']['menu'][0]['query']);
$I->assertArrayHasKey('action', $decodedResponse['meta']['Accounts']['menu'][0]['query']);
$I->assertArrayHasKey('return_module', $decodedResponse['meta']['Accounts']['menu'][0]['query']);
$I->assertArrayHasKey('return_action', $decodedResponse['meta']['Accounts']['menu'][0]['query']);
}
/**
* Get layout metadata of module view
* @param ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-meta
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/view/{view}
* @see \MBConstants for posible {view} values
*/
public function TestScenarioGetMetaLayout(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
// Edit View
$url = $I->getInstanceURL() . self::RESOURCE . '/meta/view/editview';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('Accounts', $decodedResponse['meta']);
$I->assertArrayHasKey('view', $decodedResponse['meta']['Accounts']);
$I->assertArrayHasKey('editview', $decodedResponse['meta']['Accounts']['view']);
}
/**
* Get the current user's favorites for a single module
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-meta
*
* HTTP Verb: GET
* URL: /api/v8/modules/{module}/favorites
* @see global $moduleList for posible {module} values
*/
public function TestScenarioGetModuleFavorites(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
// Create account
$I->comment('Create Account');
$url = $I->getInstanceURL() . self::RESOURCE;
$accountName = 'Test'. $this->fakeData->name();
$I->sendPost(
$url,
array(
'data' => array(
'id' => '',
'type' => 'Accounts',
'attributes' => array(
'name' => $accountName
)
)
)
);
$I->seeResponseCodeIs(201);
$I->seeJsonApiContentNegotiation();
$response = json_decode((string) $I->grabResponse(), true, 512, JSON_THROW_ON_ERROR);
$I->assertArrayHasKey('data', $response);
$I->assertArrayHasKey('type', $response['data']);
$I->assertArrayHasKey('id', $response['data']);
self::$RECORD = $response['data']['id'];
// Create Favorite
$I->comment('Create Favorite');
$url = $I->getInstanceURL() . self::$FAVORITE_RESOURCE;
$I->sendPost(
$url,
array(
'data' => array(
'id' => '',
'type' => 'Favorites',
'attributes' => array(
'name' => 'Accounts ' . self::$RECORD,
'assigned_user_id' => 1,
'assigned_user_name' => 'admin',
'parent_id' => self::$RECORD,
'parent_type'=> 'Accounts'
)
)
)
);
$I->seeResponseCodeIs(201);
$I->seeJsonApiContentNegotiation();
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
$I->assertArrayHasKey('attributes', $decodedResponse['data']);
$I->assertArrayHasKey('assigned_user_id', $decodedResponse['data']['attributes']);
$I->assertEquals('1', (string) $decodedResponse['data']['attributes']['assigned_user_id']);
// Get Favorite
$I->comment('Get Favorite');
$url = $I->getInstanceURL() . self::RESOURCE . '/favorites';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
if (isset($decodedResponse['data'][0])) {
// response has many results
$I->assertArrayHasKey('type', $decodedResponse['data'][0]);
$I->assertEquals('Accounts', $decodedResponse['data'][0]['type']);
$I->assertArrayHasKey('id', $decodedResponse['data'][0]);
} else {
$I->assertArrayHasKey('type', $decodedResponse['data']);
$I->assertEquals('Accounts', $decodedResponse['data']['type']);
$I->assertArrayHasKey('id', $decodedResponse['data']);
$I->assertEquals(self::$RECORD, $decodedResponse['data']['id']);
}
}
/**
* Get the current user's favorite records for all modules
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-compound-documents
*
* HTTP Verb: GET
* URL: /api/v8/modules/favorites
* @see global $moduleList for posible {module} values
*/
public function TestScenarioGetAllModulesFavorites(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
// Create account
$I->comment('Create Account');
$url = $I->getInstanceURL() . self::RESOURCE;
$accountName = 'Test'. $this->fakeData->name();
$I->sendPost(
$url,
array(
'data' => array(
'id' => '',
'type' => 'Accounts',
'attributes' => array(
'name' => $accountName
)
)
)
);
$I->seeResponseCodeIs(201);
$I->seeJsonApiContentNegotiation();
$response = json_decode((string) $I->grabResponse(), true, 512, JSON_THROW_ON_ERROR);
$I->assertArrayHasKey('data', $response);
$I->assertArrayHasKey('type', $response['data']);
$I->assertArrayHasKey('id', $response['data']);
self::$RECORD = $response['data']['id'];
// Create Favorite
$I->comment('Create Favorite');
$url = $I->getInstanceURL() . self::$FAVORITE_RESOURCE;
$I->sendPost(
$url,
array(
'data' => array(
'id' => '',
'type' => 'Favorites',
'attributes' => array(
'name' => 'Accounts ' . self::$RECORD,
'assigned_user_id' => 1,
'assigned_user_name' => 'admin',
'parent_id' => self::$RECORD,
'parent_type'=> 'Accounts'
)
)
)
);
$I->seeResponseCodeIs(201);
$I->seeJsonApiContentNegotiation();
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
$I->assertArrayHasKey('attributes', $decodedResponse['data']);
$I->assertArrayHasKey('assigned_user_id', $decodedResponse['data']['attributes']);
$I->assertEquals('1', (string) $decodedResponse['data']['attributes']['assigned_user_id']);
// Get Favorite
$I->comment('Get Favorite');
$url = $I->getInstanceURL() . self::$ALL_FAVORITE_RESOURCE;
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
$I->assertArrayHasKey('included', $decodedResponse);
if (isset($decodedResponse['included'][0])) {
// response has many results
$I->assertArrayHasKey('type', $decodedResponse['included'][0]);
$I->assertArrayHasKey('id', $decodedResponse['included'][0]);
} else {
$I->assertArrayHasKey('type', $decodedResponse['included']);
$I->assertArrayHasKey('id', $decodedResponse['included']);
}
}
/**
* Get the current user recently viewed records for all modules
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-compound-documents
*
* HTTP Verb: GET
* URL: /api/v8/modules/viewed
*/
public function TestScenarioGetModuleRecentlyViewed(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$I->comment('Get Recently Viewed');
$url = $I->getInstanceURL() . '/api/v8/modules/Accounts/viewed';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
$I->assertArrayHasKey('included', $decodedResponse);
if (isset($decodedResponse['included'][0])) {
// response has many results
$I->assertArrayHasKey('type', $decodedResponse['included'][0]);
$I->assertArrayHasKey('id', $decodedResponse['included'][0]);
} elseif (empty($decodedResponse['included'])) {
$I->comment('There are not recently viewed items');
} else {
$I->assertArrayHasKey('type', $decodedResponse['included']);
$I->assertArrayHasKey('id', $decodedResponse['included']);
}
}
/**
* Get the current user recently viewed records for all modules
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-compound-documents
*
* HTTP Verb: GET
* URL: /api/v8/modules/viewed
*/
public function TestScenarioGetAllModulesRecentlyViewed(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$I->comment('Get Recently Viewed');
$url = $I->getInstanceURL() . '/api/v8/modules/viewed';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('data', $decodedResponse);
$I->assertArrayHasKey('included', $decodedResponse);
if (isset($decodedResponse['included'][0])) {
// response has many results
$I->assertArrayHasKey('type', $decodedResponse['included'][0]);
$I->assertArrayHasKey('id', $decodedResponse['included'][0]);
} elseif (empty($decodedResponse['included'])) {
$I->comment('There are not recently viewed items');
} else {
$I->assertArrayHasKey('type', $decodedResponse['included']);
$I->assertArrayHasKey('id', $decodedResponse['included']);
}
}
/**
* Get the module filters
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-compound-documents
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/filters
*/
public function TestScenarioModuleFilters(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$I->comment('Get emnu filters');
$url = $I->getInstanceURL() . '/api/v8/modules/meta/menu/filters';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('menu', $decodedResponse['meta']);
$I->assertArrayHasKey('filters', $decodedResponse['meta']['menu']);
$I->assertArrayHasKey('all', $decodedResponse['meta']['menu']['filters']);
$I->assertArrayHasKey('tabs', $decodedResponse['meta']['menu']['filters']);
}
/**
* Get the module menus
* @param \ApiTester $I
* @see http://jsonapi.org/format/1.0/#document-compound-documents
*
* HTTP Verb: GET
* URL: /api/v8/modules/meta/filters
*/
public function TestScenarioModuleMenus(ApiTester $I)
{
$I->loginAsAdmin();
$I->sendJwtAuthorisation();
$I->sendJsonApiContentNegotiation();
$I->comment('Get emnu filters');
$url = $I->getInstanceURL() . '/api/v8/modules/meta/menu/modules';
$I->sendGET($url);
$I->seeResponseCodeIs(200);
$response = $I->grabResponse();
$decodedResponse = json_decode((string) $response, true, 512, JSON_THROW_ON_ERROR);
$I->assertNotEmpty($decodedResponse);
$I->assertArrayHasKey('meta', $decodedResponse);
$I->assertArrayHasKey('menu', $decodedResponse['meta']);
$I->assertArrayHasKey('modules', $decodedResponse['meta']['menu']);
$I->assertArrayHasKey('all', $decodedResponse['meta']['menu']['modules']);
}
}
Reference in New Issue View Git Blame Copy Permalink