File: test_device_messaging.py

package info (click to toggle)
python-ipmi 0.5.7-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,132 kB
  • sloc: python: 12,645; makefile: 2
file content (446 lines) | stat: -rw-r--r-- 14,531 bytes parent folder | download
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
#!/usr/bin/env python

from array import array

import pyipmi.msgs.device_messaging

from pyipmi.msgs import encode_message
from pyipmi.msgs import decode_message


def test_setbmcglobalenables_encode_all_disabled_req():
    m = pyipmi.msgs.device_messaging.SetBmcGlobalEnablesReq()
    m.enables.oem_2 = 0
    m.enables.oem_1 = 0
    m.enables.oem_0 = 0
    m.enables.system_event_logging = 0
    m.enables.event_message_buffer = 0
    m.enables.event_message_buffer_full_interrupt = 0
    m.enables.receive_message_queue_interrupt = 0
    data = encode_message(m)
    assert data == b'\x00'


def test_setbmcglobalenables_encode_enable_oem_2_req():
    m = pyipmi.msgs.device_messaging.SetBmcGlobalEnablesReq()
    m.enables.oem_2 = 1
    m.enables.oem_1 = 0
    m.enables.oem_0 = 0
    m.enables.system_event_logging = 0
    m.enables.event_message_buffer = 0
    m.enables.event_message_buffer_full_interrupt = 0
    m.enables.receive_message_queue_interrupt = 0
    data = encode_message(m)
    assert data == b'\x80'


def test_setbmcglobalenables_encode_enable_oem_1_req():
    m = pyipmi.msgs.device_messaging.SetBmcGlobalEnablesReq()
    m.enables.oem_2 = 0
    m.enables.oem_1 = 1
    m.enables.oem_0 = 0
    m.enables.system_event_logging = 0
    m.enables.event_message_buffer = 0
    m.enables.event_message_buffer_full_interrupt = 0
    m.enables.receive_message_queue_interrupt = 0
    data = encode_message(m)
    assert data == b'\x40'


def test_setbmcglobalenables_encode_enable_oem_0_req():
    m = pyipmi.msgs.device_messaging.SetBmcGlobalEnablesReq()
    m.enables.oem_2 = 0
    m.enables.oem_1 = 0
    m.enables.oem_0 = 1
    m.enables.system_event_logging = 0
    m.enables.event_message_buffer = 0
    m.enables.event_message_buffer_full_interrupt = 0
    m.enables.receive_message_queue_interrupt = 0
    data = encode_message(m)
    assert data == b'\x20'


def test_setbmcglobalenables_encode_enable_receive_queue_interrupt_req():
    m = pyipmi.msgs.device_messaging.SetBmcGlobalEnablesReq()
    m.enables.oem_2 = 0
    m.enables.oem_1 = 0
    m.enables.oem_0 = 0
    m.enables.system_event_logging = 0
    m.enables.event_message_buffer = 0
    m.enables.event_message_buffer_full_interrupt = 0
    m.enables.receive_message_queue_interrupt = 1
    data = encode_message(m)
    assert data == b'\x01'


def test_getbmcglobalenables_decode_all_disabled_rsp():
    m = pyipmi.msgs.device_messaging.GetBmcGlobalEnablesRsp()
    decode_message(m, b'\x00\x00')
    assert m.completion_code == 0x00
    assert m.enables.oem_2 == 0
    assert m.enables.oem_1 == 0
    assert m.enables.oem_0 == 0
    assert m.enables.system_event_logging == 0
    assert m.enables.event_message_buffer == 0
    assert m.enables.event_message_buffer_full_interrupt == 0
    assert m.enables.receive_message_queue_interrupt == 0


def test_getbmcglobalenables_decode_oem_2_enabled_rsp():
    m = pyipmi.msgs.device_messaging.GetBmcGlobalEnablesRsp()
    decode_message(m, b'\x00\x80')
    assert m.completion_code == 0x00
    assert m.enables.oem_2 == 1
    assert m.enables.oem_1 == 0
    assert m.enables.oem_0 == 0
    assert m.enables.system_event_logging == 0
    assert m.enables.event_message_buffer == 0
    assert m.enables.event_message_buffer_full_interrupt == 0
    assert m.enables.receive_message_queue_interrupt == 0


