openstack/python-openstackclient
Code Issues Proposed changes
56a232c79f
python-openstackclient/openstackclient/tests/object/v1/test_container_all.py
Tang Chen 35833f7bd8 Fix DisplayCommandBase comments for cliff ShowOne subclass tests 
As bug #1477199 describes, the wrong comment below is all over the
unit test code of OSC.

    # DisplayCommandBase.take_action() returns two tuples

There is no such class named DisplayCommandBase in OSC. It is in cliff.

All OSC command classes inherit from the base classes in cliff,
class Command, class Lister and class ShowOne. It is like this:

Object
|--> Command
     |--> DisplayCommandBase
          |--> Lister
          |--> ShowOne

take_action() is an abstract method of class Command, and generally is
overwritten by subclasses.
* Command.take_action() returns nothing.
* Lister.take_action() returns a tuple which contains a tuple of columns
  and a generator used to generate the data.
* ShowOne.take_action() returns an iterator which contains a tuple of
  columns and a tuple of data.

So, this problem should be fixed in 3 steps:
1. Remove all DisplayCommandBase comments for tests of classes inheriting
   from class Command in cliff as it returns nothing.
2. Fix all DisplayCommandBase comments for tests of classes inheriting
   from class Lister in cliff. Lister.take_action() returns a tuple and
   a generator.
3. Fix all DisplayCommandBase comments for tests of classes inheriting
   from class ShowOne in cliff. ShowOne.take_action() returns two tuples.

This patch finishes step 3 in all but identity tests. There are too many
such comments in identity tests. So fix them all in another patch.

Change-Id: I1afe4852069d25d562a9448ec2bf2cff58955052
Partial-bug: #1477199
2016-02-10 13:31:38 +08:00

