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
|
import os
import unittest
from unittest.mock import patch
import paramiko
from ncclient import manager
from ncclient.transport.ssh import SSHSession
from ncclient.operations.third_party.juniper.rpc import *
from ncclient.operations import RaiseMode
from ncclient.transport.parser import DefaultXMLParser
try:
import selectors
except ImportError:
import selectors2 as selectors
class TestSession(unittest.TestCase):
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_sax_on(self, mock_uuid4, mock_select, mock_session, mock_recv,
mock_close, mock_send, mock_send_ready, mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
# as filter_xml is not having software-information, response wont contain it
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 0)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_sax_on_junos_rfc_compliant(self, mock_uuid4, mock_select, mock_session, mock_recv,
mock_close, mock_send, mock_send_ready, mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
from lxml import etree
print(resp)
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
# as filter_xml is not having software-information, response wont contain it
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 0)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_delimiter_rpc_reply(self, mock_uuid4, mock_select,
mock_session, mock_recv, mock_close,
mock_send, mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')[:-1] + [b"</rpc-reply>]]>", b"]]>"]
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 0)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_delimiter_multiple_rpc_reply(self, mock_uuid4, mock_select,
mock_session, mock_recv, mock_close,
mock_send, mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')[:-1] + [b"</rpc-reply>]]>",
b"]]><rpc-reply>"] + \
self._read_file('get-software-information.xml')[1:]
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 0)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_delimiter_multiple_rpc_in_parallel(self, mock_uuid4, mock_select,
mock_session, mock_recv, mock_close,
mock_send, mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.side_effect = [type('xyz', (), {'urn': "urn:uuid:ddef40cb-5745-481d-974d-7188f9f2bb33"}),
type('pqr', (), {'urn': "urn:uuid:549ef9d1-024a-4fd0-88bf-047d25f0870d"})]
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = [b"""
<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/19.2I0/junos" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:ddef40cb-5745-481d-974d-7188f9f2bb33">
<ospf-neighbor-information xmlns="http://xml.juniper.net/junos/19.2I0/junos-routing">
<ospf-neighbor>
<neighbor-address>13.1.1.2</neighbor-address>
<interface-name>ge-0/0/0.1</interface-name>
<ospf-neighbor-state>Exchange</ospf-neighbor-state>
<neighbor-id>2.2.2.2</neighbor-id>
<neighbor-priority>128</neighbor-priority>
<activity-timer>36</activity-timer>
<ospf-area>0.0.0.0</ospf-area>
<options>0x52</options>
<dr-address>13.1.1.1</dr-address>
<bdr-address>13.1.1.2</bdr-address>
<neighbor-up-time junos:seconds="17812">
04:56:52
</neighbor-up-time>
<neighbor-adjacency-time junos:seconds="17812">
04:56:52
</neighbor-adjacency-time>
<master-slave>slave</master-slave>
<sequence-number>0x204b6fd</sequence-number>
<dbd-retransmit-time>3</dbd-retransmit-time>
<lsreq-retransmit-time>0</lsreq-retransmit-time>
<lsa-list>
Link state retransmission list:
Type LSA ID Adv rtr Seq
Router 1.1.1.1 1.1.1.1 0x80000019
OpaqArea 1.0.0.1 1.1.1.1 0x80000011
Router 3.3.3.3 3.3.3.3 0x80000004
Network 23.1.1.2 3.3.3.3 0x80000001
OpaqArea 1.0.0.1 2.2.2.2 0x80000002
OpaqArea 1.0.0.1 3.3.3.3 0x80000002
OpaqArea 1.0.0.3 1.1.1.1 0x80000002
OpaqArea 1.0.0.3 3.3.3.3 0x80000001
OpaqArea 1.0.0.4 2.2.2.2 0x80000001
</lsa-list>
<ospf-neighbor-topology>
<ospf-topology-name>default</ospf-topology-name>
<ospf-topology-id>0</ospf-topology-id>
<ospf-neighbor-topology-state>Forward Only</ospf-neighbor-topology-state>
</ospf-neighbor-topology>
</ospf-neighbor>
</ospf-neighbor-information>
</rpc-reply>]]>]]><rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:junos="http://xml.juniper.net/junos/19.2I0/junos" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:549ef9d1-024a-4fd0-88bf-047d25f0870d">
<pfe-statistics>
<pfe-traffic-statistics>
<pfe-input-packets>22450</pfe-input-packets>
<input-pps>0</input-pps>
<pfe-output-packets>31992</pfe-output-packets>
<output-pps>0</output-pps>
<pfe-fabric-input>0</pfe-fabric-input>
<pfe-fabric-input-pps>0</pfe-fabric-input-pps>
<pfe-fabric-output>0</pfe-fabric-output>
<pfe-fabric-output-pps>0</pfe-fabric-output-pps>
</pfe-traffic-statistics></pfe-statistics></rpc-reply>]]>]]>"""]
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('pfe-traffic-statistics')), 1)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_filter_xml_delimiter_splited_rpc_reply(self, mock_uuid4, mock_select,
mock_session, mock_recv, mock_close,
mock_send, mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')[:-1] + [b"</rpc", b"-reply>]]>",
b"]]><rpc-reply>"] + \
self._read_file('get-software-information.xml')[1:]
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 0)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_use_filter_xml_without_sax_input(self, mock_uuid4, mock_select,
mock_session, mock_recv,
mock_close, mock_send,
mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': True})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = None
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 2)
@patch('ncclient.transport.SSHSession.connected')
@patch('paramiko.channel.Channel.send_ready')
@patch('paramiko.channel.Channel.send')
@patch('ncclient.transport.ssh.SSHSession.close')
@patch('paramiko.channel.Channel.recv')
@patch('ncclient.transport.SSHSession')
@patch('selectors.DefaultSelector.select')
@patch('ncclient.operations.rpc.uuid4')
def test_use_filter_False(self, mock_uuid4, mock_select,
mock_session, mock_recv,
mock_close, mock_send,
mock_send_ready,
mock_connected):
mock_send.return_value = True
mock_send_ready.return_value = -1
mock_uuid4.return_value = type('dummy', (), {'urn': "urn:uuid:e0a7abe3-fffa-11e5-b78e-b8e85604f858"})
device_handler = manager.make_device_handler({'name': 'junos', 'use_filter': False})
rpc = '<get-software-information/>'
mock_recv.side_effect = self._read_file('get-software-information.xml')
session = SSHSession(device_handler)
session._connected = True
session._channel = paramiko.Channel("c100")
session.parser = session._device_handler.get_xml_parser(session)
obj = ExecuteRpc(session, device_handler, raise_mode=RaiseMode.ALL)
obj._filter_xml = '<multi-routing-engine-results><multi-routing-engine-item><re-name/></multi-routing-engine-item></multi-routing-engine-results>'
session.run()
resp = obj.request(rpc)._NCElement__doc[0]
self.assertEqual(len(resp.xpath('multi-routing-engine-item/re-name')), 2)
# as filter_xml is not having software-information, response wont contain it
self.assertEqual(len(resp.xpath('multi-routing-engine-item/software-information')), 2)
self.assertIsInstance(session.parser, DefaultXMLParser)
def _read_file(self, fname):
fpath = os.path.join(os.path.dirname(__file__),
'rpc-reply', fname)
lines = []
with open(fpath, "rb") as fp:
lines = fp.readlines()
return lines
|