twisted.web.test.test_proxy.ProxyClientTests

Tests for ProxyClient.

Method	makeRequest	Make a dummy request object for the URL path.
Method	makeProxyClient	Make a `ProxyClient` object used for testing.
Method	connectProxy	Connect a proxy client to a `StringTransportWithDisconnection`.
Method	assertForwardsHeaders	Assert that `proxyClient` sends `headers` when it connects.
Method	makeResponseBytes	Undocumented
Method	assertForwardsResponse	Assert that `request` has forwarded a response from the server.
Method	test_forward	When connected to the server, `ProxyClient` should send the saved request, with modifications of the headers, and then forward the result to the parent request.
Method	test_postData	Try to post content in the request, and check that the proxy client forward the body of the request.
Method	test_statusWithMessage	If the response contains a status with a message, it should be forwarded to the parent request with all the information.
Method	test_contentLength	If the response contains a Content-Length header, the inbound request object should still only have `finish` called on it once.
Method	test_losesConnection	If the response contains a Content-Length header, the outgoing connection is closed when all response body data has been received.
Method	test_headersCleanups	The headers given at initialization should be modified: proxy-connection should be removed if present, and connection should be added.
Method	test_keepaliveNotForwarded	The proxy doesn't really know what to do with keepalive things from the remote server, so we stomp over any keepalive header we get from the client.
Method	test_defaultHeadersOverridden	`server.Request` within the proxy sets certain response headers by default. When we get these headers back from the remote server, the defaults are overridden rather than simply appended.
Method	_parseOutHeaders	Parse the headers out of some web content.
Method	_testDataForward	Build a fake proxy connection, and send `data` over it, checking that it's forwarded to the originating request.

Inherited from TestCase:

Instance Variable	timeout	A real number of seconds. If set, the test will raise an error if it takes longer than `timeout` seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method	__init__	Construct an asynchronous test case for `methodName`.
Method	assertFailure	Fail if `deferred` does not errback with one of `expectedFailures`. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method	__call__	Run the test. Should always do exactly the same thing as run().
Method	deferSetUp	Undocumented
Method	deferTestMethod	Undocumented
Method	deferTearDown	Undocumented
Method	deferRunCleanups	Run any scheduled cleanups and report errors (if any to the result object.
Method	addCleanup	Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method	getSuppress	Undocumented
Method	getTimeout	No summary
Method	_run	Run a single method, either a test method or fixture.
Method	_ebDeferSetUp	Undocumented
Method	_cbDeferTestMethod	Undocumented
Method	_ebDeferTestMethod	Undocumented
Method	_ebDeferTearDown	Undocumented
Method	_cbDeferRunCleanups	Undocumented
Method	_cleanUp	Undocumented
Method	_classCleanUp	Undocumented
Method	_makeReactorMethod	Create a method which wraps the reactor method `name`. The new method issues a deprecation warning and calls the original.
Method	_deprecateReactor	Deprecate `iterate`, `crash` and `stop` on `reactor`. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method	_undeprecateReactor	Restore the deprecated reactor methods. Undoes what `_deprecateReactor` did.
Method	_runCleanups	Run the cleanups added with `addCleanup` in order.
Method	_runFixturesAndTest	Really run `setUp`, the test method, and `tearDown`. Any of these may return `defer.Deferred`s. After they complete, do some reactor cleanup.
Method	_wait	Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via TestCase):

Instance Variable	failureException	An exception class, defaulting to `FailTest`. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable	skip	`None` or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the `TestResult` supports skipping).
Instance Variable	todo	`None`, a string or a tuple of `(errors, reason)` where `errors` is either an exception class or an iterable of exception classes, and `reason` is a string. See `Todo` or `makeTodo` for more information.
Instance Variable	suppress	`None` or a list of tuples of `(args, kwargs)` to be passed to `warnings.filterwarnings`. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also `util.suppress`.
Method	__eq__	No summary
Method	__ne__	Undocumented
Method	__hash__	Undocumented
Method	shortDescription	Undocumented
Method	getSkip	No summary
Method	getTodo	No summary
Method	runTest	If no `methodName` argument is passed to the constructor, `run` will treat this method as the thing with the actual test inside.
Method	run	Run the test case, storing the results in `result`.
Method	patch	Monkey patch an object for the duration of the test.
Method	flushLoggedErrors	Remove stored errors received from the log.
Method	flushWarnings	Remove stored warnings from the list of captured warnings and return them.
Method	callDeprecated	Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method	mktemp	Create a new path name which can be used for a new file or directory.
Method	_getSuppress	No summary
Method	_getSkipReason	Return the reason to use for skipping a test method.
Method	_installObserver	Undocumented
Method	_removeObserver	Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

