-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathtest_task_runner_coverage.py
More file actions
1030 lines (796 loc) · 39.9 KB
/
test_task_runner_coverage.py
File metadata and controls
1030 lines (796 loc) · 39.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
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
"""
Comprehensive test coverage for task_runner.py to achieve 95%+ coverage.
Tests focus on missing coverage areas including:
- Metrics collection
- Authorization handling
- Task context integration
- Different worker return types
- Error conditions
- Edge cases
"""
import logging
import os
import sys
import time
import unittest
from unittest.mock import patch, Mock, MagicMock, PropertyMock, call
from conductor.client.automator.task_runner import TaskRunner
from conductor.client.configuration.configuration import Configuration
from conductor.client.configuration.settings.metrics_settings import MetricsSettings
from conductor.client.context.task_context import TaskInProgress
from conductor.client.http.api.task_resource_api import TaskResourceApi
from conductor.client.http.models.task import Task
from conductor.client.http.models.task_result import TaskResult
from conductor.client.http.models.task_result_status import TaskResultStatus
from conductor.client.http.rest import AuthorizationException, ApiException
from conductor.client.worker.worker_interface import WorkerInterface
class MockWorker(WorkerInterface):
"""Mock worker for testing various scenarios"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01 # Fast polling for tests
def execute(self, task: Task) -> TaskResult:
task_result = self.get_task_result_from_task(task)
task_result.status = TaskResultStatus.COMPLETED
task_result.output_data = {'result': 'success'}
return task_result
class TaskInProgressWorker(WorkerInterface):
"""Worker that returns TaskInProgress"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01
def execute(self, task: Task) -> TaskInProgress:
return TaskInProgress(
callback_after_seconds=30,
output={'status': 'in_progress', 'progress': 50}
)
class DictReturnWorker(WorkerInterface):
"""Worker that returns a plain dict"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01
def execute(self, task: Task) -> dict:
return {'key': 'value', 'number': 42}
class StringReturnWorker(WorkerInterface):
"""Worker that returns unexpected type (string)"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01
def execute(self, task: Task) -> str:
return "unexpected_string_result"
class ObjectWithStatusWorker(WorkerInterface):
"""Worker that returns object with status attribute (line 207)"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01
def execute(self, task: Task):
# Return a mock object that has status but is not TaskResult or TaskInProgress
class CustomResult:
def __init__(self):
self.status = TaskResultStatus.COMPLETED
self.output_data = {'custom': 'result'}
self.task_id = task.task_id
self.workflow_instance_id = task.workflow_instance_id
return CustomResult()
class ContextModifyingWorker(WorkerInterface):
"""Worker that modifies context with logs and callbacks"""
def __init__(self, task_name='test_task'):
super().__init__(task_name)
self.poll_interval = 0.01
def execute(self, task: Task) -> TaskResult:
from conductor.client.context.task_context import get_task_context
ctx = get_task_context()
ctx.add_log("Starting task")
ctx.add_log("Processing data")
ctx.set_callback_after(45)
task_result = self.get_task_result_from_task(task)
task_result.status = TaskResultStatus.COMPLETED
task_result.output_data = {'result': 'success'}
return task_result
class TestTaskRunnerCoverage(unittest.TestCase):
"""Comprehensive test suite for TaskRunner coverage"""
def setUp(self):
"""Setup test fixtures"""
logging.disable(logging.CRITICAL)
# Clear any environment variables that might affect tests
for key in list(os.environ.keys()):
if key.startswith('CONDUCTOR_WORKER') or key.startswith('conductor_worker'):
os.environ.pop(key, None)
def tearDown(self):
"""Cleanup after tests"""
logging.disable(logging.NOTSET)
# Clear environment variables
for key in list(os.environ.keys()):
if key.startswith('CONDUCTOR_WORKER') or key.startswith('conductor_worker'):
os.environ.pop(key, None)
# ========================================
# Initialization and Configuration Tests
# ========================================
def test_initialization_with_metrics_settings(self):
"""Test TaskRunner initialization with metrics enabled"""
worker = MockWorker('test_task')
config = Configuration()
metrics_settings = MetricsSettings(update_interval=0.1)
task_runner = TaskRunner(
worker=worker,
configuration=config,
metrics_settings=metrics_settings
)
self.assertIsNotNone(task_runner.metrics_collector)
self.assertEqual(task_runner.worker, worker)
self.assertEqual(task_runner.configuration, config)
def test_initialization_without_metrics_settings(self):
"""Test TaskRunner initialization without metrics"""
worker = MockWorker('test_task')
config = Configuration()
task_runner = TaskRunner(
worker=worker,
configuration=config,
metrics_settings=None
)
self.assertIsNone(task_runner.metrics_collector)
def test_initialization_creates_default_configuration(self):
"""Test that None configuration creates default Configuration"""
worker = MockWorker('test_task')
task_runner = TaskRunner(
worker=worker,
configuration=None
)
self.assertIsNotNone(task_runner.configuration)
self.assertIsInstance(task_runner.configuration, Configuration)
@patch.dict(os.environ, {
'conductor_worker_test_task_polling_interval': 'invalid_value'
}, clear=False)
def test_set_worker_properties_invalid_polling_interval(self):
"""Test handling of invalid polling interval in environment"""
worker = MockWorker('test_task')
# Should not raise an exception even with invalid value
task_runner = TaskRunner(
worker=worker,
configuration=Configuration()
)
# The important part is that it doesn't crash - the value will be modified due to
# the double-application on lines 359-365 and 367-371
self.assertIsNotNone(task_runner.worker)
# Verify the polling interval is still a number (not None or crashed)
self.assertIsInstance(task_runner.worker.get_polling_interval_in_seconds(), (int, float))
@patch.dict(os.environ, {
'conductor_worker_polling_interval': '5.5'
}, clear=False)
def test_set_worker_properties_valid_polling_interval(self):
"""Test setting valid polling interval from environment"""
worker = MockWorker('test_task')
task_runner = TaskRunner(
worker=worker,
configuration=Configuration()
)
self.assertEqual(task_runner.worker.poll_interval, 5.5)
# ========================================
# Run and Run Once Tests
# ========================================
@patch('time.sleep', Mock(return_value=None))
def test_run_with_configuration_logging(self):
"""Test run method applies logging configuration"""
worker = MockWorker('test_task')
config = Configuration()
task_runner = TaskRunner(
worker=worker,
configuration=config
)
# Mock run_once to exit after one iteration
with patch.object(task_runner, 'run_once', side_effect=[None, Exception("Exit loop")]):
with self.assertRaises(Exception):
task_runner.run()
@patch('time.sleep', Mock(return_value=None))
def test_run_without_configuration_sets_debug_logging(self):
"""Test run method sets DEBUG logging when configuration is None"""
worker = MockWorker('test_task')
task_runner = TaskRunner(
worker=worker,
configuration=Configuration()
)
# Set configuration to None to test the logging path
task_runner.configuration = None
# Mock run_once to exit after one iteration
with patch.object(task_runner, 'run_once', side_effect=[None, Exception("Exit loop")]):
with self.assertRaises(Exception):
task_runner.run()
@patch('time.sleep', Mock(return_value=None))
def test_run_once_with_exception_handling(self):
"""Test that run_once handles exceptions gracefully"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Mock __batch_poll_tasks to raise an exception
with patch.object(task_runner, '_TaskRunner__batch_poll_tasks', side_effect=Exception("Test error")):
# Should not raise, exception is caught
task_runner.run_once()
@patch('time.sleep', Mock(return_value=None))
def test_run_once_clears_task_definition_name_cache(self):
"""Test that run_once clears the task definition name cache"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
with patch.object(TaskResourceApi, 'poll', return_value=None):
with patch.object(worker, 'clear_task_definition_name_cache') as mock_clear:
task_runner.run_once()
mock_clear.assert_called_once()
# ========================================
# Poll Task Tests
# ========================================
@patch('time.sleep')
def test_poll_task_when_worker_paused(self, mock_sleep):
"""Test polling returns empty list when worker is paused"""
worker = MockWorker('test_task')
worker.paused = True
task_runner = TaskRunner(worker=worker)
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
@patch('time.sleep')
def test_poll_task_with_auth_failure_backoff(self, mock_sleep):
"""Test exponential backoff on authorization failures"""
worker = MockWorker('test_task')
# Ensure auth env vars do not cause ApiClient token refresh (which can call time.sleep internally).
with patch.dict(os.environ, {}, clear=True):
task_runner = TaskRunner(worker=worker)
# Simulate auth failure
task_runner._auth_failures = 2
task_runner._last_auth_failure = time.time()
with patch.object(TaskResourceApi, 'batch_poll', return_value=[]):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
# Should skip polling and return empty list due to backoff
self.assertEqual(tasks, [])
mock_sleep.assert_called_once_with(0.1)
@patch('time.sleep')
def test_poll_task_auth_failure_with_invalid_token(self, mock_sleep):
"""Test handling of authorization failure with invalid token"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Create mock response with INVALID_TOKEN error
mock_resp = Mock()
mock_resp.text = '{"error": "INVALID_TOKEN"}'
mock_http_resp = Mock()
mock_http_resp.resp = mock_resp
auth_exception = AuthorizationException(
status=401,
reason='Unauthorized',
http_resp=mock_http_resp
)
with patch.object(TaskResourceApi, 'batch_poll', side_effect=auth_exception):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
self.assertEqual(task_runner._auth_failures, 1)
self.assertGreater(task_runner._last_auth_failure, 0)
@patch('time.sleep')
def test_poll_task_auth_failure_without_invalid_token(self, mock_sleep):
"""Test handling of authorization failure without invalid token"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Create mock response with different error code
mock_resp = Mock()
mock_resp.text = '{"error": "FORBIDDEN"}'
mock_http_resp = Mock()
mock_http_resp.resp = mock_resp
auth_exception = AuthorizationException(
status=403,
reason='Forbidden',
http_resp=mock_http_resp
)
with patch.object(TaskResourceApi, 'batch_poll', side_effect=auth_exception):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
self.assertEqual(task_runner._auth_failures, 1)
@patch('time.sleep')
def test_poll_task_success_resets_auth_failures(self, mock_sleep):
"""Test that successful poll resets auth failure counter"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Set some auth failures in the past (so backoff has elapsed)
task_runner._auth_failures = 3
task_runner._last_auth_failure = time.time() - 100 # 100 seconds ago
test_task = Task(task_id='test_id', workflow_instance_id='wf_id')
with patch.object(TaskResourceApi, 'batch_poll', return_value=[test_task]):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(len(tasks), 1)
self.assertEqual(tasks[0], test_task)
self.assertEqual(task_runner._auth_failures, 0)
def test_poll_task_no_task_available_resets_auth_failures(self):
"""Test that empty result from successful poll resets auth failures"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Set some auth failures
task_runner._auth_failures = 2
with patch.object(TaskResourceApi, 'batch_poll', return_value=[]):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
self.assertEqual(task_runner._auth_failures, 0)
def test_poll_task_with_metrics_collector(self):
"""Test polling with metrics collection enabled publishes events"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
test_task = Task(task_id='test_id', workflow_instance_id='wf_id')
with patch.object(TaskResourceApi, 'batch_poll', return_value=[test_task]):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(len(tasks), 1)
self.assertEqual(tasks[0], test_task)
def test_poll_task_with_metrics_on_auth_error(self):
"""Test that auth error during poll publishes PollFailure event"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
# Create mock response with INVALID_TOKEN error
mock_resp = Mock()
mock_resp.text = '{"error": "INVALID_TOKEN"}'
mock_http_resp = Mock()
mock_http_resp.resp = mock_resp
auth_exception = AuthorizationException(
status=401,
reason='Unauthorized',
http_resp=mock_http_resp
)
with patch.object(TaskResourceApi, 'batch_poll', side_effect=auth_exception):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
self.assertEqual(task_runner._auth_failures, 1)
def test_poll_task_with_metrics_on_general_error(self):
"""Test that general error during poll publishes PollFailure event"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
with patch.object(TaskResourceApi, 'batch_poll', side_effect=Exception("General error")):
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(tasks, [])
def test_poll_task_with_domain(self):
"""Test polling with domain parameter"""
worker = MockWorker('test_task')
worker.domain = 'test_domain'
task_runner = TaskRunner(worker=worker)
test_task = Task(task_id='test_id', workflow_instance_id='wf_id')
with patch.object(TaskResourceApi, 'batch_poll', return_value=[test_task]) as mock_poll:
tasks = task_runner._TaskRunner__batch_poll_tasks(1)
self.assertEqual(len(tasks), 1)
self.assertEqual(tasks[0], test_task)
# Verify domain was passed
mock_poll.assert_called_once()
call_kwargs = mock_poll.call_args[1]
self.assertEqual(call_kwargs['domain'], 'test_domain')
# ========================================
# Execute Task Tests
# ========================================
def test_execute_task_returns_task_in_progress(self):
"""Test execution when worker returns TaskInProgress"""
worker = TaskInProgressWorker('test_task')
task_runner = TaskRunner(worker=worker)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, TaskResultStatus.IN_PROGRESS)
self.assertEqual(result.callback_after_seconds, 30)
self.assertEqual(result.output_data['status'], 'in_progress')
self.assertEqual(result.output_data['progress'], 50)
def test_execute_task_returns_dict(self):
"""Test execution when worker returns plain dict"""
worker = DictReturnWorker('test_task')
task_runner = TaskRunner(worker=worker)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, TaskResultStatus.COMPLETED)
self.assertEqual(result.output_data['key'], 'value')
self.assertEqual(result.output_data['number'], 42)
def test_execute_task_returns_unexpected_type(self):
"""Test execution when worker returns unexpected type (string)"""
worker = StringReturnWorker('test_task')
task_runner = TaskRunner(worker=worker)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, TaskResultStatus.COMPLETED)
self.assertIn('result', result.output_data)
self.assertEqual(result.output_data['result'], 'unexpected_string_result')
def test_execute_task_returns_object_with_status(self):
"""Test execution when worker returns object with status attribute (line 207)"""
worker = ObjectWithStatusWorker('test_task')
task_runner = TaskRunner(worker=worker)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
result = task_runner._TaskRunner__execute_task(test_task)
# The object with status should be used as-is (line 207)
self.assertEqual(result.status, TaskResultStatus.COMPLETED)
self.assertEqual(result.output_data['custom'], 'result')
def test_execute_task_with_context_modifications(self):
"""Test that context modifications (logs, callbacks) are merged"""
worker = ContextModifyingWorker('test_task')
task_runner = TaskRunner(worker=worker)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, TaskResultStatus.COMPLETED)
self.assertIsNotNone(result.logs)
self.assertEqual(len(result.logs), 2)
self.assertEqual(result.callback_after_seconds, 45)
def test_execute_task_with_metrics_collector(self):
"""Test task execution with metrics collection"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
with patch.object(task_runner.metrics_collector, 'record_task_execute_time'):
with patch.object(task_runner.metrics_collector, 'record_task_result_payload_size'):
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, TaskResultStatus.COMPLETED)
task_runner.metrics_collector.record_task_execute_time.assert_called_once()
task_runner.metrics_collector.record_task_result_payload_size.assert_called_once()
def test_execute_task_with_metrics_on_error(self):
"""Test metrics collection on task execution error"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
test_task = Task(
task_id='test_id',
workflow_instance_id='wf_id'
)
# Make worker throw exception
with patch.object(worker, 'execute', side_effect=Exception("Execution failed")):
with patch.object(task_runner.metrics_collector, 'increment_task_execution_error'):
result = task_runner._TaskRunner__execute_task(test_task)
self.assertEqual(result.status, "FAILED")
self.assertEqual(result.reason_for_incompletion, "Execution failed")
task_runner.metrics_collector.increment_task_execution_error.assert_called_once()
# ========================================
# Merge Context Modifications Tests
# ========================================
def test_merge_context_modifications_with_logs(self):
"""Test merging logs from context to task result"""
from conductor.client.http.models.task_exec_log import TaskExecLog
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
task_result.status = TaskResultStatus.COMPLETED
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.logs = [
TaskExecLog(log='Log 1', task_id='test_id', created_time=123),
TaskExecLog(log='Log 2', task_id='test_id', created_time=456)
]
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
self.assertIsNotNone(task_result.logs)
self.assertEqual(len(task_result.logs), 2)
def test_merge_context_modifications_with_callback(self):
"""Test merging callback_after_seconds from context"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
task_result.status = TaskResultStatus.COMPLETED
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.callback_after_seconds = 60
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
self.assertEqual(task_result.callback_after_seconds, 60)
def test_merge_context_modifications_prefers_task_result_callback(self):
"""Test that existing callback_after_seconds in task_result is preserved"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
task_result.callback_after_seconds = 30
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.callback_after_seconds = 60
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
# Should keep task_result value
self.assertEqual(task_result.callback_after_seconds, 30)
def test_merge_context_modifications_with_output_data_both_dicts(self):
"""Test merging output_data when both are dicts"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# Set task_result with a dict output (the common case, won't trigger line 299-302)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
task_result.output_data = {'key1': 'value1', 'key2': 'value2'}
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.output_data = {'key3': 'value3'}
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
# Since task_result.output_data IS a dict, the merge won't happen (line 298 condition)
self.assertEqual(task_result.output_data['key1'], 'value1')
self.assertEqual(task_result.output_data['key2'], 'value2')
# key3 won't be there because condition on line 298 fails
self.assertNotIn('key3', task_result.output_data)
def test_merge_context_modifications_with_output_data_non_dict(self):
"""Test merging when task_result.output_data is not a dict (line 299-302)"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
# To hit lines 301-302, we need:
# 1. context_result.output_data to be a dict (truthy)
# 2. task_result.output_data to NOT be an instance of dict
# 3. task_result.output_data to be truthy
# Create a custom class that is not a dict but is truthy and has dict-like behavior
class NotADict:
def __init__(self, data):
self.data = data
def __bool__(self):
return True
# Support dict unpacking for line 301
def keys(self):
return self.data.keys()
def __getitem__(self, key):
return self.data[key]
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
task_result.output_data = NotADict({'key1': 'value1'})
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.output_data = {'key2': 'value2'}
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
# Now lines 301-302 should have executed: merged both dicts
self.assertIsInstance(task_result.output_data, dict)
self.assertEqual(task_result.output_data['key1'], 'value1')
self.assertEqual(task_result.output_data['key2'], 'value2')
def test_merge_context_modifications_with_empty_task_result_output(self):
"""Test merging when task_result has no output_data (line 304)"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
# Leave output_data as None/empty
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.output_data = {'key2': 'value2'}
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
# Now it should use context_result.output_data (line 304)
self.assertEqual(task_result.output_data, {'key2': 'value2'})
def test_merge_context_modifications_context_output_only(self):
"""Test using context output when task_result has none"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result = TaskResult(task_id='test_id', workflow_instance_id='wf_id')
context_result.output_data = {'key1': 'value1'}
task_runner._TaskRunner__merge_context_modifications(task_result, context_result)
self.assertEqual(task_result.output_data['key1'], 'value1')
# ========================================
# Update Task Tests
# ========================================
@patch('time.sleep', Mock(return_value=None))
def test_update_task_with_retry_success(self):
"""Test update task succeeds on retry"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity()
)
task_result.status = TaskResultStatus.COMPLETED
mock_next_task = Task(task_id='next_id', workflow_instance_id='next_wf_id')
# First call fails, second succeeds
with patch.object(
TaskResourceApi,
'update_task_v2',
side_effect=[Exception("Network error"), mock_next_task]
) as mock_update:
response = task_runner._TaskRunner__update_task(task_result)
self.assertEqual(response, mock_next_task)
self.assertEqual(mock_update.call_count, 2)
@patch('time.sleep', Mock(return_value=None))
def test_update_task_with_metrics_on_error(self):
"""Test metrics collection on update error"""
worker = MockWorker('test_task')
metrics_settings = MetricsSettings()
task_runner = TaskRunner(
worker=worker,
metrics_settings=metrics_settings
)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity()
)
with patch.object(TaskResourceApi, 'update_task_v2', side_effect=Exception("Update failed")):
with patch.object(task_runner.metrics_collector, 'increment_task_update_error'):
response = task_runner._TaskRunner__update_task(task_result)
self.assertIsNone(response)
# Should be called 4 times (4 attempts)
self.assertEqual(
task_runner.metrics_collector.increment_task_update_error.call_count,
4
)
# ========================================
# v1 Fallback Tests (backward compat with Orkes Conductor < v5)
# ========================================
@patch('time.sleep', Mock(return_value=None))
def test_update_task_v2_404_falls_back_to_v1(self):
"""When server returns 404 for v2 endpoint, should fall back to v1 and return None."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity(),
status=TaskResultStatus.COMPLETED
)
with patch.object(TaskResourceApi, 'update_task_v2',
side_effect=ApiException(status=404)) as mock_v2, \
patch.object(TaskResourceApi, 'update_task', return_value='ok') as mock_v1:
result = task_runner._TaskRunner__update_task(task_result)
mock_v2.assert_called_once()
mock_v1.assert_called_once()
self.assertIsNone(result)
@patch('time.sleep', Mock(return_value=None))
def test_update_task_v2_405_falls_back_to_v1(self):
"""When server returns 405 for v2 endpoint (older Conductor), should fall back to v1."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity(),
status=TaskResultStatus.COMPLETED
)
with patch.object(TaskResourceApi, 'update_task_v2',
side_effect=ApiException(status=405)) as mock_v2, \
patch.object(TaskResourceApi, 'update_task', return_value='ok') as mock_v1:
result = task_runner._TaskRunner__update_task(task_result)
mock_v2.assert_called_once()
mock_v1.assert_called_once()
self.assertIsNone(result)
self.assertFalse(task_runner._use_update_v2)
@patch('time.sleep', Mock(return_value=None))
def test_update_task_v2_404_sets_v1_flag(self):
"""After a 404 on v2, _use_update_v2 flag must be False."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
self.assertTrue(task_runner._use_update_v2)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity(),
status=TaskResultStatus.COMPLETED
)
with patch.object(TaskResourceApi, 'update_task_v2',
side_effect=ApiException(status=404)), \
patch.object(TaskResourceApi, 'update_task', return_value='ok'):
task_runner._TaskRunner__update_task(task_result)
self.assertFalse(task_runner._use_update_v2)
@patch('time.sleep', Mock(return_value=None))
def test_update_task_uses_v1_only_after_flag_set(self):
"""Once _use_update_v2 is False, v2 is never called again."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_runner._use_update_v2 = False # pre-set as if fallback already happened
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity(),
status=TaskResultStatus.COMPLETED
)
with patch.object(TaskResourceApi, 'update_task_v2') as mock_v2, \
patch.object(TaskResourceApi, 'update_task', return_value='ok') as mock_v1:
result = task_runner._TaskRunner__update_task(task_result)
mock_v2.assert_not_called()
mock_v1.assert_called_once()
self.assertIsNone(result)
@patch('time.sleep', Mock(return_value=None))
def test_update_task_non_404_api_exception_does_not_fallback(self):
"""A non-404 ApiException (e.g. 500) should not trigger v1 fallback."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_result = TaskResult(
task_id='test_id',
workflow_instance_id='wf_id',
worker_id=worker.get_identity(),
status=TaskResultStatus.COMPLETED
)
with patch.object(TaskResourceApi, 'update_task_v2',
side_effect=ApiException(status=500)) as mock_v2, \
patch.object(TaskResourceApi, 'update_task') as mock_v1:
result = task_runner._TaskRunner__update_task(task_result)
# v2 called 4 times (all retries), v1 never called, flag unchanged
self.assertEqual(mock_v2.call_count, 4)
mock_v1.assert_not_called()
self.assertTrue(task_runner._use_update_v2)
self.assertIsNone(result)
@patch('time.sleep', Mock(return_value=None))
def test_execute_and_update_task_tight_loop_with_v1_polls_for_next(self):
"""When v1 is used, the tight loop should poll immediately for the next task."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_runner._use_update_v2 = False # simulate post-fallback state
first_task = Task(task_id='task_1', workflow_instance_id='wf_1')
second_task = Task(task_id='task_2', workflow_instance_id='wf_1')
# Execute returns a result, update v1 returns None, poll returns second task then empty
with patch.object(TaskResourceApi, 'update_task', return_value='ok') as mock_v1, \
patch.object(TaskResourceApi, 'batch_poll',
side_effect=[[second_task], []]) as mock_poll:
task_runner._TaskRunner__execute_and_update_task(first_task)
# update_task called twice (once per task), poll called twice (second_task then empty)
self.assertEqual(mock_v1.call_count, 2)
self.assertEqual(mock_poll.call_count, 2)
@patch('time.sleep', Mock(return_value=None))
def test_execute_and_update_task_tight_loop_stops_when_queue_empty_on_v1(self):
"""With v1, if poll returns nothing the tight loop exits cleanly."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
task_runner._use_update_v2 = False
task = Task(task_id='task_1', workflow_instance_id='wf_1')
with patch.object(TaskResourceApi, 'update_task', return_value='ok') as mock_v1, \
patch.object(TaskResourceApi, 'batch_poll', return_value=[]) as mock_poll:
task_runner._TaskRunner__execute_and_update_task(task)
mock_v1.assert_called_once()
mock_poll.assert_called_once()
@patch('time.sleep', Mock(return_value=None))
def test_execute_and_update_task_tight_loop_not_pollled_when_v2(self):
"""With v2, poll is NOT called inside the tight loop (v2 returns next task directly)."""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
first_task = Task(task_id='task_1', workflow_instance_id='wf_1')
with patch.object(TaskResourceApi, 'update_task_v2', return_value=None) as mock_v2, \
patch.object(TaskResourceApi, 'batch_poll') as mock_poll:
task_runner._TaskRunner__execute_and_update_task(first_task)
mock_v2.assert_called_once()
mock_poll.assert_not_called()
# ========================================
# Property and Environment Tests
# ========================================
@patch.dict(os.environ, {
'conductor_worker_test_task_polling_interval': '2.5',
'conductor_worker_test_task_domain': 'test_domain'
}, clear=False)
def test_get_property_value_from_env_task_specific(self):
"""Test getting task-specific property from environment"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
self.assertEqual(task_runner.worker.poll_interval, 2.5)
self.assertEqual(task_runner.worker.domain, 'test_domain')
@patch.dict(os.environ, {
'CONDUCTOR_WORKER_test_task_POLLING_INTERVAL': '3.0',
'CONDUCTOR_WORKER_test_task_DOMAIN': 'UPPER_DOMAIN'
}, clear=False)
def test_get_property_value_from_env_uppercase(self):
"""Test getting property from uppercase environment variable"""
worker = MockWorker('test_task')
task_runner = TaskRunner(worker=worker)
self.assertEqual(task_runner.worker.poll_interval, 3.0)
self.assertEqual(task_runner.worker.domain, 'UPPER_DOMAIN')