• Home
• Scalr
• Tests
• Functional
• Api
• V2
• ApiTest

PHP Class Scalr\Tests\Functional\Api\V2\ApiTest

Show file Open project: scalr/scalr Class Usage Examples

Protected Properties

Property	Type	Description
$accountSpec	Scalr\Tests\Functional\Api\V2\SpecSchema\SpecManager	Object generated of Account Api specifications
$adapters	Scalr\Api\DataType\ApiEntityAdapter[]	List of adapters using in test
$checkScope	array	Object where should check scope
$data	array	Test data container for testGetEndpoint()
$dbObjectMapping	array	Mapping api object name and specific which gives an entity this object Key is object name Value is functions name
$defaultAcl	Scalr\Acl\Acl	Default test Acl
$filterPropertyMap	array	Map filterable properties key based on object name in Api definitions
$fullAccessAcl	Scalr\Tests\Fixtures\Api\V2\Acl\ApiTestAcl
$ignoreCheckRules	array	List of objects where should ignore check filterable properties
$maxResults	false | integer	Max response results
$noAccessAcl	PHPUnit_Framework_MockObject_MockObject
$paramMap	array	Mapping params in path definitions and response objects
$pathMap	array	Map save structure if object need other data structure key based on object name in Api definitions
$propertyAssertMap	array	Mapping specifics assert for properties Key is property name Value is functions name
$readOnlyAccessAcl	Scalr\Tests\Fixtures\Api\V2\Acl\ApiTestAcl
$simpleFilterRules
$testData	array	Ids of data generated during the test Destructor clean up data by these ids
$testUserType	string	Default user type
$userSpec	Scalr\Tests\Functional\Api\V2\SpecSchema\SpecManager	Object generated of User Api specifications

Public Methods

Method	Description
__construct ( $name = null, $data = [], $dataName = null )
assertBuiltinAutomation ( array $filterValue, array $property, string $message )	Custom assert BuiltinAutomation property
assertFilterableProperties ( string $url, ListResponse $apiResp, string $saveDataPath = null )	Assert and check unique filterable properties from requested url
assertGetEndpoint ( string $uri, ListResponse $apiResp, array $filters = [], boolean $collect = true, null | integer $maxResults = null ) : array	Return list of Objects available in this account or environment
assertTeams ( object $team, object[] $teams, string $message )	Reports an error if specified team is not present in the list of teams of the Farm obtained by filtration
checkAdapterRules ( ObjectEntity $objectEntity, array $rules )	Check adapter rules
dataApiProvider ( ) : array	Data provider for testApi()
dataGetEndpointProvider ( ) : array[]	Data provider for testGetEndpoint()
getAdapter ( string $class, ApiController $controller = null ) : ApiEntityAdapter	Gets API entity adapter
getEnvironmentEntity ( integer $envId ) : Environment	Gets Environment entity
getFilter ( string $class = null, string $property = null, array $values = [] ) : FilterRule	Makes the filtering rule for the specified properties of an object
getFixturesDirectory ( )
getGlobalVariable ( string $criteria, array $params ) : array	Get GV
setUpBeforeClass ( )	Add test environment, test Acl, setups test user, environment and API key
tearDownAfterClass ( )	Removes API key generated for test
testApi ( string $path, string | Exceptio\Exception $type, string $adapter, string $aclType, string $userType, string $method, integer $responseCode, array $params, array $filterable, array $body )	Test for Api endpoints Data provider prepares data for Api request SpecFile get responses definition from api specifications for each endpoint ResponseBodyConstraint compares Api definition with request
testGetEndpoint ( string $path, string $type )	Test for base user and account Api GET endpoints

Protected Methods

Method	Description
getDbObject ( string $objectName, string $criteria, string $entityClass, array $params ) : mixed	Get db object
getEnvironmentTeam ( string $criteria, array $params ) : TeamEnvs	Gets TeamEnvs entity
getFarmRoleScalingMetrics ( string $criteria, array $params = [] ) : FarmRoleScalingMetric	Get FarmRoleScalingMetric entity
getScalingMetric ( string $criteria ) : ScalingMetric	Get ScalingMetric entity
getScriptVersion ( string $criteria, array $params ) : Scalr\Model\Entity\ScriptVersion	Gets ScriptVersion entity
mapApiResponsePk ( string $path, string $objectName ) : string	On the based api endpoint and name api object return primary key If pk don't exist in paramMath throw fail
mapPath ( string $path, string $type ) : Generator	Generate url with api endpoint and saved data
matchApiUrl ( string $path, array $params = [] ) : string	Match API url params
saveUrlData ( string $url, stdClass $object, string $nameEntity )	Save data for x-usedIn endpoints
setTestAcl ( string $acl )	Set mock acl for test
setUp ( )
setUserType ( string $type )	Set user types for test Some endpoints need extra credentials
tearDown ( )

Method Details

Property Details