Guzzle\Tests\GuzzleTestCase Class Reference

Inheritance diagram for Guzzle\Tests\GuzzleTestCase:

Public Member Functions
	addMockedRequest (RequestInterface $request)
	assertContainsIns ($needle, $haystack, $message=null)
	compareHeaders ($filteredHeaders, $actualHeaders)
	getMockedRequests ()
	getMockResponse ($path)
	getWildcardObserver (HasDispatcherInterface $hasDispatcher)
	setMockResponse (Client $client, $paths)

Static Public Member Functions
static	getServer ()
static	getServiceBuilder ()
static	setMockBasePath ($path)
static	setServiceBuilder (ServiceBuilderInterface $builder)

Data Fields
	$mockObserver

Static Public Attributes
static	$server
static	$serviceBuilder

Protected Member Functions
	hasSubscriber (HasDispatcherInterface $dispatcher, EventSubscriberInterface $subscriber)

Static Protected Attributes
static	$mockBasePath

Detailed Description

Base testcase class for all Guzzle testcases.

Definition at line 22 of file GuzzleTestCase.php.

Member Function Documentation

addMockedRequest()

Guzzle\Tests\GuzzleTestCase::addMockedRequest

(

RequestInterface

$request

)

Mark a request as being mocked

Parameters

RequestInterface

$request

Returns

self

Definition at line 137 of file GuzzleTestCase.php.

assertContainsIns()

Guzzle\Tests\GuzzleTestCase::assertContainsIns	(		$needle,
			$haystack,
			$message = null
	)

Case insensitive assertContains

Parameters

string	$needle	Search string
string	$haystack	Search this
string	$message	Optional failure message

Definition at line 231 of file GuzzleTestCase.php.

