-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathtest_process_tool.py
More file actions
795 lines (646 loc) · 30.5 KB
/
Copy pathtest_process_tool.py
File metadata and controls
795 lines (646 loc) · 30.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
"""Tests for process_tool.py."""
import os
from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from uipath.agent.models.agent import (
AgentProcessToolProperties,
AgentProcessToolResourceConfig,
AgentToolType,
)
from uipath.platform.common import WaitJob
from uipath.platform.orchestrator import Job
from uipath_langchain.agent.tools.process_tool import create_process_tool
@pytest.fixture
def process_resource():
"""Create a minimal process tool resource config."""
return AgentProcessToolResourceConfig(
type=AgentToolType.PROCESS,
name="test_process",
description="Test process description",
input_schema={"type": "object", "properties": {}},
output_schema={"type": "object", "properties": {}},
properties=AgentProcessToolProperties(
process_name="MyProcess",
folder_path="/Shared/MyFolder",
),
)
@pytest.fixture
def flow_resource():
"""Create a process tool resource config of type Flow (Maestro Flow release)."""
return AgentProcessToolResourceConfig(
type=AgentToolType.FLOW,
name="test_flow",
description="Test flow description",
input_schema={"type": "object", "properties": {}},
output_schema={"type": "object", "properties": {}},
properties=AgentProcessToolProperties(
process_name="MyFlow",
folder_path="/Shared/Flows",
),
)
@pytest.fixture
def function_resource():
"""Create a process tool resource config of type Function (coded function release)."""
return AgentProcessToolResourceConfig(
type=AgentToolType.FUNCTION,
name="test_function",
description="Test function description",
input_schema={"type": "object", "properties": {}},
output_schema={"type": "object", "properties": {}},
properties=AgentProcessToolProperties(
process_name="MyFunction",
folder_path="/Shared/Functions",
),
)
@pytest.fixture
def process_resource_with_inputs():
"""Create a process tool resource config with input arguments."""
return AgentProcessToolResourceConfig(
type=AgentToolType.PROCESS,
name="data_processor",
description="Process data with arguments",
input_schema={
"type": "object",
"properties": {
"name": {"type": "string"},
"count": {"type": "integer"},
},
},
output_schema={
"type": "object",
"properties": {
"result": {"type": "string"},
},
},
properties=AgentProcessToolProperties(
process_name="DataProcessor",
folder_path="/Shared/DataFolder",
),
)
class TestProcessToolMetadata:
"""Test that process tool has correct metadata for observability."""
def test_process_tool_has_metadata(self, process_resource):
"""Test that process tool has metadata dict."""
tool = create_process_tool(process_resource)
assert tool.metadata is not None
assert isinstance(tool.metadata, dict)
def test_process_tool_metadata_has_tool_type(self, process_resource):
"""Test that metadata contains tool_type derived from resource type."""
tool = create_process_tool(process_resource)
assert tool.metadata is not None
assert tool.metadata["tool_type"] == "process"
def test_process_tool_metadata_has_display_name(self, process_resource):
"""Test that metadata contains display_name from process_name."""
tool = create_process_tool(process_resource)
assert tool.metadata is not None
assert tool.metadata["display_name"] == "MyProcess"
@patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/TestFolder"})
def test_process_tool_metadata_has_folder_path(self, process_resource):
"""Test that metadata contains folder_path for span attributes."""
tool = create_process_tool(process_resource)
assert tool.metadata is not None
assert tool.metadata["folder_path"] == "/Shared/TestFolder"
def test_process_tool_metadata_has_span_context(self, process_resource):
"""Test that metadata contains _span_context dict for tracing."""
tool = create_process_tool(process_resource)
assert tool.metadata is not None
assert "_span_context" in tool.metadata
assert isinstance(tool.metadata["_span_context"], dict)
def test_process_tool_metadata_tool_type_uses_resource_type(self):
"""Test that tool_type is derived from resource.type.lower()."""
resource = AgentProcessToolResourceConfig(
type=AgentToolType.PROCESS,
name="test_process",
description="Test",
input_schema={"type": "object", "properties": {}},
output_schema={"type": "object", "properties": {}},
properties=AgentProcessToolProperties(
process_name="MyProcess",
folder_path="/Shared",
),
)
tool = create_process_tool(resource)
assert tool.metadata is not None
assert tool.metadata["tool_type"] == resource.type.lower()
class TestProcessToolInvocation:
"""Test process tool invocation behavior: invoke then interrupt."""
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/MyFolder"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_invoke_calls_processes_invoke_async(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that invoking the tool calls client.processes.invoke_async."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key-123"
mock_job.folder_key = "folder-key-123"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
await tool.ainvoke({})
mock_client.processes.invoke_async.assert_called_once_with(
name="MyProcess",
input_arguments={},
folder_path="/Shared/MyFolder",
attachments=[],
parent_span_id=None,
parent_operation_id=None,
run_as_me=None,
)
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_invoke_interrupts_with_wait_job(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that after invoking, the tool interrupts with WaitJobRaw."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key-456"
mock_job.folder_key = "folder-key-456"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
await tool.ainvoke({})
mock_interrupt.assert_called_once()
wait_job_arg = mock_interrupt.call_args[0][0]
assert isinstance(wait_job_arg, WaitJob)
assert wait_job_arg.job == mock_job
assert wait_job_arg.process_folder_key == "folder-key-456"
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/DataFolder"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_invoke_passes_input_arguments(
self, mock_uipath_class, mock_interrupt, process_resource_with_inputs
):
"""Test that input arguments are correctly passed to invoke_async."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource_with_inputs)
await tool.ainvoke({"name": "test-data", "count": 42})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["input_arguments"] == {"name": "test-data", "count": 42}
assert call_kwargs["name"] == "DataProcessor"
assert call_kwargs["folder_path"] == "/Shared/DataFolder"
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_invoke_returns_output_from_extract(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that the tool returns the extracted job output on success."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(
return_value='{"output_arg": "value123"}'
)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
result = await tool.ainvoke({})
assert result == {"output_arg": "value123"}
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_invoke_returns_error_message_on_faulted_job(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that the tool returns an error message string when the job is faulted."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "faulted"
mock_resumed_job.job_error = None
mock_resumed_job.info = "Something went wrong in the workflow"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
result = await tool.ainvoke({})
assert isinstance(result, str)
assert "Something went wrong in the workflow" in result
class TestProcessToolSpanContext:
"""Test that _span_context is properly wired for tracing."""
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_span_context_parent_span_id_passed_to_invoke(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that parent_span_id from _span_context is forwarded to invoke_async."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
assert tool.metadata is not None
# Simulate tracing setting parent_span_id via the shared _span_context
tool.metadata["_span_context"]["parent_span_id"] = "span-abc-123"
await tool.ainvoke({})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["parent_span_id"] == "span-abc-123"
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_span_context_consumed_after_invoke(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that parent_span_id is popped (consumed) from _span_context after use."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
assert tool.metadata is not None
tool.metadata["_span_context"]["parent_span_id"] = "span-xyz"
await tool.ainvoke({})
# parent_span_id should be consumed (popped) after invocation
assert "parent_span_id" not in tool.metadata["_span_context"]
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_span_context_defaults_to_none_when_empty(
self, mock_uipath_class, mock_interrupt, process_resource
):
"""Test that parent_span_id defaults to None when _span_context is empty."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
# Don't set any parent_span_id
await tool.ainvoke({})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["parent_span_id"] is None
class TestProcessToolRunAsMe:
"""Test RunAsMe propagation passed top-down from tool factory."""
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_run_as_me_true_passed_to_invoke(
self,
mock_uipath_class,
mock_interrupt,
process_resource,
):
"""Test RunAsMe=True is forwarded to invoke_async when set."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource, run_as_me=True)
await tool.ainvoke({})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["run_as_me"] is True
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_run_as_me_false_sends_none(
self,
mock_uipath_class,
mock_interrupt,
process_resource,
):
"""Test RunAsMe=None when run_as_me=False (default)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource, run_as_me=False)
await tool.ainvoke({})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["run_as_me"] is None
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_run_as_me_default_sends_none(
self,
mock_uipath_class,
mock_interrupt,
process_resource,
):
"""Test RunAsMe=None when run_as_me not specified (default)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource)
await tool.ainvoke({})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["run_as_me"] is None
class TestProcessToolFlowType:
"""Test that a Flow-type resource flows through create_process_tool correctly."""
def test_flow_tool_metadata_has_flow_tool_type(self, flow_resource):
"""A Flow resource produces a tool with metadata.tool_type == 'flow'."""
tool = create_process_tool(flow_resource)
assert tool.metadata is not None
assert tool.metadata["tool_type"] == "flow"
def test_flow_tool_metadata_has_display_name(self, flow_resource):
"""Flow tool metadata exposes the process_name as display_name."""
tool = create_process_tool(flow_resource)
assert tool.metadata is not None
assert tool.metadata["display_name"] == "MyFlow"
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/Flows"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_flow_tool_invokes_processes_invoke_async(
self, mock_uipath_class, mock_interrupt, flow_resource
):
"""Flow tool invokes client.processes.invoke_async (same path as Process)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "flow-job-key"
mock_job.folder_key = "flow-folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(flow_resource)
await tool.ainvoke({})
mock_client.processes.invoke_async.assert_called_once_with(
name="MyFlow",
input_arguments={},
folder_path="/Shared/Flows",
attachments=[],
parent_span_id=None,
parent_operation_id=None,
run_as_me=None,
)
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_flow_tool_uses_non_agent_bts_key(
self, mock_uipath_class, mock_interrupt, flow_resource
):
"""Flow tool stores the BTS tracking key under 'wait_for_job_key' (not agent variant)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "flow-job-key"
mock_job.folder_key = "flow-folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(flow_resource)
assert tool.metadata is not None
await tool.ainvoke({})
bts_context = tool.metadata["_bts_context"]
assert bts_context.get("wait_for_job_key") == "flow-job-key"
assert "wait_for_agent_job_key" not in bts_context
@pytest.fixture
def process_resource_with_conversation_id():
"""Resource whose input schema declares the reserved conversation-id arg."""
return AgentProcessToolResourceConfig(
type=AgentToolType.PROCESS,
name="conv_process",
description="Process that consumes conversation id",
input_schema={
"type": "object",
"properties": {
"topic": {"type": "string"},
"UIPATH_RESERVED_CONVERSATIONID": {"type": "string"},
},
},
output_schema={"type": "object", "properties": {}},
properties=AgentProcessToolProperties(
process_name="ConvProcess",
folder_path="/Shared/Conv",
),
)
class TestProcessToolConversationIdInjection:
"""Auto-inject conversation id when the tool's input schema declares it."""
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_CONVERSATION_ID": "conv-xyz"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_injects_conversation_id_when_schema_declares_it(
self,
mock_uipath_class,
mock_interrupt,
process_resource_with_conversation_id,
):
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource_with_conversation_id)
await tool.ainvoke({"topic": "hello"})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["input_arguments"] == {
"topic": "hello",
"UIPATH_RESERVED_CONVERSATIONID": "conv-xyz",
}
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_CONVERSATION_ID": "from-runtime"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_runtime_value_overrides_caller_supplied_value(
self,
mock_uipath_class,
mock_interrupt,
process_resource_with_conversation_id,
):
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource_with_conversation_id)
await tool.ainvoke(
{"topic": "hi", "UIPATH_RESERVED_CONVERSATIONID": "from-llm"}
)
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert (
call_kwargs["input_arguments"]["UIPATH_RESERVED_CONVERSATIONID"]
== "from-runtime"
)
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_omits_when_conversation_id_missing(
self,
mock_uipath_class,
mock_interrupt,
process_resource_with_conversation_id,
):
os.environ.pop("UIPATH_CONVERSATION_ID", None)
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource_with_conversation_id)
await tool.ainvoke({"topic": "hi"})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert call_kwargs["input_arguments"].get("UIPATH_RESERVED_CONVERSATIONID") is None
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_CONVERSATION_ID": "conv-xyz"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_skips_injection_when_schema_does_not_declare_it(
self,
mock_uipath_class,
mock_interrupt,
process_resource_with_inputs,
):
mock_job = MagicMock(spec=Job)
mock_job.key = "job-key"
mock_job.folder_key = "folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(process_resource_with_inputs)
await tool.ainvoke({"name": "x", "count": 1})
call_kwargs = mock_client.processes.invoke_async.call_args[1]
assert "UIPATH_RESERVED_CONVERSATIONID" not in call_kwargs["input_arguments"]
class TestProcessToolFunctionType:
"""Test that a Function-type resource flows through create_process_tool correctly."""
def test_function_tool_metadata_has_function_tool_type(self, function_resource):
"""A Function resource produces a tool with metadata.tool_type == 'function'."""
tool = create_process_tool(function_resource)
assert tool.metadata is not None
assert tool.metadata["tool_type"] == "function"
def test_function_tool_metadata_has_display_name(self, function_resource):
"""Function tool metadata exposes the process_name as display_name."""
tool = create_process_tool(function_resource)
assert tool.metadata is not None
assert tool.metadata["display_name"] == "MyFunction"
@pytest.mark.asyncio
@patch.dict(os.environ, {"UIPATH_FOLDER_PATH": "/Shared/Functions"})
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_function_tool_invokes_processes_invoke_async(
self, mock_uipath_class, mock_interrupt, function_resource
):
"""Function tool invokes client.processes.invoke_async (same path as Process)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "function-job-key"
mock_job.folder_key = "function-folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(function_resource)
await tool.ainvoke({})
mock_client.processes.invoke_async.assert_called_once_with(
name="MyFunction",
input_arguments={},
folder_path="/Shared/Functions",
attachments=[],
parent_span_id=None,
parent_operation_id=None,
run_as_me=None,
)
@pytest.mark.asyncio
@patch("uipath_langchain._utils.durable_interrupt.decorator.interrupt")
@patch("uipath_langchain.agent.tools.process_tool.UiPath")
async def test_function_tool_uses_non_agent_bts_key(
self, mock_uipath_class, mock_interrupt, function_resource
):
"""Function tool stores the BTS tracking key under 'wait_for_job_key' (not agent variant)."""
mock_job = MagicMock(spec=Job)
mock_job.key = "function-job-key"
mock_job.folder_key = "function-folder-key"
mock_resumed_job = MagicMock(spec=Job)
mock_resumed_job.state = "successful"
mock_client = MagicMock()
mock_client.processes.invoke_async = AsyncMock(return_value=mock_job)
mock_client.jobs.extract_output_async = AsyncMock(return_value=None)
mock_uipath_class.return_value = mock_client
mock_interrupt.return_value = mock_resumed_job
tool = create_process_tool(function_resource)
assert tool.metadata is not None
await tool.ainvoke({})
bts_context = tool.metadata["_bts_context"]
assert bts_context.get("wait_for_job_key") == "function-job-key"
assert "wait_for_agent_job_key" not in bts_context