Method	fail	Absolutely fail the test. Do not pass go, do not collect $200.
Method	assertFalse	Fail the test if `condition` evaluates to True.
Method	assertTrue	Fail the test if `condition` evaluates to False.
Method	assertRaises	Fail the test unless calling the function `f` with the given `args` and `kwargs` raises `exception`. The failure will report the traceback and call stack of the unexpected exception.
Method	assertEqual	Fail the test if `first` and `second` are not equal.
Method	assertIs	Fail the test if `first` is not `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertIsNot	Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertNotEqual	Fail the test if `first` == `second`.
Method	assertIn	Fail the test if `containee` is not found in `container`.
Method	assertNotIn	Fail the test if `containee` is found in `container`.
Method	assertNotAlmostEqual	Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method	assertAlmostEqual	Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method	assertApproximates	Fail if `first` - `second` > `tolerance`
Method	assertSubstring	Fail if `substring` does not exist within `astring`.
Method	assertNotSubstring	Fail if `astring` contains `substring`.
Method	assertWarns	Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method	assertIsInstance	Fail if `instance` is not an instance of the given class or of one of the given classes.
Method	assertNotIsInstance	Fail if `instance` is an instance of the given class or of one of the given classes.
Method	successResultOf	Return the current success result of `deferred` or raise `self.failureException`.
Method	failureResultOf	Return the current failure result of `deferred` or raise `self.failureException`.
Method	assertNoResult	Assert that `deferred` does not have a result at this point.
Method	assertRegex	Fail the test if a `regexp` search of `text` fails.

def _parseOutHeaders(self, content):

Parse the headers out of some web content.

Parameters	content	Bytes received from a web server.
Returns	A tuple of (requestLine, headers, body). `headers` is a dict of headers, `requestLine` is the first line (e.g. "POST /foo ...") and `body` is whatever is left.

def makeRequest(self, path):

Make a dummy request object for the URL path.

Parameters	path	A URL path, beginning with a slash.
Returns	A `DummyRequest`.

def makeProxyClient(self, request, method='GET', headers=None, requestBody=''):

Make a ProxyClient object used for testing.

Parameters	request	The request to use.
	method	The HTTP method to use, GET by default.
	headers	The HTTP headers to use expressed as a dict. If not provided, defaults to {'accept': 'text/html'}.
	requestBody	The body of the request. Defaults to the empty string.
Returns	A `ProxyClient`

def connectProxy(self, proxyClient):

Connect a proxy client to a StringTransportWithDisconnection.

Parameters	proxyClient	A `ProxyClient`.
Returns	The `StringTransportWithDisconnection`.

def assertForwardsHeaders(self, proxyClient, requestLine, headers):

Assert that proxyClient sends headers when it connects.

Parameters	proxyClient	A `ProxyClient`.
	requestLine	The request line we expect to be sent.
	headers	A dict of headers we expect to be sent.
Returns	If the assertion is successful, return the request body as bytes.

def makeResponseBytes(self, code, message, headers, body):

Undocumented

def assertForwardsResponse(self, request, code, message, headers, body):

Assert that request has forwarded a response from the server.

Parameters	request	A `DummyRequest`.
	code	The expected HTTP response code.
	message	The expected HTTP message.
	headers	The expected HTTP headers.
	body	The expected response body.

def _testDataForward(self, code, message, headers, body, method='GET', requestBody='', loseConnection=True):

Build a fake proxy connection, and send data over it, checking that it's forwarded to the originating request.

def test_forward(self):

When connected to the server, ProxyClient should send the saved request, with modifications of the headers, and then forward the result to the parent request.

def test_postData(self):

Try to post content in the request, and check that the proxy client forward the body of the request.

def test_statusWithMessage(self):

If the response contains a status with a message, it should be forwarded to the parent request with all the information.

def test_contentLength(self):

If the response contains a Content-Length header, the inbound request object should still only have finish called on it once.

def test_losesConnection(self):

If the response contains a Content-Length header, the outgoing connection is closed when all response body data has been received.

def test_headersCleanups(self):

The headers given at initialization should be modified: proxy-connection should be removed if present, and connection should be added.

def test_keepaliveNotForwarded(self):

The proxy doesn't really know what to do with keepalive things from the remote server, so we stomp over any keepalive header we get from the client.

def test_defaultHeadersOverridden(self):

server.Request within the proxy sets certain response headers by default. When we get these headers back from the remote server, the defaults are overridden rather than simply appended.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.web.test.test_proxy.ProxyClientTests(TestCase) class documentation

`twisted.web.test.test_proxy.ProxyClientTests(TestCase)` class documentation