Referenced by Guzzle\Tests\Http\Curl\CurlHandleTest\testAllowsCurloptEncodingToBeSet(), Guzzle\Tests\Plugin\Log\LogPluginTest\testHasHelpfulStaticFactoryMethod(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsExpectHeaderWhenSizeIsGreaterThanCutoff(), and Guzzle\Tests\Http\Curl\CurlHandleTest\testSetsCurloptEncodingWhenAcceptEncodingHeaderIsSet().

compareHeaders()

Guzzle\Tests\GuzzleTestCase::compareHeaders	(		$filteredHeaders,
			$actualHeaders
	)

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

Parameters

array	$filteredHeaders	Array of special headers
array	$actualHeaders	Array of headers to check against

Returns

array|bool Returns an array of the differences or FALSE if none

Definition at line 217 of file GuzzleTestCase.php.

Referenced by Guzzle\Tests\Http\Curl\CurlHandleTest\testFactoryCreatesCurlBasedOnRequest().

getMockedRequests()

Guzzle\Tests\GuzzleTestCase::getMockedRequests

(

)

Get all of the mocked requests

Returns

array

Definition at line 149 of file GuzzleTestCase.php.

getMockResponse()

Guzzle\Tests\GuzzleTestCase::getMockResponse

(

$path

)

Get a mock response for a client by mock file name

Parameters

string

$path

Relative path to the mock response file

Returns

Response

Definition at line 161 of file GuzzleTestCase.php.

References Guzzle\Plugin\Mock\MockPlugin\getMockFile().

Referenced by Guzzle\Tests\GuzzleTestCase\setMockResponse().

getServer()

static Guzzle\Tests\GuzzleTestCase::getServer ( )

static

Get the global server object used throughout the unit tests of Guzzle

Returns

Server

Definition at line 36 of file GuzzleTestCase.php.

References Guzzle\Tests\GuzzleTestCase\$server.

Referenced by Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\setUp(), Guzzle\Tests\Stream\PhpStreamRequestFactoryTest\setUp(), Guzzle\Tests\Http\Message\RequestTest\setUp(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\tearDownAfterClass(), Guzzle\Tests\Stream\PhpStreamRequestFactoryTest\testAddsBody(), Guzzle\Tests\Http\Curl\CurlHandleTest\testAddsCustomCurlOptions(), Guzzle\Tests\Stream\PhpStreamRequestFactoryTest\testAddsPostFields(), Guzzle\Tests\Http\Curl\CurlHandleTest\testAllowsCurloptEncodingToBeSet(), Guzzle\Tests\Http\Message\RequestTest\testAllowsFilenameForDownloadingContent(), Guzzle\Tests\Http\Curl\CurlHandleTest\testAllowsWireTransferInfoToBeEnabled(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testBailsWhenSendReturnsNoResults(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testCalculatesPageSize(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddCookies(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddEvents(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanAddEventsWithPriority(), Guzzle\Tests\Stream\PhpStreamRequestFactoryTest\testCanCreateCustomStreamClass(), Guzzle\Tests\Plugin\Redirect\StaticClientTest\testCanCreateStreamsUsingCustomFactory(), Guzzle\Tests\Plugin\Redirect\StaticClientTest\testCanCreateStreamsUsingDefaultFactory(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCanDisableRedirects(), Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testCanHandleRevalidationFailures(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testCanLimitNumberOfRedirects(), Guzzle\Tests\Http\Message\RequestTest\testCanOverrideUnsuccessfulResponses(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testCanRedirectWithNoLeadingSlashAndQuery(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testCanRedirectWithStrictRfcCompliance(), Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testCanRevalidateWithPlugin(), Guzzle\Tests\Http\Curl\CurlHandleTest\testCanSendBodyAsString(), Guzzle\Tests\Http\Message\RequestTest\testCanSendCustomRequests(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testCanSendMultipleRequestsUsingASingleRequestObject(), Guzzle\Tests\Http\Curl\CurlHandleTest\testCanSendPostBodyAsString(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCatchesExceptionsBeforeSendingMultipleRequests(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCatchesExceptionsBeforeSendingSingleRequest(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCatchesExceptionsWhenRemovingQueuedRequests(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCatchesExceptionsWhenRemovingQueuedRequestsBeforeSending(), Guzzle\Tests\Http\ClientTest\testClientAttachersObserversToRequests(), Guzzle\Tests\Http\ClientTest\testClientHasHelperMethodsForCreatingRequests(), Guzzle\Tests\Service\ClientTest\testClientResetsRequestsBeforeExecutingCommands(), Guzzle\Tests\Http\ClientTest\testClientSendsMultipleRequests(), Guzzle\Tests\Http\ClientTest\testClientSendsSingleRequest(), Guzzle\Tests\Http\ClientTest\testClientThrowsExceptionForMultipleRequests(), Guzzle\Tests\Http\ClientTest\testClientThrowsExceptionForSingleRequest(), Guzzle\Tests\Http\Curl\CurlHandleTest\testConstructorExpectsProperOptions(), Guzzle\Tests\Http\Curl\CurlHandleTest\testConstructorInitializesObject(), Guzzle\Tests\Http\Message\PostFileTest\testContentDispositionFilePathIsStripped(), Guzzle\Tests\Plugin\Cookie\CookiePluginTest\testCookiesAreExtractedFromRedirectResponses(), Guzzle\Tests\Http\EntityBodyTest\testCreatesMd5Checksum(), Guzzle\Tests\Http\Message\HttpRequestFactoryTest\testCreatesNewGetRequests(), Guzzle\Tests\Http\ClientTest\testCreatesRequestsWithDefaultValues(), Guzzle\Tests\Http\Curl\CurlHandleTest\testCurlConfigurationOptionsAreSet(), Guzzle\Tests\Http\Curl\CurlMultiTest\testCurlErrorsAreCaught(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testDefaultBehaviorIsToRedirectWithGetForEntityEnclosingRequests(), Guzzle\Tests\Http\Curl\CurlHandleTest\testDeterminesIfResourceIsAvailable(), Guzzle\Tests\Http\Curl\CurlMultiTest\testDoesNotCatchRandomExceptionsThrownDuringPerform(), Guzzle\Tests\Http\Curl\CurlMultiTest\testDoesNotThrowExceptionsWhenRequestsRecoverWithRetry(), Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testDoesNotTouchClosureListeners(), Guzzle\Tests\Http\Curl\RequestMediatorTest\testDoesNotUseRequestResponseBodyWhenNotCustom(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testEnsuresErrorResponseExists(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testEnsuresErrorResponseImplementsInterface(), Guzzle\Tests\Http\Message\RequestTest\testEnsuresFileCanBeCreated(), Guzzle\Tests\Plugin\Async\AsyncPluginTest\testEnsuresIntegration(), Guzzle\Tests\Http\Curl\CurlHandleTest\testEnsuresRequestsHaveResponsesWhenUpdatingFromTransfer(), Guzzle\Tests\Service\ClientTest\testExecutesCommands(), Guzzle\Tests\Http\Curl\CurlHandleTest\testFactoryCreatesCurlBasedOnRequest(), Guzzle\Tests\Plugin\Backoff\BackoffPluginTest\testFailsOnTruncation(), Guzzle\Tests\Http\Curl\CurlHandleTest\testGetInfoWithoutDebugMode(), Guzzle\Tests\Stream\StreamTest\testGetSize(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testHandlesRedirectsWithSpacesProperly(), Guzzle\Tests\Http\Curl\CurlMultiTest\testHardResetReopensMultiHandle(), Guzzle\Tests\Log\MessageFormatterTest\testInjectsTotalTime(), Guzzle\Tests\Stream\PhpStreamRequestFactoryTest\testOpensValidStreamByCreatingContext(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRedirect303WithGet(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRedirect303WithGetWithStrictRfcCompliance(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRedirectsCanBeDisabledPerRequest(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRedirectsRequests(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRedirectWithStrictRfc386Compliance(), Guzzle\Tests\Http\Curl\CurlMultiTest\testRemovesConflictingTransferEncodingHeader(), Guzzle\Tests\Http\Curl\CurlMultiTest\testRemovesQueuedRequestsAddedInTransit(), Guzzle\Tests\Http\Curl\CurlMultiTest\testRequestBeforeSendIncludesContentLengthHeaderIfEmptyBody(), Guzzle\Tests\Http\Message\RequestTest\testRequestCanBeSentUsingCurl(), Guzzle\Tests\Http\Message\RequestTest\testRequestCanHaveManuallySetResponseBody(), Guzzle\Tests\Http\Message\RequestTest\testRequestHandlesAuthorization(), Guzzle\Tests\Http\Message\RequestTest\testRequestStringsIncludeAuth(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testResetsHistoryEachSend(), Guzzle\Tests\Plugin\Backoff\BackoffPluginTest\testRetriesPooledRequestsUsingDelayAndPollingEvent(), Guzzle\Tests\Plugin\Backoff\BackoffPluginTest\testRetriesRequests(), Guzzle\Tests\Plugin\Backoff\BackoffPluginTest\testRetriesRequestsWhenInParallel(), Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testRevalidatesResponsesAgainstOriginServer(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testRewindsStreamWhenRedirectingIfNeeded(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSeeksToBeginningOfStreamWhenSending(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsExpectHeaderWhenSizeIsGreaterThanCutoff(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostFieldsForNonPostRequests(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostFilesForNonPostRequests(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostRequestsWithFields(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostRequestsWithFiles(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsPostUploadsWithContentDispositionHeaders(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testSendsRequestsForNextSetOfResources(), Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsRequestsThroughCurl(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSendsRequestsWithNoBodyUsingContentLengthZero(), Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsThroughCurlAndAggregatesRequestExceptions(), Guzzle\Tests\Http\Curl\CurlMultiProxyTest\testSendWillSendQueuedRequestsFirst(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testSetPostFiles(), Guzzle\Tests\Http\Curl\CurlHandleTest\testSetsCurloptEncodingWhenAcceptEncodingHeaderIsSet(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testSettingLimitOrPageSizeClearsData(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testSkipsWhenErrorResponsesIsNotSet(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testSkipsWhenErrorResponsesIsNotSetAndAllowsSuccess(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testSkipsWhenNoClassIsSet(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testSkipsWhenReasonDoesNotMatch(), Guzzle\Tests\Http\Message\RequestTest\testThrowsExceptionsWhenUnsuccessfulResponseIsReceivedByDefault(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testThrowsExceptionWhenContentLengthCannotBeDeterminedAndUsingHttp1(), Guzzle\Tests\Plugin\Redirect\RedirectPluginTest\testThrowsExceptionWhenStreamCannotBeRewound(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testThrowsSpecificErrorResponseOnMatch(), Guzzle\Tests\Plugin\ErrorResponse\ErrorResponsePluginTest\testThrowsWhenCodeAndPhraseMatch(), Guzzle\Tests\Http\Curl\CurlMultiProxyTest\testTrimsDownMaxHandleCount(), Guzzle\Tests\Http\Message\RequestTest\testUnresolvedRedirectsReturnResponse(), Guzzle\Tests\Http\Curl\CurlHandleTest\testUploadsPutData(), Guzzle\Tests\Http\Curl\CurlHandleTest\testUploadsPutDataUsingChunkedEncodingWhenForced(), Guzzle\Tests\Http\Curl\CurlHandleTest\testUploadsPutDataUsingChunkedEncodingWhenLengthCannotBeDetermined(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testUseAsArray(), Guzzle\Tests\Http\Message\EntityEnclosingRequestTest\testUsesChunkedTransferWhenBodyLengthCannotBeDetermined(), Guzzle\Tests\Service\Command\LocationVisitor\Request\PostFileVisitorTest\testVisitsLocationWithMultipleFiles(), Guzzle\Tests\Plugin\Log\LogPluginTest\testWiresBodiesWhenNeeded(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testWorksWithCustomAppendIterator(), Guzzle\Tests\Http\Curl\CurlHandleTest\testWrapsCurlOptions(), Guzzle\Tests\Http\Curl\CurlHandleTest\testWrapsErrorsAndInfo(), and Guzzle\Tests\Http\ClientTest\urlProvider().

getServiceBuilder()

static Guzzle\Tests\GuzzleTestCase::getServiceBuilder ( )

static

Get a service builder object that can be used throughout the service tests

Returns

ServiceBuilder

Definition at line 65 of file GuzzleTestCase.php.

References Guzzle\Tests\GuzzleTestCase\$serviceBuilder.

Referenced by Guzzle\Tests\Service\Description\ParameterTest\testAllowsNestedShape(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testBailsWhenSendReturnsNoResults(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testCalculatesPageSize(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testConstructorConfiguresDefaults(), Guzzle\Tests\Service\Command\ClosureCommandTest\testExecutesClosure(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testHoldsDataOptions(), Guzzle\Tests\Service\Command\ClosureCommandTest\testMustReturnRequest(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testSendsRequestsForNextSetOfResources(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testSettingLimitOrPageSizeClearsData(), Guzzle\Tests\Service\Resource\ResourceIteratorTest\testUseAsArray(), and Guzzle\Tests\Service\Resource\ResourceIteratorTest\testWorksWithCustomAppendIterator().

getWildcardObserver()

Guzzle\Tests\GuzzleTestCase::getWildcardObserver

(

HasDispatcherInterface

$hasDispatcher

)

Get a wildcard observer for an event dispatcher

Parameters

HasDispatcherInterface

$hasDispatcher

Returns

MockObserver

Definition at line 106 of file GuzzleTestCase.php.

References Guzzle\Common\HasDispatcherInterface\getEventDispatcher().

Referenced by Guzzle\Tests\Http\Curl\CurlHandleTest\testUploadsPutData().

hasSubscriber()

Guzzle\Tests\GuzzleTestCase::hasSubscriber ( HasDispatcherInterface  $dispatcher, EventSubscriberInterface  $subscriber  )

protected

Check if an event dispatcher has a subscriber

Parameters

HasDispatcherInterface	$dispatcher
EventSubscriberInterface	$subscriber

Returns

bool

Definition at line 82 of file GuzzleTestCase.php.

References Guzzle\Common\HasDispatcherInterface\getEventDispatcher().

Referenced by Guzzle\Tests\Http\ClientTest\testClientAttachersObserversToRequests(), and Guzzle\Tests\Plugin\Mock\MockPluginTest\testDetachesTemporaryWhenEmpty().

setMockBasePath()

static Guzzle\Tests\GuzzleTestCase::setMockBasePath (   $path )

static

Set the mock response base path

Parameters

string

$path

Path to mock response folder

Returns

GuzzleTestCase

Definition at line 125 of file GuzzleTestCase.php.

setMockResponse()

Guzzle\Tests\GuzzleTestCase::setMockResponse	(	Client	$client,
			$paths
	)

Set a mock response from a mock file on the next client request.

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
string	$paths	Path to files within the Mock folder of the service

Returns

MockPlugin returns the created mock plugin

Definition at line 181 of file GuzzleTestCase.php.

References Guzzle\Tests\GuzzleTestCase\getMockResponse().

Referenced by Guzzle\Tests\Service\Command\CommandTest\testConvertsInvalidJsonResponsesToArray(), Guzzle\Tests\Service\Command\CommandTest\testConvertsJsonResponsesToArray(), Guzzle\Tests\Service\Command\CommandTest\testExecute(), Guzzle\Tests\Service\Command\CommandTest\testGetResponseExecutesCommandsWhenNeeded(), Guzzle\Tests\Service\Command\CommandTest\testGetResultExecutesCommandsWhenNeeded(), Guzzle\Tests\Service\Command\CommandTest\testIsInvokable(), and Guzzle\Tests\Service\Command\CommandTest\testProcessResponseIsNotXml().

setServiceBuilder()

static Guzzle\Tests\GuzzleTestCase::setServiceBuilder ( ServiceBuilderInterface  $builder )

static

Set the service builder to use for tests

Parameters

ServiceBuilderInterface

$builder

Service builder

Definition at line 55 of file GuzzleTestCase.php.

Field Documentation

$mockBasePath

Guzzle\Tests\GuzzleTestCase::$mockBasePath

staticprotected

Definition at line 24 of file GuzzleTestCase.php.

$mockObserver

Guzzle\Tests\GuzzleTestCase::$mockObserver

Definition at line 29 of file GuzzleTestCase.php.

$server

Guzzle\Tests\GuzzleTestCase::$server

static

Definition at line 26 of file GuzzleTestCase.php.

Referenced by Guzzle\Tests\GuzzleTestCase\getServer(), Guzzle\Tests\Http\EntityBodyTest\testCreatesMd5Checksum(), and Guzzle\Tests\Plugin\Cache\DefaultRevalidationTest\testRevalidatesResponsesAgainstOriginServer().

$serviceBuilder

Guzzle\Tests\GuzzleTestCase::$serviceBuilder

static

Definition at line 25 of file GuzzleTestCase.php.

Referenced by Guzzle\Tests\GuzzleTestCase\getServiceBuilder().

---

The documentation for this class was generated from the following file:

• GuzzleTestCase.php