python-openstackclient/openstackclient/tests/identity/v3/test_unscoped_saml.py
Tang Chen d0c0cefb84 Identity: Fix DisplayCommandBase comments for cliff Lister 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 2 in all identity tests.

Change-Id: I2929ee688b1d7afc52c6ab325982bdc24c60a995
Partial-bug: #1477199
2016-02-10 22:44:29 +08:00

133 lines
4.5 KiB
Python

# 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 openstackclient.common import exceptions
from openstackclient.identity.v3 import unscoped_saml
from openstackclient.tests import fakes
from openstackclient.tests.identity.v3 import fakes as identity_fakes
class TestUnscopedSAML(identity_fakes.TestFederatedIdentity):
def setUp(self):
super(TestUnscopedSAML, self).setUp()
federation_lib = self.app.client_manager.identity.federation
self.projects_mock = federation_lib.projects
self.projects_mock.reset_mock()
self.domains_mock = federation_lib.domains
self.domains_mock.reset_mock()
class TestProjectList(TestUnscopedSAML):
def setUp(self):
super(TestProjectList, self).setUp()
self.projects_mock.list.return_value = [
fakes.FakeResource(
None,
copy.deepcopy(identity_fakes.PROJECT),
loaded=True,
),
]
# Get the command object to test
self.cmd = unscoped_saml.ListAccessibleProjects(self.app, None)
def test_accessible_projects_list(self):
self.app.client_manager.auth_plugin_name = 'v3unscopedsaml'
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class Lister in cliff, abstract method take_action()
# returns a tuple containing the column names and an iterable
# containing the data to be listed.
columns, data = self.cmd.take_action(parsed_args)
self.projects_mock.list.assert_called_with()
collist = ('ID', 'Domain ID', 'Enabled', 'Name')
self.assertEqual(collist, columns)
datalist = ((
identity_fakes.project_id,
identity_fakes.domain_id,
True,
identity_fakes.project_name,
), )
self.assertEqual(datalist, tuple(data))
def test_accessible_projects_list_wrong_auth(self):
auth = identity_fakes.FakeAuth("wrong auth")
self.app.client_manager.identity.session.auth = auth
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exceptions.CommandError,
self.cmd.take_action,
parsed_args)
class TestDomainList(TestUnscopedSAML):
def setUp(self):
super(TestDomainList, self).setUp()
self.domains_mock.list.return_value = [
fakes.FakeResource(
None,
copy.deepcopy(identity_fakes.DOMAIN),
loaded=True,
),
]
# Get the command object to test
self.cmd = unscoped_saml.ListAccessibleDomains(self.app, None)
def test_accessible_domains_list(self):
self.app.client_manager.auth_plugin_name = 'v3unscopedsaml'
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class Lister in cliff, abstract method take_action()
# returns a tuple containing the column names and an iterable
# containing the data to be listed.
columns, data = self.cmd.take_action(parsed_args)
self.domains_mock.list.assert_called_with()
collist = ('ID', 'Enabled', 'Name', 'Description')
self.assertEqual(collist, columns)
datalist = ((
identity_fakes.domain_id,
True,
identity_fakes.domain_name,
identity_fakes.domain_description,
), )
self.assertEqual(datalist, tuple(data))
def test_accessible_domains_list_wrong_auth(self):
auth = identity_fakes.FakeAuth("wrong auth")
self.app.client_manager.identity.session.auth = auth
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exceptions.CommandError,
self.cmd.take_action,
parsed_args)