5b3a827a1f
For negative tests that are asserting an argparse failure it would be useful to assert the specific reason for the failure in the test rather than just getting an exception, especially to avoid false positives in the tests when what is being tested and failing isn't the actual expected reason for the failure. This wraps the check_parser code that parses the args and mocks sys.stderr so we can trap that output and put it in the exception message that gets raised to the test. As a result, we can tighten up a test that was passing before for the wrong reason [1]. [1] https://review.opendev.org/#/c/673725/12/openstackclient/tests/unit/compute/v2/test_server.py@605 Change-Id: I0f1dc1215bdfb3eba98ccaf66a0041d220b93812
104 lines
3.6 KiB
Python
104 lines
3.6 KiB
Python
# Copyright 2012-2013 OpenStack Foundation
|
|
# Copyright 2013 Nebula Inc.
|
|
#
|
|
# 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 os
|
|
|
|
import fixtures
|
|
from six.moves import StringIO
|
|
import testtools
|
|
|
|
from cliff import columns as cliff_columns
|
|
|
|
from openstackclient.tests.unit import fakes
|
|
|
|
|
|
class ParserException(Exception):
|
|
pass
|
|
|
|
|
|
class CompareBySet(list):
|
|
"""Class to compare value using set."""
|
|
def __eq__(self, other):
|
|
return set(self) == set(other)
|
|
|
|
|
|
class TestCase(testtools.TestCase):
|
|
|
|
def setUp(self):
|
|
testtools.TestCase.setUp(self)
|
|
|
|
if (os.environ.get("OS_STDOUT_CAPTURE") == "True" or
|
|
os.environ.get("OS_STDOUT_CAPTURE") == "1"):
|
|
stdout = self.useFixture(fixtures.StringStream("stdout")).stream
|
|
self.useFixture(fixtures.MonkeyPatch("sys.stdout", stdout))
|
|
|
|
if (os.environ.get("OS_STDERR_CAPTURE") == "True" or
|
|
os.environ.get("OS_STDERR_CAPTURE") == "1"):
|
|
stderr = self.useFixture(fixtures.StringStream("stderr")).stream
|
|
self.useFixture(fixtures.MonkeyPatch("sys.stderr", stderr))
|
|
|
|
def assertNotCalled(self, m, msg=None):
|
|
"""Assert a function was not called"""
|
|
|
|
if m.called:
|
|
if not msg:
|
|
msg = 'method %s should not have been called' % m
|
|
self.fail(msg)
|
|
|
|
|
|
class TestCommand(TestCase):
|
|
"""Test cliff command classes"""
|
|
|
|
def setUp(self):
|
|
super(TestCommand, self).setUp()
|
|
# Build up a fake app
|
|
self.fake_stdout = fakes.FakeStdout()
|
|
self.fake_log = fakes.FakeLog()
|
|
self.app = fakes.FakeApp(self.fake_stdout, self.fake_log)
|
|
self.app.client_manager = fakes.FakeClientManager()
|
|
self.app.options = fakes.FakeOptions()
|
|
|
|
def check_parser(self, cmd, args, verify_args):
|
|
cmd_parser = cmd.get_parser('check_parser')
|
|
stderr = StringIO()
|
|
with fixtures.MonkeyPatch('sys.stderr', stderr):
|
|
try:
|
|
parsed_args = cmd_parser.parse_args(args)
|
|
except SystemExit:
|
|
raise ParserException("Argument parse failed: %s" %
|
|
stderr.getvalue())
|
|
for av in verify_args:
|
|
attr, value = av
|
|
if attr:
|
|
self.assertIn(attr, parsed_args)
|
|
self.assertEqual(value, getattr(parsed_args, attr))
|
|
return parsed_args
|
|
|
|
def assertListItemEqual(self, expected, actual):
|
|
self.assertEqual(len(expected), len(actual))
|
|
for item_expected, item_actual in zip(expected, actual):
|
|
self.assertItemEqual(item_expected, item_actual)
|
|
|
|
def assertItemEqual(self, expected, actual):
|
|
self.assertEqual(len(expected), len(actual))
|
|
for col_expected, col_actual in zip(expected, actual):
|
|
if isinstance(col_expected, cliff_columns.FormattableColumn):
|
|
self.assertIsInstance(col_actual, col_expected.__class__)
|
|
self.assertEqual(col_expected.human_readable(),
|
|
col_actual.human_readable())
|
|
else:
|
|
self.assertEqual(col_expected, col_actual)
|