functest/tests/unit/cli/commands/test_cli_os.py

   1 #!/usr/bin/env python
   2 #
   3 # jose.lausuch@ericsson.com
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9
  10 import logging
  11 import unittest
  12 import os
  13
  14 import mock
  15
  16 from functest.cli.commands import cli_os
  17 from functest.utils.constants import CONST
  18
  19
  20 class CliOpenStackTesting(unittest.TestCase):
  21     logging.disable(logging.CRITICAL)
  22
  23     def setUp(self):
  24         self.endpoint_ip = 'test_ip'
  25         self.os_auth_url = 'http://test_ip:test_port/v2.0'
  26         self.installer_type = 'test_installer_type'
  27         self.installer_ip = 'test_installer_ip'
  28         self.openstack_creds = 'test_openstack_creds'
  29         self.dir_repo_functest = 'test_dir_repo_functest'
  30         self.snapshot_file = 'test_snapshot_file'
  31         self.cli_os = cli_os.CliOpenStack()
  32
  33     def test_ping_endpoint_default(self):
  34         self.cli_os.os_auth_url = self.os_auth_url
  35         self.cli_os.endpoint_ip = self.endpoint_ip
  36         with mock.patch('functest.cli.commands.cli_os.os.system',
  37                         return_value=0):
  38             self.assertEqual(self.cli_os.ping_endpoint(), 0)
  39
  40     @mock.patch('functest.cli.commands.cli_os.exit', side_effect=Exception)
  41     @mock.patch('functest.cli.commands.cli_os.click.echo')
  42     def test_ping_endpoint_missing_auth_url(self, mock_click_echo,
  43                                             mock_exit):
  44         with self.assertRaises(Exception):
  45             self.cli_os.os_auth_url = None
  46             self.cli_os.ping_endpoint()
  47             mock_click_echo.assert_called_once_with("Source the OpenStack "
  48                                                     "credentials first '. "
  49                                                     "$creds'")
  50
  51     @mock.patch('functest.cli.commands.cli_os.exit')
  52     @mock.patch('functest.cli.commands.cli_os.click.echo')
  53     def test_ping_endpoint_os_system_fails(self, mock_click_echo,
  54                                            mock_exit):
  55         self.cli_os.os_auth_url = self.os_auth_url
  56         self.cli_os.endpoint_ip = self.endpoint_ip
  57         with mock.patch('functest.cli.commands.cli_os.os.system',
  58                         return_value=1):
  59             self.cli_os.ping_endpoint()
  60             mock_click_echo.assert_called_once_with("Cannot talk to the "
  61                                                     "endpoint %s\n" %
  62                                                     self.endpoint_ip)
  63             mock_exit.assert_called_once_with(0)
  64
  65     @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command')
  66     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
  67                 return_value=False)
  68     @mock.patch('functest.cli.commands.cli_os.click.echo')
  69     def test_fetch_credentials_default(self, mock_click_echo,
  70                                        mock_os_path,
  71                                        mock_ftutils_execute):
  72         CONST.__setattr__('INSTALLER_TYPE', self.installer_type)
  73         CONST.__setattr__('INSTALLER_IP', self.installer_ip)
  74         cmd = ("%s/releng/utils/fetch_os_creds.sh -d %s -i %s -a %s"
  75                % (CONST.__getattribute__('dir_repos'),
  76                   self.openstack_creds,
  77                   self.installer_type,
  78                   self.installer_ip))
  79         self.cli_os.openstack_creds = self.openstack_creds
  80         self.cli_os.fetch_credentials()
  81         mock_click_echo.assert_called_once_with("Fetching credentials from "
  82                                                 "installer node '%s' with "
  83                                                 "IP=%s.." %
  84                                                 (self.installer_type,
  85                                                  self.installer_ip))
  86         mock_ftutils_execute.assert_called_once_with(cmd, verbose=False)
  87
  88     @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command')
  89     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
  90                 return_value=False)
  91     @mock.patch('functest.cli.commands.cli_os.click.echo')
  92     def test_fetch_credentials_missing_installer_type(self, mock_click_echo,
  93                                                       mock_os_path,
  94                                                       mock_ftutils_execute):
  95         CONST.__setattr__('INSTALLER_TYPE', None)
  96         CONST.__setattr__('INSTALLER_IP', self.installer_ip)
  97         cmd = ("%s/releng/utils/fetch_os_creds.sh -d %s -i %s -a %s"
  98                % (CONST.__getattribute__('dir_repos'),
  99                   self.openstack_creds,
 100                   None,
 101                   self.installer_ip))
 102         self.cli_os.openstack_creds = self.openstack_creds
 103         self.cli_os.fetch_credentials()
 104         mock_click_echo.assert_any_call("The environment variable "
 105                                         "'INSTALLER_TYPE' is not"
 106                                         "defined. Please export it")
 107         mock_click_echo.assert_any_call("Fetching credentials from "
 108                                         "installer node '%s' with "
 109                                         "IP=%s.." %
 110                                         (None,
 111                                          self.installer_ip))
 112         mock_ftutils_execute.assert_called_once_with(cmd, verbose=False)
 113
 114     @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command')
 115     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 116                 return_value=False)
 117     @mock.patch('functest.cli.commands.cli_os.click.echo')
 118     def test_fetch_credentials_missing_installer_ip(self, mock_click_echo,
 119                                                     mock_os_path,
 120                                                     mock_ftutils_execute):
 121         installer_type = self.installer_type
 122         installer_ip = None
 123         CONST.__setattr__('INSTALLER_TYPE', installer_type)
 124         CONST.__setattr__('INSTALLER_IP', installer_ip)
 125         cmd = ("%s/releng/utils/fetch_os_creds.sh -d %s -i %s -a %s"
 126                % (CONST.__getattribute__('dir_repos'),
 127                   self.openstack_creds,
 128                   installer_type,
 129                   installer_ip))
 130         self.cli_os.openstack_creds = self.openstack_creds
 131         self.cli_os.fetch_credentials()
 132         mock_click_echo.assert_any_call("The environment variable "
 133                                         "'INSTALLER_IP' is not"
 134                                         "defined. Please export it")
 135         mock_click_echo.assert_any_call("Fetching credentials from "
 136                                         "installer node '%s' with "
 137                                         "IP=%s.." %
 138                                         (installer_type,
 139                                          installer_ip))
 140         mock_ftutils_execute.assert_called_once_with(cmd, verbose=False)
 141
 142     @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command')
 143     def test_check(self, mock_ftutils_execute):
 144         with mock.patch.object(self.cli_os, 'ping_endpoint'):
 145             CONST.__setattr__('dir_repo_functest', self.dir_repo_functest)
 146             cmd = os.path.join(CONST.__getattribute__('dir_repo_functest'),
 147                                "functest/ci/check_os.sh")
 148             self.cli_os.check()
 149             mock_ftutils_execute.assert_called_once_with(cmd, verbose=False)
 150
 151     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 152                 return_value=False)
 153     @mock.patch('functest.cli.commands.cli_os.click.echo')
 154     def test_snapshot_create(self, mock_click_echo, mock_os_path):
 155         with mock.patch.object(self.cli_os, 'ping_endpoint'), \
 156                 mock.patch('functest.cli.commands.cli_os.os_snapshot.main') \
 157                 as mock_os_snapshot:
 158             self.cli_os.snapshot_create()
 159             mock_click_echo.assert_called_once_with("Generating Openstack "
 160                                                     "snapshot...")
 161             self.assertTrue(mock_os_snapshot.called)
 162
 163     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 164                 return_value=True)
 165     @mock.patch('functest.cli.commands.cli_os.click.echo')
 166     def test_snapshot_create_overwrite(self, mock_click_echo, mock_os_path):
 167         with mock.patch('__builtin__.raw_input', return_value="y") \
 168                 as mock_raw_input, \
 169                 mock.patch.object(self.cli_os, 'ping_endpoint'), \
 170                 mock.patch('functest.cli.commands.cli_os.os_snapshot.main') \
 171                 as mock_os_snapshot:
 172             self.cli_os.snapshot_create()
 173             mock_click_echo.assert_called_once_with("Generating Openstack "
 174                                                     "snapshot...")
 175             mock_raw_input.assert_any_call("It seems there is already an "
 176                                            "OpenStack snapshot. Do you want "
 177                                            "to overwrite it with the current "
 178                                            "OpenStack status? [y|n]\n")
 179             self.assertTrue(mock_os_snapshot.called)
 180
 181     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 182                 return_value=False)
 183     @mock.patch('functest.cli.commands.cli_os.click.echo')
 184     def test_snapshot_show_missing_snap(self, mock_click_echo, mock_os_path):
 185         self.cli_os.snapshot_show()
 186         mock_click_echo.assert_called_once_with("There is no OpenStack "
 187                                                 "snapshot created. To create "
 188                                                 "one run the command "
 189                                                 "'functest openstack "
 190                                                 "snapshot-create'")
 191
 192     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 193                 return_value=True)
 194     @mock.patch('functest.cli.commands.cli_os.click.echo')
 195     def test_snapshot_show_default(self, mock_click_echo, mock_os_path):
 196         with mock.patch('__builtin__.open', mock.mock_open(read_data='0')) \
 197                 as m:
 198             self.cli_os.snapshot_file = self.snapshot_file
 199             self.cli_os.snapshot_show()
 200             m.assert_called_once_with(self.snapshot_file, 'r')
 201             mock_click_echo.assert_called_once_with("\n0")
 202
 203     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 204                 return_value=True)
 205     @mock.patch('functest.cli.commands.cli_os.click.echo')
 206     def test_clean(self, mock_click_echo, mock_os_path):
 207         with mock.patch.object(self.cli_os, 'ping_endpoint'), \
 208                 mock.patch('functest.cli.commands.cli_os.os_clean.main') \
 209                 as mock_os_clean:
 210             self.cli_os.clean()
 211             self.assertTrue(mock_os_clean.called)
 212
 213     @mock.patch('functest.cli.commands.cli_os.os.path.isfile',
 214                 return_value=False)
 215     @mock.patch('functest.cli.commands.cli_os.click.echo')
 216     def test_clean_missing_file(self, mock_click_echo, mock_os_path):
 217         with mock.patch.object(self.cli_os, 'ping_endpoint'):
 218             self.cli_os.clean()
 219             mock_click_echo.assert_called_once_with("Not possible to clean "
 220                                                     "OpenStack without a "
 221                                                     "snapshot. This could "
 222                                                     "cause problems. "
 223                                                     "Run first the command "
 224                                                     "'functest openstack "
 225                                                     "snapshot-create'")
 226
 227     @mock.patch('functest.cli.commands.cli_os.click.echo')
 228     def test_show_credentials(self, mock_click_echo):
 229         key = 'OS_KEY'
 230         value = 'OS_VALUE'
 231         with mock.patch.dict(os.environ, {key: value}):
 232             self.cli_os.show_credentials()
 233             mock_click_echo.assert_any_call("{}={}".format(key, value))
 234
 235
 236 if __name__ == "__main__":
 237     unittest.main(verbosity=2)