openstack/nova
Code Issues Proposed changes

Adds infrastructure for microversioned api samples

Browse Source 
This adds the necessary infrastructure to support the generation
and testing of microversioned api samples. The new api sample tests
require a request_api_version class attribute which
defines what api version is requested when running the tests and
where the api samples are stored for this specific version

Partially implements bp api-microversions
Co-Authored-By: Claudiu Belu <cbelu@cloudbasesolutions.com>

Change-Id: I6ea8ec1b4e2439d8d2c856c399d31af838a3edf8
This commit is contained in:
Chris Yeoh
2015-02-12 15:39:57 +10:30
parent eee39db9e9
commit 4dbd37b1fd
2 changed files with 27 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
nova/tests/functional/api_samples_test_base.py
View File

@@ -32,6 +32,7 @@ class ApiSampleTestBase(integrated_helpers._IntegratedTestBase):
ctype = 'json'
all_extensions = False
extension_name = None
request_api_version = None
def _pretty_data(self, data):
data = jsonutils.dumps(jsonutils.loads(data), sort_keys=True,
@@ -46,7 +47,7 @@ class ApiSampleTestBase(integrated_helpers._IntegratedTestBase):
return jsonutils.loads(data)
@classmethod
def _get_sample_path(cls, name, dirname, suffix=''):
def _get_sample_path(cls, name, dirname, suffix='', api_version=None):
parts = [dirname]
parts.append('api_samples')
if cls.all_extensions:
@@ -58,27 +59,30 @@ class ApiSampleTestBase(integrated_helpers._IntegratedTestBase):
return os.path.join(*parts)
@classmethod
def _get_sample(cls, name):
def _get_sample(cls, name, api_version):
dirname = os.path.dirname(os.path.abspath(__file__))
dirname = os.path.normpath(os.path.join(dirname, "../../../doc"))
return cls._get_sample_path(name, dirname)
return cls._get_sample_path(name, dirname, api_version=api_version)
@classmethod
def _get_template(cls, name):
def _get_template(cls, name, api_version):
dirname = os.path.dirname(os.path.abspath(__file__))
return cls._get_sample_path(name, dirname, suffix='.tpl')
return cls._get_sample_path(name, dirname, suffix='.tpl',
api_version=api_version)
def _read_template(self, name):
template = self._get_template(name)
template = self._get_template(name, self.request_api_version)
with open(template) as inf:
return inf.read().strip()
def _write_template(self, name, data):
with open(self._get_template(name), 'w') as outf:
with open(self._get_template(name,
self.request_api_version), 'w') as outf:
outf.write(data)
def _write_sample(self, name, data):
with open(self._get_sample(name), 'w') as outf:
with open(self._get_sample(
name, self.request_api_version), 'w') as outf:
outf.write(data)
def _compare_result(self, subs, expected, result, result_str):
@@ -195,18 +199,21 @@ class ApiSampleTestBase(integrated_helpers._IntegratedTestBase):
self.assertEqual(response.status_code, exp_code)
response_data = response.content
response_data = self._pretty_data(response_data)
if not os.path.exists(self._get_template(name)):
if not os.path.exists(self._get_template(name,
self.request_api_version)):
self._write_template(name, response_data)
template_data = response_data
else:
template_data = self._read_template(name)
if (self.generate_samples and
not os.path.exists(self._get_sample(name))):
not os.path.exists(self._get_sample(
name, self.request_api_version))):
self._write_sample(name, response_data)
sample_data = response_data
else:
with file(self._get_sample(name)) as sample:
with file(self._get_sample(name,
self.request_api_version)) as sample:
sample_data = sample.read()
try:
@@ -287,7 +294,7 @@ class ApiSampleTestBase(integrated_helpers._IntegratedTestBase):
def _do_post(self, url, name, subs, method='POST', api_version=None):
body = self._read_template(name) % subs
sample = self._get_sample(name)
sample = self._get_sample(name, self.request_api_version)
if self.generate_samples and not os.path.exists(sample):
self._write_sample(name, body)
return self._get_response(url, method, body, api_version=api_version)

13
nova/tests/functional/v3/api_sample_base.py
View File

@@ -54,7 +54,7 @@ class ApiSampleTestBaseV3(api_samples_test_base.ApiSampleTestBase):
self.generate_samples = os.getenv('GENERATE_SAMPLES') is not None
@classmethod
def _get_sample_path(cls, name, dirname, suffix=''):
def _get_sample_path(cls, name, dirname, suffix='', api_version=None):
parts = [dirname]
parts.append('api_samples')
if cls.all_extensions:
@@ -63,17 +63,20 @@ class ApiSampleTestBaseV3(api_samples_test_base.ApiSampleTestBase):
parts.append(cls.sample_dir)
elif cls.extension_name:
parts.append(cls.extension_name)
if api_version:
parts.append('v' + api_version)
parts.append(name + "." + cls.ctype + suffix)
return os.path.join(*parts)
@classmethod
def _get_sample(cls, name):
def _get_sample(cls, name, api_version=None):
dirname = os.path.dirname(os.path.abspath(__file__))
dirname = os.path.normpath(os.path.join(dirname,
"../../../../doc/v3"))
return cls._get_sample_path(name, dirname)
return cls._get_sample_path(name, dirname, api_version=api_version)
@classmethod
def _get_template(cls, name):
def _get_template(cls, name, api_version=None):
dirname = os.path.dirname(os.path.abspath(__file__))
return cls._get_sample_path(name, dirname, suffix='.tpl')
return cls._get_sample_path(name, dirname, suffix='.tpl',
api_version=api_version)