subui.step module

class subui.step.StatefulUrlParamsTestStep(**kwargs)

Bases: subui.step.TestStep

Test step same as TestStep except it references url_args and url_kwargs from the state.

Having url computed from the state, allows for a particular step to change url_args or url_kwargs hence future steps will fetch different resources.

get_url_args()

Get URL args for Django’s reverse

Similar to TestStep.get_url_args() except url args are retrieved by default from state and if not available get args from class attribute.

Returns:tuple of url_args

get_url_kwargs()

Get URL kwargs fpr Django’s reverse

Similar to TestStep.get_url_kwargs() except url args are retrieved by default from state and if not available get kwargs from class attribute.

Returns:dict of url_kwargs

class subui.step.TestStep(**kwargs)

Bases: object

Test step for subui.test_runner.SubUITestRunner.

The step is responsible for executing a self-contained task such as submitting a form to a particular URL and then make assertions regarding the server response.

Variables:

• TestStep.test (unittest.TestCase) – Test class instance with which validators are going to run all their assertions with. By default it is an instance of unittest.TestCase however can be changed to any other class to add additional assertion methods.
• url_name (str) – Name of the url as defined in urls.py by which the URL is going to be calculated.
• url_args (tuple) – URL args to be used while calculating the URL using Django’s reverse.
• url_kwargs (dict) – URL kwargs to be used while calculating the URL using Django’s reverse.
• request_method (str) – HTTP method to use for the request. Default is "post"
• urlconf (str) – Django URL Configuration.
• content_type (str) – Content-Type of the request.
• overriden_settings (dict) – Dictionary of settings to be overriden for the test request.
• data (dict) – Data to be sent to the server in the request
• state (pycontext.context.Context) – Reference to a global state from the test runner.
• TestStep.validators (list) – List of response validators
• response – Server response for the made request. This attribute is only available after request() is called.

Parameters:

kwargs (dict) – A dictionary of values which will overwrite any instance attributes. This allows to pass additional data to the test step without necessarily subclassing and manually instantiating step instance.

content_type = None

data = None

get_content_type()

Get content_type which will be used when making the test request.

By default this returns content_type, if defined, else empty string.

Return type:str

get_override_settings()

Get overriden_settings which will be used to decorate the request with the defined settings to be overriden.

By default this returns overriden_settings, if defined, else empty dict

Return type:dict

get_request_data(data=None)

Get data dict to be sent to the server.

Parameters:data – Data to be used while sending server request. If not defined, data is returned. Return type:dict

get_request_kwargs()

Get kwargs to be passed to the client.

By default this returns dict of format:

{
    'path': ...,
    'data': ...
}

Can be overwritten in case additional parameters need to be passed to the client to make the request.

Return type:dict

get_url()

Compute the URL to request using Django’s reverse.

Reverse is called using url_name, get_url_args() and get_url_args().

Return type:str

get_url_args()

Get url_args which will be used to compute the URL using reverse.

By default this returns url_args, if defined, else empty tuple.

Return type:tuple

get_url_kwargs()

Get url_kwargs which will be used to compute the URL using reverse.

By default this returns url_kwargs, if defined, else empty dict.

Return type:dict

get_urlconf()

Get urlconf which will be used to compute the URL using reverse

By default this returns urlconf, if defined, else None

Return type:str

get_validators()

Get all validators.

By default returns validators however can be used as a hook to returns additional validators dynamically.

Return type:list

init(client, steps, step_index, step_key, state)

Initialize the step with necessary values from the test runner.

Parameters:

• client (django.test.client.Client) – Django test client to use to make server requests
• steps (collections.OrderedDict) – All steps from the test runner. This and step index allows to get previous and/or next steps.
• step_index (int) – Index of the step within all steps test runner will execute.
• step_key (str) – Key of the state of how it was provided to the test runner in case test step needs to reference other steps within the runner by their.
• state (platform_utils.utils.dt_context.BaseContext) – Global state reference from the test runner.

next_step

Get previous step instance, if any.

Return type:TestStep

next_steps

Get collections.OrderedDict of next steps excluding itself, if any.

Return type:collections.OrderedDict

overriden_settings = None

post_request_hook()

Hook which is executed after server request is sent.

post_test_response()

Hook which is executed after validating the response.

pre_request_hook()

Hook which is executed before server request is sent.

pre_test_response()

Hook which is executed before validating the response.

prev_step

Get previous step instance, if any.

Return type:TestStep

prev_steps

Get collections.OrderedDict of previous steps excluding itself, if any.

Note

The steps are returned in order of adjacency from the current step. For example (using list instead of OrederedDict in example):

> step = TestStep()
> step.steps = [0, 1, 2, 3, 4]
> step.step_index = 3
> step.prev_steps
[2, 1, 0]

Return type:collections.OrderedDict

request()

Make the server request. Server response is then saved in request.

Before making the request, pre_request_hook() is called and post_request_hook() is called after the request.

Returns:server response

request_method = u'post'

state = None

test = <unittest.case.TestCase testMethod=__init__>

test_response()

Test the server response by looping over all validators as returned by get_validators().

Before assertions, pre_test_response() is called and post_test_response() is called after assertions.

url_args = None

url_kwargs = None

url_name = None

urlconf = None

validators = []