PHP Класс Scalr\Tests\Functional\Api\ApiTestCase

С версии: 5.4 (12.03.2015)
Автор: Vlad Dobrovolskiy ([email protected])
Наследование: extends Scalr\Tests\TestCase
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$apiController Scalr\Api\Rest\Controller\ApiController For the purpose of data conversion
$apiKeyEntity Scalr\Model\Entity\Account\User\ApiKeyEntity Api key entity
$apiVersion string API version
$env Scalr\Model\Entity\Account\Environment Scalr_Environment instance
$governance Scalr_Governance Scalr Governance
$governanceConfiguration array Governance configuration
$loggerConfiguration array List of logger what we should be excluded from debug output key is logger name and value is logger level
$testData array Ids of data generated during the test Destructor clean up data by these ids
$testEnvId integer ID of the user's environment
$testUserId integer ID of the user which is used in the functional test
$user Scalr\Model\Entity\Account\User Test User

Открытые методы

Метод Описание
__construct ( $name = null, $data = [], $dataName = null )
assertDescribeResponseNotEmpty ( Scalr\Tests\Functional\Api\ApiTestResponse $response ) Asserts describe response has all properties
assertErrorMessageContains ( Scalr\Tests\Functional\Api\ApiTestResponse $response, integer $expectedStatus, string $expectedError = null, string $expectedMessage = null ) Asserts api error response
assertErrorMessageErrorEquals ( string $expectedError, Scalr\Tests\Functional\Api\ApiTestResponse $response ) Asserts error message error
assertErrorMessageStatusEquals ( integer $expectedStatus, Scalr\Tests\Functional\Api\ApiTestResponse $response ) Asserts error message status
assertErrorMessageTextEquals ( string $expectedMessage, Scalr\Tests\Functional\Api\ApiTestResponse $response ) Asserts error message text
assertFetchResponseNotEmpty ( Scalr\Tests\Functional\Api\ApiTestResponse $response ) Asserts fetch response has all properties
assertImageObjectNotEmpty ( object $data ) Asserts if images's object has all properties
assertObjectEqualsEntity ( $object, AbstractEntity | array $entity, string $adapter = null ) Asserts that object equals entity
assertVariableObjectNotEmpty ( object $data ) Asserts if variable's object has all properties
createEntity ( AbstractEntity $entity, array $data, array $requiredData = null ) : AbstractEntity Creates and save entity to DB, keeps entity to delete after test
getAccountApiUrl ( string $uriPart ) : string Gets Account API url
getAdapter ( string $name, ApiController $controller = null ) : ApiEntityAdapter Gets API entity adapter
getGovernance ( ) : Scalr_Governance Gets governance object
getUserApiUrl ( string $uriPart, integer $envId = null ) : string Gets User API url
isRecursivelyEmpty ( mixed $data ) : boolean Recursively checks that data is empty
printResponseError ( Scalr\Tests\Functional\Api\ApiTestResponse $response ) : string Makes string representation of error
request ( string $uri, string $method = Request::METHOD_GET, array $params = [], array $body = [], array $headers = [] ) : Scalr\Tests\Functional\Api\ApiTestResponse Calls api controllers' actions
restoreGovernanceConfiguration ( ) Restores a previously saved governance configuration
setUpBeforeClass ( ) Setups test user, environment and API key
setupGovernanceConfiguration ( array $governanceConfiguration, boolean $savePrevious = true ) Setup governance configuration
tearDownAfterClass ( ) Removes API key and Entities generated for test
toDelete ( string $class, array $identifier, array $initProperties = null ) Registers specified Entity for removal

Защищенные методы

Метод Описание
changeLoggerConfiguration ( ) Change logger level and save current level
getEnvironment ( ) : Environment Gets a test environment instance
getNewImageId ( Scalr_Environment $env, string $cloudLocation ) : null | string Gets unused image id from the cloud
getUser ( ) : User Gets an test User instance
setUp ( )

Приватные методы

Метод Описание
getTestEnvProperties ( ) : array Gets test properties for applicatiob environment

Описание методов

__construct() публичный Метод

public __construct ( $name = null, $data = [], $dataName = null )

assertDescribeResponseNotEmpty() публичный Метод

Asserts describe response has all properties
public assertDescribeResponseNotEmpty ( Scalr\Tests\Functional\Api\ApiTestResponse $response )
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response

assertErrorMessageContains() публичный Метод

Asserts api error response
public assertErrorMessageContains ( Scalr\Tests\Functional\Api\ApiTestResponse $response, integer $expectedStatus, string $expectedError = null, string $expectedMessage = null )
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response
$expectedStatus integer Expected Status
$expectedError string optional Expected error
$expectedMessage string optional Expected message

assertErrorMessageErrorEquals() публичный Метод

Asserts error message error
public assertErrorMessageErrorEquals ( string $expectedError, Scalr\Tests\Functional\Api\ApiTestResponse $response )
$expectedError string Expected error
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response

assertErrorMessageStatusEquals() публичный Метод

Asserts error message status
public assertErrorMessageStatusEquals ( integer $expectedStatus, Scalr\Tests\Functional\Api\ApiTestResponse $response )
$expectedStatus integer Expected Status
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response

assertErrorMessageTextEquals() публичный Метод

Asserts error message text
public assertErrorMessageTextEquals ( string $expectedMessage, Scalr\Tests\Functional\Api\ApiTestResponse $response )
$expectedMessage string Expected message
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response

assertFetchResponseNotEmpty() публичный Метод

Asserts fetch response has all properties
public assertFetchResponseNotEmpty ( Scalr\Tests\Functional\Api\ApiTestResponse $response )
$response Scalr\Tests\Functional\Api\ApiTestResponse Api response

assertImageObjectNotEmpty() публичный Метод

Asserts if images's object has all properties
public assertImageObjectNotEmpty ( object $data )
$data object Single image's item

assertObjectEqualsEntity() публичный Метод

Asserts that object equals entity
public assertObjectEqualsEntity ( $object, AbstractEntity | array $entity, string $adapter = null )
$object
$entity Scalr\Model\AbstractEntity | array
$adapter string optional Entity adapter name

assertVariableObjectNotEmpty() публичный Метод

Asserts if variable's object has all properties
public assertVariableObjectNotEmpty ( object $data )
$data object Single image's item

changeLoggerConfiguration() защищенный статический Метод

Change logger level and save current level
protected static changeLoggerConfiguration ( )

createEntity() публичный статический Метод

Creates and save entity to DB, keeps entity to delete after test
public static createEntity ( AbstractEntity $entity, array $data, array $requiredData = null ) : AbstractEntity
$entity Scalr\Model\AbstractEntity Entity instance
$data array Properties to initialize
$requiredData array The list of names properties which should be save and initialize after delete
Результат Scalr\Model\AbstractEntity

getAccountApiUrl() публичный статический Метод

Gets Account API url
public static getAccountApiUrl ( string $uriPart ) : string
$uriPart string Part of the api uri
Результат string Returns User API url

getAdapter() публичный Метод

Gets API entity adapter
public getAdapter ( string $name, ApiController $controller = null ) : ApiEntityAdapter
$name string Adapter name
$controller Scalr\Api\Rest\Controller\ApiController optional API Controller
Результат Scalr\Api\DataType\ApiEntityAdapter

getEnvironment() защищенный Метод

Gets a test environment instance
protected getEnvironment ( ) : Environment
Результат Scalr\Model\Entity\Account\Environment Returns environment instance

getGovernance() публичный Метод

Gets governance object
public getGovernance ( ) : Scalr_Governance
Результат Scalr_Governance

getNewImageId() защищенный Метод

Gets unused image id from the cloud
protected getNewImageId ( Scalr_Environment $env, string $cloudLocation ) : null | string
$env Scalr_Environment Scalr environment
$cloudLocation string Region
Результат null | string

