PHP 클래스 Scalr\Tests\Functional\Api\V2\ApiTest

부터: 5.11 (03.12.2015)
저자: Andrii Penchuk ([email protected])
파일 보기 프로젝트 열기: scalr/scalr 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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

공개 메소드들

메소드 설명
__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

보호된 메소드들

메소드 설명
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 ( )

메소드 상세

__construct() 공개 메소드

또한 보기: ApiTestCase::setUpBeforeClass()
public __construct ( $name = null, $data = [], $dataName = null )

assertBuiltinAutomation() 공개 메소드

Custom assert BuiltinAutomation property
public assertBuiltinAutomation ( array $filterValue, array $property, string $message )
$filterValue array Filter value property
$property array Object property
$message string Assert message

assertFilterableProperties() 공개 메소드

Assert and check unique filterable properties from requested url
public assertFilterableProperties ( string $url, ListResponse $apiResp, string $saveDataPath = null )
$url string Request uri
$apiResp Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\ListResponse Schema current object generated of api specification
$saveDataPath string Save url for child endpoints

assertGetEndpoint() 공개 메소드

Return list of Objects available in this account or environment
public assertGetEndpoint ( string $uri, ListResponse $apiResp, array $filters = [], boolean $collect = true, null | integer $maxResults = null ) : array
$uri string Request uri
$apiResp Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\ListResponse schema current object generated of api specification
$filters array optional Filterable properties
$collect boolean optional Collect response data
$maxResults null | integer optional max list results
리턴 array

assertTeams() 공개 메소드

Reports an error if specified team is not present in the list of teams of the Farm obtained by filtration
public assertTeams ( object $team, object[] $teams, string $message )
$team object Filter value
$teams object[] Filtering property of the object obtained by filtration
$message string optional Message in case of error

checkAdapterRules() 공개 메소드

Check adapter rules
public checkAdapterRules ( ObjectEntity $objectEntity, array $rules )
$objectEntity Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\ObjectEntity api object entity generated form specs
$rules array list of rules

dataApiProvider() 공개 메소드

Data provider for testApi()
public dataApiProvider ( ) : array
리턴 array

dataGetEndpointProvider() 공개 메소드

Data provider for testGetEndpoint()
public dataGetEndpointProvider ( ) : array[]
리턴 array[]

getAdapter() 공개 메소드

Gets API entity adapter
public getAdapter ( string $class, ApiController $controller = null ) : ApiEntityAdapter
$class string Adapter class
$controller Scalr\Api\Rest\Controller\ApiController optional API Controller
리턴 Scalr\Api\DataType\ApiEntityAdapter

getDbObject() 보호된 메소드

Get db object
protected getDbObject ( string $objectName, string $criteria, string $entityClass, array $params ) : mixed
$objectName string api object name
$criteria string search criteria
$entityClass string
$params array array params
리턴 mixed

getEnvironmentEntity() 공개 메소드

Gets Environment entity
public getEnvironmentEntity ( integer $envId ) : Environment
$envId integer environment identifier
리턴 Scalr\Model\Entity\Account\Environment

getEnvironmentTeam() 보호된 메소드

Gets TeamEnvs entity
protected getEnvironmentTeam ( string $criteria, array $params ) : TeamEnvs
$criteria string search criteria
$params array query params
리턴 Scalr\Model\Entity\Account\TeamEnvs

getFarmRoleScalingMetrics() 보호된 메소드

Get FarmRoleScalingMetric entity
protected getFarmRoleScalingMetrics ( string $criteria, array $params = [] ) : FarmRoleScalingMetric
$criteria string search criteria
$params array optional query params
리턴 Scalr\Model\Entity\FarmRoleScalingMetric

getFilter() 공개 메소드

Makes the filtering rule for the specified properties of an object
public getFilter ( string $class = null, string $property = null, array $values = [] ) : FilterRule
$class string optional The object name
$property string optional The property name
$values array optional The array of filter values
리턴 Scalr\Tests\Functional\Api\V2\Iterator\FilterRule

getFixturesDirectory() 공개 메소드

또한 보기: TestCase::getFixturesDirectory()

getGlobalVariable() 공개 메소드

Get GV
public getGlobalVariable ( string $criteria, array $params ) : array
$criteria string search criteria
$params array query params
리턴 array

getScalingMetric() 보호된 메소드

Get ScalingMetric entity
protected getScalingMetric ( string $criteria ) : ScalingMetric
$criteria string search criteria
리턴 Scalr\Model\Entity\ScalingMetric

getScriptVersion() 보호된 메소드

Gets ScriptVersion entity
protected getScriptVersion ( string $criteria, array $params ) : Scalr\Model\Entity\ScriptVersion
$criteria string search criteria
$params array query params
리턴 Scalr\Model\Entity\ScriptVersion

mapApiResponsePk() 보호된 메소드

On the based api endpoint and name api object return primary key If pk don't exist in paramMath throw fail
protected mapApiResponsePk ( string $path, string $objectName ) : string
$path string Api endpoint
$objectName string Name object entity from specification
리턴 string

mapPath() 보호된 메소드

Generate url with api endpoint and saved data
protected mapPath ( string $path, string $type ) : Generator
$path string api endpoint
$type string api specifications type
리턴 Generator

matchApiUrl() 보호된 메소드

