-
Notifications
You must be signed in to change notification settings - Fork 6
/
objects.py
993 lines (801 loc) · 28.8 KB
/
objects.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
# Copyright 2019 Katteli Inc.
# TestFlows.com Open-Source Software Testing Framework (http://testflows.com)
#
# 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.
import re
import base64
import hashlib
import threading
import testflows.settings as settings
from collections import namedtuple
from .utils.enum import IntEnum
from .exceptions import SpecificationError, RequirementError, ResultException
from .baseobject import TestObject, Table
from .baseobject import get, hash
from .testtype import TestType
import testflows._core.contrib.rsa as rsa
class Result(TestObject, ResultException):
_fields = ("message", "reason", "type", "test")
_defaults = (None,) * 6
metrics = []
tickets = []
values = []
type = None
class Type(IntEnum):
OK = 1
Fail = 2
Error = 3
Null = 4
Skip = 5
XOK = 6
XFail = 7
XError = 8
XNull = 9
def __repr__(self):
return f"Result.Type.{self._name_}"
def __init__(self, message=None, reason=None, type=None, test=None, metrics=None, tickets=None, values=None, start_time=None, test_time=None):
from .funcs import current
self.test = test if test is not None else current().name
if not isinstance(self.test, str):
raise TypeError("test must be of 'str' type")
self.type = get(type, self.type)
if self.type is None:
raise TypeError("type must be defined")
self.message = message
self.reason = reason
self.metrics = get(metrics, list(self.metrics))
self.tickets = get(tickets, list(self.tickets))
self.values = get(values, list(self.values))
self.start_time = start_time
self.test_time = test_time
return super(Result, self).__init__()
def __reduce__(self):
return (self.__class__, (self.message, self.reason, self.type, self.test, self.metrics, self.tickets, self.values, self.start_time, self.test_time))
@property
def value(self):
return self.values[-1].value if self.values else None
def __call__(self, result=None):
if result is None:
result = getattr(self.__module__, str(self.type))
obj = result.__class__(*[getattr(result, field) for field in result._fields])
obj.metrics = self.metrics
obj.tickets = self.tickets
obj.values = self.values
obj.start_time = self.start_time
obj.test_time = self.test_time
return obj
def xout(self, reason=None):
if type(self) in [Result, XResult]:
return self().xout(reason=reason)
return self
def __str__(self):
return str(self.type)
def __bool__(cls):
return True
def __eq__(self, o):
return self.type == o.type
def __ne__(self, o):
return not self == o
class XResult(Result):
pass
class OK(Result):
type = Result.Type.OK
def xout(self, reason):
return self(XOK(test=self.test, message=self.message, reason=reason))
class XOK(XResult):
type = Result.Type.XOK
class Fail(Result):
type = Result.Type.Fail
def xout(self, reason):
return self(XFail(test=self.test, message=self.message, reason=reason))
def __bool__(self):
return False
class XFail(XResult):
type = Result.Type.XFail
class Skip(Result):
type = Result.Type.Skip
class Error(Result):
type = Result.Type.Error
def xout(self, reason):
return self(XError(test=self.test, message=self.message, reason=reason))
def __bool__(self):
return False
class XError(XResult):
type = Result.Type.XError
class Null(Result):
type = Result.Type.Null
def xout(self, reason):
return self(XNull(test=self.test, message=self.message, reason=reason))
def __bool__(self):
return False
class XNull(XResult):
type = Result.Type.XNull
XoutResults = (XOK, XFail, XError, XNull)
FailResults = (Fail, Error, Null)
PassResults = (OK,) + XoutResults
NonFailResults = (Skip,) + PassResults
class Node(TestObject):
_fields = ("name", "module", "uid", "nexts", "ins", "outs")
_defaults = (None,) * 3
NodeAttributes = namedtuple("NodeAttributes", "name module uid")
def __init__(self, name, module, uid, nexts=None, ins=None, outs=None):
self.name = name
self.module = module
self.uid = uid
self.nexts = get(nexts, [])
self.ins = get(ins, [])
self.outs =get(outs, [])
return super(Node, self).__init__()
@classmethod
def attributes(cls, test):
name = test.__name__
module = ".".join([test.__module__, test.__name__])
uid = hash(module, short=True)
return cls.NodeAttributes(name, module, uid)
class Tag(TestObject):
_fields = ("value",)
_defaults = ()
def __init__(self, value):
self.value = value
return super(Tag, self).__init__()
def __str__(self):
return str(self.value)
class Argument(TestObject):
_fields = ("name", "value", "type", "group", "uid")
_defaults = (None,) * 4
uid = None
type = None
group = None
def __init__(self, name, value=None, type=None, group=None, uid=None):
self.name = name
self.value = value
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
return super(Argument, self).__init__()
class Attribute(TestObject):
_fields = ("name", "value", "type", "group", "uid")
_defaults = (None,) * 3
uid = None
type = None
group = None
def __init__(self, name, value, type=None, group=None, uid=None):
self.name = name
self.value = value
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
return super(Attribute, self).__init__()
class Requirement(TestObject):
_fields = ("name", "version", "description",
"link", "priority", "type", "group", "uid", "level", "num")
_defaults = (None,) * 8
uid = None
link = None
priority = None
type = None
group = None
def __init__(self, name, version, description=None, link=None,
priority=None, type=None, group=None, uid=None, level=None, num=None):
self.name = name
self.version = version
self.description = get(description, self.__doc__)
self.link = get(link, self.link)
self.priority = get(priority, self.priority)
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
self.level = level
self.num = num
return super(Requirement, self).__init__()
def __call__(self, *version):
if not self.version in version:
raise RequirementError("requirement version %s is not in %s" % (self.version, list(version)))
return self
class Metric(TestObject):
_fields = ("name", "value", "units", "type", "group", "uid")
_defaults = (None,) * 3
uid = None
type = None
group = None
def __init__(self, name, value, units, type=None, group=None, uid=None):
self.name = name
self.value = value
self.units = units
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
return super(Metric, self).__init__()
class Value(TestObject):
_fields = ("name", "value", "type", "group", "uid")
_defaults = (None,) * 3
uid = None
type = None
group = None
def __init__(self, name, value, type=None, group=None, uid=None):
self.name = name
self.value = str(value)
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
return super(Value, self).__init__()
class Ticket(TestObject):
_fields = ("name", "link", "type", "group", "uid")
_defaults = (None,) * 4
uid = None
link = None
type = None
group = None
def __init__(self, name, link=None, type=None, group=None, uid=None):
self.name = name
self.link = get(link, self.link)
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
return super(Ticket, self).__init__()
class Specification(TestObject):
_fields = ("name", "content", "description", "link", "author", "version",
"date", "status", "approved_by", "approved_date", "approved_version",
"type", "group", "uid", "parent", "children", "headings", "requirements")
_defaults = (None,) * 16
uid = None
link = None
type = None
group = None
Heading = namedtuple("Heading", "name level num")
def __init__(self, name, content, description=None, link=None, author=None, version=None,
date=None, status=None, approved_by=None, approved_date=None, approved_version=None,
type=None, group=None, uid=None, parent=None, children=None, headings=None,
requirements=None):
self.name = name
self.content = content
self.description = description
self.author = author
self.version = version
self.date = date
self.status = status
self.approved_by = approved_by
self.approved_date = approved_date
self.approved_version = approved_version
self.link = get(link, self.link)
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
self.parent = parent
self.children = children
self.headings = headings
self.requirements = requirements
def __call__(self, *version):
if not self.version in version:
raise SpecificationError("specification version %s is not in %s" % (self.version, list(version)))
return self
class ExamplesRow(TestObject):
_fields = ("row", "columns", "values", "row_format")
_defaults = (None,)
def __init__(self, row, columns, values, row_format=None):
self.row = row
self.columns = columns
self.values = [str(value) for value in values]
self.row_format = row_format
class Secrets:
"""Secrets registry.
"""
def __init__(self, secrets=None):
self._secrets = secrets or {}
self._filter_regex = re.compile(r"")
self._filter_secrets = []
self._lock = threading.Lock()
self._update_filter()
def __reduce__(self):
return (Secrets, (self._secrets,))
def is_empty(self):
"""Return True if registry is empty.
"""
with self._lock:
return not bool(self._filter_secrets)
def register(self, secret):
"""Register secret object.
"""
with self._lock:
if secret.name in self._secrets:
raise ValueError(f"secret '{secret.name}' already registered")
self._secrets[secret.name] = secret
self._update_filter()
def unregister(self, secret):
"""Unregister secret object.
"""
with self._lock:
self._secrets.pop(secret.name, None)
self._update_filter()
def _update_filter(self):
"""Update filter regex.
"""
self._filter_secrets = [s for s in self._secrets.values() if s.is_set()]
self._filter_regex = re.compile("|".join([f"(?P<{s.name}>{re.escape(s.value)})" for s in self._filter_secrets]))
def filter(self, message):
"""Filter all secret values from message.
"""
def _filter(s):
if not isinstance(s, str):
return message
return self._filter_regex.sub(lambda m: f"[masked]:{self._filter_secrets[m.lastindex-1]}", s)
with self._lock:
if isinstance(message, (list, tuple)):
for i, e in enumerate(message):
message[i] = self.filter(e)
return message
elif isinstance(message, dict):
_message = {}
for k, v in message.items():
_message[filter(k)] = filter(v)
return _message
return _filter(message)
class Secret(TestObject):
"""Secret value.
"""
_fields = ("name", "type", "group", "uid")
_defaults = (None,) * 4
uid = None
type = None
name = None
group = None
def __init__(self, name=None, type=None, group=None, uid=None):
self.name = get(name, self.name)
if self.name is None:
raise TypeError("name must be specified")
else:
try:
re.compile(rf"(?P<{self.name}>)")
except re.error as e:
raise ValueError("invalid secret name, " + str(e).replace("group name ", "")) from None
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
self._value = None
def __enter__(self):
return self
def __exit__(self, exc_value, exc_type, exc_tb):
self.clear()
def clear(self):
self._value = None
if not settings.secrets_registry:
raise RuntimeError("no secrets registry")
settings.secrets_registry.unregister(self)
return self
def __call__(self, value=None):
if value is not None:
self._value = str(value)
if not settings.secrets_registry:
raise RuntimeError("no secrets registry")
settings.secrets_registry.register(self)
return self
def is_set(self):
"""Return true if value has been set.
"""
return self._value is not None
@property
def value(self):
"""Return plaintext value of the secret.
"""
if self._value is None:
raise ValueError("no value")
return self._value
def __str__(self):
return self.__repr__()
def __repr__(self):
"""Custom object representation.
"""
kwargs = []
for field in self._fields:
value = getattr(self, field)
if value is None:
continue
kwargs.append(f"{field}={repr(value)}")
return f"Secret({','.join(kwargs)})"
class RSASecret(Secret):
"""RSA encrypted secret value.
"""
_fields = ("name", "type", "group", "uid", "code", "pubkey_id",)
_defaults = (None,) * 6
uid = None
name = None
type = None
group = None
encoding = "utf-8"
def __init__(self, name=None, type=None, group=None, uid=None, code=None, pubkey_id=None):
self.name = get(name, None)
self.type = get(type, self.type)
self.group = get(group, self.group)
self.uid = get(uid, self.uid)
self.pubkey_id = get(pubkey_id, None)
if self.pubkey_id is not None:
self.pubkey_id = base64.b64decode(pubkey_id.encode(self.encoding))
self.code = get(code, None)
self._value = None
self.__call__(code=code)
def __call__(self, value=None, code=None, private_key=None, public_key=None):
if value is not None:
self._value = str(value)
self.code = None
if code is not None:
self.code = base64.b64decode(code.encode(self.encoding))
self._value = None
if public_key is not None:
self.pubkey_id = hashlib.sha1(public_key.save_pkcs1()).digest()
self.code = None
if self._value is None:
raise ValueError("no value")
self.code = rsa.encrypt(self._value.encode(self.encoding), public_key)
if private_key is not None:
if self.pubkey_id is not None:
pk_id = hashlib.sha1(private_key.pubkey.save_pkcs1()).digest()
if self.pubkey_id != pk_id:
raise ValueError("wrong private key")
if self.code is None:
raise ValueError("no code")
self._value = rsa.decrypt(self.code, private_key).decode(self.encoding)
return self
def __repr__(self):
"""Custom object representation.
"""
kwargs = []
for field in self._fields:
value = getattr(self, field)
if value is None:
continue
if field in ("code", "pubkey_id"):
kwargs.append(f"{field}='{base64.b64encode(value).decode('utf-8')}'")
else:
kwargs.append(f"{field}={repr(value)}")
return f"Secret({','.join(kwargs)})"
class ExamplesTable(Table):
_row_type_name = "Example"
def __new__(cls, header=None, rows=None, row_format=None, args=None):
if rows is None:
rows = []
if header is None:
header = ""
if args is None:
args = {}
else:
args = dict(args)
row_type = namedtuple(cls._row_type_name, header)
class ExampleRow(row_type):
def __new__(cls, *args):
_args = {}
args = list(args)
len_header = len(header.split(" "))
if len(args) > len_header:
_args = {k:v for arg in args[len_header:] for k, v in dict(arg).items()}
if "type" in args:
raise TypeError("can't specify 'type' using example arguments")
if "args" in args:
raise TypeError("can't specify 'args' using example arguments")
del args[len_header:]
obj = super(ExampleRow, cls).__new__(cls, *args)
obj._args = _args
return obj
obj = super(ExamplesTable, cls).__new__(cls, header, rows, row_format, ExampleRow)
for idx, row in enumerate(obj):
row._idx = idx
row._row_format = obj.row_format
obj.args = args
return obj
class NamedValue(object):
name = None
def __init__(self, value):
self.value = value
def keys(self):
return [self.name]
def __getitem__(self, key):
if key == self.name:
return self.value
raise KeyError(key)
def __call__(self, func):
setattr(func, self.name, self.value)
return func
class NamedString(NamedValue):
def __str__(self):
return str(self.value)
class NamedList(list):
name = None
def __init__(self, *items):
super(NamedList, self).__init__(items)
def keys(self):
return [self.name]
def __getitem__(self, key):
if key == self.name:
return list(self)
return super(NamedList, self).__getitem__(key)
def __call__(self, func):
setattr(func, self.name, list(self))
return func
class Onlys(NamedList):
"""only container.
```python
@Only(
pattern,
...
)
```
"""
name = "only"
def __init__(self, *items):
super(Onlys, self).__init__(*items)
class Skips(NamedList):
"""skip container.
```python
@Skips(
pattern,
...
)
```
"""
name = "skip"
def __init__(self, *items):
super(Skips, self).__init__(*items)
class _FilterTags(NamedValue):
"""filter tags object.
"""
def __init__(self, test=None, suite=None, module=None, any=None):
test = set(test) if test is not None else set()
suite = set(suite) if suite is not None else set()
module = set(module) if module is not None else set()
any = set(any) if any is not None else set()
if any:
test = test.union(any)
suite = suite.union(any)
module = module.union(any)
super(_FilterTags, self).__init__({TestType.Test: test, TestType.Suite: suite, TestType.Module: module})
class OnlyTags(_FilterTags):
"""only_tags filter object.
```python
@OnlyTags(
test=[tagA,(tagA,tagB),...],
suite=[...],
module=[...],
any=[...]
)
```
"""
name = "only_tags"
class SkipTags(_FilterTags):
"""skip_tags filter object.
```python
@SkipTags(
test=[tagA,(tagA,tagB),...],
suite=[...],
module=[...],
any=[...]
)
```
"""
name = "skip_tags"
class Setup(NamedValue):
name = "setup"
class XFails(NamedValue):
"""xfails container.
xfails = {
"pattern": [("result", "reason"[, when])],
...
}
"""
name = "xfails"
def __init__(self, value):
super(XFails, self).__init__(dict(value))
def items(self):
return self.value.items()
def add(self, pattern, *results):
"""Add an entry to the xfails.
:param pattern: test name pattern to match
:param *results: one or more results to cross out
where each result is a two-tuple or three-tuple of (result, reason[, when])
"""
self.value[pattern] = results
return self
class FFails(NamedValue):
"""ffails (forced fails) container.
ffails = {
"pattern": (result, "reason"[, when]),
...
}
"""
name = "ffails"
def __init__(self, value):
value = dict(value)
value = {p: list(FFail(*v).value.values())[0] for p, v in value.items()}
super(FFails, self).__init__(value)
def items(self):
return self.value.items()
def add(self, pattern, reason, result=Fail, when=None):
"""Add an entry to the ffails (force fails).
:param pattern: test name pattern to match
:param reason: reason
:param result: forced result, default: Fails
:param when: when filter
"""
if when is not None and not callable(when):
raise TypeError(f"invalid when type '{type(when)}'; must be callable")
self.value[pattern] = (result, reason, when)
return self
class FFail(NamedValue):
"""ffails (forced fails) container with single result.
"""
name = "ffails"
def __init__(self, result, reason, when=None, pattern=""):
if not issubclass(result, Result):
raise TypeError(f"invalid result '{result}' type")
if not type(reason) in (str,):
raise TypeError(f"reason '{type(reason)}' must be str")
if when is not None and not callable(when):
raise TypeError(f"when '{type(when)}' must be callable")
super(FFail, self).__init__({pattern: (result, reason, when)})
class Skipped(FFail):
"""ffails (forced fails) container with single Skip result.
"""
def __init__(self, reason, when=None, pattern=""):
super(Skipped, self).__init__(reason=reason, when=when, pattern=pattern, result=Skip)
class Failed(FFail):
"""ffails (forced fails) container with single Fail result.
"""
def __init__(self, reason, when=None, pattern=""):
super(Failed, self).__init__(reason=reason, when=when, pattern=pattern, result=Fail)
class XFailed(FFail):
"""ffails (forced fails) container with single XFail result.
"""
def __init__(self, reason, when=None, pattern=""):
super(XFailed, self).__init__(reason=reason, when=when, pattern=pattern, result=XFail)
class XErrored(FFail):
"""ffails (forced fails) container with single XError result.
"""
def __init__(self, reason, when=None, pattern=""):
super(XErrored, self).__init__(reason=reason, when=when, pattern=pattern, result=XError)
class Okayed(FFail):
"""ffails (forced fails) container with single OK result.
"""
def __init__(self, reason, when=None, pattern=""):
super(Okayed, self).__init__(reason=reason, when=when, pattern=pattern, result=OK)
class XOkayed(FFail):
"""ffails (forced fails) container with single XOK result.
"""
def __init__(self, reason, when=None, pattern=""):
super(XOkayed, self).__init__(reason=reason, when=when, pattern=pattern, result=XOK)
class XFlags(NamedValue):
"""xflags container.
xflags = {
"filter": (set_flags, clear_flags[, when]),
...
}
"""
name = "xflags"
def __init__(self, value):
super(XFlags, self).__init__(dict(value))
def items(self):
return self.value.items()
def add(self, pattern, set_flags=0, clear_flags=0, when=None):
"""Add an entry to the xflags.
:param pattern: test name pattern to match
:param set_flags: flags to set
:param clear_flags: flags to clear, default: None
:param when: condition function, default: None
"""
self.value[pattern] = [Flags(set_flags), Flags(clear_flags), when]
return self
class Repeats(NamedValue):
"""repeats containers.
repeats={
"pattern": (count, until),
...
}
"""
name = "repeats"
def __init__(self, value):
super(Repeats, self).__init__(dict(value))
class Repeat(NamedValue):
"""single repetition container.
"""
name = "repeats"
def __init__(self, count, until="complete", pattern=""):
self.count = int(count)
self.pattern = str(pattern)
self.until = str(until)
if self.count < 1:
raise ValueError("count must be > 0")
if self.until not in ("fail", "pass", "complete"):
raise ValueError("invalid until value")
return super(Repeat, self).__init__({self.pattern: (self.count, self.until)})
class Retries(NamedValue):
"""retries containers.
retries={
"pattern": count[,timeout[,delay[,backoff[,jitter]]]] ,
...
}
"""
name = "retries"
def __init__(self, value):
value = dict(value)
value = {p: list(Retry(*r).value.values())[0] for p, r in value.items()}
super(Retries, self).__init__(value)
class Retry(NamedValue):
"""single retry container.
"""
name = "retries"
def __init__(self, count=None, timeout=None, delay=0, backoff=1, jitter=None, pattern=""):
"""
:param count: number of retries, default: None
:param timeout: timeout in sec, default: None
:param delay: delay in sec between retries, default: 0 sec
:param backoff: backoff multiplier that is applied to the delay, default: 1
:param jitter: jitter added to delay between retries specified as
a tuple(min, max), default: (0,0)
"""
self.count = int(count) if count is not None else None
self.timeout = float(timeout) if timeout is not None else None
self.delay = float(delay)
self.backoff = backoff
self.jitter = tuple(jitter) if jitter else tuple([0, 0])
self.pattern = str(pattern)
if self.count is not None and self.count < 1:
raise ValueError("count must be > 0")
if self.timeout is not None and self.timeout < 0:
raise ValueError("timeout must be >= 0")
return super(Retry, self).__init__({self.pattern: (self.count, self.timeout, self.delay, self.backoff, self.jitter)})
class Args(dict):
def __init__(self, **args):
super(Args, self).__init__(**args)
def __call__(self, func):
for k, v in self.items():
if not k.startswith("_"):
setattr(func, k, v)
return func
class Attributes(NamedList):
name = "attributes"
def __init__(self, *attributes):
super(Attributes, self).__init__(*[Attribute(*a) for a in attributes])
class Requirements(NamedList):
name = "requirements"
def __init__(self, *requirements):
super(Requirements, self).__init__(*[Requirement(*r) for r in requirements])
class Specifications(NamedList):
name = "specifications"
def __init__(self, *specifications):
super(Specifications, self).__init__(*[Specification(*r) for r in specifications])
class Tags(NamedList):
name = "tags"
def __init__(self, *tags):
super(Tags, self).__init__(*tags)
class Uid(NamedString):
name = "uid"
class Parallel(NamedValue):
name = "parallel"
def __init__(self, value):
self.value = bool(value)
class Executor(NamedValue):
name = "executor"
def __init__(self, executor):
self.value = executor
class ArgumentParser(NamedValue):
name = "argparser"
def __init__(self, parser):
self.value = parser
class Name(NamedString):
name = "name"
class Description(NamedString):
name = "description"
class Examples(ExamplesTable):
def __new__(cls, header, rows, row_format=None, args=None):
return super(Examples, cls).__new__(cls, header=header,
rows=rows, row_format=row_format, args=args)
def __call__(self, func):
func.examples = self
return func