ServiceBuilderTest
extends GuzzleTestCase
in package
Base testcase class for all Guzzle testcases.
Tags
Table of Contents
- $mockObserver : mixed
- $server : mixed
- $serviceBuilder : mixed
- $arrayData : mixed
- $mockBasePath : mixed
- $requests : mixed
- addMockedRequest() : self
- Mark a request as being mocked
- assertContainsIns() : mixed
- Case insensitive assertContains
- compareHeaders() : array<string|int, mixed>|bool
- Compare HTTP headers and use special markup to filter values A header prefixed with '!' means it must not exist A header prefixed with '_' means it must be ignored A header value of '*' means anything after the * will be ignored
- getMockedRequests() : array<string|int, mixed>
- Get all of the mocked requests
- getMockResponse() : Response
- Get a mock response for a client by mock file name
- getServer() : Server
- Get the global server object used throughout the unit tests of Guzzle
- getServiceBuilder() : ServiceBuilder
- Get a service builder object that can be used throughout the service tests
- getWildcardObserver() : MockObserver
- Get a wildcard observer for an event dispatcher
- setMockBasePath() : GuzzleTestCase
- Set the mock response base path
- setMockResponse() : MockPlugin
- Set a mock response from a mock file on the next client request.
- setServiceBuilder() : mixed
- Set the service builder to use for tests
- testAddsGlobalPlugins() : mixed
- testAllowsSerialization() : mixed
- testBuilderAllowsReferencesBetweenClients() : mixed
- testBuildersPassOptionsThroughToClients() : mixed
- testCanAddGlobalParametersToServicesOnLoad() : mixed
- testCanGetByAlias() : mixed
- testCanGetData() : mixed
- testCanOverwriteParametersForThrowawayClients() : mixed
- testCanRegisterServiceData() : mixed
- testCanUseArbitraryData() : mixed
- testDelegatesFactoryMethodToAbstractFactory() : mixed
- testEmitsEventsWhenClientsAreCreated() : mixed
- testFactoryCanCreateFromArray() : mixed
- testFactoryCanCreateFromJson() : mixed
- testFactoryDoesNotRequireParams() : mixed
- testGettingAThrowawayClientWithParametersDoesNotAffectGettingOtherClients() : mixed
- testStoresClientCopy() : mixed
- testThrowsExceptionWhenGettingInvalidClient() : mixed
- testUsedAsArray() : mixed
- testUsesTheDefaultBuilderWhenNoBuilderIsSpecified() : mixed
- hasSubscriber() : bool
- Check if an event dispatcher has a subscriber
Properties
$mockObserver
public
mixed
$mockObserver
$server
public
static mixed
$server
$serviceBuilder
public
static mixed
$serviceBuilder
$arrayData
protected
mixed
$arrayData
= array('michael.mock' => array('class' => 'Guzzle\Tests\Service\Mock\MockClient', 'params' => array('username' => 'michael', 'password' => 'testing123', 'subdomain' => 'michael')), 'billy.mock' => array('alias' => 'Hello!', 'class' => 'Guzzle\Tests\Service\Mock\MockClient', 'params' => array('username' => 'billy', 'password' => 'passw0rd', 'subdomain' => 'billy')), 'billy.testing' => array('extends' => 'billy.mock', 'params' => array('subdomain' => 'test.billy')), 'missing_params' => array('extends' => 'billy.mock'))
$mockBasePath
protected
static mixed
$mockBasePath
$requests
private
mixed
$requests
= array()
Methods
addMockedRequest()
Mark a request as being mocked
public
addMockedRequest(RequestInterface $request) : self
Parameters
- $request : RequestInterface
Return values
self —assertContainsIns()
Case insensitive assertContains
public
assertContainsIns(string $needle, string $haystack[, string $message = null ]) : mixed
Parameters
- $needle : string
-
Search string
- $haystack : string
-
Search this
- $message : string = null
-
Optional failure message
Return values
mixed —compareHeaders()
Compare HTTP headers and use special markup to filter values A header prefixed with '!' means it must not exist A header prefixed with '_' means it must be ignored A header value of '*' means anything after the * will be ignored
public
compareHeaders(array<string|int, mixed> $filteredHeaders, array<string|int, mixed> $actualHeaders) : array<string|int, mixed>|bool
Parameters
- $filteredHeaders : array<string|int, mixed>
-
Array of special headers
- $actualHeaders : array<string|int, mixed>
-
Array of headers to check against
Return values
array<string|int, mixed>|bool —Returns an array of the differences or FALSE if none
getMockedRequests()
Get all of the mocked requests
public
getMockedRequests() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMockResponse()
Get a mock response for a client by mock file name
public
getMockResponse(string $path) : Response
Parameters
- $path : string
-
Relative path to the mock response file
Return values
Response —getServer()
Get the global server object used throughout the unit tests of Guzzle
public
static getServer() : Server
Return values
Server —getServiceBuilder()
Get a service builder object that can be used throughout the service tests
public
static getServiceBuilder() : ServiceBuilder
Return values
ServiceBuilder —getWildcardObserver()
Get a wildcard observer for an event dispatcher
public
getWildcardObserver(HasDispatcherInterface $hasDispatcher) : MockObserver
Parameters
- $hasDispatcher : HasDispatcherInterface
Return values
MockObserver —setMockBasePath()
Set the mock response base path
public
static setMockBasePath(string $path) : GuzzleTestCase
Parameters
- $path : string
-
Path to mock response folder
Return values
GuzzleTestCase —setMockResponse()
Set a mock response from a mock file on the next client request.
public
setMockResponse(Client $client, string $paths) : MockPlugin
This method assumes that mock response files are located under the Command/Mock/ directory of the Service being tested (e.g. Unfuddle/Command/Mock/). A mock response is added to the next request sent by the client.
Parameters
- $client : Client
-
Client object to modify
- $paths : string
-
Path to files within the Mock folder of the service
Return values
MockPlugin —returns the created mock plugin
setServiceBuilder()
Set the service builder to use for tests
public
static setServiceBuilder(ServiceBuilderInterface $builder) : mixed
Parameters
- $builder : ServiceBuilderInterface
-
Service builder
Return values
mixed —testAddsGlobalPlugins()
public
testAddsGlobalPlugins() : mixed
Return values
mixed —testAllowsSerialization()
public
testAllowsSerialization() : mixed
Return values
mixed —testBuilderAllowsReferencesBetweenClients()
public
testBuilderAllowsReferencesBetweenClients() : mixed
Return values
mixed —testBuildersPassOptionsThroughToClients()
public
testBuildersPassOptionsThroughToClients() : mixed
Return values
mixed —testCanAddGlobalParametersToServicesOnLoad()
public
testCanAddGlobalParametersToServicesOnLoad() : mixed
Return values
mixed —testCanGetByAlias()
public
testCanGetByAlias() : mixed
Return values
mixed —testCanGetData()
public
testCanGetData() : mixed
Return values
mixed —testCanOverwriteParametersForThrowawayClients()
public
testCanOverwriteParametersForThrowawayClients() : mixed
Return values
mixed —testCanRegisterServiceData()
public
testCanRegisterServiceData() : mixed
Return values
mixed —testCanUseArbitraryData()
public
testCanUseArbitraryData() : mixed
Return values
mixed —testDelegatesFactoryMethodToAbstractFactory()
public
testDelegatesFactoryMethodToAbstractFactory() : mixed
Return values
mixed —testEmitsEventsWhenClientsAreCreated()
public
testEmitsEventsWhenClientsAreCreated() : mixed
Return values
mixed —testFactoryCanCreateFromArray()
public
testFactoryCanCreateFromArray() : mixed
Return values
mixed —testFactoryCanCreateFromJson()
public
testFactoryCanCreateFromJson() : mixed
Return values
mixed —testFactoryDoesNotRequireParams()
public
testFactoryDoesNotRequireParams() : mixed
Return values
mixed —testGettingAThrowawayClientWithParametersDoesNotAffectGettingOtherClients()
public
testGettingAThrowawayClientWithParametersDoesNotAffectGettingOtherClients() : mixed
Return values
mixed —testStoresClientCopy()
public
testStoresClientCopy() : mixed
Return values
mixed —testThrowsExceptionWhenGettingInvalidClient()
public
testThrowsExceptionWhenGettingInvalidClient() : mixed
Tags
Return values
mixed —testUsedAsArray()
public
testUsedAsArray() : mixed
Return values
mixed —testUsesTheDefaultBuilderWhenNoBuilderIsSpecified()
public
testUsesTheDefaultBuilderWhenNoBuilderIsSpecified() : mixed
Return values
mixed —hasSubscriber()
Check if an event dispatcher has a subscriber
protected
hasSubscriber(HasDispatcherInterface $dispatcher, EventSubscriberInterface $subscriber) : bool
Parameters
- $dispatcher : HasDispatcherInterface
- $subscriber : EventSubscriberInterface