From 17a87b9c0270053fc3ecfaade6606d135894e51c Mon Sep 17 00:00:00 2001
From: Josh Kearney <josh@jk0.org>
Date: Wed, 30 Jan 2013 13:56:12 -0600
Subject: [PATCH] Clean up test_shell so that the tests are captured though the
test framework.
Also makes a small modification to gitignore.
Change-Id: Iefbfbcfd35270b06ed65edb34708fa9b4d5bf563
---
.gitignore | 1 +
run_tests.sh | 4 +-
tests/test_shell.py | 499 +++++++++++++++++++-------------------------
3 files changed, 221 insertions(+), 283 deletions(-)
diff --git a/.gitignore b/.gitignore
index 8b413ce11d..d6f1cdbc63 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,7 @@
*.swo
*.swp
*~
+.coverage
.openstackclient-venv
.testrepository
.tox
diff --git a/run_tests.sh b/run_tests.sh
index 5a5ff701db..71b336e58a 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -77,7 +77,7 @@ function run_tests {
if [ "x$testrargs" = "x" ]; then
testrargs="^(?!.*test_coverage_ext).*$"
fi
- export PYTHON="${wrapper} coverage run --source novaclient --parallel-mode"
+ export PYTHON="${wrapper} coverage run --source openstackclient --parallel-mode"
fi
# Just run the test suites in current environment
set +e
@@ -176,5 +176,5 @@ fi
if [ $coverage -eq 1 ]; then
echo "Generating coverage report in covhtml/"
${wrapper} coverage combine
- ${wrapper} coverage html --include='novaclient/*' --omit='novaclient/openstack/common/*' -d covhtml -i
+ ${wrapper} coverage html --include='openstackclient/*' --omit='openstackclient/openstack/common/*' -d covhtml -i
fi
diff --git a/tests/test_shell.py b/tests/test_shell.py
index 87a7795a9b..ac634c3235 100644
--- a/tests/test_shell.py
+++ b/tests/test_shell.py
@@ -13,313 +13,250 @@
# under the License.
#
-import fixtures
import os
import mock
-from openstackclient import shell as os_shell
+from openstackclient import shell
from tests import utils
-DEFAULT_AUTH_URL = 'http://127.0.0.1:5000/v2.0/'
-DEFAULT_TENANT_ID = 'xxxx-yyyy-zzzz'
-DEFAULT_TENANT_NAME = 'joe_tenant'
-DEFAULT_USERNAME = 'joe_user'
-DEFAULT_PASSWORD = 'password'
-DEFAULT_REGION_NAME = 'ZZ9_Plural_Z_Alpha'
-DEFAULT_TOKEN = 'xyzpdq'
-DEFAULT_SERVICE_URL = 'http://127.0.0.1:8771/v3.0/'
+DEFAULT_USERNAME = "username"
+DEFAULT_PASSWORD = "password"
+DEFAULT_TENANT_ID = "xxxx-yyyy-zzzz"
+DEFAULT_TENANT_NAME = "tenant"
+DEFAULT_TOKEN = "token"
+DEFAULT_REGION_NAME = "ZZ9_Plural_Z_Alpha"
+DEFAULT_AUTH_URL = "http://127.0.0.1:5000/v2.0/"
+DEFAULT_SERVICE_URL = "http://127.0.0.1:8771/v3.0/"
-DEFAULT_COMPUTE_API_VERSION = '42'
-DEFAULT_IDENTITY_API_VERSION = '42.0'
-DEFAULT_IMAGE_API_VERSION = 'v42'
+DEFAULT_COMPUTE_API_VERSION = "2"
+DEFAULT_IDENTITY_API_VERSION = "2.0"
+DEFAULT_IMAGE_API_VERSION = "v2"
-# These values are hard-coded in the client libs
-LIB_COMPUTE_API_VERSION = '2'
-LIB_IDENTITY_API_VERSION = '2.0'
-LIB_IMAGE_API_VERSION = '1.0'
+LIB_COMPUTE_API_VERSION = "2"
+LIB_IDENTITY_API_VERSION = "2.0"
+LIB_IMAGE_API_VERSION = "1.0"
def make_shell():
- """Create a new command shell and mock out some bits"""
- _shell = os_shell.OpenStackShell()
+ """Create a new command shell and mock out some bits."""
+ _shell = shell.OpenStackShell()
_shell.command_manager = mock.Mock()
+
return _shell
+def fake_execute(shell, cmd):
+ """Pretend to execute shell commands."""
+ return shell.run(cmd.split())
+
+
class TestShell(utils.TestCase):
- FAKE_ENV = {
- 'OS_AUTH_URL': DEFAULT_AUTH_URL,
- 'OS_TENANT_ID': DEFAULT_TENANT_ID,
- 'OS_TENANT_NAME': DEFAULT_TENANT_NAME,
- 'OS_USERNAME': DEFAULT_USERNAME,
- 'OS_PASSWORD': DEFAULT_PASSWORD,
- 'OS_REGION_NAME': DEFAULT_REGION_NAME,
- }
-
def setUp(self):
- """ Patch os.environ to avoid required auth info"""
super(TestShell, self).setUp()
- for var in self.FAKE_ENV:
- self.useFixture(
- fixtures.EnvironmentVariable(
- var,
- self.FAKE_ENV[var]
- )
- )
-
- # Make a fake shell object, a helping wrapper to call it, and a quick
- # way of asserting that certain API calls were made.
- global shell, _shell, assert_called, assert_called_anytime
- shell = lambda sh, cmd: sh.run(cmd.split())
-
- # Patch out some common methods
- #self.auth_patch = mock.patch(
- # 'openstackclient.shell.OpenStackShell.authenticate_user')
- #self.auth_save = self.auth_patch.start()
- self.cmd_patch = mock.patch(
- 'openstackclient.shell.OpenStackShell.run_subcommand')
+ patch = "openstackclient.shell.OpenStackShell.run_subcommand"
+ self.cmd_patch = mock.patch(patch)
self.cmd_save = self.cmd_patch.start()
+ self.app = mock.Mock("Test Shell")
def tearDown(self):
- #self.auth_patch.stop()
- self.cmd_patch.stop()
super(TestShell, self).tearDown()
+ self.cmd_patch.stop()
+
+ def _assert_password_auth(self, cmd_options, default_args):
+ with mock.patch("openstackclient.shell.OpenStackShell.initialize_app",
+ self.app):
+ _shell, _cmd = make_shell(), cmd_options + " list tenant"
+ fake_execute(_shell, _cmd)
+
+ self.app.assert_called_with(["list", "tenant"])
+ self.assertEqual(_shell.options.os_auth_url,
+ default_args["auth_url"])
+ self.assertEqual(_shell.options.os_tenant_id,
+ default_args["tenant_id"])
+ self.assertEqual(_shell.options.os_tenant_name,
+ default_args["tenant_name"])
+ self.assertEqual(_shell.options.os_username,
+ default_args["username"])
+ self.assertEqual(_shell.options.os_password,
+ default_args["password"])
+ self.assertEqual(_shell.options.os_region_name,
+ default_args["region_name"])
+
+ def _assert_token_auth(self, cmd_options, default_args):
+ with mock.patch("openstackclient.shell.OpenStackShell.initialize_app",
+ self.app):
+ _shell, _cmd = make_shell(), cmd_options + " list role"
+ fake_execute(_shell, _cmd)
+
+ self.app.assert_called_with(["list", "role"])
+ self.assertEqual(_shell.options.os_token, default_args["os_token"])
+ self.assertEqual(_shell.options.os_url, default_args["os_url"])
+
+ def _assert_cli(self, cmd_options, default_args):
+ with mock.patch("openstackclient.shell.OpenStackShell.initialize_app",
+ self.app):
+ _shell, _cmd = make_shell(), cmd_options + " list server"
+ fake_execute(_shell, _cmd)
+
+ self.app.assert_called_with(["list", "server"])
+ self.assertEqual(_shell.options.os_compute_api_version,
+ default_args["compute_api_version"])
+ self.assertEqual(_shell.options.os_identity_api_version,
+ default_args["identity_api_version"])
+ self.assertEqual(_shell.options.os_image_api_version,
+ default_args["image_api_version"])
+
+
+class TestShellPasswordAuth(TestShell):
+ def setUp(self):
+ super(TestShellPasswordAuth, self).setUp()
+ self.orig_env, os.environ = os.environ, {}
+
+ def tearDown(self):
+ super(TestShellPasswordAuth, self).tearDown()
+ os.environ = self.orig_env
+
+ def test_only_url_flow(self):
+ flag = "--os-auth-url " + DEFAULT_AUTH_URL
+ kwargs = {
+ "auth_url": DEFAULT_AUTH_URL,
+ "tenant_id": "",
+ "tenant_name": "",
+ "username": "",
+ "password": "",
+ "region_name": ""
+ }
+ self._assert_password_auth(flag, kwargs)
+
+ def test_only_tenant_id_flow(self):
+ flag = "--os-tenant-id " + DEFAULT_TENANT_ID
+ kwargs = {
+ "auth_url": "",
+ "tenant_id": DEFAULT_TENANT_ID,
+ "tenant_name": "",
+ "username": "",
+ "password": "",
+ "region_name": ""
+ }
+ self._assert_password_auth(flag, kwargs)
+
+ def test_only_tenant_name_flow(self):
+ flag = "--os-tenant-name " + DEFAULT_TENANT_NAME
+ kwargs = {
+ "auth_url": "",
+ "tenant_id": "",
+ "tenant_name": DEFAULT_TENANT_NAME,
+ "username": "",
+ "password": "",
+ "region_name": ""
+ }
+ self._assert_password_auth(flag, kwargs)
+
+ def test_only_username_flow(self):
+ flag = "--os-username " + DEFAULT_USERNAME
+ kwargs = {
+ "auth_url": "",
+ "tenant_id": "",
+ "tenant_name": "",
+ "username": DEFAULT_USERNAME,
+ "password": "",
+ "region_name": ""
+ }
+ self._assert_password_auth(flag, kwargs)
+
+ def test_only_password_flow(self):
+ flag = "--os-password " + DEFAULT_PASSWORD
+ kwargs = {
+ "auth_url": "",
+ "tenant_id": "",
+ "tenant_name": "",
+ "username": "",
+ "password": DEFAULT_PASSWORD,
+ "region_name": ""
+ }
+ self._assert_password_auth(flag, kwargs)
+
+ def test_only_region_name_flow(self):
+ flag = "--os-region-name " + DEFAULT_REGION_NAME
+ kwargs = {
+ "auth_url": "",
+ "tenant_id": "",
+ "tenant_name": "",
+ "username": "",
+ "password": "",
+ "region_name": DEFAULT_REGION_NAME
+ }
+ self._assert_password_auth(flag, kwargs)
+
+
+class TestShellTokenAuth(TestShell):
+ def setUp(self):
+ super(TestShellTokenAuth, self).setUp()
+ env = {
+ "OS_TOKEN": DEFAULT_TOKEN,
+ "OS_URL": DEFAULT_SERVICE_URL,
+ }
+ self.orig_env, os.environ = os.environ, env.copy()
+
+ def tearDown(self):
+ super(TestShellTokenAuth, self).tearDown()
+ os.environ = self.orig_env
+
+ def test_default_auth(self):
+ flag = ""
+ kwargs = {
+ "os_token": DEFAULT_TOKEN,
+ "os_url": DEFAULT_SERVICE_URL
+ }
+ self._assert_token_auth(flag, kwargs)
+
+ def test_empty_auth(self):
+ os.environ = {}
+ flag = ""
+ kwargs = {
+ "os_token": "",
+ "os_url": ""
+ }
+ self._assert_token_auth(flag, kwargs)
+
+
+class TestShellCli(TestShell):
+ def setUp(self):
+ super(TestShellCli, self).setUp()
+ env = {
+ "OS_COMPUTE_API_VERSION": DEFAULT_COMPUTE_API_VERSION,
+ "OS_IDENTITY_API_VERSION": DEFAULT_IDENTITY_API_VERSION,
+ "OS_IMAGE_API_VERSION": DEFAULT_IMAGE_API_VERSION,
+ }
+ self.orig_env, os.environ = os.environ, env.copy()
+
+ def tearDown(self):
+ super(TestShellCli, self).tearDown()
+ os.environ = self.orig_env
def test_shell_args(self):
- sh = make_shell()
- initapp_mock = mock.Mock('default environment')
- with mock.patch(
- 'openstackclient.shell.OpenStackShell.initialize_app',
- initapp_mock):
- shell(sh, 'list user')
- initapp_mock.assert_called_with((['list', 'user']))
+ _shell = make_shell()
+ with mock.patch("openstackclient.shell.OpenStackShell.initialize_app",
+ self.app):
+ fake_execute(_shell, "list user")
+ self.app.assert_called_with(["list", "user"])
- def test_shell_auth_password_flow(self):
-
- def test_auth(desc, cmd_options, default_args):
- initapp_mock = mock.Mock(desc)
- with mock.patch(
- 'openstackclient.shell.OpenStackShell.initialize_app',
- initapp_mock):
- cmd = cmd_options + ' list tenant'
- shell(sh, cmd)
- initapp_mock.assert_called_with(['list', 'tenant'])
- assert sh.options.os_auth_url == default_args['auth_url']
- assert sh.options.os_tenant_id == \
- default_args['tenant_id']
- assert sh.options.os_tenant_name == \
- default_args['tenant_name']
- assert sh.options.os_username == default_args['username']
- assert sh.options.os_password == default_args['password']
- assert sh.options.os_region_name == \
- default_args['region_name']
-
- # Test the default
- sh = make_shell()
- test_auth('default environment', '',
- {'auth_url': DEFAULT_AUTH_URL,
- 'tenant_id': DEFAULT_TENANT_ID,
- 'tenant_name': DEFAULT_TENANT_NAME,
- 'username': DEFAULT_USERNAME,
- 'password': DEFAULT_PASSWORD,
- 'region_name': DEFAULT_REGION_NAME,
- })
-
- # Test an empty environment
- save_env, os.environ = os.environ, {}
- sh = make_shell()
- test_auth('empty environment', '',
- {'auth_url': '',
- 'tenant_id': '',
- 'tenant_name': '',
- 'username': '',
- 'password': '',
- 'region_name': '',
- })
-
- # Test command-line arguments
- sh = make_shell()
- test_auth('cli arguments', '--os-auth-url ' + DEFAULT_AUTH_URL,
- {'auth_url': DEFAULT_AUTH_URL,
- 'tenant_id': '',
- 'tenant_name': '',
- 'username': '',
- 'password': '',
- 'region_name': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-tenant-id ' + DEFAULT_TENANT_ID,
- {'auth_url': '',
- 'tenant_id': DEFAULT_TENANT_ID,
- 'tenant_name': '',
- 'username': '',
- 'password': '',
- 'region_name': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-tenant-name ' + DEFAULT_TENANT_NAME,
- {'auth_url': '',
- 'tenant_id': '',
- 'tenant_name': DEFAULT_TENANT_NAME,
- 'username': '',
- 'password': '',
- 'region_name': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-username ' + DEFAULT_USERNAME,
- {'auth_url': '',
- 'tenant_id': '',
- 'tenant_name': '',
- 'username': DEFAULT_USERNAME,
- 'password': '',
- 'region_name': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-password ' + DEFAULT_PASSWORD,
- {'auth_url': '',
- 'tenant_id': '',
- 'tenant_name': '',
- 'username': '',
- 'password': DEFAULT_PASSWORD,
- 'region_name': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-region-name ' + DEFAULT_REGION_NAME,
- {'auth_url': '',
- 'tenant_id': '',
- 'tenant_name': '',
- 'username': '',
- 'password': '',
- 'region_name': DEFAULT_REGION_NAME,
- })
-
- # Restore environment
- os.environ = save_env
-
- def test_shell_auth_token_flow(self):
-
- def test_auth(desc, cmd_options, default_args):
- initapp_mock = mock.Mock(desc)
- with mock.patch(
- 'openstackclient.shell.OpenStackShell.initialize_app',
- initapp_mock):
- cmd = cmd_options + ' list role'
- shell(sh, cmd)
- initapp_mock.assert_called_with(['list', 'role'])
- assert sh.options.os_token == default_args['os_token']
- assert sh.options.os_url == default_args['os_url']
-
- token_env = {
- 'OS_TOKEN': DEFAULT_TOKEN,
- 'OS_URL': DEFAULT_SERVICE_URL,
+ def test_default_env(self):
+ flag = ""
+ kwargs = {
+ "compute_api_version": DEFAULT_COMPUTE_API_VERSION,
+ "identity_api_version": DEFAULT_IDENTITY_API_VERSION,
+ "image_api_version": DEFAULT_IMAGE_API_VERSION
}
- save_env, os.environ = os.environ, token_env.copy()
+ self._assert_cli(flag, kwargs)
- # Test the default
- sh = make_shell()
- test_auth('default environment', '',
- {'os_token': DEFAULT_TOKEN,
- 'os_url': DEFAULT_SERVICE_URL,
- })
-
- # Test an empty environment
+ def test_empty_env(self):
os.environ = {}
- sh = make_shell()
- test_auth('empty environment', '',
- {'os_token': '',
- 'os_url': '',
- })
-
- # Test command-line arguments
- sh = make_shell()
- test_auth('cli arguments', '--os-token ' + DEFAULT_TOKEN,
- {'os_token': DEFAULT_TOKEN,
- 'os_url': '',
- })
-
- sh = make_shell()
- test_auth('cli arguments', '--os-url ' + DEFAULT_SERVICE_URL,
- {'os_token': '',
- 'os_url': DEFAULT_SERVICE_URL,
- })
-
- # Restore environment
- os.environ = save_env
-
- def test_shell_cli_options(self):
-
- def test_vars(desc, cmd_options, default_args):
- initapp_mock = mock.Mock(desc)
- with mock.patch(
- 'openstackclient.shell.OpenStackShell.initialize_app',
- initapp_mock):
- cmd = cmd_options + ' list server'
- shell(sh, cmd)
- initapp_mock.assert_called_with(['list', 'server'])
- print "options: %s" % sh.options
- print "args: %s" % default_args
- assert sh.options.os_compute_api_version == \
- default_args['compute_api_version']
- assert sh.options.os_identity_api_version == \
- default_args['identity_api_version']
- assert sh.options.os_image_api_version == \
- default_args['image_api_version']
-
- option_env = {
- 'OS_COMPUTE_API_VERSION': DEFAULT_COMPUTE_API_VERSION,
- 'OS_IDENTITY_API_VERSION': DEFAULT_IDENTITY_API_VERSION,
- 'OS_IMAGE_API_VERSION': DEFAULT_IMAGE_API_VERSION,
+ flag = ""
+ kwargs = {
+ "compute_api_version": LIB_COMPUTE_API_VERSION,
+ "identity_api_version": LIB_IDENTITY_API_VERSION,
+ "image_api_version": LIB_IMAGE_API_VERSION
}
- save_env, os.environ = os.environ, option_env.copy()
-
- # Test the default
- sh = make_shell()
- test_vars('default environment', '',
- {'compute_api_version': DEFAULT_COMPUTE_API_VERSION,
- 'identity_api_version': DEFAULT_IDENTITY_API_VERSION,
- 'image_api_version': DEFAULT_IMAGE_API_VERSION,
- })
-
- # Test an empty environment
- os.environ = {}
- sh = make_shell()
- # This should fall back to the defaults hard-coded in the client libs
- test_vars('empty environment', '',
- {'compute_api_version': LIB_COMPUTE_API_VERSION,
- 'identity_api_version': LIB_IDENTITY_API_VERSION,
- 'image_api_version': LIB_IMAGE_API_VERSION,
- })
-
- # Test command-line arguments
- sh = make_shell()
- test_vars('cli arguments',
- '--os-compute-api-version ' + DEFAULT_COMPUTE_API_VERSION,
- {'compute_api_version': DEFAULT_COMPUTE_API_VERSION,
- 'identity_api_version': LIB_IDENTITY_API_VERSION,
- 'image_api_version': LIB_IMAGE_API_VERSION,
- })
-
- sh = make_shell()
- test_vars('cli arguments',
- '--os-identity-api-version ' + DEFAULT_IDENTITY_API_VERSION,
- {'compute_api_version': LIB_COMPUTE_API_VERSION,
- 'identity_api_version': DEFAULT_IDENTITY_API_VERSION,
- 'image_api_version': LIB_IMAGE_API_VERSION,
- })
-
- sh = make_shell()
- test_vars('cli arguments',
- '--os-image-api-version ' + DEFAULT_IMAGE_API_VERSION,
- {'compute_api_version': LIB_COMPUTE_API_VERSION,
- 'identity_api_version': LIB_IDENTITY_API_VERSION,
- 'image_api_version': DEFAULT_IMAGE_API_VERSION,
- })
-
- # Restore environment
- os.environ = save_env
+ self._assert_cli(flag, kwargs)