Match API url params
protected matchApiUrl ( string $path, array $params = [] ) : string
$path string Api endpoint
$params array path parameters
리턴 string

saveUrlData() 보호된 메소드

Save data for x-usedIn endpoints
protected saveUrlData ( string $url, stdClass $object, string $nameEntity )
$url string api url
$object stdClass api object
$nameEntity string name api entity

setTestAcl() 보호된 메소드

Set mock acl for test
protected setTestAcl ( string $acl )
$acl string Acl type for tests

setUp() 보호된 메소드

또한 보기: ApiTestCase::setUp()
protected setUp ( )

setUpBeforeClass() 공개 정적인 메소드

Add test environment, test Acl, setups test user, environment and API key
public static setUpBeforeClass ( )

setUserType() 보호된 메소드

Set user types for test Some endpoints need extra credentials
protected setUserType ( string $type )
$type string User type

tearDown() 보호된 메소드

또한 보기: ApiTestCase::tearDown()
protected tearDown ( )

tearDownAfterClass() 공개 정적인 메소드

Removes API key generated for test
public static tearDownAfterClass ( )

testApi() 공개 메소드

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
public testApi ( string $path, string | Exceptio\Exception $type, string $adapter, string $aclType, string $userType, string $method, integer $responseCode, array $params, array $filterable, array $body )
$path string Api endpoint
$type string | Exceptio\Exception Api specifications type
$adapter string Adapter name
$aclType string Acl type for test
$userType string UserType for test
$method string HTTP method
$responseCode integer HTTP code
$params array Array of path parameters
$filterable array Array of GET parameters
$body array Array of POST parameters

testGetEndpoint() 공개 메소드

Test for base user and account Api GET endpoints
public testGetEndpoint ( string $path, string $type )
$path string path from api specifications
$type string api specifications type

프로퍼티 상세

$accountSpec 보호되어 있는 정적으로 프로퍼티

Object generated of Account Api specifications
protected static SpecManager,Scalr\Tests\Functional\Api\V2\SpecSchema $accountSpec
리턴 Scalr\Tests\Functional\Api\V2\SpecSchema\SpecManager

$adapters 보호되어 있는 정적으로 프로퍼티

List of adapters using in test
protected static ApiEntityAdapter[],Scalr\Api\DataType $adapters
리턴 Scalr\Api\DataType\ApiEntityAdapter[]

$checkScope 보호되어 있는 프로퍼티

Object where should check scope
protected array $checkScope
리턴 array

$data 보호되어 있는 정적으로 프로퍼티

Test data container for testGetEndpoint()
protected static array $data
리턴 array

$dbObjectMapping 보호되어 있는 프로퍼티

Mapping api object name and specific which gives an entity this object Key is object name Value is functions name
protected array $dbObjectMapping
리턴 array

$defaultAcl 보호되어 있는 정적으로 프로퍼티

Default test Acl
protected static Acl,Scalr\Acl $defaultAcl
리턴 Scalr\Acl\Acl

$filterPropertyMap 보호되어 있는 프로퍼티

Map filterable properties key based on object name in Api definitions
protected array $filterPropertyMap
리턴 array

$fullAccessAcl 보호되어 있는 정적으로 프로퍼티

protected static ApiTestAcl,Scalr\Tests\Fixtures\Api\V2\Acl $fullAccessAcl
리턴 Scalr\Tests\Fixtures\Api\V2\Acl\ApiTestAcl

$ignoreCheckRules 보호되어 있는 프로퍼티

List of objects where should ignore check filterable properties
protected array $ignoreCheckRules
리턴 array

$maxResults 보호되어 있는 정적으로 프로퍼티

Max response results
protected static false|int $maxResults
리턴 false | integer

$noAccessAcl 보호되어 있는 정적으로 프로퍼티

protected static PHPUnit_Framework_MockObject_MockObject $noAccessAcl
리턴 PHPUnit_Framework_MockObject_MockObject

$paramMap 보호되어 있는 프로퍼티

Mapping params in path definitions and response objects
protected array $paramMap
리턴 array

$pathMap 보호되어 있는 프로퍼티

Map save structure if object need other data structure key based on object name in Api definitions
protected array $pathMap
리턴 array

$propertyAssertMap 보호되어 있는 프로퍼티

Mapping specifics assert for properties Key is property name Value is functions name
protected array $propertyAssertMap
리턴 array

$readOnlyAccessAcl 보호되어 있는 정적으로 프로퍼티

protected static ApiTestAcl,Scalr\Tests\Fixtures\Api\V2\Acl $readOnlyAccessAcl
리턴 Scalr\Tests\Fixtures\Api\V2\Acl\ApiTestAcl

$simpleFilterRules 보호되어 있는 프로퍼티

protected $simpleFilterRules

$testData 보호되어 있는 정적으로 프로퍼티

Ids of data generated during the test Destructor clean up data by these ids
protected static array $testData
리턴 array

$testUserType 보호되어 있는 정적으로 프로퍼티

Default user type
protected static string $testUserType
리턴 string

$userSpec 보호되어 있는 정적으로 프로퍼티

Object generated of User Api specifications
protected static SpecManager,Scalr\Tests\Functional\Api\V2\SpecSchema $userSpec
리턴 Scalr\Tests\Functional\Api\V2\SpecSchema\SpecManager