fix comments and docstrings misspelled words
Change-Id: I355b6fedf372b1273ceaebe22e8e890aa9c913c9 Closes-bug: #1267103
This commit is contained in:
parent
61a715e17e
commit
70d2c8c2d8
@ -38,7 +38,7 @@ Controlling the Growth of the Image Cache
|
|||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The image cache has a configurable maximum size (the ``image_cache_max_size``
|
The image cache has a configurable maximum size (the ``image_cache_max_size``
|
||||||
configuration file option. However, when images are succesfully returned
|
configuration file option. However, when images are successfully returned
|
||||||
from a call to ``GET /images/<IMAGE_ID>``, the image cache automatically
|
from a call to ``GET /images/<IMAGE_ID>``, the image cache automatically
|
||||||
writes the image file to its cache, regardless of whether the resulting
|
writes the image file to its cache, regardless of whether the resulting
|
||||||
write would make the image cache's size exceed the value of
|
write would make the image cache's size exceed the value of
|
||||||
|
@ -101,7 +101,7 @@ JSON-encoded mapping in the following format::
|
|||||||
The `checksum` field is an MD5 checksum of the image file data
|
The `checksum` field is an MD5 checksum of the image file data
|
||||||
|
|
||||||
The `is_public` field is a boolean indicating whether the image is
|
The `is_public` field is a boolean indicating whether the image is
|
||||||
publically available
|
publicly available
|
||||||
|
|
||||||
The `min_ram` field is an integer specifying the minimum amount of
|
The `min_ram` field is an integer specifying the minimum amount of
|
||||||
ram needed to run this image on an instance, in megabytes
|
ram needed to run this image on an instance, in megabytes
|
||||||
@ -252,7 +252,7 @@ following shows an example of the HTTP headers returned from the above
|
|||||||
`x-image-meta-checksum` value
|
`x-image-meta-checksum` value
|
||||||
|
|
||||||
The response's `x-image-meta-is_public` value is a boolean indicating
|
The response's `x-image-meta-is_public` value is a boolean indicating
|
||||||
whether the image is publically available
|
whether the image is publicly available
|
||||||
|
|
||||||
The response's `x-image-meta-owner` value is a string which may either
|
The response's `x-image-meta-owner` value is a string which may either
|
||||||
be null or which will indicate the owner of the image
|
be null or which will indicate the owner of the image
|
||||||
@ -318,7 +318,7 @@ returned from the above ``GET`` request::
|
|||||||
`x-image-meta-checksum` value
|
`x-image-meta-checksum` value
|
||||||
|
|
||||||
The response's `x-image-meta-is_public` value is a boolean indicating
|
The response's `x-image-meta-is_public` value is a boolean indicating
|
||||||
whether the image is publically available
|
whether the image is publicly available
|
||||||
|
|
||||||
The response's `x-image-meta-owner` value is a string which may either
|
The response's `x-image-meta-owner` value is a string which may either
|
||||||
be null or which will indicate the owner of the image
|
be null or which will indicate the owner of the image
|
||||||
|
@ -52,7 +52,7 @@ Images in Glance can be in one the following statuses:
|
|||||||
|
|
||||||
* ``pending_delete``
|
* ``pending_delete``
|
||||||
|
|
||||||
This is similiar to `deleted`, however, Glance has not yet removed the
|
This is similar to `deleted`, however, Glance has not yet removed the
|
||||||
image data. An image in this state is recoverable.
|
image data. An image in this state is recoverable.
|
||||||
|
|
||||||
|
|
||||||
|
@ -603,7 +603,7 @@ class Controller(controller.BaseController):
|
|||||||
:param req: The WSGI/Webob Request object
|
:param req: The WSGI/Webob Request object
|
||||||
:param image_id: Opaque image identifier
|
:param image_id: Opaque image identifier
|
||||||
:param location: Location of where Glance stored this image
|
:param location: Location of where Glance stored this image
|
||||||
:param location_metadata: a dictionary of storage specfic information
|
:param location_metadata: a dictionary of storage specific information
|
||||||
"""
|
"""
|
||||||
image_meta = {}
|
image_meta = {}
|
||||||
image_meta['location'] = location
|
image_meta['location'] = location
|
||||||
|
@ -138,7 +138,7 @@ class KeystoneStrategy(BaseStrategy):
|
|||||||
if 'v2.0' not in auth_url:
|
if 'v2.0' not in auth_url:
|
||||||
auth_url = urlparse.urljoin(auth_url, 'v2.0/')
|
auth_url = urlparse.urljoin(auth_url, 'v2.0/')
|
||||||
else:
|
else:
|
||||||
# If we sucessfully auth'd, then memorize the correct auth_url
|
# If we successfully auth'd, then memorize the correct auth_url
|
||||||
# for future use.
|
# for future use.
|
||||||
self.creds['auth_url'] = auth_url
|
self.creds['auth_url'] = auth_url
|
||||||
break
|
break
|
||||||
|
@ -284,7 +284,7 @@ class Server(object):
|
|||||||
signal.signal(signal.SIGTERM, signal.SIG_DFL)
|
signal.signal(signal.SIGTERM, signal.SIG_DFL)
|
||||||
# ignore the interrupt signal to avoid a race whereby
|
# ignore the interrupt signal to avoid a race whereby
|
||||||
# a child worker receives the signal before the parent
|
# a child worker receives the signal before the parent
|
||||||
# and is respawned unneccessarily as a result
|
# and is respawned unnecessarily as a result
|
||||||
signal.signal(signal.SIGINT, signal.SIG_IGN)
|
signal.signal(signal.SIGINT, signal.SIG_IGN)
|
||||||
self.run_server()
|
self.run_server()
|
||||||
self.logger.info(_('Child %d exiting normally') % os.getpid())
|
self.logger.info(_('Child %d exiting normally') % os.getpid())
|
||||||
|
@ -1175,7 +1175,7 @@ def task_get_all(context, filters=None, marker=None, limit=None,
|
|||||||
tasks = []
|
tasks = []
|
||||||
for task_ref in task_refs:
|
for task_ref in task_refs:
|
||||||
# NOTE(venkatesh): call to task_ref.info does not make any
|
# NOTE(venkatesh): call to task_ref.info does not make any
|
||||||
# seperate query call to fetch task info as it has been
|
# separate query call to fetch task info as it has been
|
||||||
# eagerly loaded using joinedload(models.Task.info) method above.
|
# eagerly loaded using joinedload(models.Task.info) method above.
|
||||||
task_info_ref = task_ref.info
|
task_info_ref = task_ref.info
|
||||||
tasks.append(_task_format(task_ref, task_info_ref))
|
tasks.append(_task_format(task_ref, task_info_ref))
|
||||||
|
@ -81,7 +81,7 @@ def execute(*cmd, **kwargs):
|
|||||||
:param cmd: Passed to subprocess.Popen.
|
:param cmd: Passed to subprocess.Popen.
|
||||||
:type cmd: string
|
:type cmd: string
|
||||||
:param process_input: Send to opened process.
|
:param process_input: Send to opened process.
|
||||||
:type proces_input: string
|
:type process_input: string
|
||||||
:param check_exit_code: Single bool, int, or list of allowed exit
|
:param check_exit_code: Single bool, int, or list of allowed exit
|
||||||
codes. Defaults to [0]. Raise
|
codes. Defaults to [0]. Raise
|
||||||
:class:`ProcessExecutionError` unless
|
:class:`ProcessExecutionError` unless
|
||||||
|
@ -49,7 +49,7 @@ registry_client_ctx_opts = [
|
|||||||
cfg.StrOpt('admin_password', secret=True,
|
cfg.StrOpt('admin_password', secret=True,
|
||||||
help=_('The administrators password.')),
|
help=_('The administrators password.')),
|
||||||
cfg.StrOpt('admin_tenant_name', secret=True,
|
cfg.StrOpt('admin_tenant_name', secret=True,
|
||||||
help=_('The tenant name of the adminstrative user.')),
|
help=_('The tenant name of the administrative user.')),
|
||||||
cfg.StrOpt('auth_url',
|
cfg.StrOpt('auth_url',
|
||||||
help=_('The URL to the keystone service.')),
|
help=_('The URL to the keystone service.')),
|
||||||
cfg.StrOpt('auth_strategy', default='noauth',
|
cfg.StrOpt('auth_strategy', default='noauth',
|
||||||
|
@ -180,7 +180,7 @@ class Store(glance.store.base.Store):
|
|||||||
% (CONF.filesystem_store_metadata_file, ioe))
|
% (CONF.filesystem_store_metadata_file, ioe))
|
||||||
return {}
|
return {}
|
||||||
except Exception as ex:
|
except Exception as ex:
|
||||||
LOG.exception(_('An error occured processing the storage systems '
|
LOG.exception(_('An error occurred processing the storage systems '
|
||||||
'meta data file: %s. An empty dictionary will be '
|
'meta data file: %s. An empty dictionary will be '
|
||||||
'returned to the client.') % str(ex))
|
'returned to the client.') % str(ex))
|
||||||
return {}
|
return {}
|
||||||
|
@ -45,7 +45,7 @@ s3_opts = [
|
|||||||
help=_('The S3 bucket to be used to store the Glance data.')),
|
help=_('The S3 bucket to be used to store the Glance data.')),
|
||||||
cfg.StrOpt('s3_store_object_buffer_dir',
|
cfg.StrOpt('s3_store_object_buffer_dir',
|
||||||
help=_('The local directory where uploads will be staged '
|
help=_('The local directory where uploads will be staged '
|
||||||
'before they are transfered into S3.')),
|
'before they are transferred into S3.')),
|
||||||
cfg.BoolOpt('s3_store_create_bucket_on_put', default=False,
|
cfg.BoolOpt('s3_store_create_bucket_on_put', default=False,
|
||||||
help=_('A boolean to determine if the S3 bucket should be '
|
help=_('A boolean to determine if the S3 bucket should be '
|
||||||
'created on upload if it does not exist or if '
|
'created on upload if it does not exist or if '
|
||||||
|
@ -895,7 +895,7 @@ class DriverTests(object):
|
|||||||
result = self.db_api.is_image_visible(ctxt2, image)
|
result = self.db_api.is_image_visible(ctxt2, image)
|
||||||
self.assertTrue(result)
|
self.assertTrue(result)
|
||||||
|
|
||||||
# image should not be visible for a deleted memeber
|
# image should not be visible for a deleted member
|
||||||
members = self.db_api.image_member_find(ctxt1, image_id=UUIDX)
|
members = self.db_api.image_member_find(ctxt1, image_id=UUIDX)
|
||||||
self.db_api.image_member_delete(ctxt1, members[0]['id'])
|
self.db_api.image_member_delete(ctxt1, members[0]['id'])
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ class TestScrubber(functional.FunctionalTest):
|
|||||||
|
|
||||||
def test_delayed_delete(self):
|
def test_delayed_delete(self):
|
||||||
"""
|
"""
|
||||||
test that images don't get deleted immediatly and that the scrubber
|
test that images don't get deleted immediately and that the scrubber
|
||||||
scrubs them
|
scrubs them
|
||||||
"""
|
"""
|
||||||
self.cleanup()
|
self.cleanup()
|
||||||
@ -404,7 +404,7 @@ class TestScrubber(functional.FunctionalTest):
|
|||||||
"""
|
"""
|
||||||
NOTE(jkoelker) The build servers sometimes take longer than 15 seconds
|
NOTE(jkoelker) The build servers sometimes take longer than 15 seconds
|
||||||
to scrub. Give it up to 5 min, checking checking every 15 seconds.
|
to scrub. Give it up to 5 min, checking checking every 15 seconds.
|
||||||
When/if it flips to deleted, bail immediatly.
|
When/if it flips to deleted, bail immediately.
|
||||||
"""
|
"""
|
||||||
http = httplib2.Http()
|
http = httplib2.Http()
|
||||||
wait_for = 300 # seconds
|
wait_for = 300 # seconds
|
||||||
|
@ -81,7 +81,7 @@ class TestMiscellaneous(functional.FunctionalTest):
|
|||||||
self.assertEqual(response['x-image-meta-name'], "Image1")
|
self.assertEqual(response['x-image-meta-name'], "Image1")
|
||||||
|
|
||||||
# 4. GET /images/1
|
# 4. GET /images/1
|
||||||
# Verify the api throws the apropriate 404 error
|
# Verify the api throws the appropriate 404 error
|
||||||
path = "http://%s:%d/v1/images/1" % ("127.0.0.1", self.api_port)
|
path = "http://%s:%d/v1/images/1" % ("127.0.0.1", self.api_port)
|
||||||
http = httplib2.Http()
|
http = httplib2.Http()
|
||||||
response, content = http.request(path, 'GET')
|
response, content = http.request(path, 'GET')
|
||||||
|
@ -2028,7 +2028,7 @@ class TestImageMembers(functional.FunctionalTest):
|
|||||||
self.assertEqual(3, len(images))
|
self.assertEqual(3, len(images))
|
||||||
|
|
||||||
# Image list should contain 0 shared images for TENANT3
|
# Image list should contain 0 shared images for TENANT3
|
||||||
# becuase default is accepted
|
# because default is accepted
|
||||||
path = self._url('/v2/images?visibility=shared')
|
path = self._url('/v2/images?visibility=shared')
|
||||||
response = requests.get(path, headers=get_header(TENANT3))
|
response = requests.get(path, headers=get_header(TENANT3))
|
||||||
self.assertEqual(200, response.status_code)
|
self.assertEqual(200, response.status_code)
|
||||||
|
@ -409,7 +409,7 @@ class TestKeystoneAuthPlugin(utils.BaseTestCase):
|
|||||||
'auth_url': 'http://localhost/redirect/v2.0/',
|
'auth_url': 'http://localhost/redirect/v2.0/',
|
||||||
'password': 'pass',
|
'password': 'pass',
|
||||||
'strategy': 'keystone',
|
'strategy': 'keystone',
|
||||||
'region': 'NonExistantRegion'
|
'region': 'NonExistentRegion'
|
||||||
}
|
}
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
@ -358,7 +358,7 @@ class ImageCacheTestCase(object):
|
|||||||
def consume(image_id):
|
def consume(image_id):
|
||||||
caching_iter = self.cache.get_caching_iter(image_id, None,
|
caching_iter = self.cache.get_caching_iter(image_id, None,
|
||||||
faulty_backend())
|
faulty_backend())
|
||||||
# excercise the caching_iter
|
# exercise the caching_iter
|
||||||
list(caching_iter)
|
list(caching_iter)
|
||||||
|
|
||||||
image_id = '1'
|
image_id = '1'
|
||||||
|
@ -1250,7 +1250,7 @@ class TestGlanceAPI(base.IsolatedUnitTest):
|
|||||||
'update_active', 'image_get_active'],
|
'update_active', 'image_get_active'],
|
||||||
called)
|
called)
|
||||||
|
|
||||||
# Ensure cleanup occured.
|
# Ensure cleanup occurred.
|
||||||
self.assertTrue(mock_initiate_deletion.called)
|
self.assertTrue(mock_initiate_deletion.called)
|
||||||
|
|
||||||
def test_register_and_upload(self):
|
def test_register_and_upload(self):
|
||||||
@ -3553,7 +3553,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
def test_update_protected_props_mix_no_read(self):
|
def test_update_protected_props_mix_no_read(self):
|
||||||
"""
|
"""
|
||||||
Create an image with two props - one only readable by admin, and one
|
Create an image with two props - one only readable by admin, and one
|
||||||
readable/updatable by member. Verify member can sucessfully update
|
readable/updatable by member. Verify member can successfully update
|
||||||
their property while the admin owned one is ignored transparently
|
their property while the admin owned one is ignored transparently
|
||||||
"""
|
"""
|
||||||
image_id = self._create_admin_image(
|
image_id = self._create_admin_image(
|
||||||
@ -3609,7 +3609,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
def test_delete_protected_props_mix_no_read(self):
|
def test_delete_protected_props_mix_no_read(self):
|
||||||
"""
|
"""
|
||||||
Create an image with two props - one only readable by admin, and one
|
Create an image with two props - one only readable by admin, and one
|
||||||
readable/deletable by member. Verify member can sucessfully delete
|
readable/deletable by member. Verify member can successfully delete
|
||||||
their property while the admin owned one is ignored transparently
|
their property while the admin owned one is ignored transparently
|
||||||
"""
|
"""
|
||||||
image_id = self._create_admin_image(
|
image_id = self._create_admin_image(
|
||||||
@ -3719,7 +3719,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_create_locked_down_protected_prop(self):
|
def test_create_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is creatable by noone
|
Verify a property protected by special char '!' is creatable by no one
|
||||||
"""
|
"""
|
||||||
image_id = self._create_admin_image()
|
image_id = self._create_admin_image()
|
||||||
another_request = unit_test_utils.get_fake_request(
|
another_request = unit_test_utils.get_fake_request(
|
||||||
@ -3742,7 +3742,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_read_locked_down_protected_prop(self):
|
def test_read_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is readable by noone
|
Verify a property protected by special char '!' is readable by no one
|
||||||
"""
|
"""
|
||||||
custom_props = {
|
custom_props = {
|
||||||
'x-image-meta-property-x_none_read': '1'
|
'x-image-meta-property-x_none_read': '1'
|
||||||
@ -3768,7 +3768,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_update_locked_down_protected_prop(self):
|
def test_update_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is updatable by noone
|
Verify a property protected by special char '!' is updatable by no one
|
||||||
"""
|
"""
|
||||||
image_id = self._create_admin_image(
|
image_id = self._create_admin_image(
|
||||||
{'x-image-meta-property-x_none_update': '1'})
|
{'x-image-meta-property-x_none_update': '1'})
|
||||||
@ -3792,7 +3792,7 @@ class TestAPIProtectedProps(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_delete_locked_down_protected_prop(self):
|
def test_delete_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is deletable by noone
|
Verify a property protected by special char '!' is deletable by no one
|
||||||
"""
|
"""
|
||||||
image_id = self._create_admin_image(
|
image_id = self._create_admin_image(
|
||||||
{'x-image-meta-property-x_none_delete': '1'})
|
{'x-image-meta-property-x_none_delete': '1'})
|
||||||
|
@ -1114,7 +1114,7 @@ class TestImagesController(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_create_locked_down_protected_prop(self):
|
def test_create_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is creatable by noone
|
Verify a property protected by special char '!' is creatable by no one
|
||||||
"""
|
"""
|
||||||
self.set_property_protections()
|
self.set_property_protections()
|
||||||
request = unit_test_utils.get_fake_request(roles=['admin'])
|
request = unit_test_utils.get_fake_request(roles=['admin'])
|
||||||
@ -1133,7 +1133,7 @@ class TestImagesController(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_read_locked_down_protected_prop(self):
|
def test_read_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is readable by noone
|
Verify a property protected by special char '!' is readable by no one
|
||||||
"""
|
"""
|
||||||
self.set_property_protections()
|
self.set_property_protections()
|
||||||
request = unit_test_utils.get_fake_request(roles=['member'])
|
request = unit_test_utils.get_fake_request(roles=['member'])
|
||||||
@ -1149,7 +1149,7 @@ class TestImagesController(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_update_locked_down_protected_prop(self):
|
def test_update_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is updatable by noone
|
Verify a property protected by special char '!' is updatable by no one
|
||||||
"""
|
"""
|
||||||
self.set_property_protections()
|
self.set_property_protections()
|
||||||
request = unit_test_utils.get_fake_request(roles=['admin'])
|
request = unit_test_utils.get_fake_request(roles=['admin'])
|
||||||
@ -1167,7 +1167,7 @@ class TestImagesController(base.IsolatedUnitTest):
|
|||||||
|
|
||||||
def test_delete_locked_down_protected_prop(self):
|
def test_delete_locked_down_protected_prop(self):
|
||||||
"""
|
"""
|
||||||
Verify a property protected by special char '!' is deletable by noone
|
Verify a property protected by special char '!' is deletable by no one
|
||||||
"""
|
"""
|
||||||
self.set_property_protections()
|
self.set_property_protections()
|
||||||
request = unit_test_utils.get_fake_request(roles=['admin'])
|
request = unit_test_utils.get_fake_request(roles=['admin'])
|
||||||
|
Loading…
Reference in New Issue
Block a user