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
|
import unittest
import json
from mock import Mock, patch
import pyeapi.eapilib
class TestEapiConnection(unittest.TestCase):
def test_execute_valid_response(self):
response_dict = dict(jsonrpc='2.0', result=[], id=id(self))
mock_send = Mock(name='send')
mock_send.return_value = json.dumps(response_dict)
instance = pyeapi.eapilib.EapiConnection()
instance.send = mock_send
result = instance.execute(['command'])
self.assertEqual(json.loads(result), response_dict)
def test_execute_raises_type_error(self):
instance = pyeapi.eapilib.EapiConnection()
with self.assertRaises(TypeError):
instance.execute(None, encoding='invalid')
def test_execute_raises_connection_error(self):
mock_send = Mock(name='send')
mock_send.side_effect = pyeapi.eapilib.ConnectionError('test', 'test')
instance = pyeapi.eapilib.EapiConnection()
instance.send = mock_send
with self.assertRaises(pyeapi.eapilib.ConnectionError):
instance.execute('test')
def test_execute_raises_command_error(self):
mock_send = Mock(name='send')
mock_send.side_effect = pyeapi.eapilib.CommandError('1000', 'test')
instance = pyeapi.eapilib.EapiConnection()
instance.send = mock_send
with self.assertRaises(pyeapi.eapilib.CommandError):
instance.execute('test')
def test_create_socket_connection(self):
instance = pyeapi.eapilib.SocketEapiConnection()
self.assertIsInstance(instance, pyeapi.eapilib.EapiConnection)
self.assertIsNotNone(str(instance.transport))
@patch('pyeapi.eapilib.socket')
def test_socket_connection_create(self, mock_socket):
instance = pyeapi.eapilib.SocketConnection('/path/to/sock')
instance.connect()
mock_socket.socket.return_value.connect.assert_called_with('/path/to/sock')
def test_create_http_local_connection(self):
instance = pyeapi.eapilib.HttpLocalEapiConnection()
self.assertIsInstance(instance, pyeapi.eapilib.EapiConnection)
self.assertIsNotNone(str(instance.transport))
def test_create_http_connection(self):
instance = pyeapi.eapilib.HttpEapiConnection('localhost')
self.assertIsInstance(instance, pyeapi.eapilib.EapiConnection)
self.assertIsNotNone(str(instance.transport))
def test_create_https_connection(self):
instance = pyeapi.eapilib.HttpsEapiConnection('localhost')
self.assertIsInstance(instance, pyeapi.eapilib.EapiConnection)
self.assertIsNotNone(str(instance.transport))
def test_send(self):
response_dict = dict(jsonrpc='2.0', result=[{}], id=id(self))
response_json = json.dumps(response_dict)
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.return_value': response_json}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
instance.send('test')
# HTTP requests to be processed by EAPI should always go to
# the /command-api endpoint regardless of using TCP/IP or unix-socket
# for the transport. Unix-socket implementation maps localhost to the
# unix-socket - /var/run/command-api.sock
mock_transport.putrequest.assert_called_once_with('POST',
'/command-api')
self.assertTrue(mock_transport.close.called)
def test_send_with_authentication(self):
response_dict = dict(jsonrpc='2.0', result=[{}], id=id(self))
response_json = json.dumps(response_dict)
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.return_value': response_json}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.authentication('username', 'password')
instance.transport = mock_transport
instance.send('test')
self.assertTrue(mock_transport.close.called)
def test_send_raises_connection_error(self):
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.side_effect': ValueError}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
try:
instance.send('test')
except pyeapi.eapilib.ConnectionError as err:
self.assertEqual(err.message, 'unable to connect to eAPI')
def test_send_raises_connection_socket_error(self):
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.side_effect':
OSError('timeout')}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
try:
instance.send('test')
except pyeapi.eapilib.ConnectionError as err:
error_msg = 'Socket error during eAPI connection: timeout'
self.assertEqual(err.message, error_msg)
def test_send_raises_command_error(self):
error = dict(code=9999, message='test', data=[{'errors': ['test']}])
response_dict = dict(jsonrpc='2.0', error=error, id=id(self))
response_json = json.dumps(response_dict)
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.return_value': response_json}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
with self.assertRaises(pyeapi.eapilib.CommandError):
instance.send('test')
def test_send_raises_autocomplete_command_error(self):
message = "runCmds() got an unexpected keyword argument 'autoComplete'"
error = dict(code=9999, message=message, data=[{'errors': ['test']}])
response_dict = dict(jsonrpc='2.0', error=error, id=id(self))
response_json = json.dumps(response_dict)
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.return_value': response_json}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
try:
instance.send('test')
except pyeapi.eapilib.CommandError as error:
match = ("autoComplete parameter is not supported in this version"
" of EOS.")
self.assertIn(match, error.message)
def test_send_raises_expandaliases_command_error(self):
message = "runCmds() got an unexpected keyword argument" \
" 'expandAliases'"
error = dict(code=9999, message=message, data=[{'errors': ['test']}])
response_dict = dict(jsonrpc='2.0', error=error, id=id(self))
response_json = json.dumps(response_dict)
mock_transport = Mock(name='transport')
mockcfg = {'getresponse.return_value.read.return_value': response_json}
mock_transport.configure_mock(**mockcfg)
instance = pyeapi.eapilib.EapiConnection()
instance.transport = mock_transport
try:
instance.send('test')
except pyeapi.eapilib.CommandError as error:
match = ("expandAliases parameter is not supported in this version"
" of EOS.")
self.assertIn(match, error.message)
def test_request_adds_autocomplete(self):
instance = pyeapi.eapilib.EapiConnection()
request = instance.request(['sh ver'], encoding='json',
autoComplete=True)
data = json.loads(request)
self.assertIn('autoComplete', data['params'])
def test_request_adds_expandaliases(self):
instance = pyeapi.eapilib.EapiConnection()
request = instance.request(['test'], encoding='json',
expandAliases=True)
data = json.loads(request)
self.assertIn('expandAliases', data['params'])
def test_request_ignores_unknown_param(self):
instance = pyeapi.eapilib.EapiConnection()
request = instance.request(['sh ver'], encoding='json',
unknown=True)
data = json.loads(request)
self.assertNotIn('unknown', data['params'])
class TestCommandError(unittest.TestCase):
def test_create_command_error(self):
result = pyeapi.eapilib.CommandError(9999, 'test')
self.assertIsInstance(result, pyeapi.eapilib.EapiError)
def test_command_error_trace(self):
commands = ['test command', 'test command', 'test command']
output = [{}, 'test output']
result = pyeapi.eapilib.CommandError(9999, 'test', commands=commands,
output=output)
self.assertIsNotNone(result.trace)
|