346 lines
9.9 KiB
Python
Raw Blame History

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
import copy
from requests_mock.contrib import fixture
from openstackclient.object.v1 import container as container_cmds
from openstackclient.tests.object.v1 import fakes as object_fakes
class TestContainerAll(object_fakes.TestObjectv1):
def setUp(self):
super(TestContainerAll, self).setUp()
self.requests_mock = self.useFixture(fixture.Fixture())
class TestContainerCreate(TestContainerAll):
columns = (
'account',
'container',
'x-trans-id',
)
def setUp(self):
super(TestContainerCreate, self).setUp()
# Get the command object to test
self.cmd = container_cmds.CreateContainer(self.app, None)
def test_object_create_container_single(self):
self.requests_mock.register_uri(
'PUT',
object_fakes.ENDPOINT + '/ernie',
headers={'x-trans-id': '314159'},
status_code=200,
)
arglist = [
'ernie',
]
verifylist = [(
'containers', ['ernie'],
)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class ShowOne in cliff, abstract method take_action()
# returns a two-part tuple with a tuple of column names and a tuple of
# data to be shown.
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns, columns)
datalist = [(
object_fakes.ACCOUNT_ID,
'ernie',
'314159',
)]
self.assertEqual(datalist, list(data))
def test_object_create_container_more(self):
self.requests_mock.register_uri(
'PUT',
object_fakes.ENDPOINT + '/ernie',
headers={'x-trans-id': '314159'},
status_code=200,
)
self.requests_mock.register_uri(
'PUT',
object_fakes.ENDPOINT + '/bert',
headers={'x-trans-id': '42'},
status_code=200,
)
arglist = [
'ernie',
'bert',
]
verifylist = [(
'containers', ['ernie', 'bert'],
)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class ShowOne in cliff, abstract method take_action()
# returns a two-part tuple with a tuple of column names and a tuple of
# data to be shown.
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns, columns)
datalist = [
(
object_fakes.ACCOUNT_ID,
'ernie',
'314159',
),
(
object_fakes.ACCOUNT_ID,
'bert',
'42',
),
]
self.assertEqual(datalist, list(data))
class TestContainerDelete(TestContainerAll):
def setUp(self):
super(TestContainerDelete, self).setUp()
# Get the command object to test
self.cmd = container_cmds.DeleteContainer(self.app, None)
def test_object_delete_container_single(self):
self.requests_mock.register_uri(
'DELETE',
object_fakes.ENDPOINT + '/ernie',
status_code=200,
)
arglist = [
'ernie',
]
verifylist = [(
'containers', ['ernie'],
)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# Command.take_action() returns None
ret = self.cmd.take_action(parsed_args)
self.assertIsNone(ret)
def test_object_delete_container_more(self):
self.requests_mock.register_uri(
'DELETE',
object_fakes.ENDPOINT + '/ernie',
status_code=200,
)
self.requests_mock.register_uri(
'DELETE',
object_fakes.ENDPOINT + '/bert',
status_code=200,
)
arglist = [
'ernie',
'bert',
]
verifylist = [(
'containers', ['ernie', 'bert'],
)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# Command.take_action() returns None
ret = self.cmd.take_action(parsed_args)
self.assertIsNone(ret)
class TestContainerList(TestContainerAll):
columns = ('Name',)
def setUp(self):
super(TestContainerList, self).setUp()
# Get the command object to test
self.cmd = container_cmds.ListContainer(self.app, None)
def test_object_list_containers_no_options(self):
return_body = [
copy.deepcopy(object_fakes.CONTAINER),
copy.deepcopy(object_fakes.CONTAINER_3),
copy.deepcopy(object_fakes.CONTAINER_2),
]
self.requests_mock.register_uri(
'GET',
object_fakes.ENDPOINT + '?format=json',
json=return_body,
status_code=200,
)
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# Lister.take_action() returns two tuples
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns, columns)
datalist = [
(object_fakes.container_name, ),
(object_fakes.container_name_3, ),
(object_fakes.container_name_2, ),
]
self.assertEqual(datalist, list(data))
def test_object_list_containers_prefix(self):
return_body = [
copy.deepcopy(object_fakes.CONTAINER),
copy.deepcopy(object_fakes.CONTAINER_3),
]
self.requests_mock.register_uri(
'GET',
object_fakes.ENDPOINT + '?format=json&prefix=bit',
json=return_body,
status_code=200,
)
arglist = [
'--prefix', 'bit',
]
verifylist = [
('prefix', 'bit'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# Lister.take_action() returns two tuples
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns, columns)
datalist = [
(object_fakes.container_name, ),
(object_fakes.container_name_3, ),
]
self.assertEqual(datalist, list(data))
class TestContainerSave(TestContainerAll):
def setUp(self):
super(TestContainerSave, self).setUp()
# Get the command object to test
self.cmd = container_cmds.SaveContainer(self.app, None)
# TODO(dtroyer): need to mock out object_lib.save_object() to test this
# def test_object_save_container(self):
# return_body = [
# copy.deepcopy(object_fakes.OBJECT),
# copy.deepcopy(object_fakes.OBJECT_2),
# ]
# # Initial container list request
# self.requests_mock.register_uri(
# 'GET',
# object_fakes.ENDPOINT + '/oscar?format=json',
# json=return_body,
# status_code=200,
# )
# # Individual object save requests
# self.requests_mock.register_uri(
# 'GET',
# object_fakes.ENDPOINT + '/oscar/' + object_fakes.object_name_1,
# json=object_fakes.OBJECT,
# status_code=200,
# )
# self.requests_mock.register_uri(
# 'GET',
# object_fakes.ENDPOINT + '/oscar/' + object_fakes.object_name_2,
# json=object_fakes.OBJECT_2,
# status_code=200,
# )
#
# arglist = [
# 'oscar',
# ]
# verifylist = [(
# 'container', 'oscar',
# )]
# parsed_args = self.check_parser(self.cmd, arglist, verifylist)
#
# # Command.take_action() returns None
# ret = self.cmd.take_action(parsed_args)
# self.assertIsNone(ret)
class TestContainerShow(TestContainerAll):
def setUp(self):
super(TestContainerShow, self).setUp()
# Get the command object to test
self.cmd = container_cmds.ShowContainer(self.app, None)
def test_object_show_container(self):
headers = {
'x-container-object-count': '42',
'x-container-bytes-used': '123',
'x-container-read': 'qaz',
'x-container-write': 'wsx',
'x-container-sync-to': 'edc',
'x-container-sync-key': 'rfv',
}
self.requests_mock.register_uri(
'HEAD',
object_fakes.ENDPOINT + '/ernie',
headers=headers,
status_code=200,
)
arglist = [
'ernie',
]
verifylist = [(
'container', 'ernie',
)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class ShowOne in cliff, abstract method take_action()
# returns a two-part tuple with a tuple of column names and a tuple of
# data to be shown.
columns, data = self.cmd.take_action(parsed_args)
collist = (
'account',
'bytes_used',
'container',
'object_count',
'read_acl',
'sync_key',
'sync_to',
'write_acl',
)
self.assertEqual(collist, columns)
datalist = [
object_fakes.ACCOUNT_ID,
'123',
'ernie',
'42',
'qaz',
'rfv',
'edc',
'wsx',
]
self.assertEqual(datalist, list(data))
View Git Blame Copy Permalink