rosbridge_tools.tornado.testing.AsyncHTTPTestCase Class Reference

Inheritance diagram for rosbridge_tools.tornado.testing.AsyncHTTPTestCase:

List of all members.

Public Member Functions
def	fetch
def	get_app
def	get_http_client
def	get_http_port
def	get_http_server
def	get_httpserver_options
def	get_protocol
def	get_url
def	setUp
def	tearDown
Public Attributes
	http_client
	http_server
Private Attributes
	__port
	_app

---

Detailed Description

A test case that starts up an HTTP server.

Subclasses must override `get_app()`, which returns the
`tornado.web.Application` (or other `.HTTPServer` callback) to be tested.
Tests will typically use the provided ``self.http_client`` to fetch
URLs from this server.

Example::

    class MyHTTPTest(AsyncHTTPTestCase):
        def get_app(self):
            return Application([('/', MyHandler)...])

        def test_homepage(self):
            # The following two lines are equivalent to
            #   response = self.fetch('/')
            # but are shown in full here to demonstrate explicit use
            # of self.stop and self.wait.
            self.http_client.fetch(self.get_url('/'), self.stop)
            response = self.wait()
            # test contents of response

Definition at line 318 of file testing.py.

---

Member Function Documentation

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.fetch	(		self,
			path,
			kwargs
	)

Convenience method to synchronously fetch a url.

The given path will be appended to the local server's host and
port.  Any additional kwargs will be passed directly to
`.AsyncHTTPClient.fetch` (and so could be used to pass
``method="POST"``, ``body="..."``, etc).

Definition at line 364 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_app

(

self

)

Should be overridden by subclasses to return a
`tornado.web.Application` or other `.HTTPServer` callback.

Definition at line 358 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_http_client

(

self

)

Reimplemented in rosbridge_tools.tornado.testing.AsyncHTTPSTestCase.

Definition at line 351 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_http_port

(

self

)

Returns the port used by the server.

A new port is chosen for each test.

Definition at line 381 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_http_server

(

self

)

Definition at line 354 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_httpserver_options

(

self

)

May be overridden by subclasses to return additional
keyword arguments for the server.

Reimplemented in rosbridge_tools.tornado.testing.AsyncHTTPSTestCase.

Definition at line 375 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_protocol

(

self

)

Reimplemented in rosbridge_tools.tornado.testing.AsyncHTTPSTestCase.

Definition at line 388 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.get_url	(		self,
			path
	)

Returns an absolute url for the given path on the test server.

Definition at line 391 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.setUp

(

self

)

Reimplemented from rosbridge_tools.tornado.testing.AsyncTestCase.

Definition at line 341 of file testing.py.

def rosbridge_tools.tornado.testing.AsyncHTTPTestCase.tearDown

(

self

)

Reimplemented from rosbridge_tools.tornado.testing.AsyncTestCase.

Definition at line 396 of file testing.py.

---

Member Data Documentation

rosbridge_tools::tornado::testing.AsyncHTTPTestCase::__port [private]

Definition at line 341 of file testing.py.

rosbridge_tools::tornado::testing.AsyncHTTPTestCase::_app [private]

Definition at line 341 of file testing.py.

rosbridge_tools::tornado::testing.AsyncHTTPTestCase::http_client

Definition at line 341 of file testing.py.

rosbridge_tools::tornado::testing.AsyncHTTPTestCase::http_server

Definition at line 341 of file testing.py.

---

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

• testing.py