yardstick/tests/unit/test_ssh.py

   1 # Copyright 2013: Mirantis Inc.
   2 # All Rights Reserved.
   3 #
   4 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   5 #    not use this file except in compliance with the License. You may obtain
   6 #    a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #    Unless required by applicable law or agreed to in writing, software
  11 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13 #    License for the specific language governing permissions and limitations
  14 #    under the License.
  15
  16 import os
  17 import socket
  18 import unittest
  19 from io import StringIO
  20 from itertools import count
  21
  22 import mock
  23 from oslo_utils import encodeutils
  24
  25 from yardstick.common import exceptions
  26 from yardstick import ssh
  27 from yardstick.ssh import SSH
  28 from yardstick.ssh import AutoConnectSSH
  29
  30
  31 class FakeParamikoException(Exception):
  32     pass
  33
  34
  35 class SSHTestCase(unittest.TestCase):
  36     """Test all small SSH methods."""
  37
  38     def setUp(self):
  39         super(SSHTestCase, self).setUp()
  40         self.test_client = ssh.SSH("root", "example.net")
  41
  42     @mock.patch("yardstick.ssh.SSH._get_pkey")
  43     def test_construct(self, mock_ssh__get_pkey):
  44         mock_ssh__get_pkey.return_value = "pkey"
  45         test_ssh = ssh.SSH("root", "example.net", port=33, pkey="key",
  46                            key_filename="kf", password="secret")
  47         mock_ssh__get_pkey.assert_called_once_with("key")
  48         self.assertEqual("root", test_ssh.user)
  49         self.assertEqual("example.net", test_ssh.host)
  50         self.assertEqual(33, test_ssh.port)
  51         self.assertEqual("pkey", test_ssh.pkey)
  52         self.assertEqual("kf", test_ssh.key_filename)
  53         self.assertEqual("secret", test_ssh.password)
  54
  55     @mock.patch("yardstick.ssh.SSH._get_pkey")
  56     def test_ssh_from_node(self, mock_ssh__get_pkey):
  57         mock_ssh__get_pkey.return_value = "pkey"
  58         node = {
  59             "user": "root", "ip": "example.net", "ssh_port": 33,
  60             "key_filename": "kf", "password": "secret"
  61         }
  62         test_ssh = ssh.SSH.from_node(node)
  63         self.assertEqual("root", test_ssh.user)
  64         self.assertEqual("example.net", test_ssh.host)
  65         self.assertEqual(33, test_ssh.port)
  66         self.assertEqual("kf", test_ssh.key_filename)
  67         self.assertEqual("secret", test_ssh.password)
  68
  69     @mock.patch("yardstick.ssh.SSH._get_pkey")
  70     def test_ssh_from_node_password_default(self, mock_ssh__get_pkey):
  71         mock_ssh__get_pkey.return_value = "pkey"
  72         node = {
  73             "user": "root", "ip": "example.net", "ssh_port": 33,
  74             "key_filename": "kf"
  75         }
  76         test_ssh = ssh.SSH.from_node(node)
  77         self.assertEqual("root", test_ssh.user)
  78         self.assertEqual("example.net", test_ssh.host)
  79         self.assertEqual(33, test_ssh.port)
  80         self.assertEqual("kf", test_ssh.key_filename)
  81         self.assertIsNone(test_ssh.password)
  82
  83     @mock.patch("yardstick.ssh.SSH._get_pkey")
  84     def test_ssh_from_node_ssh_port_default(self, mock_ssh__get_pkey):
  85         mock_ssh__get_pkey.return_value = "pkey"
  86         node = {
  87             "user": "root", "ip": "example.net",
  88             "key_filename": "kf", "password": "secret"
  89         }
  90         test_ssh = ssh.SSH.from_node(node)
  91         self.assertEqual("root", test_ssh.user)
  92         self.assertEqual("example.net", test_ssh.host)
  93         self.assertEqual(ssh.SSH.SSH_PORT, test_ssh.port)
  94         self.assertEqual("kf", test_ssh.key_filename)
  95         self.assertEqual("secret", test_ssh.password)
  96
  97     @mock.patch("yardstick.ssh.SSH._get_pkey")
  98     def test_ssh_from_node_key_filename_default(self, mock_ssh__get_pkey):
  99         mock_ssh__get_pkey.return_value = "pkey"
 100         node = {
 101             "user": "root", "ip": "example.net", "ssh_port": 33,
 102             "password": "secret"
 103         }
 104         test_ssh = ssh.SSH.from_node(node)
 105         self.assertEqual("root", test_ssh.user)
 106         self.assertEqual("example.net", test_ssh.host)
 107         self.assertEqual(33, test_ssh.port)
 108         self.assertIsNone(test_ssh.key_filename)
 109         self.assertEqual("secret", test_ssh.password)
 110
 111     def test_construct_default(self):
 112         self.assertEqual("root", self.test_client.user)
 113         self.assertEqual("example.net", self.test_client.host)
 114         self.assertEqual(22, self.test_client.port)
 115         self.assertIsNone(self.test_client.pkey)
 116         self.assertIsNone(self.test_client.key_filename)
 117         self.assertIsNone(self.test_client.password)
 118
 119     @mock.patch("yardstick.ssh.paramiko")
 120     def test__get_pkey_invalid(self, mock_paramiko):
 121         mock_paramiko.SSHException = FakeParamikoException
 122         rsa = mock_paramiko.rsakey.RSAKey
 123         dss = mock_paramiko.dsskey.DSSKey
 124         rsa.from_private_key.side_effect = mock_paramiko.SSHException
 125         dss.from_private_key.side_effect = mock_paramiko.SSHException
 126         self.assertRaises(exceptions.SSHError, self.test_client._get_pkey, "key")
 127
 128     @mock.patch("yardstick.ssh.six.moves.StringIO")
 129     @mock.patch("yardstick.ssh.paramiko")
 130     def test__get_pkey_dss(self, mock_paramiko, mock_string_io):
 131         mock_paramiko.SSHException = FakeParamikoException
 132         mock_string_io.return_value = "string_key"
 133         mock_paramiko.dsskey.DSSKey.from_private_key.return_value = "dss_key"
 134         rsa = mock_paramiko.rsakey.RSAKey
 135         rsa.from_private_key.side_effect = mock_paramiko.SSHException
 136         key = self.test_client._get_pkey("key")
 137         dss_calls = mock_paramiko.dsskey.DSSKey.from_private_key.mock_calls
 138         self.assertEqual([mock.call("string_key")], dss_calls)
 139         self.assertEqual(key, "dss_key")
 140         mock_string_io.assert_called_once_with("key")
 141
 142     @mock.patch("yardstick.ssh.six.moves.StringIO")
 143     @mock.patch("yardstick.ssh.paramiko")
 144     def test__get_pkey_rsa(self, mock_paramiko, mock_string_io):
 145         mock_paramiko.SSHException = FakeParamikoException
 146         mock_string_io.return_value = "string_key"
 147         mock_paramiko.rsakey.RSAKey.from_private_key.return_value = "rsa_key"
 148         dss = mock_paramiko.dsskey.DSSKey
 149         dss.from_private_key.side_effect = mock_paramiko.SSHException
 150         key = self.test_client._get_pkey("key")
 151         rsa_calls = mock_paramiko.rsakey.RSAKey.from_private_key.mock_calls
 152         self.assertEqual([mock.call("string_key")], rsa_calls)
 153         self.assertEqual(key, "rsa_key")
 154         mock_string_io.assert_called_once_with("key")
 155
 156     @mock.patch("yardstick.ssh.SSH._get_pkey")
 157     @mock.patch("yardstick.ssh.paramiko")
 158     def test__get_client(self, mock_paramiko, mock_ssh__get_pkey):
 159         mock_ssh__get_pkey.return_value = "key"
 160         fake_client = mock.Mock()
 161         mock_paramiko.SSHClient.return_value = fake_client
 162         mock_paramiko.AutoAddPolicy.return_value = "autoadd"
 163
 164         test_ssh = ssh.SSH("admin", "example.net", pkey="key")
 165         client = test_ssh._get_client()
 166
 167         self.assertEqual(fake_client, client)
 168         client_calls = [
 169             mock.call.set_missing_host_key_policy("autoadd"),
 170             mock.call.connect("example.net", username="admin",
 171                               port=22, pkey="key", key_filename=None,
 172                               password=None,
 173                               allow_agent=False, look_for_keys=False,
 174                               timeout=1),
 175         ]
 176         self.assertEqual(client_calls, client.mock_calls)
 177
 178     @mock.patch("yardstick.ssh.SSH._get_pkey")
 179     @mock.patch("yardstick.ssh.paramiko")
 180     def test__get_client_with_exception(self, mock_paramiko, mock_ssh__get_pkey):
 181         class MyError(Exception):
 182             pass
 183
 184         mock_ssh__get_pkey.return_value = "pkey"
 185         fake_client = mock.Mock()
 186         fake_client.connect.side_effect = MyError
 187         fake_client.set_missing_host_key_policy.return_value = None
 188         mock_paramiko.SSHClient.return_value = fake_client
 189         mock_paramiko.AutoAddPolicy.return_value = "autoadd"
 190
 191         test_ssh = ssh.SSH("admin", "example.net", pkey="key")
 192
 193         with self.assertRaises(exceptions.SSHError) as raised:
 194             test_ssh._get_client()
 195
 196         mock_paramiko.SSHClient.assert_called_once()
 197         mock_paramiko.AutoAddPolicy.assert_called_once()
 198         fake_client.set_missing_host_key_policy.assert_called_once()
 199         fake_client.connect.assert_called_once()
 200         exc_str = str(raised.exception)
 201         self.assertIn('raised during connect', exc_str)
 202         self.assertIn('MyError', exc_str)
 203
 204     @mock.patch("yardstick.ssh.SSH._get_pkey")
 205     @mock.patch("yardstick.ssh.paramiko")
 206     def test_copy(self, mock_paramiko, mock_ssh__get_pkey):
 207         mock_ssh__get_pkey.return_value = "pkey"
 208         fake_client = mock.Mock()
 209         fake_client.connect.side_effect = IOError
 210         mock_paramiko.SSHClient.return_value = fake_client
 211         mock_paramiko.AutoAddPolicy.return_value = "autoadd"
 212
 213         test_ssh = ssh.SSH("admin", "example.net", pkey="key")
 214         result = test_ssh.copy()
 215         self.assertIsNot(test_ssh, result)
 216
 217     def test_close(self):
 218         with mock.patch.object(self.test_client, "_client") as m_client:
 219             self.test_client.close()
 220         m_client.close.assert_called_once_with()
 221         self.assertFalse(self.test_client._client)
 222
 223     @mock.patch("yardstick.ssh.six.moves.StringIO")
 224     def test_execute(self, mock_string_io):
 225         mock_string_io.side_effect = stdio = [mock.Mock(), mock.Mock()]
 226         stdio[0].read.return_value = "stdout fake data"
 227         stdio[1].read.return_value = "stderr fake data"
 228         with mock.patch.object(self.test_client, "run", return_value=0)\
 229                 as mock_run:
 230             status, stdout, stderr = self.test_client.execute(
 231                 "cmd",
 232                 stdin="fake_stdin",
 233                 timeout=43)
 234         mock_run.assert_called_once_with(
 235             "cmd", stdin="fake_stdin", stdout=stdio[0],
 236             stderr=stdio[1], timeout=43, raise_on_error=False)
 237         self.assertEqual(0, status)
 238         self.assertEqual("stdout fake data", stdout)
 239         self.assertEqual("stderr fake data", stderr)
 240
 241     @mock.patch("yardstick.ssh.time")
 242     def test_wait_timeout(self, mock_time):
 243         mock_time.time.side_effect = [1, 50, 150]
 244         self.test_client.execute = mock.Mock(side_effect=[exceptions.SSHError,
 245                                                           exceptions.SSHError,
 246                                                           0])
 247         self.assertRaises(exceptions.SSHTimeout, self.test_client.wait)
 248         self.assertEqual([mock.call("uname")] * 2,
 249                          self.test_client.execute.mock_calls)
 250
 251     @mock.patch("yardstick.ssh.time")
 252     def test_wait(self, mock_time):
 253         mock_time.time.side_effect = [1, 50, 100]
 254         self.test_client.execute = mock.Mock(side_effect=[exceptions.SSHError,
 255                                                           exceptions.SSHError,
 256                                                           0])
 257         self.test_client.wait()
 258         self.assertEqual([mock.call("uname")] * 3,
 259                          self.test_client.execute.mock_calls)
 260
 261     @mock.patch("yardstick.ssh.paramiko")
 262     def test_send_command(self, _):
 263         paramiko_sshclient = self.test_client._get_client()
 264         with mock.patch.object(paramiko_sshclient, "exec_command") \
 265                 as mock_paramiko_exec_command:
 266             self.test_client.send_command('cmd')
 267         mock_paramiko_exec_command.assert_called_once_with('cmd',
 268                                                            get_pty=True)
 269
 270
 271 class SSHRunTestCase(unittest.TestCase):
 272     """Test SSH.run method in different aspects.
 273
 274     Also tested method "execute".
 275     """
 276
 277     def setUp(self):
 278         super(SSHRunTestCase, self).setUp()
 279
 280         self.fake_client = mock.Mock()
 281         self.fake_session = mock.Mock()
 282         self.fake_transport = mock.Mock()
 283
 284         self.fake_transport.open_session.return_value = self.fake_session
 285         self.fake_client.get_transport.return_value = self.fake_transport
 286
 287         self.fake_session.recv_ready.return_value = False
 288         self.fake_session.recv_stderr_ready.return_value = False
 289         self.fake_session.send_ready.return_value = False
 290         self.fake_session.exit_status_ready.return_value = True
 291         self.fake_session.recv_exit_status.return_value = 0
 292
 293         self.test_client = ssh.SSH("admin", "example.net")
 294         self.test_client._get_client = mock.Mock(return_value=self.fake_client)
 295
 296     @mock.patch("yardstick.ssh.select")
 297     def test_execute(self, mock_select):
 298         mock_select.select.return_value = ([], [], [])
 299         self.fake_session.recv_ready.side_effect = [1, 0, 0]
 300         self.fake_session.recv_stderr_ready.side_effect = [1, 0]
 301         self.fake_session.recv.return_value = "ok"
 302         self.fake_session.recv_stderr.return_value = "error"
 303         self.fake_session.exit_status_ready.return_value = 1
 304         self.fake_session.recv_exit_status.return_value = 127
 305         self.assertEqual((127, "ok", "error"), self.test_client.execute("cmd"))
 306         self.fake_session.exec_command.assert_called_once_with("cmd")
 307
 308     @mock.patch("yardstick.ssh.select")
 309     def test_execute_args(self, mock_select):
 310         mock_select.select.return_value = ([], [], [])
 311         self.fake_session.recv_ready.side_effect = [1, 0, 0]
 312         self.fake_session.recv_stderr_ready.side_effect = [1, 0]
 313         self.fake_session.recv.return_value = "ok"
 314         self.fake_session.recv_stderr.return_value = "error"
 315         self.fake_session.exit_status_ready.return_value = 1
 316         self.fake_session.recv_exit_status.return_value = 127
 317
 318         result = self.test_client.execute("cmd arg1 'arg2 with space'")
 319         self.assertEqual((127, "ok", "error"), result)
 320         self.fake_session.exec_command.assert_called_once_with(
 321             "cmd arg1 'arg2 with space'")
 322
 323     @mock.patch("yardstick.ssh.select")
 324     def test_run(self, mock_select):
 325         mock_select.select.return_value = ([], [], [])
 326         self.assertEqual(0, self.test_client.run("cmd"))
 327
 328     @mock.patch("yardstick.ssh.select")
 329     def test_run_nonzero_status(self, mock_select):
 330         mock_select.select.return_value = ([], [], [])
 331         self.fake_session.recv_exit_status.return_value = 1
 332         self.assertRaises(exceptions.SSHError, self.test_client.run, "cmd")
 333         self.assertEqual(1, self.test_client.run("cmd", raise_on_error=False))
 334
 335     @mock.patch("yardstick.ssh.select")
 336     def test_run_stdout(self, mock_select):
 337         mock_select.select.return_value = ([], [], [])
 338         self.fake_session.recv_ready.side_effect = [True, True, False]
 339         self.fake_session.recv.side_effect = ["ok1", "ok2"]
 340         stdout = mock.Mock()
 341         self.test_client.run("cmd", stdout=stdout)
 342         self.assertEqual([mock.call("ok1"), mock.call("ok2")],
 343                          stdout.write.mock_calls)
 344
 345     @mock.patch("yardstick.ssh.select")
 346     def test_run_stderr(self, mock_select):
 347         mock_select.select.return_value = ([], [], [])
 348         self.fake_session.recv_stderr_ready.side_effect = [True, False]
 349         self.fake_session.recv_stderr.return_value = "error"
 350         stderr = mock.Mock()
 351         self.test_client.run("cmd", stderr=stderr)
 352         stderr.write.assert_called_once_with("error")
 353
 354     @mock.patch("yardstick.ssh.select")
 355     def test_run_stdin(self, mock_select):
 356         """Test run method with stdin.
 357
 358         Third send call was called with "e2" because only 3 bytes was sent
 359         by second call. So remainig 2 bytes of "line2" was sent by third call.
 360         """
 361         mock_select.select.return_value = ([], [], [])
 362         self.fake_session.exit_status_ready.side_effect = [0, 0, 0, True]
 363         self.fake_session.send_ready.return_value = True
 364         self.fake_session.send.side_effect = [5, 3, 2]
 365         fake_stdin = mock.Mock()
 366         fake_stdin.read.side_effect = ["line1", "line2", ""]
 367         fake_stdin.closed = False
 368
 369         def close():
 370             fake_stdin.closed = True
 371         fake_stdin.close = mock.Mock(side_effect=close)
 372         self.test_client.run("cmd", stdin=fake_stdin)
 373         call = mock.call
 374         send_calls = [call(encodeutils.safe_encode("line1", "utf-8")),
 375                       call(encodeutils.safe_encode("line2", "utf-8")),
 376                       call(encodeutils.safe_encode("e2", "utf-8"))]
 377         self.assertEqual(send_calls, self.fake_session.send.mock_calls)
 378
 379     @mock.patch("yardstick.ssh.select")
 380     def test_run_stdin_keep_open(self, mock_select):
 381         """Test run method with stdin.
 382
 383         Third send call was called with "e2" because only 3 bytes was sent
 384         by second call. So remainig 2 bytes of "line2" was sent by third call.
 385         """
 386         mock_select.select.return_value = ([], [], [])
 387         self.fake_session.exit_status_ready.side_effect = [0, 0, 0, True]
 388         self.fake_session.send_ready.return_value = True
 389         self.fake_session.send.side_effect = len
 390         fake_stdin = StringIO(u"line1\nline2\n")
 391         self.test_client.run("cmd", stdin=fake_stdin, keep_stdin_open=True)
 392         call = mock.call
 393         send_calls = [call(encodeutils.safe_encode("line1\nline2\n", "utf-8"))]
 394         self.assertEqual(send_calls, self.fake_session.send.mock_calls)
 395
 396     @mock.patch("yardstick.ssh.select")
 397     def test_run_select_error(self, mock_select):
 398         self.fake_session.exit_status_ready.return_value = False
 399         mock_select.select.return_value = ([], [], [True])
 400         self.assertRaises(exceptions.SSHError, self.test_client.run, "cmd")
 401
 402     @mock.patch("yardstick.ssh.time")
 403     @mock.patch("yardstick.ssh.select")
 404     def test_run_timemout(self, mock_select, mock_time):
 405         mock_time.time.side_effect = [1, 3700]
 406         mock_select.select.return_value = ([], [], [])
 407         self.fake_session.exit_status_ready.return_value = False
 408         self.assertRaises(exceptions.SSHTimeout, self.test_client.run, "cmd")
 409
 410     @mock.patch("yardstick.ssh.open", create=True)
 411     def test__put_file_shell(self, mock_open):
 412         with mock.patch.object(self.test_client, "run") as run_mock:
 413             self.test_client._put_file_shell("localfile", "remotefile", 0o42)
 414             run_mock.assert_called_once_with(
 415                 'cat > "remotefile"&& chmod -- 042 "remotefile"',
 416                 stdin=mock_open.return_value.__enter__.return_value)
 417
 418     @mock.patch("yardstick.ssh.open", create=True)
 419     def test__put_file_shell_space(self, mock_open):
 420         with mock.patch.object(self.test_client, "run") as run_mock:
 421             self.test_client._put_file_shell("localfile",
 422                                              "filename with space", 0o42)
 423             run_mock.assert_called_once_with(
 424                 'cat > "filename with space"&& chmod -- 042 "filename with '
 425                 'space"',
 426                 stdin=mock_open.return_value.__enter__.return_value)
 427
 428     @mock.patch("yardstick.ssh.open", create=True)
 429     def test__put_file_shell_tilde(self, mock_open):
 430         with mock.patch.object(self.test_client, "run") as run_mock:
 431             self.test_client._put_file_shell("localfile", "~/remotefile", 0o42)
 432             run_mock.assert_called_once_with(
 433                 'cat > ~/"remotefile"&& chmod -- 042 ~/"remotefile"',
 434                 stdin=mock_open.return_value.__enter__.return_value)
 435
 436     @mock.patch("yardstick.ssh.open", create=True)
 437     def test__put_file_shell_tilde_spaces(self, mock_open):
 438         with mock.patch.object(self.test_client, "run") as run_mock:
 439             self.test_client._put_file_shell("localfile", "~/file with space",
 440                                              0o42)
 441             run_mock.assert_called_once_with(
 442                 'cat > ~/"file with space"&& chmod -- 042 ~/"file with space"',
 443                 stdin=mock_open.return_value.__enter__.return_value)
 444
 445     @mock.patch("yardstick.ssh.os.stat")
 446     def test__put_file_sftp(self, mock_stat):
 447         sftp = self.fake_client.open_sftp.return_value = mock.MagicMock()
 448         sftp.__enter__.return_value = sftp
 449
 450         mock_stat.return_value = os.stat_result([0o753] + [0] * 9)
 451
 452         self.test_client._put_file_sftp("localfile", "remotefile")
 453
 454         sftp.put.assert_called_once_with("localfile", "remotefile")
 455         mock_stat.assert_any_call("localfile")
 456         sftp.chmod.assert_any_call("remotefile", 0o753)
 457         sftp.__exit__.assert_called_once_with(None, None, None)
 458
 459     def test__put_file_sftp_mode(self):
 460         sftp = self.fake_client.open_sftp.return_value = mock.MagicMock()
 461         sftp.__enter__.return_value = sftp
 462
 463         self.test_client._put_file_sftp("localfile", "remotefile", mode=0o753)
 464
 465         sftp.put.assert_called_once_with("localfile", "remotefile")
 466         sftp.chmod.assert_called_once_with("remotefile", 0o753)
 467         sftp.__exit__.assert_called_once_with(None, None, None)
 468
 469     def test_put_file_SSHException(self):
 470         exc = ssh.paramiko.SSHException
 471         self.test_client._put_file_sftp = mock.Mock(side_effect=exc())
 472         self.test_client._put_file_shell = mock.Mock()
 473
 474         self.test_client.put_file("foo", "bar", 42)
 475         self.test_client._put_file_sftp.assert_called_once_with("foo", "bar",
 476                                                                 mode=42)
 477         self.test_client._put_file_shell.assert_called_once_with("foo", "bar",
 478                                                                  mode=42)
 479
 480     def test_put_file_socket_error(self):
 481         exc = socket.error
 482         self.test_client._put_file_sftp = mock.Mock(side_effect=exc())
 483         self.test_client._put_file_shell = mock.Mock()
 484
 485         self.test_client.put_file("foo", "bar", 42)
 486         self.test_client._put_file_sftp.assert_called_once_with("foo", "bar",
 487                                                                 mode=42)
 488         self.test_client._put_file_shell.assert_called_once_with("foo", "bar",
 489                                                                  mode=42)
 490
 491     @mock.patch("yardstick.ssh.os.stat")
 492     def test_put_file_obj_with_mode(self, mock_stat):
 493         sftp = self.fake_client.open_sftp.return_value = mock.MagicMock()
 494         sftp.__enter__.return_value = sftp
 495
 496         mock_stat.return_value = os.stat_result([0o753] + [0] * 9)
 497
 498         self.test_client.put_file_obj("localfile", "remotefile", 'my_mode')
 499
 500         sftp.__enter__.assert_called_once()
 501         sftp.putfo.assert_called_once_with("localfile", "remotefile")
 502         sftp.chmod.assert_called_once_with("remotefile", 'my_mode')
 503         sftp.__exit__.assert_called_once_with(None, None, None)
 504
 505
 506 class TestAutoConnectSSH(unittest.TestCase):
 507
 508     def test__connect_loop(self):
 509         auto_connect_ssh = AutoConnectSSH('user1', 'host1', wait=0)
 510         auto_connect_ssh._get_client = mock__get_client = mock.Mock()
 511
 512         auto_connect_ssh._connect()
 513         mock__get_client.assert_called_once()
 514
 515     def test___init___negative(self):
 516         with self.assertRaises(TypeError):
 517             AutoConnectSSH('user1', 'host1', wait=['wait'])
 518
 519         with self.assertRaises(ValueError):
 520             AutoConnectSSH('user1', 'host1', wait='wait')
 521
 522     @mock.patch('yardstick.ssh.time')
 523     def test__connect_loop_ssh_error(self, mock_time):
 524         mock_time.time.side_effect = count()
 525
 526         auto_connect_ssh = AutoConnectSSH('user1', 'host1', wait=10)
 527         auto_connect_ssh._get_client = mock__get_client = mock.Mock()
 528         mock__get_client.side_effect = exceptions.SSHError
 529
 530         with self.assertRaises(exceptions.SSHTimeout):
 531             auto_connect_ssh._connect()
 532
 533         self.assertEqual(mock_time.time.call_count, 12)
 534
 535     def test_get_file_obj(self):
 536         auto_connect_ssh = AutoConnectSSH('user1', 'host1', wait=10)
 537         auto_connect_ssh._get_client = mock__get_client = mock.Mock()
 538         mock_client = mock__get_client()
 539         mock_open_sftp = mock_client.open_sftp()
 540         mock_sftp = mock.Mock()
 541         mock_open_sftp.__enter__ = mock.Mock(return_value=mock_sftp)
 542         mock_open_sftp.__exit__ = mock.Mock()
 543
 544         auto_connect_ssh.get_file_obj('remote/path', mock.Mock())
 545
 546         mock_sftp.getfo.assert_called_once()
 547
 548     def test__make_dict(self):
 549         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 550
 551         expected = {
 552             'user': 'user1',
 553             'host': 'host1',
 554             'port': SSH.SSH_PORT,
 555             'pkey': None,
 556             'key_filename': None,
 557             'password': None,
 558             'name': None,
 559             'wait': AutoConnectSSH.DEFAULT_WAIT_TIMEOUT,
 560         }
 561         result = auto_connect_ssh._make_dict()
 562         self.assertDictEqual(result, expected)
 563
 564     def test_get_class(self):
 565         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 566
 567         self.assertEqual(auto_connect_ssh.get_class(), AutoConnectSSH)
 568
 569     def test_drop_connection(self):
 570         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 571         self.assertFalse(auto_connect_ssh._client)
 572         auto_connect_ssh._client = True
 573         auto_connect_ssh.drop_connection()
 574         self.assertFalse(auto_connect_ssh._client)
 575
 576     @mock.patch('yardstick.ssh.SCPClient')
 577     def test_put(self, mock_scp_client_type):
 578         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 579         auto_connect_ssh._client = mock.Mock()
 580
 581         auto_connect_ssh.put('a', 'z')
 582         with mock_scp_client_type() as mock_scp_client:
 583             mock_scp_client.put.assert_called_once()
 584
 585     @mock.patch('yardstick.ssh.SCPClient')
 586     def test_get(self, mock_scp_client_type):
 587         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 588         auto_connect_ssh._client = mock.Mock()
 589
 590         auto_connect_ssh.get('a', 'z')
 591         with mock_scp_client_type() as mock_scp_client:
 592             mock_scp_client.get.assert_called_once()
 593
 594     def test_put_file(self):
 595         auto_connect_ssh = AutoConnectSSH('user1', 'host1')
 596         auto_connect_ssh._client = mock.Mock()
 597         auto_connect_ssh._put_file_sftp = mock_put_sftp = mock.Mock()
 598
 599         auto_connect_ssh.put_file('a', 'b')
 600         mock_put_sftp.assert_called_once()