def test_getbmcglobalenables_decode_oem_0_enabled_rsp():
    m = pyipmi.msgs.device_messaging.GetBmcGlobalEnablesRsp()
    decode_message(m, b'\x00\x20')
    assert m.completion_code == 0x00
    assert m.enables.oem_2 == 0
    assert m.enables.oem_1 == 0
    assert m.enables.oem_0 == 1
    assert m.enables.system_event_logging == 0
    assert m.enables.event_message_buffer == 0
    assert m.enables.event_message_buffer_full_interrupt == 0
    assert m.enables.receive_message_queue_interrupt == 0


def test_clearmessageflags_encode_clear_none_req():
    m = pyipmi.msgs.device_messaging.ClearMessageFlagsReq()
    m.clear.oem_2 = 0
    m.clear.oem_1 = 0
    m.clear.oem_0 = 0
    m.clear.watchdog_pretimeout_interrupt_flag = 0
    m.clear.event_message_buffer = 0
    m.clear.receive_message_queue = 0
    data = encode_message(m)
    assert data == b'\x00'


def test_clearmessageflags_encode_clear_oem_2_req():
    m = pyipmi.msgs.device_messaging.ClearMessageFlagsReq()
    m.clear.oem_2 = 1
    m.clear.oem_1 = 0
    m.clear.oem_0 = 0
    m.clear.watchdog_pretimeout_interrupt_flag = 0
    m.clear.event_message_buffer = 0
    m.clear.receive_message_queue = 0
    data = encode_message(m)
    assert data == b'\x80'


def test_clearmessageflags_encode_clear_oem_0_req():
    m = pyipmi.msgs.device_messaging.ClearMessageFlagsReq()
    m.clear.oem_2 = 0
    m.clear.oem_1 = 0
    m.clear.oem_0 = 1
    m.clear.watchdog_pretimeout_interrupt_flag = 0
    m.clear.event_message_buffer = 0
    m.clear.receive_message_queue = 0
    data = encode_message(m)
    assert data == b'\x20'


def test_clearmessageflags_encode_clear_receive_message_queue_req():
    m = pyipmi.msgs.device_messaging.ClearMessageFlagsReq()
    m.clear.oem_2 = 0
    m.clear.oem_1 = 0
    m.clear.oem_0 = 0
    m.clear.watchdog_pretimeout_interrupt_flag = 0
    m.clear.event_message_buffer = 0
    m.clear.receive_message_queue = 1
    data = encode_message(m)
    assert data == b'\x01'


def test_getmessageflags_decode_not_flag_set_rsp():
    m = pyipmi.msgs.device_messaging.GetMessageFlagsRsp()
    decode_message(m, b'\x00\x00')
    assert m.completion_code == 0x00
    assert m.flag.oem_2 == 0
    assert m.flag.oem_1 == 0
    assert m.flag.oem_0 == 0
    assert m.flag.watchdog_pretimeout_interrupt_occurred == 0
    assert m.flag.event_message_buffer_full == 0
    assert m.flag.receive_message_available == 0


def test_getmessageflags_decode_oem_2_set_rsp():
    m = pyipmi.msgs.device_messaging.GetMessageFlagsRsp()
    decode_message(m, b'\x00\x80')
    assert m.completion_code == 0x00
    assert m.flag.oem_2 == 1
    assert m.flag.oem_1 == 0
    assert m.flag.oem_0 == 0
    assert m.flag.watchdog_pretimeout_interrupt_occurred == 0
    assert m.flag.event_message_buffer_full == 0
    assert m.flag.receive_message_available == 0


def test_getmessageflags_decode_event_message_full_set_rsp():
    m = pyipmi.msgs.device_messaging.GetMessageFlagsRsp()
    decode_message(m, b'\x00\x02')
    assert m.completion_code == 0x00
    assert m.flag.oem_2 == 0
    assert m.flag.oem_1 == 0
    assert m.flag.oem_0 == 0
    assert m.flag.watchdog_pretimeout_interrupt_occurred == 0
    assert m.flag.event_message_buffer_full == 1
    assert m.flag.receive_message_available == 0


def test_enablemessagechannelreceive_encode_all_off_req():
    m = pyipmi.msgs.device_messaging.EnableMessageChannelReceiveReq()
    m.channel.number = 0
    m.channel.state = 0
    data = encode_message(m)
    assert data == b'\x00\x00'


def test_enablemessagechannelreceive_encode_channel1_enable_req():
    m = pyipmi.msgs.device_messaging.EnableMessageChannelReceiveReq()
    m.channel.number = 1
    m.channel.state = 1
    data = encode_message(m)
    assert data == b'\x01\x01'


def test_enablemessagechannelreceive_encode_channel2_enable_req():
    m = pyipmi.msgs.device_messaging.EnableMessageChannelReceiveReq()
    m.channel.number = 2
    m.channel.state = 1
    data = encode_message(m)
    assert data == b'\x02\x01'


def test_enablemessagechannelreceive_decode_channel1_enabled_rsp():
    m = pyipmi.msgs.device_messaging.EnableMessageChannelReceiveRsp()
    decode_message(m, b'\x00\x01\x01')
    assert m.completion_code == 0x00
    assert m.channel.number == 1
    assert m.channel.state == 1


def test_getmessage_decode_no_data_rsp():
    m = pyipmi.msgs.device_messaging.GetMessageRsp()
    decode_message(m, b'\x00\x21')
    assert m.completion_code == 0x00
    assert m.channel.number == 1
    assert m.channel.privilege_level == 2


def test_getmessage_decode_with_data_rsp():
    m = pyipmi.msgs.device_messaging.GetMessageRsp()
    decode_message(m, b'\x00\x21\xaa\xff\xff\xee')
    assert m.completion_code == 0x00
    assert m.channel.number == 1
    assert m.channel.privilege_level == 2
    assert m.data == array('B', [0xaa, 0xff, 0xff, 0xee])


def test_readeventmessagebuffer_decode_rsp():
    m = pyipmi.msgs.device_messaging.ReadEventMessageBufferRsp()
    decode_message(m, b'\x00\x00\x01\x02\x03\x04\x05\x06\x07'
                   b'\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f')
    assert m.completion_code == 0x00
    assert m.event_data == array('B', b'\x00\x01\x02\x03\x04\x05\x06\x07'
                                      b'\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f')


def test_masterwriteread_encode_req_all_zero_read():
    m = pyipmi.msgs.device_messaging.MasterWriteReadReq()
    m.bus_id.type = 0
    m.bus_id.id = 0
    m.bus_id.channel = 0
    m.bus_id.slave_address = 0
    m.read_count = 0
    data = encode_message(m)
    assert data == b'\x00\x00\x00'


def test_masterwriteread_encode_req_for_read():
    m = pyipmi.msgs.device_messaging.MasterWriteReadReq()
    m.bus_id.type = 1
    m.bus_id.id = 2
    m.bus_id.channel = 4
    m.bus_id.slave_address = 0x3a
    m.read_count = 5
    data = encode_message(m)
    assert data == b'\x45\x74\x05'


def test_masterwriteread_encode_req_for_write():
    m = pyipmi.msgs.device_messaging.MasterWriteReadReq()
    m.bus_id.type = 0
    m.bus_id.id = 0
    m.bus_id.channel = 0
    m.bus_id.slave_address = 0
    m.read_count = 0
    m.data = [1, 0x23, 0x45]
    data = encode_message(m)
    assert data == b'\x00\x00\x00\x01\x23\x45'


def test_masterwriteread_decode_rsp():
    m = pyipmi.msgs.device_messaging.MasterWriteReadRsp()
    decode_message(m, b'\x00\x11\x22\x33\x44')
    assert m.completion_code == 0x00
    assert m.data == array('B', [0x11, 0x22, 0x33, 0x44])


def test_get_channel_authentication_capabilities_req():
    m = pyipmi.msgs.device_messaging.GetChannelAuthenticationCapabilitiesReq()
    m.channel.number = 6
    m.channel.type = 1
    m.privilege_level.requested = 5
    data = encode_message(m)
    assert m.cmdid == 0x38
    assert m.netfn == 6
    assert data == b'\x86\x05'


def test_get_channel_authentication_capabilities_rsp():
    m = pyipmi.msgs.device_messaging.GetChannelAuthenticationCapabilitiesRsp()
    decode_message(m, b'\x00\x01\x15\x19\x44\x55\x66\x77\x88')
    assert m.cmdid == 0x38
    assert m.netfn == 7
    assert m.completion_code == 0x00
    assert m.channel_number == 1
    assert m.support.none == 1
    assert m.support.md2 == 0
    assert m.support.md5 == 1
    assert m.support.straight == 1
    assert m.support.oem_proprietary == 0
    assert m.status.anonymous_login_enabled == 1
    assert m.status.anonymous_login_null_user == 0
    assert m.status.anonymous_login_non_null == 0
    assert m.status.user_level == 1
    assert m.status.per_message == 1
    assert m.status.kg == 0


