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
|
__author__ = "Rick Sherman"
__credits__ = "Jeremy Schulman"
import unittest
import os
import yaml
import json
import nose2
from jnpr.junos import Device
from jnpr.junos.op.phyport import PhyPortStatsTable
from jnpr.junos.op.ethport import EthPortTable
from jnpr.junos.factory.factory_loader import FactoryLoader
from jnpr.junos.factory.optable import generate_sax_parser_input
from ncclient.manager import Manager, make_device_handler
from ncclient.transport import SSHSession
from ncclient.operations.rpc import RPCReply
from lxml import etree
from unittest.mock import patch
class TestFactoryOpTable(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.ppt = PhyPortStatsTable(self.dev)
@patch("jnpr.junos.Device.execute")
def test_optable_get(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.ppt.get()
self.assertEqual(len(self.ppt), 2)
@patch("jnpr.junos.Device.execute")
def test_optable_get_key(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.ppt.get("ge-0/0/0")
self.assertEqual(self.ppt.GET_KEY, "interface_name")
def test_optable_path(self):
fname = "local-get-interface-information.xml"
path = os.path.join(os.path.dirname(__file__), "rpc-reply", fname)
lppt = PhyPortStatsTable(path=path)
lppt.get()
self.assertEqual(len(lppt), 2)
def test_optable_xml(self):
fname = "get-interface-information.xml"
xml = self._read_file(fname)
lppt = PhyPortStatsTable(xml=xml)
lppt.get()
self.assertEqual(len(lppt), 2)
@patch("jnpr.junos.Device.execute")
def test_optable_view_get(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.ppt.get()
v = self.ppt["ge-0/0/0"]
self.assertEqual(v["rx_packets"], 1207)
@patch("jnpr.junos.Device.execute")
def test_optable_view_get_astype_bool(self, mock_execute):
mock_execute.side_effect = self._mock_manager
et = EthPortTable(self.dev)
et.get()
v = et["ge-0/0/0"]
self.assertEqual(v["present"], True)
@patch("jnpr.junos.Device.execute")
def test_optable_view_get_astype_bool_regex(self, mock_execute):
mock_execute.side_effect = self._mock_manager
from jnpr.junos.op.bfd import BfdSessionTable
bfd = BfdSessionTable(self.dev)
bfd.get()
v = bfd["10.92.20.4"]
self.assertEqual(v["no_absorb"], True)
@patch("jnpr.junos.Device.execute")
def test_optable_view_get_unknown_field(self, mock_execute):
mock_execute.side_effect = self._mock_manager
self.ppt.get()
def bad(key):
v = self.ppt["ge-0/0/0"]
return v[key]
self.assertRaises(ValueError, bad, "bunk")
def test_generate_sax_parser_fields_with_many_slash(self):
yaml_data = """
---
bgpNeighborTable:
rpc: get-bgp-neighbor-information
item: bgp-peer
key: peer-address
view: bgpNeighborView
bgpNeighborView:
fields:
prefix-count: bgp-option-information/prefix-limit/prefix-count
prefix-dummy: bgp-option-information/prefix-limit/prefix-dummy
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = bgpNeighborTable(self.dev)
data = generate_sax_parser_input(tbl)
self.assertEqual(data.tag, "bgp-peer")
self.assertEqual(
len(etree.tostring(data)),
len(
b"<bgp-peer><peer-address/><bgp-option-information><prefix-limit>"
b"<prefix-count/><prefix-dummy/></prefix-limit>"
b"</bgp-option-information></bgp-peer>"
),
)
def test_generate_sax_parser_fields_with_diff_child_xpaths(self):
yaml_data = """
---
twampProbeTable:
rpc: twamp-get-probe-results
item: probe-test-results
key: test-name
view: probeResultsView
probeResultsView:
fields:
min-delay: probe-test-global-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/min-delay
max-delay: probe-test-global-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/max-delay
avg-delay: probe-test-global-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/avg-delay
positive-rtt-jitter: probe-test-global-results/probe-test-generic-results/probe-test-positive-round-trip-jitter/probe-summary-results/avg-delay
loss-percentage: probe-test-global-results/probe-test-generic-results/loss-percentage
current-min-delay: probe-last-test-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/min-delay
current-max-delay: probe-last-test-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/max-delay
current-avg-delay: probe-last-test-results/probe-test-generic-results/probe-test-rtt/probe-summary-results/avg-delay
current-positive-rtt-jitter: probe-last-test-results/probe-test-generic-results/probe-test-positive-round-trip-jitter/probe-summary-results/avg-delay
current-loss-percentage: probe-last-test-results/probe-test-generic-results/loss-percentage
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = twampProbeTable(self.dev)
data = generate_sax_parser_input(tbl)
self.assertEqual(data.tag, "probe-test-results")
self.assertEqual(
len(etree.tostring(data)),
len(
b"<probe-test-results><test-name/><probe-last-test-results>"
b"<probe-test-generic-results><probe-test-rtt><probe-summary"
b"-results><min-delay/><avg-delay/><max-delay/></probe-summary"
b"-results></probe-test-rtt><loss-percentage/>"
b"<probe-test-positive-round-trip-jitter><probe-summary-results>"
b"<avg-delay/></probe-summary-results></probe-test-positive-round"
b"-trip-jitter></probe-test-generic-results></probe-last-test-resu"
b"lts><probe-test-global-results><probe-test-generic-results>"
b"<probe-test-rtt><probe-summary-results><min-delay/><avg-delay/>"
b"<max-delay/></probe-summary-results></probe-test-rtt>"
b"<loss-percentage/><probe-test-positive-round-trip-jitter>"
b"<probe-summary-results><avg-delay/></probe-summary-results>"
b"</probe-test-positive-round-trip-jitter></probe-test-generic-"
b"results></probe-test-global-results></probe-test-results>"
),
)
def test_generate_sax_parser_item_with_many_slash(self):
yaml_data = """
---
taskmallocdetail:
rpc: get-task-memory-information
args:
level: detail
item: task-memory-malloc-usage-report/task-malloc-list/task-malloc
key: tm-name
view: taskmallocview
taskmallocview:
fields:
tmallocs: tm-allocs
tmallocbytes: tm-alloc-bytes
tmmaxallocs: tm-max-allocs
tmmaxallocbytes: tm-max-alloc-bytes
tmfunctioncalls: tm-function-calls
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = taskmallocdetail(self.dev)
data = generate_sax_parser_input(tbl)
self.assertEqual(data.tag, "task-memory-malloc-usage-report")
self.assertEqual(
len(etree.tostring(data)),
len(
b"<task-memory-malloc-usage-report><task-malloc-list><task-malloc><tm-name/><t"
b"m-allocs/><tm-alloc-bytes/><tm-max-allocs/><tm-max-alloc-bytes/><tm-function"
b"-calls/></task-malloc></task-malloc-list></task-memory-malloc-usage-report>"
),
)
def test_generate_sax_parser_same_parents_with_diff_fields(self):
yaml_data = """
---
VtepTable:
rpc: get-interface-information
args:
interface-name: "vtep"
extensive: True
item: physical-interface
key: name
view: VtepView
VtepView:
fields:
admin-status: admin-status
oper-status: oper-status
link-level-type: link-level-type
input-bytes: traffic-statistics/input-bytes
output-bytes: traffic-statistics/output-bytes
input-errors: input-error-list/input-errors
output-errors: output-error-list/output-errors
carrier-transitions: output-error-list/carrier-transitions
vtep-tunnel-stats: VtepTunnelTable
VtepTunnelTable:
item: logical-interface
key: name
view: VtepTunnelView
VtepTunnelView:
fields:
vtep-type: vtep-info/vtep-type
vtep-address: vtep-info/vtep-address
tunnel-input-bytes: traffic-statistics/input-bytes
tunnel-output-bytes: traffic-statistics/output-bytes
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = VtepTable(self.dev)
data = generate_sax_parser_input(tbl)
self.assertEqual(data.tag, "physical-interface")
self.assertEqual(
len(etree.tostring(data)),
len(
b"<physical-interface><name/><admin-status/><oper-status/>"
b"<link-level-type/><traffic-statistics><input-bytes/>"
b"<output-bytes/></traffic-statistics><input-error-list>"
b"<input-errors/></input-error-list><output-error-list>"
b"<output-errors/><carrier-transitions/></output-error-list>"
b"<logical-interface><name/><vtep-info><vtep-type/><vtep-address/>"
b"</vtep-info><traffic-statistics><input-bytes/><output-bytes/>"
b"</traffic-statistics></logical-interface></physical-interface>"
),
)
@patch("jnpr.junos.Device.execute")
def test_key_pipe_delim_with_Null(self, mock_execute):
mock_execute.side_effect = self._mock_manager
yaml_data = """
---
UTMStatusTable:
rpc: show-utmd-status
item: //utmd-status
view: UTMStatusView
key: ../re-name | Null
UTMStatusView:
fields:
running: { running: flag }
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = UTMStatusTable(self.dev)
data = tbl.get()
self.assertEqual(
json.loads(data.to_json()),
{"node0": {"running": True}, "node1": {"running": True}},
)
@patch("jnpr.junos.Device.execute")
def test_key_pipe_delim_with_Null_use_Null(self, mock_execute):
mock_execute.side_effect = self._mock_manager
yaml_data = """
---
UTMStatusTable:
rpc: show-utmd-status_use_Null
item: //utmd-status
view: UTMStatusView
key: ../re-name | Null
UTMStatusView:
fields:
running: { running: flag }
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = UTMStatusTable(self.dev)
data = tbl.get()
self.assertEqual(json.loads(data.to_json()), {"running": True})
@patch("jnpr.junos.Device.execute")
def test_key_and_item_pipe_delim_with_Null_use_Null(self, mock_execute):
mock_execute.side_effect = self._mock_manager
yaml_data = """
---
UTMStatusTable:
rpc: show-utmd-status_use_Null
item: //multi-routing-engine-item/utmd-status | //utmd-status
view: UTMStatusView
key:
- ../re-name | Null
UTMStatusView:
fields:
running: { running: flag }
"""
globals().update(FactoryLoader().load(yaml.load(yaml_data, Loader=yaml.Loader)))
tbl = UTMStatusTable(self.dev)
data = tbl.get()
self.assertEqual(json.loads(data.to_json()), {"running": True})
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()
reply = RPCReply(foo)
reply.parse()
rpc_reply = NCElement(
reply, self.dev._conn._device_handler.transform_reply()
)._NCElement__doc[0]
return rpc_reply
def _mock_manager(self, *args, **kwargs):
if kwargs:
if args and ("normalize" in kwargs or "filter_xml" in kwargs):
return self._read_file(args[0].tag + ".xml")
device_params = kwargs["device_params"]
device_handler = make_device_handler(device_params)
session = SSHSession(device_handler)
return Manager(session, device_handler)
if args:
return self._read_file(args[0].tag + ".xml")
|
