-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Expand file tree
/
Copy pathtest_guardrails.py
More file actions
1503 lines (1252 loc) · 51.5 KB
/
test_guardrails.py
File metadata and controls
1503 lines (1252 loc) · 51.5 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
from __future__ import annotations
import asyncio
import time
from typing import Any
from unittest.mock import patch
import pytest
from agents import (
Agent,
GuardrailFunctionOutput,
InputGuardrail,
InputGuardrailTripwireTriggered,
OutputGuardrail,
RunConfig,
RunContextWrapper,
Runner,
TResponseInputItem,
UserError,
function_tool,
)
from agents.guardrail import input_guardrail, output_guardrail
from .fake_model import FakeModel
from .test_responses import get_function_tool_call, get_text_message
SHORT_DELAY = 0.01
MEDIUM_DELAY = 0.03
LONG_DELAY = 0.05
def get_sync_guardrail(triggers: bool, output_info: Any | None = None):
def sync_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
):
return GuardrailFunctionOutput(
output_info=output_info,
tripwire_triggered=triggers,
)
return sync_guardrail
@pytest.mark.asyncio
async def test_sync_input_guardrail():
guardrail = InputGuardrail(guardrail_function=get_sync_guardrail(triggers=False))
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = InputGuardrail(guardrail_function=get_sync_guardrail(triggers=True))
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = InputGuardrail(
guardrail_function=get_sync_guardrail(triggers=True, output_info="test")
)
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info == "test"
def get_async_input_guardrail(triggers: bool, output_info: Any | None = None):
async def async_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
):
return GuardrailFunctionOutput(
output_info=output_info,
tripwire_triggered=triggers,
)
return async_guardrail
@pytest.mark.asyncio
async def test_async_input_guardrail():
guardrail = InputGuardrail(guardrail_function=get_async_input_guardrail(triggers=False))
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = InputGuardrail(guardrail_function=get_async_input_guardrail(triggers=True))
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = InputGuardrail(
guardrail_function=get_async_input_guardrail(triggers=True, output_info="test")
)
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info == "test"
@pytest.mark.asyncio
async def test_invalid_input_guardrail_raises_user_error():
with pytest.raises(UserError):
# Purposely ignoring type error
guardrail = InputGuardrail(guardrail_function="foo") # type: ignore
await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
def get_sync_output_guardrail(triggers: bool, output_info: Any | None = None):
def sync_guardrail(context: RunContextWrapper[Any], agent: Agent[Any], agent_output: Any):
return GuardrailFunctionOutput(
output_info=output_info,
tripwire_triggered=triggers,
)
return sync_guardrail
@pytest.mark.asyncio
async def test_sync_output_guardrail():
guardrail = OutputGuardrail(guardrail_function=get_sync_output_guardrail(triggers=False))
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = OutputGuardrail(guardrail_function=get_sync_output_guardrail(triggers=True))
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = OutputGuardrail(
guardrail_function=get_sync_output_guardrail(triggers=True, output_info="test")
)
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info == "test"
def get_async_output_guardrail(triggers: bool, output_info: Any | None = None):
async def async_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], agent_output: Any
):
return GuardrailFunctionOutput(
output_info=output_info,
tripwire_triggered=triggers,
)
return async_guardrail
@pytest.mark.asyncio
async def test_async_output_guardrail():
guardrail = OutputGuardrail(guardrail_function=get_async_output_guardrail(triggers=False))
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = OutputGuardrail(guardrail_function=get_async_output_guardrail(triggers=True))
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info is None
guardrail = OutputGuardrail(
guardrail_function=get_async_output_guardrail(triggers=True, output_info="test")
)
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert result.output.tripwire_triggered
assert result.output.output_info == "test"
@pytest.mark.asyncio
async def test_invalid_output_guardrail_raises_user_error():
with pytest.raises(UserError):
# Purposely ignoring type error
guardrail = OutputGuardrail(guardrail_function="foo") # type: ignore
await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
@input_guardrail
def decorated_input_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="test_1",
tripwire_triggered=False,
)
@input_guardrail(name="Custom name")
def decorated_named_input_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="test_2",
tripwire_triggered=False,
)
@pytest.mark.asyncio
async def test_input_guardrail_decorators():
guardrail = decorated_input_guardrail
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info == "test_1"
guardrail = decorated_named_input_guardrail
result = await guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info == "test_2"
assert guardrail.get_name() == "Custom name"
@output_guardrail
def decorated_output_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], agent_output: Any
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="test_3",
tripwire_triggered=False,
)
@output_guardrail(name="Custom name")
def decorated_named_output_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], agent_output: Any
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="test_4",
tripwire_triggered=False,
)
@pytest.mark.asyncio
async def test_output_guardrail_decorators():
guardrail = decorated_output_guardrail
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info == "test_3"
guardrail = decorated_named_output_guardrail
result = await guardrail.run(
agent=Agent(name="test"), agent_output="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info == "test_4"
assert guardrail.get_name() == "Custom name"
@pytest.mark.asyncio
async def test_input_guardrail_run_in_parallel_default():
guardrail = InputGuardrail(
guardrail_function=lambda ctx, agent, input: GuardrailFunctionOutput(
output_info=None, tripwire_triggered=False
)
)
assert guardrail.run_in_parallel is True
@pytest.mark.asyncio
async def test_input_guardrail_run_in_parallel_false():
guardrail = InputGuardrail(
guardrail_function=lambda ctx, agent, input: GuardrailFunctionOutput(
output_info=None, tripwire_triggered=False
),
run_in_parallel=False,
)
assert guardrail.run_in_parallel is False
@pytest.mark.asyncio
async def test_input_guardrail_decorator_with_run_in_parallel():
@input_guardrail(run_in_parallel=False)
def blocking_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="blocking",
tripwire_triggered=False,
)
assert blocking_guardrail.run_in_parallel is False
result = await blocking_guardrail.run(
agent=Agent(name="test"), input="test", context=RunContextWrapper(context=None)
)
assert not result.output.tripwire_triggered
assert result.output.output_info == "blocking"
@pytest.mark.asyncio
async def test_input_guardrail_decorator_with_name_and_run_in_parallel():
@input_guardrail(name="custom_name", run_in_parallel=False)
def named_blocking_guardrail(
context: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
return GuardrailFunctionOutput(
output_info="named_blocking",
tripwire_triggered=False,
)
assert named_blocking_guardrail.get_name() == "custom_name"
assert named_blocking_guardrail.run_in_parallel is False
@pytest.mark.asyncio
async def test_parallel_guardrail_runs_concurrently_with_agent():
guardrail_executed = False
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(MEDIUM_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="parallel_ok",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'hello'",
input_guardrails=[parallel_check],
model=model,
)
model.set_next_output([get_text_message("hello")])
result = await Runner.run(agent, "test input")
assert guardrail_executed is True
assert result.final_output is not None
assert len(result.input_guardrail_results) == 1
assert result.input_guardrail_results[0].output.output_info == "parallel_ok"
assert model.first_turn_args is not None, "Model should have been called in parallel mode"
@pytest.mark.asyncio
async def test_parallel_guardrail_runs_concurrently_with_agent_streaming():
guardrail_executed = False
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(SHORT_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="parallel_streaming_ok",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="streaming_agent",
instructions="Reply with 'hello'",
input_guardrails=[parallel_check],
model=model,
)
model.set_next_output([get_text_message("hello from stream")])
result = Runner.run_streamed(agent, "test input")
received_events = False
async for _event in result.stream_events():
received_events = True
assert guardrail_executed is True
assert received_events is True
assert model.first_turn_args is not None, "Model should have been called in parallel mode"
@pytest.mark.asyncio
async def test_blocking_guardrail_prevents_agent_execution():
guardrail_executed = False
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
guardrail_executed = True
await asyncio.sleep(MEDIUM_DELAY)
return GuardrailFunctionOutput(
output_info="security_violation",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'hello'",
input_guardrails=[blocking_check],
model=model,
)
model.set_next_output([get_text_message("hello")])
with pytest.raises(InputGuardrailTripwireTriggered) as exc_info:
await Runner.run(agent, "test input")
assert guardrail_executed is True
assert exc_info.value.guardrail_result.output.output_info == "security_violation"
assert model.first_turn_args is None, "Model should not have been called"
@pytest.mark.asyncio
async def test_blocking_guardrail_prevents_agent_execution_streaming():
guardrail_executed = False
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
guardrail_executed = True
await asyncio.sleep(MEDIUM_DELAY)
return GuardrailFunctionOutput(
output_info="blocked_streaming",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="streaming_agent",
instructions="Reply with a long message",
input_guardrails=[blocking_check],
model=model,
)
model.set_next_output([get_text_message("hello")])
result = Runner.run_streamed(agent, "test input")
with pytest.raises(InputGuardrailTripwireTriggered):
async for _event in result.stream_events():
pass
assert guardrail_executed is True
assert model.first_turn_args is None, "Model should not have been called"
@pytest.mark.asyncio
async def test_parallel_guardrail_may_not_prevent_tool_execution():
tool_was_executed = False
guardrail_executed = False
@function_tool
def fast_tool() -> str:
nonlocal tool_was_executed
tool_was_executed = True
return "tool_executed"
@input_guardrail(run_in_parallel=True)
async def slow_parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(LONG_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="slow_parallel_triggered",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="agent_with_tools",
instructions="Call the fast_tool immediately",
tools=[fast_tool],
input_guardrails=[slow_parallel_check],
model=model,
)
model.set_next_output([get_function_tool_call("fast_tool", arguments="{}")])
model.set_next_output([get_text_message("done")])
with pytest.raises(InputGuardrailTripwireTriggered):
await Runner.run(agent, "trigger guardrail")
assert guardrail_executed is True
assert tool_was_executed is True, (
"Expected tool to execute before slow parallel guardrail triggered"
)
assert model.first_turn_args is not None, "Model should have been called in parallel mode"
@pytest.mark.asyncio
async def test_parallel_guardrail_trip_cancels_model_task():
model_started = asyncio.Event()
model_cancelled = asyncio.Event()
model_finished = asyncio.Event()
@input_guardrail(run_in_parallel=True)
async def tripwire_after_model_starts(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
await asyncio.wait_for(model_started.wait(), timeout=1)
return GuardrailFunctionOutput(
output_info="parallel_tripwire",
tripwire_triggered=True,
)
model = FakeModel()
original_get_response = model.get_response
async def slow_get_response(*args, **kwargs):
model_started.set()
try:
await asyncio.sleep(0.02)
return await original_get_response(*args, **kwargs)
except asyncio.CancelledError:
model_cancelled.set()
raise
finally:
model_finished.set()
agent = Agent(
name="parallel_tripwire_agent",
instructions="Reply with 'hello'",
input_guardrails=[tripwire_after_model_starts],
model=model,
)
model.set_next_output([get_text_message("should_not_finish")])
with patch.object(model, "get_response", side_effect=slow_get_response):
with pytest.raises(InputGuardrailTripwireTriggered):
await Runner.run(agent, "trigger guardrail")
await asyncio.wait_for(model_finished.wait(), timeout=1)
assert model_started.is_set() is True
assert model_cancelled.is_set() is True
@pytest.mark.asyncio
async def test_parallel_guardrail_trip_compat_mode_does_not_cancel_model_task():
model_started = asyncio.Event()
model_cancelled = asyncio.Event()
model_finished = asyncio.Event()
@input_guardrail(run_in_parallel=True)
async def tripwire_after_model_starts(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
await asyncio.wait_for(model_started.wait(), timeout=1)
return GuardrailFunctionOutput(
output_info="parallel_tripwire",
tripwire_triggered=True,
)
model = FakeModel()
original_get_response = model.get_response
async def slow_get_response(*args, **kwargs):
model_started.set()
try:
await asyncio.sleep(0.02)
return await original_get_response(*args, **kwargs)
except asyncio.CancelledError:
model_cancelled.set()
raise
finally:
model_finished.set()
agent = Agent(
name="parallel_tripwire_agent",
instructions="Reply with 'hello'",
input_guardrails=[tripwire_after_model_starts],
model=model,
)
model.set_next_output([get_text_message("should_finish_without_cancel")])
with patch.object(model, "get_response", side_effect=slow_get_response):
with patch(
"agents.run.should_cancel_parallel_model_task_on_input_guardrail_trip",
return_value=False,
):
with pytest.raises(InputGuardrailTripwireTriggered):
await Runner.run(agent, "trigger guardrail")
await asyncio.wait_for(model_finished.wait(), timeout=1)
assert model_started.is_set() is True
assert model_cancelled.is_set() is False
@pytest.mark.asyncio
async def test_parallel_guardrail_may_not_prevent_tool_execution_streaming():
tool_was_executed = False
guardrail_executed = False
@function_tool
def fast_tool() -> str:
nonlocal tool_was_executed
tool_was_executed = True
return "tool_executed"
@input_guardrail(run_in_parallel=True)
async def slow_parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(LONG_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="slow_parallel_triggered_streaming",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="agent_with_tools",
instructions="Call the fast_tool immediately",
tools=[fast_tool],
input_guardrails=[slow_parallel_check],
model=model,
)
model.set_next_output([get_function_tool_call("fast_tool", arguments="{}")])
model.set_next_output([get_text_message("done")])
result = Runner.run_streamed(agent, "trigger guardrail")
with pytest.raises(InputGuardrailTripwireTriggered):
async for _event in result.stream_events():
pass
assert guardrail_executed is True
assert tool_was_executed is True, (
"Expected tool to execute before slow parallel guardrail triggered"
)
assert model.first_turn_args is not None, "Model should have been called in parallel mode"
@pytest.mark.asyncio
async def test_blocking_guardrail_prevents_tool_execution():
tool_was_executed = False
guardrail_executed = False
@function_tool
def dangerous_tool() -> str:
nonlocal tool_was_executed
tool_was_executed = True
return "tool_executed"
@input_guardrail(run_in_parallel=False)
async def security_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(MEDIUM_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="blocked_dangerous_input",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="agent_with_tools",
instructions="Call the dangerous_tool immediately",
tools=[dangerous_tool],
input_guardrails=[security_check],
model=model,
)
model.set_next_output([get_function_tool_call("dangerous_tool", arguments="{}")])
with pytest.raises(InputGuardrailTripwireTriggered):
await Runner.run(agent, "trigger guardrail")
assert guardrail_executed is True
assert tool_was_executed is False
assert model.first_turn_args is None, "Model should not have been called"
@pytest.mark.asyncio
async def test_blocking_guardrail_prevents_tool_execution_streaming():
tool_was_executed = False
guardrail_executed = False
@function_tool
def dangerous_tool() -> str:
nonlocal tool_was_executed
tool_was_executed = True
return "tool_executed"
@input_guardrail(run_in_parallel=False)
async def security_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(MEDIUM_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="blocked_dangerous_input_streaming",
tripwire_triggered=True,
)
model = FakeModel()
agent = Agent(
name="agent_with_tools",
instructions="Call the dangerous_tool immediately",
tools=[dangerous_tool],
input_guardrails=[security_check],
model=model,
)
model.set_next_output([get_function_tool_call("dangerous_tool", arguments="{}")])
result = Runner.run_streamed(agent, "trigger guardrail")
with pytest.raises(InputGuardrailTripwireTriggered):
async for _event in result.stream_events():
pass
assert guardrail_executed is True
assert tool_was_executed is False
assert model.first_turn_args is None, "Model should not have been called"
@pytest.mark.asyncio
async def test_parallel_guardrail_passes_agent_continues():
guardrail_executed = False
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(SHORT_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="parallel_passed",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'success'",
input_guardrails=[parallel_check],
model=model,
)
model.set_next_output([get_text_message("success")])
result = await Runner.run(agent, "test input")
assert guardrail_executed is True
assert result.final_output is not None
assert model.first_turn_args is not None, "Model should have been called"
@pytest.mark.asyncio
async def test_parallel_guardrail_passes_agent_continues_streaming():
guardrail_executed = False
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(SHORT_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="parallel_passed_streaming",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'success'",
input_guardrails=[parallel_check],
model=model,
)
model.set_next_output([get_text_message("success")])
result = Runner.run_streamed(agent, "test input")
received_events = False
async for _event in result.stream_events():
received_events = True
assert guardrail_executed is True
assert received_events is True
assert model.first_turn_args is not None, "Model should have been called"
@pytest.mark.asyncio
async def test_blocking_guardrail_passes_agent_continues():
guardrail_executed = False
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(MEDIUM_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="blocking_passed",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'success'",
input_guardrails=[blocking_check],
model=model,
)
model.set_next_output([get_text_message("success")])
result = await Runner.run(agent, "test input")
assert guardrail_executed is True
assert result.final_output is not None
assert model.first_turn_args is not None, "Model should have been called after guardrail passed"
@pytest.mark.asyncio
async def test_blocking_guardrail_passes_agent_continues_streaming():
guardrail_executed = False
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
nonlocal guardrail_executed
await asyncio.sleep(MEDIUM_DELAY)
guardrail_executed = True
return GuardrailFunctionOutput(
output_info="blocking_passed_streaming",
tripwire_triggered=False,
)
model = FakeModel()
agent = Agent(
name="test_agent",
instructions="Reply with 'success'",
input_guardrails=[blocking_check],
model=model,
)
model.set_next_output([get_text_message("success")])
result = Runner.run_streamed(agent, "test input")
received_events = False
async for _event in result.stream_events():
received_events = True
assert guardrail_executed is True
assert received_events is True
assert model.first_turn_args is not None, "Model should have been called after guardrail passed"
@pytest.mark.asyncio
async def test_mixed_blocking_and_parallel_guardrails():
timestamps = {}
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
timestamps["blocking_start"] = time.time()
await asyncio.sleep(MEDIUM_DELAY)
timestamps["blocking_end"] = time.time()
return GuardrailFunctionOutput(
output_info="blocking_passed",
tripwire_triggered=False,
)
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
timestamps["parallel_start"] = time.time()
await asyncio.sleep(MEDIUM_DELAY)
timestamps["parallel_end"] = time.time()
return GuardrailFunctionOutput(
output_info="parallel_passed",
tripwire_triggered=False,
)
model = FakeModel()
original_get_response = model.get_response
async def tracked_get_response(*args, **kwargs):
timestamps["model_called"] = time.time()
return await original_get_response(*args, **kwargs)
agent = Agent(
name="mixed_agent",
instructions="Reply with 'hello'",
input_guardrails=[blocking_check, parallel_check],
model=model,
)
model.set_next_output([get_text_message("hello")])
with patch.object(model, "get_response", side_effect=tracked_get_response):
result = await Runner.run(agent, "test input")
assert result.final_output is not None
assert len(result.input_guardrail_results) == 2
assert "blocking_start" in timestamps
assert "blocking_end" in timestamps
assert "parallel_start" in timestamps
assert "parallel_end" in timestamps
assert "model_called" in timestamps
assert timestamps["blocking_end"] <= timestamps["parallel_start"], (
"Blocking must complete before parallel starts"
)
assert timestamps["blocking_end"] <= timestamps["model_called"], (
"Blocking must complete before model is called"
)
assert timestamps["model_called"] <= timestamps["parallel_end"], (
"Model called while parallel guardrail still running"
)
assert model.first_turn_args is not None, (
"Model should have been called after blocking guardrails passed"
)
@pytest.mark.asyncio
async def test_mixed_blocking_and_parallel_guardrails_streaming():
timestamps = {}
@input_guardrail(run_in_parallel=False)
async def blocking_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
timestamps["blocking_start"] = time.time()
await asyncio.sleep(MEDIUM_DELAY)
timestamps["blocking_end"] = time.time()
return GuardrailFunctionOutput(
output_info="blocking_passed",
tripwire_triggered=False,
)
@input_guardrail(run_in_parallel=True)
async def parallel_check(
ctx: RunContextWrapper[Any], agent: Agent[Any], input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
timestamps["parallel_start"] = time.time()
await asyncio.sleep(MEDIUM_DELAY)
timestamps["parallel_end"] = time.time()
return GuardrailFunctionOutput(
output_info="parallel_passed",
tripwire_triggered=False,
)
model = FakeModel()
original_stream_response = model.stream_response
async def tracked_stream_response(*args, **kwargs):
timestamps["model_called"] = time.time()
async for event in original_stream_response(*args, **kwargs):
yield event
agent = Agent(
name="mixed_agent",
instructions="Reply with 'hello'",
input_guardrails=[blocking_check, parallel_check],
model=model,
)
model.set_next_output([get_text_message("hello")])
with patch.object(model, "stream_response", side_effect=tracked_stream_response):
result = Runner.run_streamed(agent, "test input")
received_events = False