-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathtest_api_server_sql.py
More file actions
1933 lines (1776 loc) · 66.6 KB
/
Copy pathtest_api_server_sql.py
File metadata and controls
1933 lines (1776 loc) · 66.6 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
import datetime
import json
import pytest
import sqlalchemy
from sqlalchemy import orm
from cloud_pipelines_backend import api_server_sql
from cloud_pipelines_backend import backend_types_sql as bts
from cloud_pipelines_backend import component_structures as structures
from cloud_pipelines_backend import database_ops
from cloud_pipelines_backend import errors
from cloud_pipelines_backend import filter_query_sql
class TestExecutionStatusSummary:
def test_initial_state(self):
summary = api_server_sql.ExecutionStatusSummary()
assert summary.total_executions == 0
assert summary.ended_executions == 0
assert summary.has_ended is False
def test_accumulate_all_ended_statuses(self):
"""Add each ended status with 2^i count for robust uniqueness."""
summary = api_server_sql.ExecutionStatusSummary()
ended_statuses = sorted(bts.CONTAINER_STATUSES_ENDED, key=lambda s: s.value)
expected_total = 0
expected_ended = 0
for i, status in enumerate(ended_statuses):
count = 2**i
summary.count_execution_status(status=status, count=count)
expected_total += count
expected_ended += count
assert summary.total_executions == expected_total
assert summary.ended_executions == expected_ended
assert summary.has_ended is True
def test_accumulate_all_in_progress_statuses(self):
"""Add each in-progress status with 2^i count for robust uniqueness."""
summary = api_server_sql.ExecutionStatusSummary()
in_progress_statuses = sorted(
set(bts.ContainerExecutionStatus) - bts.CONTAINER_STATUSES_ENDED,
key=lambda s: s.value,
)
expected_total = 0
for i, status in enumerate(in_progress_statuses):
count = 2**i
summary.count_execution_status(status=status, count=count)
expected_total += count
assert summary.total_executions == expected_total
assert summary.ended_executions == 0
assert summary.has_ended is False
def test_accumulate_all_statuses(self):
"""Add every status with 2^i count. Summary math must be exact."""
summary = api_server_sql.ExecutionStatusSummary()
all_statuses = sorted(bts.ContainerExecutionStatus, key=lambda s: s.value)
expected_total = 0
expected_ended = 0
for i, status in enumerate(all_statuses):
count = 2**i
expected_total += count
if status in bts.CONTAINER_STATUSES_ENDED:
expected_ended += count
summary.count_execution_status(status=status, count=count)
assert summary.total_executions == expected_total
assert summary.ended_executions == expected_ended
assert summary.has_ended == (expected_ended == expected_total)
def _make_task_spec(pipeline_name: str = "test-pipeline") -> structures.TaskSpec:
return structures.TaskSpec(
component_ref=structures.ComponentReference(
spec=structures.ComponentSpec(
name=pipeline_name,
implementation=structures.ContainerImplementation(
container=structures.ContainerSpec(image="test-image:latest"),
),
),
),
)
@pytest.fixture()
def session_factory():
engine = database_ops.create_db_engine(database_uri="sqlite://")
bts._TableBase.metadata.create_all(engine)
return orm.sessionmaker(engine)
@pytest.fixture()
def db_session(session_factory):
with session_factory() as session:
yield session
@pytest.fixture()
def service():
return api_server_sql.PipelineRunsApiService_Sql()
def _create_run(session_factory, service, **kwargs):
"""Create a pipeline run using a fresh session (mirrors production per-request sessions)."""
with session_factory() as session:
return service.create(session, **kwargs)
class TestPipelineRunServiceList:
def test_list_empty(self, session_factory, service):
with session_factory() as session:
result = service.list(
session=session,
)
assert result.pipeline_runs == []
assert result.next_page_token is None
def test_list_returns_pipeline_runs(self, session_factory, service):
_create_run(session_factory, service, root_task=_make_task_spec("pipeline-a"))
_create_run(session_factory, service, root_task=_make_task_spec("pipeline-b"))
with session_factory() as session:
result = service.list(
session=session,
)
assert len(result.pipeline_runs) == 2
def test_list_with_execution_stats(self, session_factory, service):
_create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
result = service.list(
session=session,
include_execution_stats=True,
)
assert len(result.pipeline_runs) == 1
assert result.pipeline_runs[0].execution_status_stats is not None
def test_list_filter_created_by(self, session_factory, service):
_create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
_create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user2",
)
with session_factory() as session:
result = service.list(
session=session,
filter="created_by:user1",
)
assert len(result.pipeline_runs) == 1
assert result.pipeline_runs[0].created_by == "user1"
def test_list_filter_created_by_empty_raises(self, session_factory, service):
with session_factory() as session:
with pytest.raises(errors.ApiValidationError, match="non-empty value"):
service.list(
session=session,
filter="created_by:",
)
def test_list_pagination(self, session_factory, service):
for i in range(12):
_create_run(
session_factory,
service,
root_task=_make_task_spec(f"pipeline-{i}"),
)
with session_factory() as session:
page1 = service.list(
session=session,
)
assert len(page1.pipeline_runs) == 10
assert page1.next_page_token is not None
assert "~" in page1.next_page_token
with session_factory() as session:
page2 = service.list(
session=session,
page_token=page1.next_page_token,
)
assert len(page2.pipeline_runs) == 2
assert page2.next_page_token is None
def test_list_cursor_pagination_order(self, session_factory, service):
for i in range(5):
_create_run(
session_factory,
service,
root_task=_make_task_spec(f"pipeline-{i}"),
)
with session_factory() as session:
result = service.list(session=session)
dates = [r.created_at for r in result.pipeline_runs]
assert dates == sorted(dates, reverse=True)
def test_list_cursor_pagination_no_overlap(self, session_factory, service):
for i in range(12):
_create_run(
session_factory,
service,
root_task=_make_task_spec(f"pipeline-{i}"),
)
with session_factory() as session:
page1 = service.list(session=session)
with session_factory() as session:
page2 = service.list(session=session, page_token=page1.next_page_token)
page1_ids = {r.id for r in page1.pipeline_runs}
page2_ids = {r.id for r in page2.pipeline_runs}
assert page1_ids.isdisjoint(page2_ids)
def test_list_cursor_pagination_stable_under_inserts(
self, session_factory, service
):
for i in range(12):
_create_run(
session_factory,
service,
root_task=_make_task_spec(f"pipeline-{i}"),
)
with session_factory() as session:
page1 = service.list(session=session)
page1_ids = {r.id for r in page1.pipeline_runs}
_create_run(
session_factory,
service,
root_task=_make_task_spec("pipeline-new"),
)
with session_factory() as session:
page2 = service.list(session=session, page_token=page1.next_page_token)
page2_ids = {r.id for r in page2.pipeline_runs}
assert page1_ids.isdisjoint(page2_ids)
assert len(page2.pipeline_runs) == 2
def test_list_invalid_page_token_raises(self, session_factory, service):
"""page_token without ~ raises ApiValidationError (422)."""
with session_factory() as session:
with pytest.raises(
errors.ApiValidationError, match="Unrecognized page_token"
):
service.list(session=session, page_token="not-a-cursor")
def test_list_filter_unsupported(self, session_factory, service):
with session_factory() as session:
with pytest.raises(NotImplementedError, match="Unsupported filter"):
service.list(
session=session,
filter="unknown_key:value",
)
def test_list_with_pipeline_names(self, session_factory, service):
_create_run(session_factory, service, root_task=_make_task_spec("my-pipeline"))
with session_factory() as session:
result = service.list(
session=session,
include_pipeline_names=True,
)
assert len(result.pipeline_runs) == 1
assert result.pipeline_runs[0].pipeline_name == "my-pipeline"
def test_list_filter_created_by_me(self, session_factory, service):
_create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="alice@example.com",
)
_create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="bob@example.com",
)
with session_factory() as session:
result = service.list(
session=session,
current_user="alice@example.com",
filter="created_by:me",
)
assert len(result.pipeline_runs) == 1
assert result.pipeline_runs[0].created_by == "alice@example.com"
def test_list_include_sql_default_none(self, session_factory, service):
_create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
result = service.list(session=session)
assert result.sql is None
def test_list_include_sql_true(self, session_factory, service):
_create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
result = service.list(session=session, include_sql=True)
expected = (
"SELECT pipeline_run.id, pipeline_run.root_execution_id,"
" pipeline_run.annotations, pipeline_run.created_by,"
" pipeline_run.created_at, pipeline_run.updated_at,"
" pipeline_run.parent_pipeline_id, pipeline_run.extra_data \n"
"FROM pipeline_run"
" ORDER BY pipeline_run.created_at DESC, pipeline_run.id DESC\n"
" LIMIT 10 OFFSET 0"
)
assert result.sql == expected
def test_list_include_sql_with_filter_query(self, session_factory, service):
run = _create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
service.set_annotation(session=session, id=run.id, key="team", value="ml")
fq = json.dumps({"and": [{"key_exists": {"key": "team"}}]})
with session_factory() as session:
result = service.list(session=session, filter_query=fq, include_sql=True)
expected = (
"SELECT pipeline_run.id, pipeline_run.root_execution_id,"
" pipeline_run.annotations, pipeline_run.created_by,"
" pipeline_run.created_at, pipeline_run.updated_at,"
" pipeline_run.parent_pipeline_id, pipeline_run.extra_data \n"
"FROM pipeline_run \n"
"WHERE EXISTS (SELECT pipeline_run_annotation.pipeline_run_id \n"
"FROM pipeline_run_annotation \n"
"WHERE pipeline_run_annotation.pipeline_run_id = pipeline_run.id"
" AND pipeline_run_annotation.\"key\" = 'team')"
" ORDER BY pipeline_run.created_at DESC, pipeline_run.id DESC\n"
" LIMIT 10 OFFSET 0"
)
assert result.sql == expected
def test_list_include_sql_with_cursor(self, session_factory, service):
for i in range(12):
_create_run(
session_factory,
service,
root_task=_make_task_spec(f"pipeline-{i}"),
)
with session_factory() as session:
page1 = service.list(session=session)
assert page1.next_page_token is not None
with session_factory() as session:
page2 = service.list(
session=session,
page_token=page1.next_page_token,
include_sql=True,
)
cursor_dt_iso, cursor_id = page1.next_page_token.split("~")
cursor_dt = datetime.datetime.fromisoformat(cursor_dt_iso)
sql_dt = cursor_dt.strftime("%Y-%m-%d %H:%M:%S.%f")
expected = (
"SELECT pipeline_run.id, pipeline_run.root_execution_id,"
" pipeline_run.annotations, pipeline_run.created_by,"
" pipeline_run.created_at, pipeline_run.updated_at,"
" pipeline_run.parent_pipeline_id, pipeline_run.extra_data \n"
"FROM pipeline_run \n"
f"WHERE (pipeline_run.created_at, pipeline_run.id)"
f" < ('{sql_dt}', '{cursor_id}')"
" ORDER BY pipeline_run.created_at DESC, pipeline_run.id DESC\n"
" LIMIT 10 OFFSET 0"
)
assert page2.sql == expected
class TestCreatePipelineRunResponse:
def test_base_response(self, session_factory, service):
run = _create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
response = service._create_pipeline_run_response(
session=session,
pipeline_run=db_run,
include_pipeline_names=False,
include_execution_stats=False,
)
assert response.id == run.id
assert response.pipeline_name is None
assert response.execution_status_stats is None
def test_pipeline_name_from_task_spec(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
)
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
response = service._create_pipeline_run_response(
session=session,
pipeline_run=db_run,
include_pipeline_names=True,
include_execution_stats=False,
)
assert response.pipeline_name == "my-pipeline"
def test_pipeline_name_from_extra_data(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("spec-name"),
)
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
db_run.extra_data = {"pipeline_name": "cached-name"}
session.commit()
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
response = service._create_pipeline_run_response(
session=session,
pipeline_run=db_run,
include_pipeline_names=True,
include_execution_stats=False,
)
assert response.pipeline_name == "cached-name"
def test_pipeline_name_none_when_no_execution_node(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("some-name"),
)
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
db_run.root_execution_id = "nonexistent-id"
db_run.extra_data = {}
session.commit()
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
response = service._create_pipeline_run_response(
session=session,
pipeline_run=db_run,
include_pipeline_names=True,
include_execution_stats=False,
)
assert response.pipeline_name is None
def test_with_execution_stats(self, session_factory, service):
run = _create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
db_run = session.get(bts.PipelineRun, run.id)
response = service._create_pipeline_run_response(
session=session,
pipeline_run=db_run,
include_pipeline_names=False,
include_execution_stats=True,
)
assert response.execution_status_stats is not None
class TestPipelineRunServiceCreate:
def test_create_returns_pipeline_run(self, session_factory, service):
result = _create_run(
session_factory, service, root_task=_make_task_spec("my-pipeline")
)
assert result.id is not None
assert result.root_execution_id is not None
assert result.created_at is not None
def test_create_with_created_by(self, session_factory, service):
result = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1@example.com",
)
assert result.created_by == "user1@example.com"
def test_create_with_annotations(self, session_factory, service):
annotations = {"team": "ml-ops", "project": "search"}
result = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
annotations=annotations,
)
assert result.annotations == annotations
def test_create_without_created_by(self, session_factory, service):
result = _create_run(session_factory, service, root_task=_make_task_spec())
assert result.created_by is None
def test_create_mirrors_name_and_created_by(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
created_by="alice",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== "my-pipeline"
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== "alice"
)
def test_create_mirrors_name_only(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("solo-pipeline"),
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== "solo-pipeline"
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== ""
)
def test_create_mirrors_created_by_only(self, session_factory, service):
task_spec = _make_task_spec("placeholder")
task_spec.component_ref.spec.name = None
run = _create_run(
session_factory, service, root_task=task_spec, created_by="alice"
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== "alice"
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== ""
)
def test_create_mirrors_empty_values_as_empty_string(
self, session_factory, service
):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(""),
created_by="",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== ""
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== ""
)
def test_create_mirrors_absent_values_as_empty_string(
self, session_factory, service
):
task_spec = _make_task_spec("placeholder")
task_spec.component_ref.spec.name = None
run = _create_run(session_factory, service, root_task=task_spec)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== ""
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== ""
)
class TestCreateMirrorsUserAnnotations:
def test_create_mirrors_user_annotations(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
annotations = {"team": "ml-ops", "project": "search"}
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
annotations=annotations,
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert mirrored["team"] == "ml-ops"
assert mirrored["project"] == "search"
def test_create_mirrors_user_annotations_empty_dict(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
annotations={},
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert set(mirrored.keys()) == {
filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY,
filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME,
}
def test_create_mirrors_user_annotations_none(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
annotations=None,
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert set(mirrored.keys()) == {
filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY,
filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME,
}
def test_create_skips_system_prefix_in_user_annotations(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
caplog: pytest.LogCaptureFixture,
) -> None:
annotations = {"system/foo": "bar", "valid": "ok"}
with caplog.at_level("WARNING"):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
annotations=annotations,
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert "valid" in mirrored
assert mirrored["valid"] == "ok"
assert "system/foo" not in mirrored
assert any("system/foo" in r.message for r in caplog.records)
def test_create_mirrors_user_annotations_none_value_as_empty_string(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
annotations = {"tag": None}
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
annotations=annotations,
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert mirrored["tag"] == ""
def test_create_user_annotations_coexist_with_system(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
created_by="alice",
annotations={"team": "a"},
)
with session_factory() as session:
mirrored = service.list_annotations(session=session, id=run.id)
assert mirrored["team"] == "a"
assert (
mirrored[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== "alice"
)
assert (
mirrored[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== "my-pipeline"
)
class TestPipelineRunAnnotationCrud:
def test_system_annotations_coexist_with_user_annotations(
self, session_factory, service
):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec("my-pipeline"),
created_by="alice",
)
with session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="ml-ops",
user_name="alice",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations["team"] == "ml-ops"
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME]
== "my-pipeline"
)
assert (
annotations[filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY]
== "alice"
)
def test_set_annotation(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="ml-ops",
user_name="user1",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations["team"] == "ml-ops"
def test_set_annotation_overwrites(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="old-value",
user_name="user1",
)
with session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="new-value",
user_name="user1",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations["team"] == "new-value"
def test_delete_annotation(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="ml-ops",
user_name="user1",
)
with session_factory() as session:
service.delete_annotation(
session=session,
id=run.id,
key="team",
user_name="user1",
)
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert "team" not in annotations
def test_list_annotations_only_system(self, session_factory, service):
run = _create_run(session_factory, service, root_task=_make_task_spec())
with session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations == {
filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME: "test-pipeline",
filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY: "",
}
def test_set_annotation_rejects_system_key(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with session_factory() as session:
with pytest.raises(
errors.ApiValidationError, match="reserved for system use"
):
service.set_annotation(
session=session,
id=run.id,
key="system/pipeline_run.created_by",
value="hacker",
user_name="user1",
)
def test_delete_annotation_rejects_system_key(self, session_factory, service):
run = _create_run(
session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with session_factory() as session:
with pytest.raises(
errors.ApiValidationError, match="reserved for system use"
):
service.delete_annotation(
session=session,
id=run.id,
key="system/pipeline_run.created_by",
user_name="user1",
)
class TestTruncateForAnnotation:
"""Unit tests for _truncate_for_annotation() helper."""
def test_exact_255_unchanged(self) -> None:
value = "a" * bts._STR_MAX_LENGTH
result = api_server_sql._truncate_for_annotation(
value=value,
field_name=filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME,
pipeline_run_id="run-1",
)
assert result == value
def test_256_truncated_and_logs_warning(self, caplog) -> None:
value = "b" * 256
field = filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME
with caplog.at_level("WARNING"):
result = api_server_sql._truncate_for_annotation(
value=value,
field_name=field,
pipeline_run_id="run-xyz",
)
assert result == "b" * bts._STR_MAX_LENGTH
assert len(caplog.records) == 1
msg = caplog.records[0].message
assert "run-xyz" in msg
assert str(field) in msg
class TestAnnotationValueOverflow:
"""Reproduction tests using mysql_varchar_limit_session_factory (SQLite TRIGGER
enforcement). These tests prove that >255 char values are rejected,
mimicking MySQL's DataError 1406.
Covers all write paths into pipeline_run_annotation:
- set_annotation(): long key, long value
- create() via _mirror_system_annotations(): long pipeline_name, long created_by
"""
def test_set_annotation_long_value_truncated(
self,
mysql_varchar_limit_session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
"""set_annotation() with a 300-char value is truncated to 255
via _mirror_single_annotation()."""
run = _create_run(
mysql_varchar_limit_session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with mysql_varchar_limit_session_factory() as session:
service.set_annotation(
session=session,
id=run.id,
key="team",
value="v" * 300,
user_name="user1",
)
with mysql_varchar_limit_session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations["team"] == "v" * bts._STR_MAX_LENGTH
def test_set_annotation_long_key_raises_on_overflow(
self,
mysql_varchar_limit_session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
"""set_annotation() with a 300-char key overflows the
VARCHAR(255) key column and triggers IntegrityError."""
run = _create_run(
mysql_varchar_limit_session_factory,
service,
root_task=_make_task_spec(),
created_by="user1",
)
with mysql_varchar_limit_session_factory() as session:
with pytest.raises(
sqlalchemy.exc.IntegrityError, match="Data too long.*key"
):
service.set_annotation(
session=session,
id=run.id,
key="k" * 300,
value="short",
user_name="user1",
)
def test_create_run_long_pipeline_name_truncated(
self,
mysql_varchar_limit_session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
"""create() with a 300-char pipeline name is truncated to 255
in _mirror_system_annotations()."""
run = _create_run(
mysql_varchar_limit_session_factory,
service,
root_task=_make_task_spec("p" * 300),
)
key = filter_query_sql.PipelineRunAnnotationSystemKey.PIPELINE_NAME
with mysql_varchar_limit_session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations[key] == "p" * bts._STR_MAX_LENGTH
def test_create_run_long_created_by_truncated(
self,
mysql_varchar_limit_session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
"""create() with a 300-char created_by is truncated to 255
in _mirror_system_annotations()."""
run = _create_run(
mysql_varchar_limit_session_factory,
service,
root_task=_make_task_spec(),
created_by="u" * 300,
)
key = filter_query_sql.PipelineRunAnnotationSystemKey.CREATED_BY
with mysql_varchar_limit_session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations[key] == "u" * bts._STR_MAX_LENGTH
def test_create_truncates_long_user_annotation_value(
self,
mysql_varchar_limit_session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
"""create() with a 300-char user annotation value is truncated to 255
via _mirror_pipeline_run_annotations()."""
run = _create_run(
mysql_varchar_limit_session_factory,
service,
root_task=_make_task_spec(),
annotations={"long_val": "x" * 300},
)
with mysql_varchar_limit_session_factory() as session:
annotations = service.list_annotations(session=session, id=run.id)
assert annotations["long_val"] == "x" * bts._STR_MAX_LENGTH
class TestSetAnnotationBehavior:
def test_set_annotation_none_value_stored_as_empty_string(
self,
session_factory: orm.sessionmaker,
service: api_server_sql.PipelineRunsApiService_Sql,
) -> None:
run = _create_run(
session_factory,