getUser() защищенный Метод

Gets an test User instance
protected getUser ( ) : User
Результат Scalr\Model\Entity\Account\User Returns user instance

getUserApiUrl() публичный статический Метод

Gets User API url
public static getUserApiUrl ( string $uriPart, integer $envId = null ) : string
$uriPart string Part of the api uri
$envId integer optional Identifier of the Environment. If it is not specified method uses default test Environment.
Результат string Returns User API url

isRecursivelyEmpty() публичный статический Метод

Recursively checks that data is empty
public static isRecursivelyEmpty ( mixed $data ) : boolean
$data mixed Data to check
Результат boolean Returns true if $data are empty or $data is object/array, all child elements of which recursively empty, false otherwise

printResponseError() публичный Метод

Makes string representation of error
public printResponseError ( Scalr\Tests\Functional\Api\ApiTestResponse $response ) : string
$response Scalr\Tests\Functional\Api\ApiTestResponse Response envelope
Результат string

request() публичный Метод

Calls api controllers' actions
public request ( string $uri, string $method = Request::METHOD_GET, array $params = [], array $body = [], array $headers = [] ) : Scalr\Tests\Functional\Api\ApiTestResponse
$uri string Request uri
$method string Http action
$params array optional Array of GET values
$body array optional POST fields => values
$headers array optional Custom headers
Результат Scalr\Tests\Functional\Api\ApiTestResponse Returns API test response

restoreGovernanceConfiguration() публичный Метод

Restores a previously saved governance configuration
public restoreGovernanceConfiguration ( )

setUp() защищенный Метод

protected setUp ( )

setUpBeforeClass() публичный статический Метод

Setups test user, environment and API key
public static setUpBeforeClass ( )

setupGovernanceConfiguration() публичный Метод

Setup governance configuration
public setupGovernanceConfiguration ( array $governanceConfiguration, boolean $savePrevious = true )
$governanceConfiguration array Governance configuration
$savePrevious boolean optional If true, current governance configuration be saved before setting up a new

tearDownAfterClass() публичный статический Метод

Removes API key and Entities generated for test
public static tearDownAfterClass ( )

toDelete() публичный статический Метод

Registers specified Entity for removal
public static toDelete ( string $class, array $identifier, array $initProperties = null )
$class string The name of the class
$identifier array The PrimaryKey value of the Entity
$initProperties array The properties value what use in delete action

Описание свойств

$apiController защищенное статическое свойство

For the purpose of data conversion
protected static ApiController,Scalr\Api\Rest\Controller $apiController
Результат Scalr\Api\Rest\Controller\ApiController

$apiKeyEntity защищенное статическое свойство

Api key entity
protected static ApiKeyEntity,Scalr\Model\Entity\Account\User $apiKeyEntity
Результат Scalr\Model\Entity\Account\User\ApiKeyEntity

$apiVersion защищенное статическое свойство

API version
protected static string $apiVersion
Результат string

$env защищенное статическое свойство

Scalr_Environment instance
protected static Environment,Scalr\Model\Entity\Account $env
Результат Scalr\Model\Entity\Account\Environment

$governance защищенное свойство

Scalr Governance
protected Scalr_Governance $governance
Результат Scalr_Governance

$governanceConfiguration защищенное свойство

Governance configuration
protected array $governanceConfiguration
Результат array

$loggerConfiguration защищенное статическое свойство

List of logger what we should be excluded from debug output key is logger name and value is logger level
protected static array $loggerConfiguration
Результат array

$testData защищенное статическое свойство

Ids of data generated during the test Destructor clean up data by these ids
protected static array $testData
Результат array

$testEnvId защищенное статическое свойство

ID of the user's environment
protected static int $testEnvId
Результат integer

$testUserId защищенное статическое свойство

ID of the user which is used in the functional test
protected static int $testUserId
Результат integer

$user защищенное статическое свойство

Test User
protected static User,Scalr\Model\Entity\Account $user
Результат Scalr\Model\Entity\Account\User