def test_get_session_challenge_rsp():
    m = pyipmi.msgs.device_messaging.GetSessionChallengeRsp()
    data = encode_message(m)
    assert data == b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00' \
                   b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'


def test_get_session_challenge_rsp_cc_not_ok():
    m = pyipmi.msgs.device_messaging.GetSessionChallengeRsp()
    m.completion_code = 0xc1
    m.temporary_session_id = 0x11121314
    m.challenge_string = '0123456789abcdef'
    data = encode_message(m)
    assert data == b'\xc1\x14\x13\x12\x110123456789abcdef'


def test_get_session_challenge_req():
    m = pyipmi.msgs.device_messaging.GetSessionChallengeReq()
    m.authentication.type = 1
#    m.user_name = "helloworld"
    data = encode_message(m)
    assert m.cmdid == 0x39
    assert m.netfn == 6
    assert data == \
        b'\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'

    m.authentication.type = 1
    m.user_name = '0123456789abcdef'
    data = encode_message(m)
    assert m.cmdid == 0x39
    assert m.netfn == 6
    assert data == b'\x010123456789abcdef'


def test_get_username_rsp():
    m = pyipmi.msgs.device_messaging.GetUserNameRsp()
    decode_message(m, b'\x00\x72\x6f\x6f\x74\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
    assert m.cmdid == 0x46
    assert m.netfn == 7
    assert m.completion_code == 0x00
    assert m.user_name == b'root\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'


def test_get_username_req():
    m = pyipmi.msgs.device_messaging.GetUserNameReq()
    m.userid.userid = 2
    data = encode_message(m)
    assert data == b'\x02'
    assert m.cmdid == 0x46
    assert m.netfn == 6
    assert m.userid.userid == 2


def test_set_user_password_req():
    m = pyipmi.msgs.device_messaging.SetUserPasswordReq()
    m.userid.userid = 2
    m.operation.operation = 0b10
    m.password = "password".ljust(16, '\x00')
    data = encode_message(m)
    assert m.cmdid == 0x47
    assert m.netfn == 6
    assert data == b'\x02\x02password\x00\x00\x00\x00\x00\x00\x00\x00'


def test_set_user_password_rsp():
    m = pyipmi.msgs.device_messaging.SetUserPasswordRsp()
    decode_message(m, b'\x00')
    assert m.cmdid == 0x47
    assert m.netfn == 7
    assert m.completion_code == 0x00


def test_get_user_access_req():
    m = pyipmi.msgs.device_messaging.GetUserAccessReq()
    m.channel.channel_number = 1
    m.userid.userid = 2
    data = encode_message(m)
    assert m.cmdid == 0x44
    assert m.netfn == 6
    assert data == b'\x01\x02'


def test_get_user_access_rsp():
    m = pyipmi.msgs.device_messaging.GetUserAccessRsp()
    decode_message(m, b'\x00\x0a\x42\x01\x13')
    assert m.cmdid == 0x44
    assert m.netfn == 7
    assert m.max_user.max_user == 10
    assert m.enabled_user.count == 2
    assert m.enabled_user.status == 1
    assert m.fixed_names.count == 1
    assert m.channel_access.privilege == 3
    assert m.channel_access.ipmi_msg == 1
    assert m.channel_access.link_auth == 0
    assert m.channel_access.callback == 0


def test_set_user_access_req():
    m = pyipmi.msgs.device_messaging.SetUserAccessReq()
    m.channel_access.channel_number = 1
    m.channel_access.ipmi_msg = 1
    m.channel_access.link_auth = 0
    m.channel_access.callback = 0
    m.channel_access.enable_change = 1
    m.userid.userid = 2
    m.privilege.privilege_level = 3
    data = encode_message(m)
    assert m.cmdid == 0x43
    assert m.netfn == 6
    assert data == b'\x91\x02\x03\x00'


def test_user_access_rsp():
    m = pyipmi.msgs.device_messaging.SetUserAccessRsp()
    decode_message(m, b'\x00')
    assert m.cmdid == 0x43
    assert m.netfn == 7
    assert m.completion_code == 0x00