1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
|
import unittest
import nose2
import os
from ncclient.manager import Manager, make_device_handler
from ncclient.transport import SSHSession
from jnpr.junos import Device
from jnpr.junos.utils.fs import FS
from jnpr.junos.exception import RpcError
from unittest.mock import patch, MagicMock, call
from lxml import etree
__author__ = "Nitin Kumar, Rick Sherman"
__credits__ = "Jeremy Schulman"
class TestFS(unittest.TestCase):
@patch("ncclient.manager.connect")
def setUp(self, mock_connect):
mock_connect.side_effect = self._mock_manager
self.dev = Device(
host="1.1.1.1", user="rick", password="password123", gather_facts=False
)
self.dev.open()
self.fs = FS(self.dev)
@patch("jnpr.junos.device.warnings")
def test_cat_wrong_path_return_none(self, mock_warnings):
path = "test/report"
self.assertEqual(self.fs.cat(path), None)
def test_cat(self):
self.fs._dev.rpc.file_show = MagicMock(side_effect=self._mock_manager)
path = "test/cat.txt"
self.assertTrue("testing cat functionality" in self.fs.cat(path))
self.fs._dev.rpc.file_show.assert_called_with(filename="test/cat.txt")
def test_cwd(self):
self.fs._dev.rpc.set_cli_working_directory = MagicMock(
side_effect=self._mock_manager
)
folder = "change/directory"
self.assertEqual("change/directory", self.fs.cwd(folder))
self.fs._dev.rpc.set_cli_working_directory.assert_called_with(
directory="change/directory"
)
@patch("jnpr.junos.Device.execute")
def test_pwd(self, mock_execute):
mock_execute.side_effect = MagicMock(side_effect=self._mock_manager)
self.fs.pwd()
self.assertEqual(self.fs.pwd(), "/cf/var/home/rick")
@patch("jnpr.junos.device.warnings")
def test_checksum_return_none(self, mock_warnings):
path = "test/report"
self.assertEqual(self.fs.checksum(path), None)
def test_checksum_unknown_calc(self):
path = "test/report"
self.assertRaises(ValueError, self.fs.checksum, path=path, calc="abc")
def test_checksum_return_rsp(self):
self.fs.dev.rpc.get_sha256_checksum_information = MagicMock(
side_effect=self._mock_manager
)
path = "test/checksum"
self.assertEqual(self.fs.checksum(path, "sha256"), "xxxx")
self.fs.dev.rpc.get_sha256_checksum_information.assert_called_with(
path="test/checksum"
)
def test_stat_calling___decode_file(self):
path = "test/stat/decode_file"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.stat(path),
{
"owner": "pqr",
"path": "/var/abc.sh",
"permissions": 755,
"permissions_text": "-rwxr-xr-x",
"size": 2,
"ts_date": "Mar 13 06:54",
"ts_epoc": "1394693680",
"type": "file",
},
)
def test_stat_calling___decode_dir(self):
path = "test/stat/decode_dir"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.stat(path),
{"path": "/var", "type": "dir", "file_count": 1, "size": 2},
)
def test_stat_return_none(self):
path = "test/abc"
self.fs.dev.rpc.file_list = MagicMock()
self.fs.dev.rpc.file_list.find.return_value = "output"
self.assertEqual(self.fs.stat(path), None)
def test_ls_calling___decode_file(self):
path = "test/stat/decode_file"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.ls(path),
{
"owner": "pqr",
"path": "/var/abc.sh",
"permissions": 755,
"permissions_text": "-rwxr-xr-x",
"size": 2,
"ts_date": "Mar 13 06:54",
"ts_epoc": "1394693680",
"type": "file",
},
)
def test_ls_calling___decode_dir(self):
path = "test/stat/decode_dir"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.ls(path),
{
"files": {
"abc": {
"permissions_text": "drwxr-xr-x",
"ts_date": "Feb 17 15:30",
"ts_epoc": "1392651039",
"owner": "root",
"path": "abc",
"size": 2,
"type": "dir",
"permissions": 555,
}
},
"path": "/var",
"type": "dir",
"file_count": 1,
"size": 2,
},
)
def test_ls_return_none(self):
path = "test/abc"
self.fs.dev.rpc.file_list = MagicMock()
self.fs.dev.rpc.file_list.find.return_value = "output"
self.assertEqual(self.fs.ls(path), None)
@patch("jnpr.junos.utils.fs.FS._decode_file")
def test_ls_link_path_false(self, mock_decode_file):
mock_decode_file.get.return_value = False
path = "test/stat/decode_file"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.fs.ls(path, followlink=False)
mock_decode_file.assert_has_calls([call().get("link")])
def test_ls_brief_true(self):
path = "test/stat/decode_dir"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.ls(path, brief=True),
{
"files": ["abc"],
"path": "/var",
"type": "dir",
"file_count": 1,
"size": 2,
},
)
def test_ls_calling___decode_dir_type_symbolic_link(self):
path = "test/stat/decode_symbolic_link"
self.fs.dev.rpc.file_list = MagicMock(side_effect=self._mock_manager)
self.assertEqual(
self.fs.ls(path),
{
"files": {
"abc": {
"permissions_text": "drwxr-xr-x",
"ts_date": "Feb 17 15:30",
"link": "symlink test",
"ts_epoc": "1392651039",
"owner": "root",
"path": "abc",
"size": 2,
"type": "link",
"permissions": 555,
}
},
"path": "/var",
"type": "dir",
"file_count": 1,
"size": 2,
},
)
def test_rm_return_true(self):
self.fs.dev.rpc.file_delete = MagicMock(return_value=True)
path = "test/abc"
self.assertTrue(self.fs.rm(path))
self.fs.dev.rpc.file_delete.assert_called_once_with(path="test/abc")
def test_rm_return_false(self):
path = "test/abc"
self.fs.dev.rpc.file_delete = MagicMock(return_value=False)
self.assertFalse(self.fs.rm(path))
self.fs.dev.rpc.file_delete.assert_called_once_with(path="test/abc")
def test_copy_return_true(self):
self.fs.dev.rpc.file_copy = MagicMock()
initial = "test/abc"
final = "test/xyz"
self.assertTrue(self.fs.cp(initial, final))
self.fs.dev.rpc.file_copy.assert_called_once_with(
source="test/abc", destination="test/xyz"
)
def test_copy_routing_instance_return_true(self):
self.fs.dev.rpc.file_copy = MagicMock()
initial = "test/abc"
final = "test/xyz"
ri_name = "test_ri"
self.assertTrue(self.fs.cp(initial, final, routing_instance=ri_name))
self.fs.dev.rpc.file_copy.assert_called_once_with(
source="test/abc", destination="test/xyz", routing_instance="test_ri"
)
def test_copy_source_address_return_true(self):
self.fs.dev.rpc.file_copy = MagicMock()
initial = "test/abc"
final = "test/xyz"
s_add = "0.0.0.0"
self.assertTrue(self.fs.cp(initial, final, source_address=s_add))
self.fs.dev.rpc.file_copy.assert_called_once_with(
source="test/abc", destination="test/xyz", source_address="0.0.0.0"
)
def test_copy_return_false(self):
initial = "test/abc"
final = "test/xyz"
self.fs.dev.rpc.file_copy = MagicMock(side_effect=Exception)
self.assertFalse(self.fs.cp(initial, final))
self.fs.dev.rpc.file_copy.assert_called_once_with(
source="test/abc", destination="test/xyz"
)
def test_move_return_true(self):
self.fs.dev.rpc.file_rename = MagicMock(return_value=True)
initial = "test/abc"
final = "test/xyz"
self.assertTrue(self.fs.mv(initial, final))
self.fs.dev.rpc.file_rename.assert_called_once_with(
source="test/abc", destination="test/xyz"
)
def test_move_return_false(self):
initial = "test/abc"
final = "test/xyz"
self.fs.dev.rpc.file_rename = MagicMock(return_value=False)
self.assertFalse(self.fs.mv(initial, final))
self.fs.dev.rpc.file_rename.assert_called_once_with(
source="test/abc", destination="test/xyz"
)
def test_tgz_return_true(self):
src = "test/tgz.txt"
dst = "test/xyz"
self.fs.dev.rpc.file_archive = MagicMock(return_value=True)
self.assertTrue(self.fs.tgz(src, dst))
self.fs.dev.rpc.file_archive.assert_called_once_with(
source="test/tgz.txt", destination="test/xyz", compress=True
)
@patch("jnpr.junos.Device.execute")
def test_tgz_return_error(self, mock_execute):
mock_execute.side_effect = self._mock_manager
src = "test/tgz.txt"
dst = "test/xyz"
self.assertTrue("testing tgz" in self.fs.tgz(src, dst))
@patch("jnpr.junos.utils.fs.StartShell")
def test_rmdir(self, mock_StartShell):
path = "test/rmdir"
print(self.fs.rmdir(path))
calls = [
call().__enter__(),
call().__enter__().run("rmdir test/rmdir"),
call().__exit__(None, None, None),
]
mock_StartShell.assert_has_calls(calls)
@patch("jnpr.junos.utils.fs.StartShell")
def test_mkdir(self, mock_StartShell):
path = "test/mkdir"
print(self.fs.mkdir(path))
calls = [
call().__enter__(),
call().__enter__().run("mkdir -p test/mkdir"),
call().__exit__(None, None, None),
]
mock_StartShell.assert_has_calls(calls)
@patch("jnpr.junos.utils.fs.StartShell")
def test_symlink(self, mock_StartShell):
src = "test/tgz.txt"
dst = "test/xyz"
print(self.fs.symlink(src, dst))
calls = [
call().__enter__(),
call().__enter__().run("ln -sf test/tgz.txt test/xyz"),
call().__exit__(None, None, None),
]
mock_StartShell.assert_has_calls(calls)
@patch("jnpr.junos.Device.execute")
def test_storage_usage(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.assertEqual(
self.fs.storage_usage(),
{
"/dev/abc": {
"avail_block": 234234,
"used_blocks": 2346455,
"used_pct": "1",
"mount": "/",
"total_blocks": 567431,
"avail": "2F",
"used": "481M",
"total": "4F",
}
},
)
@patch("jnpr.junos.Device.execute")
def test_storage_usage_linux(self, mock_execute):
mock_execute.side_effect = self._mock_manager_linux
self.assertEqual(
self.fs.storage_usage(),
{
"re0": {
"/dev/sda6": {
"avail": "916M",
"avail_block": 1874712,
"mount": "/data/config",
"total": "984M",
"total_blocks": 2015024,
"used": "1.4M",
"used_blocks": 2688,
"used_pct": "1",
}
}
},
)
@patch("jnpr.junos.Device.execute")
def test_directory_usage(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.assertEqual(
self.fs.directory_usage(path="/var/tmp", depth=1),
{
"/var/tmp": {"blocks": 456076, "bytes": 233510912, "size": "223M"},
"/var/tmp/gres-tp": {"blocks": 68, "bytes": 34816, "size": "34K"},
"/var/tmp/install": {"blocks": 4, "bytes": 2048, "size": "2.0K"},
"/var/tmp/pics": {"blocks": 4, "bytes": 2048, "size": "2.0K"},
"/var/tmp/rtsdb": {"blocks": 4, "bytes": 2048, "size": "2.0K"},
"/var/tmp/sec-download": {"blocks": 8, "bytes": 4096, "size": "4.0K"},
"/var/tmp/vi.recover": {"blocks": 4, "bytes": 2048, "size": "2.0K"},
},
)
@patch("jnpr.junos.Device.execute")
def test_directory_usage_error(self, mock_execute):
mock_execute.return_value = etree.fromstring(
"""
<directory-usage-information>
<directory>
<used-space used-blocks="456076">
223M
</used-space>
</directory>
</directory-usage-information>"""
)
self.assertRaises(RpcError, self.fs.directory_usage, path="/var/tmp", depth=1)
@patch("jnpr.junos.Device.execute")
def test_directory_usage_no_directory(self, mock_execute):
mock_execute.side_effect = self._mock_manager_error1
self.assertRaises(RpcError, self.fs.directory_usage, path="/var/tmp", depth="1")
@patch("jnpr.junos.Device.execute")
def test_directory_usage_no_dir_name(self, mock_execute):
mock_execute.side_effect = self._mock_manager_error2
self.assertRaises(RpcError, self.fs.directory_usage, path="/var/tmp", depth="1")
@patch("jnpr.junos.Device.execute")
def test_storage_cleanup(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.assertEqual(
self.fs.storage_cleanup(),
{"/var/abc.txt": {"ts_date": "Apr 25 10:38", "size": 11}},
)
@patch("jnpr.junos.Device.execute")
def test_storage_cleanup_check(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.assertEqual(
self.fs.storage_cleanup_check(),
{"/var/abc.txt": {"ts_date": "Apr 25 10:38", "size": 11}},
)
def _read_file(self, fname):
from ncclient.xml_ import NCElement
fpath = os.path.join(os.path.dirname(__file__), "rpc-reply", fname)
foo = open(fpath).read()
if (
fname == "get-rpc-error.xml"
or fname == "get-index-error.xml"
or fname == "get-system-core-dumps.xml"
):
rpc_reply = NCElement(foo, self.dev._conn._device_handler.transform_reply())
elif (
fname == "show-configuration.xml"
or fname == "show-system-alarms.xml"
or fname == "set-cli-working-directory.xml"
):
rpc_reply = NCElement(
foo, self.dev._conn._device_handler.transform_reply()
)._NCElement__doc
else:
rpc_reply = NCElement(
foo, self.dev._conn._device_handler.transform_reply()
)._NCElement__doc[0]
return rpc_reply
def _mock_manager(self, *args, **kwargs):
if kwargs:
# if 'path' in kwargs and 'detail' in kwargs:
# return self._read_file('dir_list_detail.xml')
if "path" in kwargs:
if kwargs["path"] == "test/stat/decode_dir":
return self._read_file("file-list_dir.xml")
elif kwargs["path"] == "test/stat/decode_file":
return self._read_file("file-list_file.xml")
elif kwargs["path"] == "test/checksum":
return self._read_file("checksum.xml")
elif kwargs["path"] == "test/stat/decode_symbolic_link":
return self._read_file("file-list_symlink.xml")
if "directory" in kwargs:
if kwargs["directory"] == "change/directory":
return self._read_file("set-cli-working-directory.xml")
if "filename" in kwargs:
if kwargs["filename"] == "test/cat.txt":
return self._read_file("file-show.xml")
device_params = kwargs["device_params"]
device_handler = make_device_handler(device_params)
session = SSHSession(device_handler)
return Manager(session, device_handler)
elif args:
if args[0].tag == "command":
if args[0].text == "show cli directory":
return self._read_file("show-cli-directory.xml")
elif args[0].tag == "get-system-storage":
return self._read_file("get-system-storage.xml")
elif args[0].tag == "get-directory-usage-information":
return self._read_file("get-directory-usage-information.xml")
elif args[0].tag == "request-system-storage-cleanup":
return self._read_file("request-system-storage-cleanup.xml")
elif args[0].tag == "file-archive":
return self._read_file("file-archive.xml")
def _mock_manager_error1(self, *args, **kwargs):
if args:
if args[0].tag == "get-directory-usage-information":
return self._read_file("get-directory-usage-information_error1.xml")
def _mock_manager_error2(self, *args, **kwargs):
if args:
if args[0].tag == "get-directory-usage-information":
return self._read_file("get-directory-usage-information_error2.xml")
def _mock_manager_linux(self, *args, **kwargs):
if args:
if args[0].tag == "get-system-storage":
return self._read_file("get-storage-usage-linux.xml")
|