openstack
/
horizon
Code Issues Proposed changes

Update docstring of test.helpers.create_mocks 

This commit improves examples in the docstring of create_mocks.

Note that we agreed to use a list over a tuple to define methods
to be mocked for consistency in general.

Part of blueprint mock-framework-in-unit-tests
Change-Id: Ie2e31a7a4f4d205b19190be5960770f83e1ce858
This commit is contained in:
Akihiro Motoki 2018-02-21 23:20:37 +09:00
parent c32b5c1f2e
commit 61c7473bff
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
openstack_dashboard/test/helpers.py
View File

@ -128,7 +128,7 @@ def create_mocks(target_methods):
patched.
A value of "target_methods" is a list of methods to be patched
using mock. Each element can be a string or a tuple
using mock. Each element of the list can be a string or a tuple
consisting of two strings.
A string specifies a method name of "target" object to be mocked.
@ -136,7 +136,12 @@ def create_mocks(target_methods):
can be accessed via 'mock_<method-name>' of the test class.
For example, in case of::
@create_mocks({api.nova: ['server_list']})
@create_mocks({api.nova: ['server_list',
'flavor_list']})
def test_example(self):
...
self.mock_server_list.return_value = ...
self.mock_flavar_list.side_effect = ...
you can access the mocked method via "self.mock_server_list"
inside a test class.
@ -158,11 +163,16 @@ def create_mocks(target_methods):
'usage_get',
('tenant_absolute_limits', 'nova_tenant_absolute_limits'),
'extension_supported',
]})
],
api.cinder: [
('tenant_absolute_limits', 'cinder_tenant_absolute_limits'),
],
})
def test_example(self):
...
self.mock_usage_get.return_value = ...
self.mock_nova_tenant_absolute_limits.return_value = ...
self.mock_cinder_tenant_absolute_limits.return_value = ...
...
self.mock_extension_supported.assert_has_calls(....)