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
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from http import client as http_client
import json
from unittest import mock
import requests
from sushy import exceptions
from sushy.resources import base as resource_base
from sushy.resources.taskservice import task
from sushy import taskmonitor
from sushy.tests.unit import base
class TaskMonitorTestCase(base.TestCase):
def setUp(self):
super().setUp()
self.conn = mock.Mock()
with open('sushy/tests/unit/json_samples/task.json') as f:
self.json_doc = json.load(f)
self.conn.get.return_value.json.return_value = self.json_doc
self.field_data = resource_base.FieldData(
http_client.ACCEPTED,
{'Content-Length': 42,
'Location': '/Task/545',
'Retry-After': 20,
'Allow': 'DELETE'},
self.json_doc)
self.response = mock.Mock()
self.response.status_code = http_client.ACCEPTED
self.response.headers = {'Content-Length': 42,
'Location': '/Task/545',
'Retry-After': 20,
'Allow': 'DELETE'}
self.response.content = json.dumps(self.json_doc).encode('utf-8')
self.response.json.return_value = self.json_doc
self.task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545',
response=self.response
)
def test_init_accepted_no_content(self):
response = mock.Mock()
response.status_code = http_client.ACCEPTED
response.headers = {'Location': '/Task/545',
'Retry-After': 20,
'Allow': 'DELETE'}
response.content = None
task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545',
response=response)
self.assertIsNone(task_monitor.task)
def test_init_accepted_content(self):
self.assertIsNotNone(self.task_monitor.task)
def test_init_no_response(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
self.conn.get.return_value.headers = {'Content-Length': 42}
task_monitor = taskmonitor.TaskMonitor(self.conn, '/Task/545')
self.conn.get.assert_called_with(path='/Task/545')
self.assertEqual(1, self.conn.get.call_count)
self.assertIsNotNone(task_monitor.task)
def test_refresh_no_content(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
self.conn.get.return_value.headers = {'Content-Length': 0}
self.conn.get.return_value.content = None
self.task_monitor.refresh()
self.conn.get.assert_called_with(path='/Task/545')
self.assertEqual(1, self.conn.get.call_count)
self.assertIsNone(self.task_monitor.task)
def test_refresh_content_no_task(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
self.conn.get.return_value.headers = {'Content-Length': 42}
self.task_monitor._task = None
self.task_monitor.refresh()
self.conn.get.assert_called_with(path='/Task/545')
self.assertEqual(1, self.conn.get.call_count)
self.assertIsNotNone(self.task_monitor.task)
def test_refresh_content_task(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
self.conn.get.return_value.headers = {'Content-Length': 42}
self.task_monitor.refresh()
self.conn.get.assert_called_with(path='/Task/545')
self.assertEqual(1, self.conn.get.call_count)
self.assertIsNotNone(self.task_monitor.task)
def test_refresh_done(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 200
self.task_monitor.refresh()
self.conn.get.assert_called_once_with(path='/Task/545')
self.assertIsNone(self.task_monitor.task)
def test_task_monitor_uri(self):
self.assertEqual('/Task/545', self.task_monitor.task_monitor_uri)
def test_is_processing(self):
self.assertTrue(self.task_monitor.is_processing)
def test_check_is_processing_not_processing(self):
response = mock.Mock()
response.status_code = http_client.OK
response.headers = {}
response.content = None
task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545',
response=response)
self.assertEqual(False, task_monitor.check_is_processing)
def test_check_is_processing_refreshing(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
self.conn.get.return_value.headers = {}
self.conn.get.return_value.content = None
task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545')
self.assertEqual(True, task_monitor.check_is_processing)
def test_cancellable(self):
self.assertTrue(self.task_monitor.cancellable)
def test_sleep_for_retry_after_empty(self):
self.task_monitor._response.headers["Retry-After"] = None
self.assertEqual(1, self.task_monitor.sleep_for)
def test_sleep_for_retry_after_digit(self):
self.assertEqual(20, self.task_monitor.sleep_for)
def test_sleep_for_retry_after_date_past(self):
self.task_monitor._response.headers["Retry-After"] =\
'Fri, 31 Dec 1999 23:59:59 GMT'
self.assertEqual(0, self.task_monitor.sleep_for)
def test_not_cancellable_no_header(self):
response = mock.Mock()
response.status_code = http_client.ACCEPTED
response.headers = {
'Content-Length': 42,
'Location': '/Task/545',
'Retry-After': 20}
response.json.return_value = self.json_doc
task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545',
response=response
)
self.assertFalse(task_monitor.cancellable)
def test_not_cancellable(self):
response = mock.Mock()
response.status_code = http_client.ACCEPTED
response.headers = {
'Content-Length': 42,
'Location': '/Task/545',
'Retry-After': 20,
'Allow': 'GET'}
response.json.return_value = self.json_doc
task_monitor = taskmonitor.TaskMonitor(
self.conn, '/Task/545',
response=response
)
self.assertFalse(task_monitor.cancellable)
def test_task(self):
tm_task = self.task_monitor.task
self.assertIsInstance(tm_task, task.Task)
self.assertEqual('545', tm_task.identity)
def test_get_task(self):
tm_task = self.task_monitor.get_task()
self.assertIsInstance(tm_task, task.Task)
self.assertEqual('545', tm_task.identity)
@mock.patch('time.sleep', autospec=True)
def test_wait(self, mock_time):
self.conn.reset_mock()
response1 = mock.MagicMock(spec=requests.Response)
response1.status_code = http_client.ACCEPTED
response1.headers = {
'Retry-After': 5,
'Location': '/redfish/v1/taskmon/1',
'Content-Length': 10
}
response1.json.return_value = {'Id': 3, 'Name': 'Test'}
response2 = mock.MagicMock(spec=requests.Response)
response2.status_code = http_client.OK
response2.headers = {
'Retry-After': 5,
'Location': '/redfish/v1/taskmon/1',
'Content-Length': 10
}
response2.json.return_value = {'Id': 3, 'Name': 'Test'}
self.conn.get.side_effect = [response1, response2]
self.task_monitor.wait(60)
self.assertFalse(self.task_monitor.is_processing)
self.assertEqual(response2, self.task_monitor.response)
@mock.patch('time.sleep', autospec=True)
def test_wait_timeout(self, mock_time):
self.conn.reset_mock()
response1 = mock.MagicMock(spec=requests.Response)
response1.status_code = http_client.ACCEPTED
response1.headers = {
'Retry-After': 5,
'Location': '/redfish/v1/taskmon/1',
'Content-Length': 10
}
response1.json.return_value = {'Id': 3, 'Name': 'Test'}
self.conn.get.side_effect = [response1, response1]
self.assertRaises(exceptions.ConnectionError,
self.task_monitor.wait, -10)
def test_from_response_no_content(self):
self.conn.reset_mock()
self.conn.get.return_value.status_code = 202
response = mock.Mock()
response.content = None
response.headers = {'Location': '/Task/545'}
response.status_code = http_client.ACCEPTED
tm = taskmonitor.TaskMonitor.from_response(
self.conn, response,
'/redfish/v1/UpdateService/Actions/SimpleUpdate')
self.assertIsInstance(tm, taskmonitor.TaskMonitor)
self.assertEqual('/Task/545', tm.task_monitor_uri)
self.assertIsNotNone(tm.task)
self.assertEqual('545', tm.task.identity)
def test_from_response_odata_id(self):
response = mock.Mock()
response.content = "something"
response.json.return_value = {'Id': '545', 'Name': 'test',
'@odata.id': '545'}
response.headers = {'Location': '/TaskMonitor/'}
response.status_code = http_client.ACCEPTED
tm = taskmonitor.TaskMonitor.from_response(
self.conn, response,
'/redfish/v1/UpdateService/Actions/SimpleUpdate')
self.assertIsInstance(tm, taskmonitor.TaskMonitor)
self.assertEqual('/TaskMonitor/545', tm.task_monitor_uri)
self.assertIsNotNone(tm.task)
self.assertEqual('545', tm.task.identity)
def test_from_response_location_header_missing(self):
response = mock.Mock()
response.content = "something"
response.json.return_value = {'Id': '545', 'Name': 'test'}
response.headers = {}
response.status_code = http_client.ACCEPTED
self.assertRaises(exceptions.MissingHeaderError,
taskmonitor.TaskMonitor.from_response,
self.conn, response,
'/redfish/v1/UpdateService/Actions/SimpleUpdate')
def test_from_response(self):
response = mock.Mock()
response.content = "something"
response.json.return_value = {'Id': '545', 'Name': 'test'}
response.headers = {'Location': '/Task/545'}
response.status_code = http_client.ACCEPTED
tm = taskmonitor.TaskMonitor.from_response(
self.conn, response,
'/redfish/v1/UpdateService/Actions/SimpleUpdate')
self.assertIsInstance(tm, taskmonitor.TaskMonitor)
self.assertEqual('/Task/545', tm.task_monitor_uri)
self.assertIsNotNone(tm.task)
self.assertEqual('545', tm.task.identity)
|
