-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathtest_rules.py
More file actions
873 lines (725 loc) · 35.9 KB
/
Copy pathtest_rules.py
File metadata and controls
873 lines (725 loc) · 35.9 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
"""Pytest tests for the Rules API.
These tests demonstrate and validate the usage of the Rules API including:
- Basic rule operations (get, list, find)
- Rule filtering and searching
- Rule creation, updates, and archiving
- Error handling and edge cases
"""
import uuid
from datetime import datetime, timezone
import pytest
from sift_client import SiftClient
from sift_client.resources import RulesAPI, RulesAPIAsync
from sift_client.sift_types import Rule
from sift_client.sift_types.channel import ChannelReference
from sift_client.sift_types.rule import (
RuleAction,
RuleActionType,
RuleAnnotationType,
RuleCreate,
RuleUpdate,
RuleVersion,
)
pytestmark = pytest.mark.integration
def test_client_binding(sift_client):
assert sift_client.rules
assert isinstance(sift_client.rules, RulesAPI)
assert sift_client.async_.rules
assert isinstance(sift_client.async_.rules, RulesAPIAsync)
@pytest.fixture
def rules_api_async(sift_client: SiftClient):
"""Get the async rules API instance."""
return sift_client.async_.rules
@pytest.fixture
def rules_api_sync(sift_client: SiftClient):
"""Get the synchronous rules API instance."""
return sift_client.rules
@pytest.fixture
def test_rule(rules_api_sync):
rules = rules_api_sync.list_(limit=1)
assert rules
assert len(rules) >= 1
return rules[0]
@pytest.fixture
def new_rule(rules_api_sync, sift_client):
"""Create a test rule for update tests."""
from datetime import datetime, timezone
rule_name = f"test_rule_{datetime.now(timezone.utc).isoformat()}"
description = "Test rule created by Sift Client pytest"
# Get some channels to reference
channels = sift_client.channels.list_(limit=2)
assert len(channels) >= 2
# Get an asset to apply the rule to
assets = sift_client.assets.list_(limit=1)
assert len(assets) >= 1
created_rule = rules_api_sync.create(
RuleCreate(
name=rule_name,
client_key=f"test_rule_{str(uuid.uuid4())[-8:]}",
description=description,
expression="$1 > $2",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier=channels[0].name),
ChannelReference(channel_reference="$2", channel_identifier=channels[1].name),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[assets[0].id_],
)
)
return created_rule
class TestRulesAPIAsync:
"""Test suite for the async Rules API functionality."""
class TestGet:
"""Tests for the async get method."""
@pytest.mark.asyncio
async def test_get_by_id(self, rules_api_async, test_rule):
"""Test getting a specific rule by ID."""
retrieved_rule = await rules_api_async.get(rule_id=test_rule.id_)
assert isinstance(retrieved_rule, Rule)
assert retrieved_rule.id_ == test_rule.id_
assert retrieved_rule.name == test_rule.name
@pytest.mark.asyncio
async def test_get_by_client_key(self, rules_api_async, test_rule):
"""Test getting a specific rule by client key."""
if test_rule.client_key:
retrieved_rule = await rules_api_async.get(client_key=test_rule.client_key)
assert retrieved_rule is not None
assert retrieved_rule.id_ == test_rule.id_
class TestList:
"""Tests for the async list_ method."""
@pytest.mark.asyncio
async def test_basic_list(self, rules_api_async):
"""Test basic rule listing functionality."""
rules = await rules_api_async.list_(limit=5)
assert isinstance(rules, list)
assert len(rules) == 5
rule = rules[0]
assert isinstance(rule, Rule)
@pytest.mark.asyncio
async def test_list_with_name_filter(self, rules_api_async, test_rule):
"""Test rule listing with name filtering."""
filtered_rules = await rules_api_async.list_(name=test_rule.name)
assert isinstance(filtered_rules, list)
assert len(filtered_rules) >= 1
for rule in filtered_rules:
assert rule.name == test_rule.name
@pytest.mark.asyncio
async def test_list_with_name_contains_filter(self, rules_api_async):
"""Test rule listing with name contains filtering."""
rules = await rules_api_async.list_(name_contains="test", limit=5)
assert isinstance(rules, list)
assert rules
for rule in rules:
assert "test" in rule.name.lower()
@pytest.mark.asyncio
async def test_list_with_name_regex_filter(self, rules_api_async):
"""Test rule listing with regex name filtering."""
rules = await rules_api_async.list_(name_regex=r".*test.*", limit=5)
assert isinstance(rules, list)
assert rules
import re
pattern = re.compile(r".*test.*", re.IGNORECASE)
for rule in rules:
assert pattern.match(rule.name)
@pytest.mark.asyncio
async def test_list_with_rule_ids_filter(self, rules_api_async):
"""Test rule listing with rule IDs filter."""
all_rules = await rules_api_async.list_(limit=3)
if all_rules:
rule_ids = [r.id_ for r in all_rules]
filtered_rules = await rules_api_async.list_(rule_ids=rule_ids)
assert isinstance(filtered_rules, list)
assert len(filtered_rules) >= len(all_rules)
for rule in filtered_rules:
assert rule.id_ in rule_ids
@pytest.mark.asyncio
async def test_list_with_description_contains_filter(self, rules_api_async):
"""Test rule listing with description contains filtering."""
rules = await rules_api_async.list_(description_contains="test", limit=5)
assert isinstance(rules, list)
assert rules
for rule in rules:
assert "test" in rule.description.lower()
@pytest.mark.asyncio
async def test_list_with_limit(self, rules_api_async):
"""Test rule listing with different limits."""
rules_1 = await rules_api_async.list_(limit=1)
assert isinstance(rules_1, list)
assert len(rules_1) <= 1
rules_3 = await rules_api_async.list_(limit=3)
assert isinstance(rules_3, list)
assert len(rules_3) <= 3
@pytest.mark.asyncio
async def test_list_with_time_filters(self, rules_api_async):
"""Test rule listing with time-based filters."""
from datetime import datetime, timedelta, timezone
one_year_ago = datetime.now(timezone.utc) - timedelta(days=365)
rules = await rules_api_async.list_(created_after=one_year_ago, limit=5)
assert isinstance(rules, list)
assert rules
for rule in rules:
assert rule.created_date >= one_year_ago
class TestListRuleVersions:
"""Tests for the async list_rule_versions method."""
@pytest.mark.asyncio
async def test_list_rule_versions_by_rule(self, rules_api_async, test_rule):
"""Test listing rule versions for a rule."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert isinstance(versions, list)
assert len(versions) >= 1
for v in versions:
assert isinstance(v, RuleVersion)
assert v.rule_id == test_rule.id_
assert v.rule_version_id
assert v.version
assert v.created_date
@pytest.mark.asyncio
async def test_list_rule_versions_by_rule_id_str(self, rules_api_async, test_rule):
"""Test listing rule versions by rule ID string."""
versions = await rules_api_async.list_rule_versions(test_rule.id_)
assert isinstance(versions, list)
assert len(versions) >= 1
for v in versions:
assert v.rule_id == test_rule.id_
@pytest.mark.asyncio
async def test_list_rule_versions_with_limit(self, rules_api_async, test_rule):
"""Test listing rule versions with limit."""
versions = await rules_api_async.list_rule_versions(test_rule, limit=1)
assert isinstance(versions, list)
assert len(versions) <= 1
if versions:
assert isinstance(versions[0], RuleVersion)
@pytest.mark.asyncio
async def test_list_rule_versions_with_rule_version_ids_filter(
self, rules_api_async, test_rule
):
"""Test listing rule versions filtered by rule_version_ids."""
all_versions = await rules_api_async.list_rule_versions(test_rule)
assert all_versions
first_id = all_versions[0].rule_version_id
versions = await rules_api_async.list_rule_versions(
test_rule, rule_version_ids=[first_id]
)
assert len(versions) == 1
assert versions[0].rule_version_id == first_id
class TestGetRuleVersion:
"""Tests for the async get_rule_version method."""
@pytest.mark.asyncio
async def test_get_rule_version_by_id(self, rules_api_async, test_rule):
"""Test getting a rule at a specific version by rule_version_id."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert versions
rule_at_version = await rules_api_async.get_rule_version(versions[0].rule_version_id)
assert rule_at_version is not None
assert rule_at_version.id_ == test_rule.id_
assert rule_at_version.rule_version is not None
assert rule_at_version.rule_version.rule_version_id == versions[0].rule_version_id
@pytest.mark.asyncio
async def test_get_rule_version_by_rule_version_instance(self, rules_api_async, test_rule):
"""Test getting a rule at a specific version by passing RuleVersion instance."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert versions
rule_at_version = await rules_api_async.get_rule_version(versions[0])
assert rule_at_version is not None
assert rule_at_version.id_ == test_rule.id_
assert rule_at_version.rule_version.rule_version_id == versions[0].rule_version_id
class TestBatchGetRuleVersions:
"""Tests for the async batch_get_rule_versions method."""
@pytest.mark.asyncio
async def test_batch_get_rule_versions_by_ids(self, rules_api_async, test_rule):
"""Test batch getting rules by rule_version_id strings."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert versions
ids = [v.rule_version_id for v in versions[:2]]
rules = await rules_api_async.batch_get_rule_versions(ids)
assert len(rules) == len(ids)
returned_ids = {r.rule_version.rule_version_id for r in rules if r.rule_version}
assert returned_ids >= set(ids)
for r in rules:
assert r.id_ == test_rule.id_
@pytest.mark.asyncio
async def test_batch_get_rule_versions_by_rule_version_instances(
self, rules_api_async, test_rule
):
"""Test batch getting rules by passing RuleVersion instances."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert versions
rules = await rules_api_async.batch_get_rule_versions(versions[:2])
assert len(rules) <= 2
for r in rules:
assert r.id_ == test_rule.id_
if len(versions) >= 2:
assert len(rules) == 2
@pytest.mark.asyncio
async def test_batch_get_rule_versions_single(self, rules_api_async, test_rule):
"""Test batch_get_rule_versions with a single version ID."""
versions = await rules_api_async.list_rule_versions(test_rule)
assert versions
rules = await rules_api_async.batch_get_rule_versions([versions[0].rule_version_id])
assert len(rules) == 1
assert rules[0].id_ == test_rule.id_
assert rules[0].rule_version.rule_version_id == versions[0].rule_version_id
class TestFind:
"""Tests for the async find method."""
@pytest.mark.asyncio
async def test_find_rule(self, rules_api_async, test_rule):
"""Test finding a single rule."""
found_rule = await rules_api_async.find(rule_ids=[test_rule.id_])
assert found_rule is not None
assert found_rule.id_ == test_rule.id_
@pytest.mark.asyncio
async def test_find_nonexistent_rule(self, rules_api_async):
"""Test finding a non-existent rule returns None."""
found_rule = await rules_api_async.find(name="nonexistent-rule-name-12345")
assert found_rule is None
@pytest.mark.asyncio
async def test_find_multiple_raises_error(self, rules_api_async):
"""Test finding multiple rules raises an error."""
with pytest.raises(ValueError, match="Multiple"):
await rules_api_async.find(name_contains="test", limit=5)
class TestCreate:
"""Tests for the async create method."""
@pytest.mark.asyncio
async def test_create_basic_rule(self, rules_api_async):
"""Test creating a basic rule with minimal fields."""
from datetime import datetime, timezone
rule_name = f"test_rule_create_{datetime.now(timezone.utc).isoformat()}"
description = "Test rule created by Sift Client pytest"
channels = await rules_api_async.client.async_.channels.list_(limit=2)
assert len(channels) >= 2
assets = await rules_api_async.client.async_.assets.list_(limit=1)
assert len(assets) >= 1
rule_create = RuleCreate(
name=rule_name,
description=description,
expression="$1 > $2",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier=channels[0].name),
ChannelReference(channel_reference="$2", channel_identifier=channels[1].name),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[assets[0]._id_or_error],
)
created_rule = await rules_api_async.create(rule_create)
try:
assert created_rule is not None
assert isinstance(created_rule, Rule)
assert created_rule.id_ is not None
assert created_rule.name == rule_name
assert created_rule.description == description
assert created_rule.created_date is not None
assert created_rule.modified_date is not None
finally:
await rules_api_async.archive(created_rule)
@pytest.mark.asyncio
async def test_create_rule_with_dict(self, rules_api_async):
"""Test creating a rule using a dictionary."""
from datetime import datetime, timezone
rule_name = f"test_rule_dict_{datetime.now(timezone.utc).isoformat()}"
description = "Test rule created by Sift Client pytest"
channels = await rules_api_async.client.async_.channels.list_(limit=2)
assert len(channels) >= 2
assets = await rules_api_async.client.async_.assets.list_(limit=1)
assert len(assets) >= 1
rule_dict = {
"name": rule_name,
"description": description,
"expression": "$1 > $2",
"channel_references": [
{"channel_reference": "$1", "channel_identifier": channels[0].name},
{"channel_reference": "$2", "channel_identifier": channels[1].name},
],
"action": {
"action_type": RuleActionType.ANNOTATION,
"annotation_type": RuleAnnotationType.PHASE,
"tags": [],
},
"asset_ids": [assets[0].id_],
}
created_rule = await rules_api_async.create(rule_dict)
try:
assert created_rule.name == rule_name
assert created_rule.description == description
finally:
await rules_api_async.archive(created_rule)
class TestUpdate:
"""Tests for the async update method."""
@pytest.mark.asyncio
async def test_update_rule_description(self, rules_api_async, new_rule):
"""Test updating a rule's description."""
try:
update = RuleUpdate(description="Updated description")
updated_rule = await rules_api_async.update(new_rule, update)
assert updated_rule.id_ == new_rule.id_
assert updated_rule.description == "Updated description"
# Validate that things we didn't intentionally change didn't change
assert updated_rule.name == new_rule.name
assert updated_rule.is_external == new_rule.is_external
assert updated_rule.expression == new_rule.expression
assert updated_rule.action.action_type == new_rule.action.action_type
assert updated_rule.client_key == new_rule.client_key
assert updated_rule.rule_version.created_date > new_rule.rule_version.created_date
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_rule_name(self, rules_api_async, new_rule):
"""Test updating a rule's name."""
try:
new_name = f"updated_{new_rule.name}"
update = RuleUpdate(name=new_name)
updated_rule = await rules_api_async.update(new_rule, update)
assert updated_rule.name == new_name
assert updated_rule.id_ == new_rule.id_
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_with_dict(self, rules_api_async, new_rule):
"""Test updating a rule using a dictionary."""
try:
update_dict = {"description": "Updated via dict"}
updated_rule = await rules_api_async.update(new_rule, update_dict)
assert updated_rule.description == "Updated via dict"
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_with_id_string(self, rules_api_async, new_rule):
"""Test updating a rule by passing ID as string."""
try:
update = RuleUpdate(description="Updated via ID string")
updated_rule = await rules_api_async.update(new_rule.id_, update)
assert updated_rule.id_ == new_rule.id_
assert updated_rule.description == "Updated via ID string"
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_with_version_notes(self, rules_api_async, new_rule):
"""Test updating a rule with version notes."""
try:
update = RuleUpdate(description="Updated with version notes")
updated_rule = await rules_api_async.update(
new_rule, update, version_notes="Test version notes"
)
assert updated_rule.id_ == new_rule.id_
assert updated_rule.description == "Updated with version notes"
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_rule_action(self, rules_api_async, new_rule, ci_pytest_tag):
"""Test updating a rule's action including annotation type, tags, and assignee."""
try:
# Update the action with new annotation type, tags, and assignee
update = RuleUpdate(
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.PHASE,
tags=[ci_pytest_tag],
default_assignee_user=new_rule.created_by_user_id,
),
)
updated_rule = await rules_api_async.update(new_rule, update)
# Verify the action was updated
assert updated_rule.id_ == new_rule.id_
assert updated_rule.action.action_type == RuleActionType.ANNOTATION
assert updated_rule.action.annotation_type == RuleAnnotationType.PHASE
assert set(updated_rule.action.tags_ids) == {ci_pytest_tag.id_}
assert updated_rule.action.default_assignee_user == new_rule.created_by_user_id
# Verify other fields remain unchanged
assert updated_rule.name == new_rule.name
assert updated_rule.expression == new_rule.expression
finally:
await rules_api_async.archive(new_rule.id_)
@pytest.mark.asyncio
async def test_update_with_complex_expression(self, rules_api_async, sift_client, test_tag):
"""Test updating a rule with a complex expression (range check)."""
# Get channels and assets
channels = await sift_client.async_.channels.list_(limit=2)
assert len(channels) >= 1
assets = await sift_client.async_.assets.list_(limit=1)
assert len(assets) >= 1
# Create a rule with simple expression
rule_name = f"test_rule_complex_expr_{datetime.now(timezone.utc).isoformat()}"
rule_create = RuleCreate(
name=rule_name,
description="Test rule for complex expression update",
expression="$1 > 0.5",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier=channels[0].name),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[test_tag],
),
asset_ids=[assets[0].id_],
)
created_rule = await rules_api_async.create(rule_create)
try:
# Update with complex expression (range check)
update = RuleUpdate(
expression="$1 > 0.3 && $1 < 0.8",
channel_references=[
ChannelReference(
channel_reference="$1", channel_identifier=channels[0].name
),
],
)
updated_rule = await rules_api_async.update(created_rule, update)
# Verify the expression was updated
assert updated_rule.id_ == created_rule.id_
assert updated_rule.expression == "$1 > 0.3 && $1 < 0.8"
assert len(updated_rule.channel_references) == 1
assert updated_rule.channel_references[0].channel_identifier == channels[0].name
# Verify other fields remain unchanged
assert updated_rule.name == created_rule.name
assert updated_rule.action.action_type == created_rule.action.action_type
finally:
await rules_api_async.archive(created_rule.id_)
@pytest.mark.asyncio
async def test_update_with_multiple_channel_references(
self, rules_api_async, sift_client, test_tag
):
"""Test updating a rule expression to use multiple channel references."""
# Get channels and assets
channels = await sift_client.async_.channels.list_(limit=3)
assert len(channels) >= 3
assets = await sift_client.async_.assets.list_(limit=1)
assert len(assets) >= 1
# Create a rule with simple expression
rule_name = f"test_rule_multi_refs_{datetime.now(timezone.utc).isoformat()}"
rule_create = RuleCreate(
name=rule_name,
description="Test rule for multiple channel references",
expression="$1 > $2",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier=channels[0].name),
ChannelReference(channel_reference="$2", channel_identifier=channels[1].name),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[test_tag],
),
asset_ids=[assets[0].id_],
)
created_rule = await rules_api_async.create(rule_create)
try:
# Update with expression using three channel references
update = RuleUpdate(
expression="($1 > $2) && ($3 < 100)",
channel_references=[
ChannelReference(
channel_reference="$1", channel_identifier=channels[0].name
),
ChannelReference(
channel_reference="$2", channel_identifier=channels[1].name
),
ChannelReference(
channel_reference="$3", channel_identifier=channels[2].name
),
],
)
updated_rule = await rules_api_async.update(created_rule, update)
# Verify the expression and channel references were updated
assert updated_rule.id_ == created_rule.id_
assert updated_rule.expression == "($1 > $2) && ($3 < 100)"
assert len(updated_rule.channel_references) == 3
# Verify all three channel references are present
ref_identifiers = {
ref.channel_identifier for ref in updated_rule.channel_references
}
assert channels[0].name in ref_identifiers
assert channels[1].name in ref_identifiers
assert channels[2].name in ref_identifiers
finally:
await rules_api_async.archive(created_rule.id_)
@pytest.mark.asyncio
async def test_update_with_invalid_expression(self, rules_api_async, new_rule):
"""Test updating a rule with an invalid expression.
Note: The server may or may not validate expression syntax at update time.
This test documents the current behavior.
"""
try:
# Attempt to update with an invalid expression
update = RuleUpdate(
expression="invalid_expression",
channel_references=[
ChannelReference(
channel_reference="$1",
channel_identifier=new_rule.channel_references[0].channel_identifier,
),
],
)
# This may succeed or fail depending on server-side validation
# If it succeeds, the expression is stored but may fail at evaluation time
try:
updated_rule = await rules_api_async.update(new_rule, update)
# If update succeeds, verify the expression was set
assert updated_rule.expression == "invalid_expression"
except Exception as e:
# If server validates and rejects, that's also acceptable behavior
assert ( # noqa: PT017
"expression" in str(e).lower() or "invalid" in str(e).lower()
)
finally:
await rules_api_async.archive(new_rule.id_)
class TestArchive:
"""Tests for the async archive method."""
@pytest.mark.asyncio
async def test_archive_rule(self, rules_api_async, new_rule):
"""Test archiving a rule."""
rule = await rules_api_async.archive(new_rule)
assert isinstance(rule, Rule)
assert rule.id_ == new_rule.id_
assert rule.is_archived is True
rules_without_archived = await rules_api_async.list_(
name=new_rule.name, include_archived=False
)
assert len(rules_without_archived) == 0
rules_with_archived = await rules_api_async.list_(
name=new_rule.name, include_archived=True
)
assert len(rules_with_archived) == 1
assert rules_with_archived[0].id_ == new_rule.id_
assert rules_with_archived[0].archived_date is not None
@pytest.mark.asyncio
async def test_archive_with_id_string(self, rules_api_async, new_rule):
"""Test archiving a rule by passing ID as string."""
rule = await rules_api_async.archive(new_rule.id_)
assert isinstance(rule, Rule)
assert rule.id_ == new_rule.id_
assert rule.is_archived is True
class TestUnarchive:
"""Tests for the async unarchive method."""
@pytest.mark.asyncio
async def test_unarchive_rule(self, rules_api_async, new_rule):
"""Test unarchiving a rule."""
try:
await rules_api_async.archive(new_rule)
rule = await rules_api_async.unarchive(new_rule)
assert isinstance(rule, Rule)
assert rule.id_ == new_rule.id_
assert rule.is_archived is False
finally:
await rules_api_async.archive(new_rule.id_)
class TestBatchUpdate:
"""Tests for the async batch_update_rules method."""
@pytest.mark.asyncio
async def test_batch_update_or_create_rules(self, rules_api_async, nostromo_asset):
"""Test updating multiple rules with different fields."""
from datetime import datetime, timezone
rule1_name = f"test_batch_rule_1_{datetime.now(timezone.utc).isoformat()}"
rule2_name = f"test_batch_rule_2_{datetime.now(timezone.utc).isoformat()}"
rule1 = await rules_api_async.create(
RuleCreate(
name=rule1_name,
client_key=f"test_batch_1_{str(uuid.uuid4())[-8:]}",
description="Test rule 1 for batch update",
expression="$1 > $2",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier="channel1"),
ChannelReference(channel_reference="$2", channel_identifier="channel2"),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[nostromo_asset.id_],
)
)
rule2 = await rules_api_async.create(
RuleCreate(
name=rule2_name,
client_key=f"test_batch_2_{str(uuid.uuid4())[-8:]}",
description="Test rule 2 for batch update",
expression="$1 > 0.5",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier="channel1"),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[nostromo_asset.id_],
)
)
try:
# Batch update both rules
rule1_update = RuleUpdate(description="Updated description 1")
rule1_update.resource_id = rule1.id_
rule2_update = RuleUpdate(description="Updated description 2")
rule2_update.resource_id = rule2.id_
updates = [rule1_update, rule2_update]
updated_rules = await rules_api_async.batch_update_or_create_rules(updates)
assert isinstance(updated_rules, list)
assert len(updated_rules) == 2
# Verify updates were applied
assert updated_rules[0].description == "Updated description 1"
assert updated_rules[1].description == "Updated description 2"
finally:
await rules_api_async.archive(rule1.id_)
await rules_api_async.archive(rule2.id_)
@pytest.mark.asyncio
async def test_batch_update_rules_creates_rules(self, rules_api_async, nostromo_asset):
"""Test batch updating rules that don't already exist."""
from datetime import datetime, timezone
rule1_name = f"test_batch_rule_1_{datetime.now(timezone.utc).isoformat()}"
rule2_name = f"test_batch_rule_2_{datetime.now(timezone.utc).isoformat()}"
rule1 = RuleCreate(
name=rule1_name,
client_key=f"test_batch_1_{str(uuid.uuid4())[-8:]}",
description="Test rule 1 for batch update",
expression="$1 > $2",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier="channel1"),
ChannelReference(channel_reference="$2", channel_identifier="channel2"),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[nostromo_asset.id_],
)
rule2 = RuleCreate(
name=rule2_name,
client_key=f"test_batch_2_{str(uuid.uuid4())[-8:]}",
description="Test rule 2 for batch update",
expression="$1 > 0.5",
channel_references=[
ChannelReference(channel_reference="$1", channel_identifier="channel1"),
],
action=RuleAction.annotation(
annotation_type=RuleAnnotationType.DATA_REVIEW,
tags=[],
),
asset_ids=[nostromo_asset.id_],
)
updated_rules: list[Rule] = []
try:
# Batch update (actually create) both rules
updates = [rule1, rule2]
updated_rules = await rules_api_async.batch_update_or_create_rules(updates)
assert isinstance(updated_rules, list)
assert len(updated_rules) == 2
assert updated_rules[0].client_key == rule1.client_key
assert updated_rules[1].client_key == rule2.client_key
finally:
for rule in updated_rules:
await rules_api_async.archive(rule.id_)
@pytest.mark.asyncio
async def test_batch_update_rules_empty_list(self, rules_api_async):
"""Test handling empty list."""
updated_rules = await rules_api_async.batch_update_or_create_rules([])
assert isinstance(updated_rules, list)
assert len(updated_rules) == 0
class TestRulesAPISync:
"""Test suite for the synchronous Rules API functionality."""
class TestGet:
"""Tests for the sync get method."""
def test_get_by_id(self, rules_api_sync, test_rule):
"""Test getting a specific rule by ID synchronously."""
retrieved_rule = rules_api_sync.get(rule_id=test_rule.id_)
assert retrieved_rule is not None
assert retrieved_rule.id_ == test_rule.id_