forked from auto-pts/auto-pts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
autoptsclient_common.py
executable file
·1458 lines (1089 loc) · 47.4 KB
/
autoptsclient_common.py
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
#!/usr/bin/env python
#
# auto-pts - The Bluetooth PTS Automation Framework
#
# Copyright (c) 2017, Intel Corporation.
#
# This program is free software; you can redistribute it and/or modify it
# under the terms and conditions of the GNU General Public License,
# version 2, as published by the Free Software Foundation.
#
# This program is distributed in the hope it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
"""Common code for the auto PTS clients"""
import argparse
import datetime
import errno
import importlib
import logging
import os
import queue
import random
import signal
import socket
import subprocess
import sys
import tempfile
import threading
import time
import traceback
import xml.etree.ElementTree as ElementTree
import xmlrpc.client
from distutils.spawn import find_executable
from xmlrpc.server import SimpleXMLRPCServer
import _locale
from termcolor import colored
import ptsprojects.ptstypes as ptstypes
from config import SERVER_PORT, CLIENT_PORT
from ptsprojects import stack
from ptsprojects.boards import com_to_tty, get_available_boards, tty_exists
from ptsprojects.testcase import PTSCallback, TestCaseLT1, TestCaseLT2
from ptsprojects.testcase_db import TestCaseTable, DATABASE_FILE
from pybtp import btp
from pybtp.types import BTPError, SynchError
from utils import InterruptableThread
from winutils import have_admin_rights
log = logging.debug
RUNNING_TEST_CASE = {}
TEST_CASE_DB = None
autoprojects = None
# The number of seconds to wait for autoptsserver restart.
# - during normal recovery:
MIN_SERVER_RESTART_TIME = 40
# - during recovery of recovery
MAX_SERVER_RESTART_TIME = 60
# To test autopts client locally:
# Envrinment variable AUTO_PTS_LOCAL must be set for FakeProxy to
# be used. When FakeProxy is used autoptsserver on Windows will
# not be contacted.
AUTO_PTS_LOCAL = "AUTO_PTS_LOCAL" in os.environ
RUN_END = False
class RunEnd(KeyboardInterrupt):
pass
class PtsServerProxy(xmlrpc.client.ServerProxy):
def __init__(self, uri, transport=None, encoding=None, verbose=False,
allow_none=False, use_datetime=False, use_builtin_types=False,
*, headers=(), context=None):
super().__init__(uri, transport, encoding, verbose, allow_none, use_datetime,
use_builtin_types, headers=headers, context=context)
def __getattr__(self, name):
if RUN_END:
raise RunEnd
return super().__getattr__(name)
class ClientCallback(PTSCallback):
def __init__(self):
super().__init__()
self.exception = queue.Queue()
self._pending_responses = {}
def error_code(self):
"""Return error code or None if there are no errors
Used by the main thread to get the errors happened in the callback
thread
"""
error_code = None
try:
exc = self.exception.get_nowait()
except queue.Empty:
pass
else:
error_code = get_error_code(exc)
log("Error %r from the callback thread", error_code)
self.exception.task_done()
return error_code
def log(self, log_type, logtype_string, log_time, log_message,
test_case_name):
"""Implements:
interface IPTSControlClientLogger : IUnknown {
HRESULT _stdcall Log(
[in] _PTS_LOGTYPE logType,
[in] LPWSTR szLogType,
[in] LPWSTR szTime,
[in] LPWSTR pszMessage);
};
test_case_name - To be identified by client in case of multiple pts
usage.
"""
logger = logging.getLogger("{}.{}".format(self.__class__.__name__,
self.log.__name__))
logger.info("%s %s %s %s %s", ptstypes.PTS_LOGTYPE_STRING[log_type],
logtype_string, log_time, test_case_name,
log_message)
try:
if test_case_name in RUNNING_TEST_CASE:
RUNNING_TEST_CASE[test_case_name].log(log_type, logtype_string,
log_time, log_message, test_case_name)
except Exception as e:
logging.exception(e)
self.exception.put(sys.exc_info()[1])
# exit does not work, cause app is blocked in PTS.RunTestCase?
sys.exit("Exception in Log")
def on_implicit_send(self, project_name, wid, test_case_name, description,
style):
"""Implements:
interface IPTSImplicitSendCallbackEx : IUnknown {
HRESULT _stdcall OnImplicitSend(
[in] LPWSTR pszProjectName,
[in] unsigned short wID,
[in] LPWSTR pszTestCase,
[in] LPWSTR pszDescription,
[in] unsigned long style,
[in, out] LPWSTR pszResponse,
[in] unsigned long responseSize,
[in, out] long* pbResponseIsPresent);
};
"""
logger = logging.getLogger("{}.{}".format(
self.__class__.__name__, self.on_implicit_send.__name__))
logger.info("*" * 20)
logger.info("BEGIN OnImplicitSend:")
logger.info("project_name: %s", project_name)
logger.info("wid: %s", wid)
logger.info("test_case_name: %s", test_case_name)
logger.info("description: %s", description)
logger.info("style: %s 0x%x", ptstypes.MMI_STYLE_STRING[style], style)
try:
# XXX: 361 WID MESH sends tc name with leading white spaces
test_case_name = test_case_name.lstrip()
logger.info("Calling test cases on_implicit_send")
testcase_response = RUNNING_TEST_CASE[test_case_name].on_implicit_send(project_name, wid, test_case_name,
description, style)
logger.info("test case returned on_implicit_send, response: %s",
testcase_response)
except Exception as e:
logging.exception("OnImplicitSend caught exception %s", e)
self.exception.put(sys.exc_info()[1])
# exit does not work, cause app is blocked in PTS.RunTestCase?
sys.exit("Exception in OnImplicitSend")
logger.info("END OnImplicitSend:")
logger.info("*" * 20)
return testcase_response
def get_pending_response(self, test_case_name):
log("%s.%s, %s", self.__class__.__name__,
self.get_pending_response.__name__, test_case_name)
if not self._pending_responses:
return None
rsp = self._pending_responses.pop(test_case_name, None)
if not rsp:
return rsp
if rsp["delay"]:
time.sleep(rsp["delay"])
return rsp["value"]
def set_pending_response(self, pending_response):
tc_name = pending_response[0]
response = pending_response[1]
delay = pending_response[2]
self._pending_responses[tc_name] = {"value": response, "delay": delay}
def clear_pending_responses(self):
self._pending_responses = {}
def cleanup(self):
self.clear_pending_responses()
while not self.exception.empty():
self.exception.get_nowait()
self.exception.task_done()
class CallbackThread(threading.Thread):
"""Thread for XML-RPC callback server
To prevent SimpleXMLRPCServer blocking whole app it is started in a thread
"""
def __init__(self, port):
log("%s.%s port=%r", self.__class__.__name__, self.__init__.__name__, port)
super().__init__()
self.server = None
self.callback = ClientCallback()
self.port = port
self.current_test_case = None
self.end = False
def run(self):
"""Starts the xmlrpc callback server"""
log("%s.%s", self.__class__.__name__, self.run.__name__)
log("Serving on port %s ...", self.port)
self.server = SimpleXMLRPCServer(("", self.port),
allow_none=True, logRequests=False)
self.server.register_instance(self.callback)
self.server.register_introspection_functions()
self.server.timeout = 1.0
while not self.end:
self.server.handle_request()
self.server.server_close()
def stop(self):
self.end = True
def set_current_test_case(self, name):
log("%s.%s %s", self.__class__.__name__, self.set_current_test_case.__name__, name)
self.current_test_case = name
def get_current_test_case(self):
log("%s.%s %s", self.__class__.__name__, self.get_current_test_case.__name__, self.current_test_case)
return self.current_test_case
def error_code(self):
log("%s.%s", self.__class__.__name__, self.error_code.__name__)
return self.callback.error_code()
def set_pending_response(self, pending_response):
log("%s.%s, %r", self.__class__.__name__,
self.set_pending_response.__name__, pending_response)
return self.callback.set_pending_response(pending_response)
def clear_pending_responses(self):
log("%s.%s", self.__class__.__name__,
self.clear_pending_responses.__name__)
return self.callback.clear_pending_responses()
def cleanup(self):
log("%s.%s", self.__class__.__name__, self.cleanup.__name__)
return self.callback.cleanup()
def get_my_ip_address():
"""Returns the IP address of the host"""
if get_my_ip_address.cached_address:
return get_my_ip_address.cached_address
my_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
my_socket.connect(('8.8.8.8', 0)) # udp connection to google public dns
my_ip_address = my_socket.getsockname()[0]
get_my_ip_address.cached_address = my_ip_address
return my_ip_address
def get_unique_name(pts):
name = 'Tester'
# get address of PTS dongle IUT is connecting to
pts_addr = pts.q_bd_addr.replace(":", "")
# use last 6 characters of PTS dongle adress
name += "_" + pts_addr[6:12]
return name.encode('utf-8')
get_my_ip_address.cached_address = None
def init_logging(tag=""):
"""Initialize logging"""
script_name = os.path.basename(sys.argv[0]) # in case it is full path
script_name_no_ext = os.path.splitext(script_name)[0]
log_filename = "%s%s.log" % (script_name_no_ext, tag)
format_template = ("%(asctime)s %(threadName)s %(name)s %(levelname)s %(filename)-25s "
"%(lineno)-5s %(funcName)-25s : %(message)s")
logging.basicConfig(format=format_template,
filename=log_filename,
filemode='w',
level=logging.DEBUG)
class FakeProxy:
"""Fake PTS XML-RPC proxy client.
Usefull when testing code locally and auto-pts server is not needed"""
class System:
def listMethods(self):
pass
def __init__(self):
self.system = FakeProxy.System()
def restart_pts(self):
pass
def set_call_timeout(self, timeout):
pass
def get_version(self):
return 0x65
def bd_addr(self):
return "00:01:02:03:04:05"
def register_xmlrpc_ptscallback(self, client_address, client_port):
pass
def unregister_xmlrpc_ptscallback(self):
pass
def open_workspace(self, workspace_path):
pass
def enable_maximum_logging(self, enable):
pass
def update_pixit_param(self, project_name, param_name, new_param_value):
pass
def run_test_case(self, project_name, test_case_name):
pass
def init_pts_thread_entry_wrapper(func):
def wrapper(*args):
exeptions = args[6]
try:
func(*args)
except Exception as exc:
logging.exception(exc)
exeptions.put(exc)
return wrapper
@init_pts_thread_entry_wrapper
def init_pts_thread_entry(proxy, local_address, local_port, workspace_path,
bd_addr, enable_max_logs, exceptions):
"""PTS instance initialization thread function entry"""
sys.stdout.flush()
proxy.restart_pts()
print("(%r) OK" % (id(proxy),))
proxy.callback_thread.start()
proxy.set_call_timeout(300000) # milliseconds
log("Server methods: %s", proxy.system.listMethods())
log("PTS Version: %s", proxy.get_version())
# cache locally for quick access (avoid contacting server)
proxy.q_bd_addr = proxy.bd_addr()
log("PTS BD_ADDR: %s", proxy.q_bd_addr)
client_ip_address = local_address
if client_ip_address is None:
client_ip_address = get_my_ip_address()
log("Client IP Address: %s", client_ip_address)
proxy.register_xmlrpc_ptscallback(client_ip_address, local_port)
log("Opening workspace: %s", workspace_path)
proxy.open_workspace(workspace_path)
if bd_addr:
projects = proxy.get_project_list()
for project_name in projects:
log("Set bd_addr PIXIT: %s for project: %s", bd_addr, project_name)
proxy.update_pixit_param(project_name, "TSPX_bd_addr_iut", bd_addr)
proxy.enable_maximum_logging(enable_max_logs)
def init_pts(args, ptses, tc_db_table_name=None):
"""Initialization procedure for PTS instances"""
proxy_list = ptses
thread_list = []
exceptions = queue.Queue()
i = 0
init_logging('_' + '_'.join(str(x) for x in args.cli_port))
for server_addr, local_addr, server_port, local_port \
in zip(args.ip_addr, args.local_addr, args.srv_port, args.cli_port):
if i < len(proxy_list):
proxy = proxy_list[i]
if isinstance(proxy.callback_thread, CallbackThread):
proxy.callback_thread.stop()
else:
if AUTO_PTS_LOCAL:
proxy = FakeProxy()
else:
proxy = PtsServerProxy(
"http://{}:{}/".format(server_addr, server_port),
allow_none=True, )
proxy_list.append(proxy)
proxy.callback_thread = CallbackThread(local_port)
print("(%r) Starting PTS %s:%s ..." % (id(proxy), server_addr, server_port))
thread = threading.Thread(target=init_pts_thread_entry,
args=(proxy, local_addr, local_port, args.workspace,
args.bd_addr, args.enable_max_logs, exceptions))
thread_list.append(thread)
thread.start()
i += 1
if tc_db_table_name:
global TEST_CASE_DB
TEST_CASE_DB = TestCaseTable(tc_db_table_name, args.database_file)
for index, thread in enumerate(thread_list):
thread.join(timeout=180.0)
# check init completed
if thread.is_alive():
raise Exception("(%r) init failed" % (id(proxy_list[index]),))
exeption_msg = ''
while not exceptions.empty():
try:
exeption_msg += str(exceptions.get_nowait()) + '\n'
except queue.Empty:
break
if exeption_msg:
raise Exception(exeption_msg)
return proxy_list
def shutdown_pts(ptses):
for pts in ptses:
proxy = xmlrpc.client.ServerProxy(
'http://%s/' % pts.__getattribute__('_ServerProxy__host'),
allow_none=True)
proxy.unregister_xmlrpc_ptscallback()
if isinstance(pts.callback_thread, CallbackThread):
pts.callback_thread.stop()
def get_result_color(status):
if status == "PASS":
return "green"
if status == "FAIL":
return "red"
if status == "INCONC":
return "yellow"
return "white"
class TestCaseRunStats:
def __init__(self, projects, test_cases, retry_count, db=None):
self.run_count_max = retry_count + 1 # Run test at least once
self.run_count = 0 # Run count of current test case
self.num_test_cases = len(test_cases)
self.num_test_cases_width = len(str(self.num_test_cases))
self.max_project_name = len(max(projects, key=len)) if projects else 0
self.max_test_case_name = len(max(test_cases, key=len)) if test_cases else 0
self.margin = 3
self.index = 0
self.xml_results = tempfile.NamedTemporaryFile(delete=False).name
root = ElementTree.Element("results")
tree = ElementTree.ElementTree(root)
tree.write(self.xml_results)
self.db = db
if self.db:
self.est_duration = db.estimate_session_duration(test_cases,
self.run_count_max)
if self.est_duration:
approx = str(datetime.timedelta(seconds=self.est_duration))
print("Number of test cases to run: ", self.num_test_cases, " in approximately: ", approx)
else:
self.est_duration = 0
def update(self, test_case_name, duration, status):
tree = ElementTree.parse(self.xml_results)
root = tree.getroot()
elem = root.find("./test_case[@name='%s']" % test_case_name)
if elem is None:
elem = ElementTree.SubElement(root, 'test_case')
status_previous = None
if self.db:
status_previous = self.db.get_result(test_case_name)
elem.attrib["project"] = test_case_name.split('/')[0]
elem.attrib["name"] = test_case_name
elem.attrib["duration"] = str(duration)
elem.attrib["status"] = ""
elem.attrib["status_previous"] = str(status_previous)
run_count = 0
else:
run_count = int(elem.attrib["run_count"])
elem.attrib["status"] = status
regression = bool(elem.attrib["status"] != "PASS" and elem.attrib["status_previous"] == "PASS")
progress = bool(elem.attrib["status"] == "PASS" and elem.attrib["status_previous"] != "PASS" \
and elem.attrib["status_previous"] != "None")
elem.attrib["regression"] = str(regression)
elem.attrib["progress"] = str(progress)
elem.attrib["run_count"] = str(run_count + 1)
tree.write(self.xml_results)
return regression, progress
def get_results(self):
tree = ElementTree.parse(self.xml_results)
root = tree.getroot()
results = {}
for tc_xml in root.findall("./test_case"):
results[tc_xml.attrib["name"]] = \
(tc_xml.attrib["status"], tc_xml.attrib["run_count"])
return results
def get_regressions(self):
tree = ElementTree.parse(self.xml_results)
root = tree.getroot()
tcs_xml = root.findall("./test_case[@regression='True']")
return [tc_xml.attrib["name"] for tc_xml in tcs_xml]
def get_progresses(self):
tree = ElementTree.parse(self.xml_results)
root = tree.getroot()
tcs_xml = root.findall("./test_case[@progress='True']")
return [tc_xml.attrib["name"] for tc_xml in tcs_xml]
def get_status_count(self):
tree = ElementTree.parse(self.xml_results)
root = tree.getroot()
status_dict = {}
for test_case_xml in root.findall("./test_case"):
if test_case_xml.attrib["status"] not in status_dict:
status_dict[test_case_xml.attrib["status"]] = 0
status_dict[test_case_xml.attrib["status"]] += 1
return status_dict
def print_summary(self):
"""Prints test case list status summary"""
print("\nSummary:\n")
content = [['Status', 'Count'], '=']
status_count = self.get_status_count()
for status, count in list(status_count.items()):
content.append([status, str(count)])
content.append(['='])
content.append(['Total', str(self.num_test_cases)])
regressions = len(self.get_regressions())
if regressions != 0:
content.append(['='])
content.append(['Regressions', str(regressions)])
progresses = len(self.get_progresses())
if regressions != 0:
if (content[len(content) - 1]) != 1:
content.append(['='])
content.append(['Progresses', str(progresses)])
max_len = 0
for line in content:
if len(line) == 2:
max_len = max(max_len, len(' '.join(line)))
for line in content:
if len(line) == 1:
print(line[0] * max_len)
elif len(line) == 2:
spaces = ' ' * (max_len - len(line[0]) - len(line[1]))
print('{}{}{}'.format(line[0], spaces, line[1]))
def run_test_case_wrapper(func):
def wrapper(*args):
test_case_name = args[2]
stats = args[3]
run_count_max = stats.run_count_max
run_count = stats.run_count
num_test_cases = stats.num_test_cases
num_test_cases_width = stats.num_test_cases_width
max_project_name = stats.max_project_name
max_test_case_name = stats.max_test_case_name
margin = stats.margin
index = stats.index
print((str(index + 1).rjust(num_test_cases_width) +
"/" +
str(num_test_cases).ljust(num_test_cases_width + margin) +
test_case_name.split('/')[0].ljust(max_project_name + margin) +
test_case_name.ljust(max_test_case_name + margin - 1)), end=' ')
sys.stdout.flush()
start_time = time.time()
status = func(*args)
end_time = time.time() - start_time
regression, progress = stats.update(test_case_name, end_time, status)
retries_max = run_count_max - 1
if run_count:
retries_msg = "#{}".format(run_count)
else:
retries_msg = ""
if regression and run_count == retries_max:
regression_msg = "REGRESSION"
elif progress:
regression_msg = "PROGRESS"
else:
regression_msg = ""
end_time_str = str(round(datetime.timedelta(
seconds=end_time).total_seconds(), 3))
result = ("{}".format(status).ljust(16) +
end_time_str.rjust(len(end_time_str)) +
retries_msg.rjust(len("#{}".format(retries_max)) + margin) +
regression_msg.rjust(len("REGRESSION") + margin))
if sys.stdout.isatty():
output_color = get_result_color(status)
print(colored(result, output_color))
else:
print(result)
return status, end_time
return wrapper
def get_error_code(exc):
"""Return string error code for argument exception"""
error_code = None
if isinstance(exc, BTPError):
error_code = ptstypes.E_BTP_ERROR
elif isinstance(exc, socket.timeout):
error_code = ptstypes.E_BTP_TIMEOUT
elif isinstance(exc, xmlrpc.client.Fault):
error_code = ptstypes.E_XML_RPC_ERROR
elif error_code is None:
error_code = ptstypes.E_FATAL_ERROR
log("%s returning error code %r for exception %r",
get_error_code.__name__, error_code, exc)
return error_code
def synchronize_instances(state, break_state=None):
"""Synchronize instances to be in one state before executing further"""
while True:
time.sleep(1)
match = True
for tc in RUNNING_TEST_CASE.values():
if tc.state != state:
if break_state and tc.state in break_state:
raise SynchError
match = False
continue
if match:
return
def run_test_case_thread_entry_wrapper(func):
def wrapper(*args):
exeptions = args[2]
try:
func(*args)
except Exception as exc:
logging.exception(exc)
exeptions.put(exc)
return wrapper
@run_test_case_thread_entry_wrapper
def run_test_case_thread_entry(pts, test_case, exceptions):
"""Runs the test case specified by a TestCase instance.
[1] xmlrpclib.Fault normally happens due to unhandled exception in the
autoptsserver on Windows
"""
log("Starting TestCase %s %s", run_test_case_thread_entry.__name__,
test_case)
if AUTO_PTS_LOCAL: # set fake status and return
statuses = ["PASS", "INCONC", "FAIL", "UNKNOWN VERDICT: NONE",
"BTP ERROR", "XML-RPC ERROR", "BTP TIMEOUT"]
test_case.status = random.choice(statuses)
return
error_code = None
try:
RUNNING_TEST_CASE[test_case.name] = test_case
test_case.state = "PRE_RUN"
test_case.pre_run()
test_case.status = "RUNNING"
test_case.state = "RUNNING"
pts.callback_thread.set_current_test_case(test_case.name)
synchronize_instances(test_case.state)
error_code = pts.run_test_case(test_case.project_name, test_case.name)
log("After run_test_case error_code=%r status=%r",
error_code, test_case.status)
# raise exception discovered by thread
thread_error = pts.callback_thread.error_code()
pts.callback_thread.cleanup()
if thread_error:
error_code = thread_error
except Exception as error:
logging.exception(error)
error_code = get_error_code(error)
except BaseException as ex:
logging.exception(ex)
error_code = get_error_code(None)
finally:
try:
if error_code == ptstypes.E_XML_RPC_ERROR:
pts.recover_pts()
except Exception as error:
logging.exception(error)
exceptions.put(error)
test_case.state = "FINISHING"
synchronize_instances(test_case.state)
test_case.post_run(error_code) # stop qemu and other commands
del RUNNING_TEST_CASE[test_case.name]
log("Done TestCase %s %s", run_test_case_thread_entry.__name__,
test_case)
def run_test_case_thread_fun(results, ptses, test_case_instances, test_case_name, stats,
session_log_dir, exceptions):
status, duration = run_test_case(ptses, test_case_instances, test_case_name, stats,
session_log_dir, exceptions)
results.append(status)
results.append(duration)
@run_test_case_wrapper
def run_test_case(ptses, test_case_instances, test_case_name, stats,
session_log_dir, exceptions):
def test_case_lookup_name(name, test_case_class):
"""Return 'test_case_class' instance if found or None otherwise"""
if test_case_instances is None:
return None
for tc in test_case_instances:
if tc.name == name and isinstance(tc, test_case_class):
return tc
return None
logger = logging.getLogger()
format_template = ("%(asctime)s %(name)s %(levelname)s %(filename)-25s "
"%(lineno)-5s %(funcName)-25s : %(message)s")
formatter = logging.Formatter(format_template)
# Lookup TestCase class instance
test_case_lt1 = test_case_lookup_name(test_case_name, TestCaseLT1)
if test_case_lt1 is None:
# FIXME
return 'NOT_IMPLEMENTED'
test_case_lt1.reset()
test_case_lt1.initialize_logging(session_log_dir)
file_handler = logging.FileHandler(test_case_lt1.log_filename)
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)
if test_case_lt1.name_lt2:
if len(ptses) < 2:
return 'LT2_NOT_AVAILABLE'
test_case_lt2 = test_case_lookup_name(test_case_lt1.name_lt2,
TestCaseLT2)
if test_case_lt2 is None:
# FIXME
return 'NOT_IMPLEMENTED'
else:
test_case_lt2 = None
while True:
# Multiple PTS instances test cases may fill status already
if test_case_lt1.status != 'init':
continue
# Multi-instance related stuff
pts_threads = []
pts_thread = threading.Thread(
target=run_test_case_thread_entry,
args=(ptses[0], test_case_lt1, exceptions))
pts_threads.append(pts_thread)
pts_thread.start()
if test_case_lt2:
pts_thread = threading.Thread(
target=run_test_case_thread_entry,
args=(ptses[1], test_case_lt2, exceptions))
pts_threads.append(pts_thread)
pts_thread.start()
# Wait till every PTS instance finish executing test case
for pts_thread in pts_threads:
pts_thread.join()
logger.removeHandler(file_handler)
if test_case_lt2 and test_case_lt2.status != "PASS" \
and test_case_lt1.status == "PASS":
return test_case_lt2.status
return test_case_lt1.status
test_case_blacklist = [
"_HELPER",
"-LT2",
"TWO_NODES_PROVISIONER",
]
def get_test_cases(pts, test_cases, included, excluded):
"""
param: pts: proxy to initiated pts instance
param: test_cases: names (or prefixes) of test cases to run in
current configuration
param: included: test cases specified with -c option
param: excluded: test cases specified with -e option
"""
def run_or_not(test_case_name):
for entry in test_case_blacklist:
if entry in test_case_name:
return False
if excluded:
for n in excluded:
if test_case_name.startswith(n):
return False
if test_cases:
for n in test_cases:
if test_case_name.startswith(n):
return True
return False
if len(included) > 0:
_included = []
for inc in included:
for tc in test_cases:
if tc.startswith(inc):
_included.append(tc)
elif inc.startswith(tc):
_included.append(inc)
test_cases = _included
projects = pts.get_project_list()
_test_cases = []
for project in projects:
_test_case_list = pts.get_test_case_list(project)
_test_cases += [tc for tc in _test_case_list if run_or_not(tc)]
return _test_cases
def run_test_cases(ptses, test_case_instances, args):
"""Runs a list of test cases"""
ports_str = '_'.join(str(x) for x in args.cli_port)
now = datetime.datetime.now().strftime("%Y_%m_%d_%H_%M_%S")
session_log_dir = 'logs/cli_port_' + ports_str + '/' + now
try:
os.makedirs(session_log_dir)
except OSError as e:
if e.errno != errno.EEXIST:
raise
test_cases = args.test_cases
projects = ptses[0].get_project_list()
# Statistics
stats = TestCaseRunStats(projects, test_cases, args.retry, TEST_CASE_DB)
exceptions = queue.Queue()
for test_case in test_cases:
stats.run_count = 0
while True: