openstack/aodh
Code Issues Proposed changes

API FunctionalTest class lacks doc strings

Browse Source 
add docstrings to api call functions.
Partial-Bug: #1193666

Change-Id: I34a586fba343c88ef8807908eb1667392c016225
This commit is contained in:
Gordon Chung 2013-08-27 10:48:28 -04:00
parent d4fe2614a8
commit dd34d83acc
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
ceilometer/tests/api.py
View File

@ -114,6 +114,17 @@ class FunctionalTest(db_test_base.TestBase):
def put_json(self, path, params, expect_errors=False, headers=None, def put_json(self, path, params, expect_errors=False, headers=None,
extra_environ=None, status=None): extra_environ=None, status=None):
"""Sends simulated HTTP PUT request to Pecan test app.
:param path: url path of target service
:param params: content for wsgi.input of request
:param expect_errors: boolean value whether an error is expected based
on request
:param headers: A dictionary of headers to send along with the request
:param extra_environ: A dictionary of environ variables to send along
with the request
:param status: Expected status code of response
"""
return self.post_json(path=path, params=params, return self.post_json(path=path, params=params,
expect_errors=expect_errors, expect_errors=expect_errors,
headers=headers, extra_environ=extra_environ, headers=headers, extra_environ=extra_environ,
@ -121,6 +132,19 @@ class FunctionalTest(db_test_base.TestBase):
def post_json(self, path, params, expect_errors=False, headers=None, def post_json(self, path, params, expect_errors=False, headers=None,
method="post", extra_environ=None, status=None): method="post", extra_environ=None, status=None):
"""Sends simulated HTTP POST request to Pecan test app.
:param path: url path of target service
:param params: content for wsgi.input of request
:param expect_errors: boolean value whether an error is expected based
on request
:param headers: A dictionary of headers to send along with the request
:param method: Request method type. Appropriate method function call
should be used rather than passing attribute in.
:param extra_environ: A dictionary of environ variables to send along
with the request
:param status: Expected status code of response
"""
full_path = self.PATH_PREFIX + path full_path = self.PATH_PREFIX + path
print('%s: %s %s' % (method.upper(), full_path, params)) print('%s: %s %s' % (method.upper(), full_path, params))
response = getattr(self.app, "%s_json" % method)( response = getattr(self.app, "%s_json" % method)(
@ -136,6 +160,16 @@ class FunctionalTest(db_test_base.TestBase):
def delete(self, path, expect_errors=False, headers=None, def delete(self, path, expect_errors=False, headers=None,
extra_environ=None, status=None): extra_environ=None, status=None):
"""Sends simulated HTTP DELETE request to Pecan test app.
:param path: url path of target service
:param expect_errors: boolean value whether an error is expected based
on request
:param headers: A dictionary of headers to send along with the request
:param extra_environ: A dictionary of environ variables to send along
with the request
:param status: Expected status code of response
"""
full_path = self.PATH_PREFIX + path full_path = self.PATH_PREFIX + path
print('DELETE: %s' % (full_path)) print('DELETE: %s' % (full_path))
response = self.app.delete(str(full_path), response = self.app.delete(str(full_path),
@ -148,6 +182,18 @@ class FunctionalTest(db_test_base.TestBase):
def get_json(self, path, expect_errors=False, headers=None, def get_json(self, path, expect_errors=False, headers=None,
extra_environ=None, q=[], **params): extra_environ=None, q=[], **params):
"""Sends simulated HTTP GET request to Pecan test app.
:param path: url path of target service
:param expect_errors: boolean value whether an error is expected based
on request
:param headers: A dictionary of headers to send along with the request
:param extra_environ: A dictionary of environ variables to send along
with the request
:param q: list of queries consisting of: field, value, op, and type
keys
:param params: content for wsgi.input of request
"""
full_path = self.PATH_PREFIX + path full_path = self.PATH_PREFIX + path
query_params = {'q.field': [], query_params = {'q.field': [],
'q.value': [], 'q.value': [],