forked from gijzelaerr/python-snap7
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_client.py
More file actions
executable file
·1505 lines (1262 loc) · 55 KB
/
test_client.py
File metadata and controls
executable file
·1505 lines (1262 loc) · 55 KB
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import logging
import struct
import time
from typing import Any, Tuple
from unittest.mock import MagicMock
import pytest
import unittest
from ctypes import (
c_uint8,
c_uint16,
c_int32,
c_int,
POINTER,
sizeof,
create_string_buffer,
cast,
pointer,
Array,
)
from datetime import datetime, timedelta, timezone
from typing import cast as typing_cast
from snap7.util import get_real, get_int, set_int
from snap7.error import check_error, S7ProtocolError, S7StalePacketError, S7PacketLostError
from snap7.s7protocol import S7Protocol
from snap7.server import Server
from snap7.client import Client
from snap7.type import SrvArea
from snap7.type import (
S7DataItem,
S7SZL,
S7SZLList,
buffer_type,
buffer_size,
Area,
WordLen,
Block,
Parameter,
CDataArrayType,
)
logging.basicConfig(level=logging.WARNING)
ip = "127.0.0.1"
tcpport = 1102
db_number = 1
rack = 1
slot = 1
def _prepare_as_read_area(area: Area, size: int) -> Tuple[WordLen, CDataArrayType]:
wordlen = area.wordlen()
usrdata = (wordlen.ctype * size)()
return wordlen, usrdata
def _prepare_as_write_area(area: Area, data: bytearray) -> Tuple[WordLen, CDataArrayType]:
if area not in Area:
raise ValueError(f"{area} is not implemented in types")
elif area == Area.TM:
word_len = WordLen.Timer
elif area == Area.CT:
word_len = WordLen.Counter
else:
word_len = WordLen.Byte
type_ = WordLen.Byte.ctype
cdata = (type_ * len(data)).from_buffer_copy(data)
return word_len, cdata
# noinspection PyTypeChecker,PyCallingNonCallable
@pytest.mark.client
class TestClient(unittest.TestCase):
server: Server = None # type: ignore
@classmethod
def setUpClass(cls) -> None:
cls.server = Server()
# Register memory areas (same as mainloop)
cls.server.register_area(SrvArea.DB, 0, bytearray(600))
cls.server.register_area(SrvArea.DB, 1, bytearray(600))
cls.server.register_area(SrvArea.PA, 0, bytearray(100))
cls.server.register_area(SrvArea.PA, 1, bytearray(100))
cls.server.register_area(SrvArea.PE, 0, bytearray(100))
cls.server.register_area(SrvArea.PE, 1, bytearray(100))
cls.server.register_area(SrvArea.MK, 0, bytearray(100))
cls.server.register_area(SrvArea.MK, 1, bytearray(100))
cls.server.register_area(SrvArea.TM, 0, bytearray(100))
cls.server.register_area(SrvArea.TM, 1, bytearray(100))
cls.server.register_area(SrvArea.CT, 0, bytearray(100))
cls.server.register_area(SrvArea.CT, 1, bytearray(100))
cls.server.start(tcp_port=tcpport)
@classmethod
def tearDownClass(cls) -> None:
if cls.server:
cls.server.stop()
cls.server.destroy()
def setUp(self) -> None:
self.client = Client()
self.client.connect(ip, rack, slot, tcpport)
def tearDown(self) -> None:
self.client.disconnect()
self.client.destroy()
def test_db_read(self) -> None:
size = 40
start = 0
db = 1
data = bytearray(40)
self.client.db_write(db_number=db, start=start, data=data)
result = self.client.db_read(db_number=db, start=start, size=size)
self.assertEqual(data, result)
def test_db_write(self) -> None:
size = 40
data = bytearray(size)
self.client.db_write(db_number=1, start=0, data=data)
def test_db_get(self) -> None:
self.client.db_get(db_number=db_number)
def test_read_multi_vars(self) -> None:
db = 1
# build and write test values
test_value_1 = 129.5
test_bytes_1 = bytearray(struct.pack(">f", test_value_1))
self.client.db_write(db, 0, test_bytes_1)
test_value_2 = -129.5
test_bytes_2 = bytearray(struct.pack(">f", test_value_2))
self.client.db_write(db, 4, test_bytes_2)
test_value_3 = 123
test_bytes_3 = bytearray([0, 0])
set_int(test_bytes_3, 0, test_value_3)
self.client.db_write(db, 8, test_bytes_3)
test_values = [test_value_1, test_value_2, test_value_3]
# build up our requests
data_items = (S7DataItem * 3)()
# build up our requests
data_items = (S7DataItem * 3)()
data_items[0].Area = c_int32(Area.DB.value)
data_items[0].WordLen = c_int32(WordLen.Byte.value)
data_items[0].Result = c_int32(0)
data_items[0].DBNumber = c_int32(db)
data_items[0].Start = c_int32(0)
data_items[0].Amount = c_int32(4) # reading a REAL, 4 bytes
data_items[1].Area = c_int32(Area.DB.value)
data_items[1].WordLen = c_int32(WordLen.Byte.value)
data_items[1].Result = c_int32(0)
data_items[1].DBNumber = c_int32(db)
data_items[1].Start = c_int32(4)
data_items[1].Amount = c_int32(4) # reading a REAL, 4 bytes
data_items[2].Area = c_int32(Area.DB.value)
data_items[2].WordLen = c_int32(WordLen.Byte.value)
data_items[2].Result = c_int32(0)
data_items[2].DBNumber = c_int32(db)
data_items[2].Start = c_int32(8)
data_items[2].Amount = c_int32(2) # reading an INT, 2 bytes
# create buffers to receive the data
# use the Amount attribute on each item to size the buffer
for di in data_items:
# create the buffer
dataBuffer = create_string_buffer(di.Amount)
# get a pointer to the buffer
pBuffer = cast(pointer(dataBuffer), POINTER(c_uint8))
di.pData = pBuffer
result, data_items = self.client.read_multi_vars(data_items)
result_values = []
# function to cast bytes to match data_types[] above
byte_to_value = [get_real, get_real, get_int]
# unpack and test the result of each read
for i, di in enumerate(data_items):
btv = byte_to_value[i]
value = btv(di.pData, 0)
result_values.append(value)
self.assertEqual(result_values[0], test_values[0])
self.assertEqual(result_values[1], test_values[1])
self.assertEqual(result_values[2], test_values[2])
def test_upload(self) -> None:
"""Test uploading a block from PLC using real S7 protocol."""
# Write some data to DB1 first
test_data = bytearray([0x11, 0x22, 0x33, 0x44])
self.client.db_write(db_number, 0, test_data)
# Upload DB1 - should return the data we wrote
result = self.client.upload(db_number)
self.assertIsInstance(result, bytearray)
# The uploaded data should contain what we wrote
self.assertEqual(result[0:4], test_data)
@unittest.skip("Async upload not fully implemented")
def test_as_upload(self) -> None:
"""Test async upload (not fully implemented)."""
_buffer = typing_cast(Array[c_int32], buffer_type())
size = sizeof(_buffer)
self.client.as_upload(1, _buffer, size)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_download(self) -> None:
"""Test downloading a block to PLC using real S7 protocol."""
# Download data to DB1
data = bytearray([0xAA, 0xBB, 0xCC, 0xDD])
result = self.client.download(block_num=db_number, data=data)
self.assertEqual(result, 0)
# Verify by reading it back
read_data = self.client.db_read(db_number, 0, 4)
self.assertEqual(read_data, data)
def test_read_area(self) -> None:
amount = 1
start = 1
# Test read_area with a DB
area = Area.DB
dbnumber = 1
data = bytearray(b"\x11")
self.client.write_area(area, dbnumber, start, data)
res = self.client.read_area(area, dbnumber, start, amount)
self.assertEqual(data, bytearray(res))
# Test read_area with a TM
area = Area.TM
dbnumber = 0
data = bytearray(b"\x12\x34")
self.client.write_area(area, dbnumber, start, data)
res = self.client.read_area(area, dbnumber, start, amount)
self.assertEqual(data, bytearray(res))
# Test read_area with a CT
area = Area.CT
dbnumber = 0
data = bytearray(b"\x13\x35")
self.client.write_area(area, dbnumber, start, data)
res = self.client.read_area(area, dbnumber, start, amount)
self.assertEqual(data, bytearray(res))
def test_write_area(self) -> None:
# Test write area with a DB
area = Area.DB
dbnumber = 1
start = 1
data = bytearray(b"\x11")
self.client.write_area(area, dbnumber, start, data)
res = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(data, bytearray(res))
# Test write area with a TM
area = Area.TM
dbnumber = 0
timer = bytearray(b"\x12\x00")
self.client.write_area(area, dbnumber, start, timer)
res = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(timer, bytearray(res))
# Test write area with a CT
area = Area.CT
dbnumber = 0
timer = bytearray(b"\x13\x00")
self.client.write_area(area, dbnumber, start, timer)
res = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(timer, bytearray(res))
def test_list_blocks(self) -> None:
self.client.list_blocks()
def test_list_blocks_of_type(self) -> None:
self.client.list_blocks_of_type(Block.DB, 10)
def test_get_block_info(self) -> None:
self.client.get_block_info(Block.DB, 1)
def test_get_cpu_state(self) -> None:
self.client.get_cpu_state()
def test_set_session_password(self) -> None:
password = "abcdefgh" # noqa: S105
self.client.set_session_password(password)
def test_clear_session_password(self) -> None:
self.client.clear_session_password()
def test_set_connection_params(self) -> None:
self.client.set_connection_params("10.0.0.2", 10, 10)
def test_set_connection_type(self) -> None:
self.client.set_connection_type(1)
self.client.set_connection_type(2)
self.client.set_connection_type(3)
self.client.set_connection_type(20)
def test_get_connected(self) -> None:
self.client.get_connected()
def test_ab_read(self) -> None:
start = 1
size = 1
data = bytearray(size)
self.client.ab_write(start=start, data=data)
self.client.ab_read(start=start, size=size)
def test_ab_write(self) -> None:
start = 1
size = 10
data = bytearray(size)
result = self.client.ab_write(start=start, data=data)
self.assertEqual(0, result)
def test_as_ab_read(self) -> None:
expected = b"\x10\x01"
self.client.ab_write(0, bytearray(expected))
type_ = WordLen.Byte.ctype
buffer = (type_ * 2)()
self.client.as_ab_read(0, 2, buffer)
result = self.client.wait_as_completion(500)
self.assertEqual(0, result)
self.assertEqual(expected, bytearray(buffer))
def test_as_ab_write(self) -> None:
data = b"\x01\x11"
response = self.client.as_ab_write(0, bytearray(data))
result = self.client.wait_as_completion(500)
self.assertEqual(0, response)
self.assertEqual(0, result)
self.assertEqual(data, self.client.ab_read(0, 2))
def test_compress(self) -> None:
time_ = 1000
self.client.compress(time_)
def test_as_compress(self) -> None:
time_ = 1000
response = self.client.as_compress(time_)
result = self.client.wait_as_completion(500)
self.assertEqual(0, response)
self.assertEqual(0, result)
def test_set_param(self) -> None:
values = (
(Parameter.PingTimeout, 800),
(Parameter.SendTimeout, 15),
(Parameter.RecvTimeout, 3500),
(Parameter.SrcRef, 128),
(Parameter.DstRef, 128),
(Parameter.SrcTSap, 128),
(Parameter.PDURequest, 470),
)
for param, value in values:
self.client.set_param(param, value)
self.assertRaises(Exception, self.client.set_param, Parameter.RemotePort, 1)
def test_get_param(self) -> None:
expected = (
(Parameter.RemotePort, tcpport),
(Parameter.PingTimeout, 750),
(Parameter.SendTimeout, 10),
(Parameter.RecvTimeout, 3000),
(Parameter.SrcRef, 256),
(Parameter.DstRef, 0),
(Parameter.SrcTSap, 256),
(Parameter.PDURequest, 480),
)
for param, value in expected:
self.assertEqual(self.client.get_param(param), value)
non_client = (
Parameter.LocalPort,
Parameter.WorkInterval,
Parameter.MaxClients,
Parameter.BSendTimeout,
Parameter.BRecvTimeout,
Parameter.RecoveryTime,
Parameter.KeepAliveTime,
)
# invalid param for client
for param in non_client:
self.assertRaises(Exception, self.client.get_param, param)
def test_as_copy_ram_to_rom(self) -> None:
response = self.client.as_copy_ram_to_rom(timeout=2)
self.client.wait_as_completion(2000)
self.assertEqual(0, response)
def test_as_ct_read(self) -> None:
# Cli_AsCTRead
expected = b"\x10\x01"
self.client.ct_write(0, 1, bytearray(expected))
type_ = WordLen.Counter.ctype
buffer = (type_ * 1)()
self.client.as_ct_read(0, 1, buffer)
self.client.wait_as_completion(500)
self.assertEqual(expected, bytearray(buffer))
def test_as_ct_write(self) -> None:
# Cli_CTWrite
data = b"\x01\x11"
response = self.client.as_ct_write(0, 1, bytearray(data))
result = self.client.wait_as_completion(500)
self.assertEqual(0, response)
self.assertEqual(0, result)
self.assertEqual(data, self.client.ct_read(0, 1))
def test_as_db_fill(self) -> None:
filler = 31
expected = bytearray(filler.to_bytes(1, byteorder="big") * 100)
self.client.as_db_fill(1, filler)
self.client.wait_as_completion(500)
self.assertEqual(expected, self.client.db_read(1, 0, 100))
def test_as_db_get(self) -> None:
_buffer = typing_cast(Array[c_int], buffer_type())
self.client.as_db_get(db_number, _buffer, buffer_size)
self.client.wait_as_completion(500)
result = bytearray(_buffer)[:buffer_size]
self.assertEqual(buffer_size, len(result))
def test_as_db_read(self) -> None:
size = 40
start = 0
db = 1
expected = bytearray(40)
self.client.db_write(db_number=db, start=start, data=expected)
type_ = WordLen.Byte.ctype
data = (type_ * size)()
self.client.as_db_read(db, start, size, data)
self.client.wait_as_completion(500)
self.assertEqual(data, expected)
def test_as_db_write(self) -> None:
size = 40
data = bytearray(size)
type_ = WordLen.Byte.ctype
size = len(data)
result = (type_ * size).from_buffer_copy(data)
self.client.as_db_write(db_number=1, start=0, size=size, data=result)
self.client.wait_as_completion(500)
self.assertEqual(data, result)
def test_as_download(self) -> None:
"""Test async download to PLC."""
data = bytearray([0x55, 0x66, 0x77, 0x88])
result = self.client.as_download(block_num=db_number, data=data)
self.assertEqual(result, 0)
def test_plc_stop(self) -> None:
self.client.plc_stop()
def test_plc_hot_start(self) -> None:
self.client.plc_hot_start()
def test_plc_cold_start(self) -> None:
self.client.plc_cold_start()
def test_get_pdu_length(self) -> None:
pduRequested = self.client.get_param(Parameter.PDURequest)
pduSize = self.client.get_pdu_length()
self.assertEqual(pduSize, pduRequested)
def test_get_cpu_info(self) -> None:
expected = (
("ModuleTypeName", "CPU 315-2 PN/DP"),
("SerialNumber", "S C-C2UR28922012"),
("ASName", "SNAP7-SERVER"),
("Copyright", "Original Siemens Equipment"),
("ModuleName", "CPU 315-2 PN/DP"),
)
cpuInfo = self.client.get_cpu_info()
for param, value in expected:
self.assertEqual(getattr(cpuInfo, param).decode("utf-8"), value)
def test_db_write_with_byte_literal_does_not_throw(self) -> None:
data = b"\xde\xad\xbe\xef"
try:
self.client.db_write(db_number=1, start=0, data=bytearray(data))
except TypeError as e:
self.fail(str(e))
def test_get_plc_time(self) -> None:
self.assertAlmostEqual(datetime.now().replace(microsecond=0), self.client.get_plc_datetime(), delta=timedelta(seconds=1))
def test_set_plc_datetime(self) -> None:
new_dt = datetime(2011, 1, 1, 1, 1, 1, 0)
self.client.set_plc_datetime(new_dt)
# Can't actually set datetime in emulated PLC, get_plc_datetime always returns system time.
# self.assertEqual(new_dt, self.client.get_plc_datetime())
def test_wait_as_completion_pass(self, timeout: int = 1000) -> None:
# Cli_WaitAsCompletion
# prepare Server with values
area = Area.DB
dbnumber = 1
size = 1
start = 1
data = bytearray(size)
self.client.write_area(area, dbnumber, start, data)
# start as_request and test
wordlen, usrdata = _prepare_as_read_area(area, size)
self.client.as_read_area(area, dbnumber, start, size, wordlen, usrdata)
self.client.wait_as_completion(timeout)
self.assertEqual(bytearray(usrdata), data)
def test_wait_as_completion_timeout(self, timeout: int = 0, tries: int = 500) -> None:
# Cli_WaitAsCompletion
# prepare Server
area = Area.DB
dbnumber = 1
size = 1
start = 1
wordlen, data = _prepare_as_read_area(area, size)
self.client.write_area(area, dbnumber, start, bytearray(data))
# start as_request and wait for zero seconds to try trigger timeout
for i in range(tries):
self.client.as_read_area(area, dbnumber, start, size, wordlen, data)
res = None
try:
res = self.client.wait_as_completion(timeout)
check_error(res)
except RuntimeError as s7_err:
if not s7_err.args[0] == b"CLI : Job Timeout":
self.fail(f"While waiting another error appeared: {s7_err}")
# Wait for a thread to finish
time.sleep(0.1)
return
except BaseException:
self.fail(f"While waiting another error appeared:>>>>>>>> {res}")
self.fail(
f"After {tries} tries, no timout could be envoked by snap7. Either tests are passing to fast or"
f"a problem is existing in the method. Fail test."
)
def test_check_as_completion(self, timeout: int = 5) -> None:
# Cli_CheckAsCompletion
check_status = c_int(-1)
pending_checked = False
# preparing Server values
data = bytearray(b"\x01\xff")
size = len(data)
area = Area.DB
db = 1
start = 1
self.client.write_area(area, db, start, data)
# start as_request and test
wordlen, cdata = _prepare_as_read_area(area, size)
self.client.as_read_area(area, db, start, size, wordlen, cdata)
for _ in range(10):
self.client.check_as_completion(check_status)
if check_status.value == 0:
self.assertEqual(data, bytearray(cdata))
break
pending_checked = True
time.sleep(1)
else:
self.fail(f"TimeoutError - Process pends for more than {timeout} seconds")
if pending_checked is False:
logging.warning("Pending was never reached, because Server was to fast, but request to server was successfull.")
def test_as_read_area(self) -> None:
amount = 1
start = 1
# Test read_area with a DB
area = Area.DB
dbnumber = 1
data = bytearray(b"\x11")
self.client.write_area(area, dbnumber, start, data)
wordlen, usrdata = _prepare_as_read_area(area, amount)
self.client.as_read_area(area, dbnumber, start, amount, wordlen, usrdata)
self.client.wait_as_completion(1000)
self.assertEqual(bytearray(usrdata), data)
# Test read_area with a TM
area = Area.TM
dbnumber = 0
data = bytearray(b"\x12\x34")
self.client.write_area(area, dbnumber, start, data)
wordlen, usrdata = _prepare_as_read_area(area, amount)
self.client.as_read_area(area, dbnumber, start, amount, wordlen, usrdata)
self.client.wait_as_completion(1000)
self.assertEqual(bytearray(usrdata), data)
# Test read_area with a CT
area = Area.CT
dbnumber = 0
data = bytearray(b"\x13\x35")
self.client.write_area(area, dbnumber, start, data)
wordlen, usrdata = _prepare_as_read_area(area, amount)
self.client.as_read_area(area, dbnumber, start, amount, wordlen, usrdata)
self.client.wait_as_completion(1000)
self.assertEqual(bytearray(usrdata), data)
def test_as_write_area(self) -> None:
# Test write area with a DB
area = Area.DB
dbnumber = 1
size = 1
start = 1
data = bytearray(b"\x11")
wordlen, cdata = _prepare_as_write_area(area, data)
self.client.as_write_area(area, dbnumber, start, size, wordlen, cdata)
self.client.wait_as_completion(1000)
res = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(data, bytearray(res))
# Test write area with a TM
area = Area.TM
dbnumber = 0
size = 2
timer = bytearray(b"\x12\x00")
wordlen, cdata = _prepare_as_write_area(area, timer)
self.client.as_write_area(area, dbnumber, start, size, wordlen, cdata)
self.client.wait_as_completion(1000)
res2 = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(timer, bytearray(res2))
# Test write area with a CT
area = Area.CT
dbnumber = 0
size = 2
timer = bytearray(b"\x13\x00")
wordlen, cdata = _prepare_as_write_area(area, timer)
self.client.as_write_area(area, dbnumber, start, size, wordlen, cdata)
self.client.wait_as_completion(1000)
res3 = self.client.read_area(area, dbnumber, start, 1)
self.assertEqual(timer, bytearray(res3))
def test_as_eb_read(self) -> None:
# Cli_AsEBRead
type_ = WordLen.Byte.ctype
buffer = (type_ * 1)()
response = self.client.as_eb_read(0, 1, buffer)
self.assertEqual(0, response)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_eb_write(self) -> None:
# Cli_AsEBWrite
response = self.client.as_eb_write(0, 1, bytearray(b"\x00"))
self.assertEqual(0, response)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_full_upload(self) -> None:
# Cli_AsFullUpload
self.client.as_full_upload(Block.DB, 1)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_list_blocks_of_type(self) -> None:
data = typing_cast(Array[c_int], (c_uint16 * 10)())
self.client.as_list_blocks_of_type(Block.DB, data, 0)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_mb_read(self) -> None:
# Cli_AsMBRead
type_ = WordLen.Byte.ctype
data = (type_ * 1)()
self.client.as_mb_read(0, 1, data)
bytearray(data)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_mb_write(self) -> None:
# Cli_AsMBWrite
response = self.client.as_mb_write(0, 1, bytearray(b"\x00"))
self.assertEqual(0, response)
self.assertRaises(RuntimeError, self.client.wait_as_completion, 500)
def test_as_read_szl(self) -> None:
# Cli_AsReadSZL - uses real SZL protocol
ssl_id = 0x001C # CPU info
index = 0x0000
s7_szl = S7SZL()
self.client.as_read_szl(ssl_id, index, s7_szl, sizeof(s7_szl))
self.client.wait_as_completion(100)
# Should have valid data
self.assertTrue(s7_szl.Header.LengthDR > 0)
def test_as_read_szl_list(self) -> None:
# Cli_AsReadSZLList - uses real SZL protocol
szl_list = S7SZLList()
items_count = sizeof(szl_list)
self.client.as_read_szl_list(szl_list, items_count)
self.client.wait_as_completion(500)
# Should have some SZL IDs in the list
result = bytearray(szl_list.List)[:10]
self.assertTrue(len(result) >= 4) # At least 2 SZL IDs
def test_as_tm_read(self) -> None:
expected = b"\x10\x01"
self.client.tm_write(0, 1, bytearray(expected))
type_ = WordLen.Timer.ctype
buffer = (type_ * 1)()
self.client.as_tm_read(0, 1, buffer)
self.client.wait_as_completion(500)
self.assertEqual(expected, bytearray(buffer))
def test_as_tm_write(self) -> None:
data = b"\x10\x01"
response = self.client.as_tm_write(0, 1, bytearray(data))
result = self.client.wait_as_completion(500)
self.assertEqual(0, response)
self.assertEqual(0, result)
self.assertEqual(data, self.client.tm_read(0, 1))
def test_copy_ram_to_rom(self) -> None:
# Cli_CopyRamToRom
self.assertEqual(0, self.client.copy_ram_to_rom(timeout=2))
def test_ct_read(self) -> None:
# Cli_CTRead
data = b"\x10\x01"
self.client.ct_write(0, 1, bytearray(data))
result = self.client.ct_read(0, 1)
self.assertEqual(data, result)
def test_ct_write(self) -> None:
# Cli_CTWrite
data = b"\x01\x11"
self.assertEqual(0, self.client.ct_write(0, 1, bytearray(data)))
self.assertRaises(ValueError, self.client.ct_write, 0, 2, bytes(1))
def test_db_fill(self) -> None:
# Cli_DBFill
filler = 31
expected = bytearray(filler.to_bytes(1, byteorder="big") * 100)
self.client.db_fill(1, filler)
self.assertEqual(expected, self.client.db_read(1, 0, 100))
def test_eb_read(self) -> None:
# Cli_EBRead - reads process inputs (PE area)
response = self.client.eb_read(0, 1)
self.assertTrue(isinstance(response, bytearray))
self.assertEqual(1, len(response))
def test_eb_write(self) -> None:
# Cli_EBWrite - writes to process inputs (PE area)
response = self.client.eb_write(0, 1, bytearray(b"\x00"))
self.assertEqual(0, response)
def test_error_text(self) -> None:
# Cli_ErrorText
CPU_INVALID_PASSWORD = 0x01E00000
CPU_INVLID_VALUE = 0x00D00000
CANNOT_CHANGE_PARAM = 0x02600000
self.assertEqual("CPU : Invalid password", self.client.error_text(CPU_INVALID_PASSWORD))
self.assertEqual("CPU : Invalid value supplied", self.client.error_text(CPU_INVLID_VALUE))
self.assertEqual("CLI : Cannot change this param now", self.client.error_text(CANNOT_CHANGE_PARAM))
def test_get_cp_info(self) -> None:
# Cli_GetCpInfo - now uses real SZL protocol
result = self.client.get_cp_info()
# Server returns SZL 0x0131 data: MaxPdu=480, MaxConnections=32, etc.
self.assertEqual(480, result.MaxPduLength)
self.assertEqual(32, result.MaxConnections)
self.assertEqual(12, result.MaxMpiRate)
self.assertEqual(12, result.MaxBusRate)
def test_get_exec_time(self) -> None:
# Cli_GetExecTime
response = self.client.get_exec_time()
self.assertTrue(isinstance(response, int))
def test_get_last_error(self) -> None:
# Cli_GetLastError
self.assertEqual(0, self.client.get_last_error())
def test_get_order_code(self) -> None:
# Cli_GetOrderCode - uses real SZL protocol
result = self.client.get_order_code()
# Order code should contain the 6ES7 prefix
self.assertIn(b"6ES7", result.OrderCode)
def test_get_protection(self) -> None:
# Cli_GetProtection - now uses real SZL protocol
result = self.client.get_protection()
# Server returns SZL 0x0232 data: all fields indicate "no protection"
self.assertEqual(1, result.sch_schal) # No password required
self.assertEqual(0, result.sch_par)
self.assertEqual(0, result.sch_rel)
self.assertEqual(0, result.bart_sch)
self.assertEqual(0, result.anl_sch)
def test_get_pg_block_info(self) -> None:
valid_db_block = (
b"pp\x01\x01\x05\n\x00c\x00\x00\x00t\x00\x00\x00\x00\x01\x8d\xbe)2\xa1\x01"
b"\x85V\x1f2\xa1\x00*\x00\x00\x00\x00\x00\x02\x01\x0f\x05c\x00#\x00\x00\x00"
b"\x11\x04\x10\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01"
b"\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x01\x04\x00"
b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
b"\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
)
block_info = self.client.get_pg_block_info(bytearray(valid_db_block))
self.assertEqual(10, block_info.BlkType)
self.assertEqual(99, block_info.BlkNumber)
self.assertEqual(2752512, block_info.SBBLength)
self.assertEqual(
bytes((datetime(2019, 6, 27, tzinfo=timezone.utc).astimezone().strftime("%Y/%m/%d")), encoding="utf-8"),
block_info.CodeDate,
)
self.assertEqual(
bytes((datetime(2019, 6, 27, tzinfo=timezone.utc).astimezone().strftime("%Y/%m/%d")), encoding="utf-8"),
block_info.IntfDate,
)
def test_iso_exchange_buffer(self) -> None:
# Cli_IsoExchangeBuffer
self.client.db_write(1, 0, bytearray(b"\x11"))
# PDU read DB1 1.0 BYTE
data = b"\x32\x01\x00\x00\x01\x00\x00\x0e\x00\x00\x04\x01\x12\x0a\x10\x02\x00\x01\x00\x01\x84\x00\x00\x00"
# PDU response
expected = bytearray(b"2\x03\x00\x00\x01\x00\x00\x02\x00\x05\x00\x00\x04\x01\xff\x04\x00\x08\x11")
self.assertEqual(expected, self.client.iso_exchange_buffer(bytearray(data)))
def test_mb_read(self) -> None:
# Cli_MBRead - reads marker area (MK)
response = self.client.mb_read(0, 10)
self.assertTrue(isinstance(response, bytearray))
self.assertEqual(10, len(response))
def test_mb_write(self) -> None:
# Cli_MBWrite - writes to marker area (MK)
response = self.client.mb_write(0, 1, bytearray(b"\x00"))
self.assertEqual(0, response)
def test_read_szl(self) -> None:
# Test read_szl with real protocol - server returns SZL 0x001C (CPU info)
ssl_id = 0x001C
response = self.client.read_szl(ssl_id)
# S7SZLHeader only has LengthDR and NDR fields
self.assertEqual(1, response.Header.NDR) # Server returns 1 record
self.assertTrue(response.Header.LengthDR > 0) # Has data
# Data should contain CPU info string
cpu_data = bytes(response.Data[:32]).rstrip(b"\x00")
self.assertIn(b"CPU", cpu_data)
# Test reading SZL 0x0011 (order code)
ssl_id = 0x0011
response = self.client.read_szl(ssl_id)
# Order code should be in the data
order_code = bytes(response.Data[:20]).rstrip(b"\x00")
self.assertIn(b"6ES7", order_code)
# read_szl_invalid_id - should raise error
ssl_id = 0xFFFF
index = 0xFFFF
self.assertRaises(RuntimeError, self.client.read_szl, ssl_id)
self.assertRaises(RuntimeError, self.client.read_szl, ssl_id, index)
def test_read_szl_list(self) -> None:
# Cli_ReadSZLList - returns list of available SZL IDs
result = self.client.read_szl_list()
# Should contain some SZL IDs (server returns 0x0000, 0x0011, 0x001C, 0x0131, 0x0232)
self.assertTrue(len(result) >= 4) # At least 2 SZL IDs (2 bytes each)
def test_set_plc_system_datetime(self) -> None:
# Cli_SetPlcSystemDateTime
self.assertEqual(0, self.client.set_plc_system_datetime())
def test_tm_read(self) -> None:
# Cli_TMRead
data = b"\x10\x01"
self.client.tm_write(0, 1, bytearray(data))
result = self.client.tm_read(0, 1)
self.assertEqual(data, result)
def test_tm_write(self) -> None:
# Cli_TMWrite
data = b"\x10\x01"
self.assertEqual(0, self.client.tm_write(0, 1, bytearray(data)))
self.assertEqual(data, self.client.tm_read(0, 1))
self.assertRaises(RuntimeError, self.client.tm_write, 0, 100, bytes(200))
self.assertRaises(ValueError, self.client.tm_write, 0, 2, bytes(2))
def test_write_multi_vars(self) -> None:
# Cli_WriteMultiVars
items_count = 3
items = []
areas = [Area.DB, Area.CT, Area.TM]
expected_list = []
for i in range(items_count):
item = S7DataItem()
item.Area = c_int32(areas[i].value)
wordlen = WordLen.Byte
item.WordLen = c_int32(wordlen.value)
item.DBNumber = c_int32(1)
item.Start = c_int32(0)
item.Amount = c_int32(4)
data = (i + 1).to_bytes(1, byteorder="big") * 4
array_class = c_uint8 * len(data)
cdata = array_class.from_buffer_copy(data)
item.pData = cast(cdata, POINTER(array_class)).contents
items.append(item)
expected_list.append(data)
result = self.client.write_multi_vars(items)
self.assertEqual(0, result)
self.assertEqual(expected_list[0], self.client.db_read(db_number=1, start=0, size=4))
self.assertEqual(expected_list[1], self.client.ct_read(0, 2))
self.assertEqual(expected_list[2], self.client.tm_read(0, 2))
def test_set_as_callback(self) -> None:
def event_call_back(op_code: int, op_result: int) -> None:
logging.info(f"callback event: {op_code} op_result: {op_result}")
self.client.set_as_callback(event_call_back)
def test_context_manager(self) -> None:
"""Test client as context manager."""
with Client() as client:
client.connect(ip, rack, slot, tcpport)
self.assertTrue(client.get_connected())
data = client.db_read(1, 0, 4)
self.assertEqual(len(data), 4)
# Should be disconnected after context exit
self.assertFalse(client.get_connected())
@pytest.mark.client
class TestReadMultiVarsOptimized(unittest.TestCase):
"""Integration tests verifying read_multi_vars uses the optimization pipeline."""
server: Server = None # type: ignore
@classmethod
def setUpClass(cls) -> None:
cls.server = Server()
db1_data = bytearray(range(256)) * 3
cls.server.register_area(SrvArea.DB, 1, db1_data[:600])
db2_data = bytearray(b"\xaa\xbb\xcc\xdd" * 150)
cls.server.register_area(SrvArea.DB, 2, db2_data[:600])
mk_data = bytearray(b"\x11\x22\x33\x44" * 25)
cls.server.register_area(SrvArea.MK, 0, mk_data[:100])
cls.server.register_area(SrvArea.CT, 0, bytearray(100))
cls.server.register_area(SrvArea.TM, 0, bytearray(100))
cls.server.start(tcp_port=tcpport + 1)
@classmethod
def tearDownClass(cls) -> None:
if cls.server:
cls.server.stop()
cls.server.destroy()
def setUp(self) -> None:
self.client = Client()
self.client.connect(ip, rack, slot, tcpport + 1)
def tearDown(self) -> None:
self.client.disconnect()
self.client.destroy()
def test_single_item(self) -> None:
"""Single-item read_multi_vars should match db_read."""
expected = self.client.db_read(1, 0, 4)
_, results = self.client.read_multi_vars(
[
{"area": Area.DB, "db_number": 1, "start": 0, "size": 4},
]
)
self.assertEqual(len(results), 1)
self.assertEqual(results[0], expected)
def test_multiple_same_db(self) -> None:
"""Multiple items from the same DB."""
items = [
{"area": Area.DB, "db_number": 1, "start": 0, "size": 4},
{"area": Area.DB, "db_number": 1, "start": 10, "size": 8},
{"area": Area.DB, "db_number": 1, "start": 100, "size": 4},
]
_, results = self.client.read_multi_vars(items)
self.assertEqual(len(results), 3)
self.assertEqual(results[0], self.client.db_read(1, 0, 4))
self.assertEqual(results[1], self.client.db_read(1, 10, 8))
self.assertEqual(results[2], self.client.db_read(1, 100, 4))
def test_multiple_dbs(self) -> None:
"""Items across different DBs."""
items = [
{"area": Area.DB, "db_number": 1, "start": 0, "size": 4},
{"area": Area.DB, "db_number": 2, "start": 0, "size": 4},