-
-
Notifications
You must be signed in to change notification settings - Fork 223
Expand file tree
/
Copy pathtest_logs.py
More file actions
1550 lines (1396 loc) · 59.4 KB
/
test_logs.py
File metadata and controls
1550 lines (1396 loc) · 59.4 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 base64
import logging
from datetime import datetime, timedelta, timezone
from pathlib import Path
from typing import List
from unittest.mock import Mock, call
from uuid import UUID
import botocore.exceptions
import pytest
import pytest_asyncio
from freezegun import freeze_time
from pydantic import ValidationError
from sqlalchemy.ext.asyncio import AsyncSession
from dstack._internal.core.errors import ServerClientError
from dstack._internal.core.models.logs import LogEvent, LogEventSource
from dstack._internal.server.models import ProjectModel
from dstack._internal.server.schemas.logs import PollLogsRequest
from dstack._internal.server.schemas.runner import LogEvent as RunnerLogEvent
from dstack._internal.server.services.logs.aws import (
CloudWatchLogStorage,
)
from dstack._internal.server.services.logs.base import LogStorageError
from dstack._internal.server.services.logs.filelog import FileLogStorage
from dstack._internal.server.testing.common import create_project
class TestFileLogStorage:
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_writes_logs(self, test_db, session: AsyncSession, tmp_path: Path):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Hello"),
RunnerLogEvent(timestamp=1696586513235, message=b"World"),
],
job_logs=[],
)
runner_log_path = (
tmp_path
/ "projects"
/ project.name
/ "logs"
/ "test_run"
/ "1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"
/ "runner.log"
)
assert runner_log_path.read_text() == (
'{"timestamp":"2023-10-06T10:01:53.234000+00:00","log_source":"stdout","message":"SGVsbG8="}\n'
'{"timestamp":"2023-10-06T10:01:53.235000+00:00","log_source":"stdout","message":"V29ybGQ="}\n'
)
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_basic(self, test_db, session: AsyncSession, tmp_path: Path):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write test logs
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Log1"),
RunnerLogEvent(timestamp=1696586513235, message=b"Log2"),
RunnerLogEvent(timestamp=1696586513236, message=b"Log3"),
],
job_logs=[],
)
# Test basic polling without pagination
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=10,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 3
assert job_submission_logs.next_token is None # No more logs, so no next_token
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_with_next_token_pagination(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write test logs
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Log1"),
RunnerLogEvent(timestamp=1696586513235, message=b"Log2"),
RunnerLogEvent(timestamp=1696586513236, message=b"Log3"),
RunnerLogEvent(timestamp=1696586513237, message=b"Log4"),
RunnerLogEvent(timestamp=1696586513238, message=b"Log5"),
],
job_logs=[],
)
# First page: get 2 logs
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=2,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 2
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log1".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.logs[1].message == base64.b64encode(
"Log2".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.next_token == "2" # Next line to read
# Second page: use next_token
poll_request.next_token = job_submission_logs.next_token
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 2
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log3".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.logs[1].message == base64.b64encode(
"Log4".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.next_token == "4" # Next line to read
# Third page: get remaining log
poll_request.next_token = job_submission_logs.next_token
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 1
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log5".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.next_token is None # No more logs
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_with_start_from_specific_line(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write test logs
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Log1"),
RunnerLogEvent(timestamp=1696586513235, message=b"Log2"),
RunnerLogEvent(timestamp=1696586513236, message=b"Log3"),
],
job_logs=[],
)
# Start from line 1 (second log)
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
next_token="1",
limit=10,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 2
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log2".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.logs[1].message == base64.b64encode(
"Log3".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.next_token is None
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_invalid_next_token_raises_error(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Test with non-integer next_token
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
next_token="invalid",
limit=10,
diagnose=True,
)
with pytest.raises(ServerClientError):
log_storage.poll_logs(project, poll_request)
# Test with negative next_token
poll_request.next_token = "-1"
with pytest.raises(ServerClientError):
log_storage.poll_logs(project, poll_request)
# Test with float next_token
poll_request.next_token = "1.5"
with pytest.raises(ServerClientError):
log_storage.poll_logs(project, poll_request)
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_file_not_found_raises_no_error(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Test with non-existent log file
poll_request = PollLogsRequest(
run_name="nonexistent_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=10,
diagnose=True,
)
log_storage.poll_logs(project, poll_request)
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_with_time_filtering_and_pagination(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write test logs with different timestamps
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(
timestamp=1696586513234, message=b"Log1"
), # 2023-10-06T10:01:53.234
RunnerLogEvent(
timestamp=1696586513235, message=b"Log2"
), # 2023-10-06T10:01:53.235
RunnerLogEvent(
timestamp=1696586513236, message=b"Log3"
), # 2023-10-06T10:01:53.236
RunnerLogEvent(
timestamp=1696586513237, message=b"Log4"
), # 2023-10-06T10:01:53.237
],
job_logs=[],
)
# Filter logs after 2023-10-06T10:01:53.235 with pagination
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
start_time=datetime(2023, 10, 6, 10, 1, 53, 235000, timezone.utc),
limit=1,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
# Should get Log3 first (timestamp > 235)
assert len(job_submission_logs.logs) == 1
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log3".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.next_token == "3"
# Get next page
poll_request.next_token = job_submission_logs.next_token
job_submission_logs = log_storage.poll_logs(project, poll_request)
# Should get Log4
assert len(job_submission_logs.logs) == 1
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log4".encode("utf-8")
).decode("utf-8")
# Should not have next_token since we reached end of file
assert job_submission_logs.next_token is None
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_empty_file_returns_empty_list(
self, test_db, session: AsyncSession, tmp_path: Path
):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Create empty log file
log_file_path = (
tmp_path
/ "projects"
/ project.name
/ "logs"
/ "test_run"
/ "1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"
/ "runner.log"
)
log_file_path.parent.mkdir(parents=True, exist_ok=True)
log_file_path.write_text("")
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=10,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 0
assert job_submission_logs.next_token is None
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_next_token_pagination_complete_workflow(
self, test_db, session: AsyncSession, tmp_path: Path
):
"""Test complete pagination workflow using next_token"""
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write 10 logs
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513000 + i, message=f"Log{i + 1}".encode())
for i in range(10)
],
job_logs=[],
)
# First page: get 3 logs
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=3,
diagnose=True,
)
page1 = log_storage.poll_logs(project, poll_request)
assert len(page1.logs) == 3
assert page1.logs[0].message == base64.b64encode("Log1".encode()).decode()
assert page1.logs[1].message == base64.b64encode("Log2".encode()).decode()
assert page1.logs[2].message == base64.b64encode("Log3".encode()).decode()
assert page1.next_token == "3" # Next line to read
# Second page: use next_token
poll_request.next_token = page1.next_token
page2 = log_storage.poll_logs(project, poll_request)
assert len(page2.logs) == 3
assert page2.logs[0].message == base64.b64encode("Log4".encode()).decode()
assert page2.logs[1].message == base64.b64encode("Log5".encode()).decode()
assert page2.logs[2].message == base64.b64encode("Log6".encode()).decode()
assert page2.next_token == "6"
# Third page: get more logs
poll_request.next_token = page2.next_token
page3 = log_storage.poll_logs(project, poll_request)
assert len(page3.logs) == 3
assert page3.logs[0].message == base64.b64encode("Log7".encode()).decode()
assert page3.logs[1].message == base64.b64encode("Log8".encode()).decode()
assert page3.logs[2].message == base64.b64encode("Log9".encode()).decode()
assert page3.next_token == "9"
# Fourth page: get last log
poll_request.next_token = page3.next_token
page4 = log_storage.poll_logs(project, poll_request)
assert len(page4.logs) == 1
assert page4.logs[0].message == base64.b64encode("Log10".encode()).decode()
assert page4.next_token is None # No more logs
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_next_token_with_time_filtering(
self, test_db, session: AsyncSession, tmp_path: Path
):
"""Test next_token behavior with time filtering"""
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write logs with different timestamps
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513000, message=b"Log1"), # Before filter
RunnerLogEvent(timestamp=1696586513100, message=b"Log2"), # Before filter
RunnerLogEvent(timestamp=1696586513200, message=b"Log3"), # After filter
RunnerLogEvent(timestamp=1696586513300, message=b"Log4"), # After filter
RunnerLogEvent(timestamp=1696586513400, message=b"Log5"), # After filter
],
job_logs=[],
)
# Filter logs after timestamp 150 with pagination
start_time = datetime.fromtimestamp(1696586513.150, tz=timezone.utc)
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
start_time=start_time,
limit=2,
diagnose=True,
)
page1 = log_storage.poll_logs(project, poll_request)
assert len(page1.logs) == 2
assert page1.logs[0].message == base64.b64encode("Log3".encode()).decode()
assert page1.logs[1].message == base64.b64encode("Log4".encode()).decode()
assert page1.next_token == "4"
# Get next page
poll_request.next_token = page1.next_token
page2 = log_storage.poll_logs(project, poll_request)
assert len(page2.logs) == 1
assert page2.logs[0].message == base64.b64encode("Log5".encode()).decode()
assert page2.next_token is None
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_next_token_edge_cases(self, test_db, session: AsyncSession, tmp_path: Path):
"""Test edge cases for next_token behavior"""
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write exactly one log
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513000, message=b"OnlyLog"),
],
job_logs=[],
)
# Request with limit higher than available logs
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=10,
diagnose=True,
)
result = log_storage.poll_logs(project, poll_request)
assert len(result.logs) == 1
assert result.logs[0].message == base64.b64encode("OnlyLog".encode()).decode()
assert result.next_token is None # No more logs available
# Request with limit equal to available logs
poll_request.limit = 1
result = log_storage.poll_logs(project, poll_request)
assert len(result.logs) == 1
assert result.logs[0].message == base64.b64encode("OnlyLog".encode()).decode()
assert result.next_token is None # No more logs available
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_next_token_beyond_file_end(
self, test_db, session: AsyncSession, tmp_path: Path
):
"""Test next_token that points beyond the end of file"""
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write 3 logs
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513000, message=b"Log1"),
RunnerLogEvent(timestamp=1696586513100, message=b"Log2"),
RunnerLogEvent(timestamp=1696586513200, message=b"Log3"),
],
job_logs=[],
)
# Use next_token that points beyond the file
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
next_token="10", # Points beyond the 3 logs in file
limit=5,
diagnose=True,
)
result = log_storage.poll_logs(project, poll_request)
assert len(result.logs) == 0
assert result.next_token is None
class TestPollLogsRequestValidation:
def test_descending_true_not_supported(self):
"""Test that descending: true raises a validation error."""
with pytest.raises(ValidationError, match="descending: true is not supported"):
PollLogsRequest(
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
descending=True,
)
def test_descending_false_is_supported(self):
"""Test that descending: false works correctly."""
request = PollLogsRequest(
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
descending=False,
)
assert request.descending is False
@pytest.mark.asyncio
@pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
async def test_poll_logs_with_limit(self, test_db, session: AsyncSession, tmp_path: Path):
project = await create_project(session=session)
log_storage = FileLogStorage(tmp_path)
# Write more logs than the limit
log_storage.write_logs(
project=project,
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Log1"),
RunnerLogEvent(timestamp=1696586513235, message=b"Log2"),
RunnerLogEvent(timestamp=1696586513236, message=b"Log3"),
RunnerLogEvent(timestamp=1696586513237, message=b"Log4"),
RunnerLogEvent(timestamp=1696586513238, message=b"Log5"),
],
job_logs=[],
)
logs = log_storage.poll_logs(
project,
PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
start_time=None,
end_time=None,
limit=1000,
diagnose=True,
),
).logs
assert len(logs) == 5
# Test with limit smaller than total logs
poll_request = PollLogsRequest(
run_name="test_run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
limit=3,
diagnose=True,
)
job_submission_logs = log_storage.poll_logs(project, poll_request)
# Should return only the first 3 logs and provide next_token
assert len(job_submission_logs.logs) == 3
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log1".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.logs[1].message == base64.b64encode(
"Log2".encode("utf-8")
).decode("utf-8")
assert job_submission_logs.logs[2].message == base64.b64encode(
"Log3".encode("utf-8")
).decode("utf-8")
# Should have next_token pointing to line 3 (fourth log)
assert job_submission_logs.next_token == "3"
# Test with limit of 1 and time filtering
poll_request.limit = 1
poll_request.start_time = logs[3].timestamp
job_submission_logs = log_storage.poll_logs(project, poll_request)
assert len(job_submission_logs.logs) == 1
assert job_submission_logs.logs[0].message == base64.b64encode(
"Log5".encode("utf-8")
).decode("utf-8")
# Should not have next_token since we reached end of file
assert job_submission_logs.next_token is None
class TestCloudWatchLogStorage:
FAKE_NOW = datetime(2023, 10, 6, 10, 1, 54, tzinfo=timezone.utc)
@freeze_time(FAKE_NOW)
@pytest_asyncio.fixture
async def project(self, test_db, session: AsyncSession) -> ProjectModel:
project = await create_project(session=session, name="test-proj")
return project
@pytest.fixture
def mock_client(self, monkeypatch: pytest.MonkeyPatch) -> Mock:
mock = Mock()
monkeypatch.setattr("boto3.Session.client", Mock(return_value=mock))
mock.get_log_events.return_value = {
"events": [],
"nextBackwardToken": "bwd",
"nextForwardToken": "fwd",
}
return mock
@pytest.fixture
def log_storage(self, mock_client: Mock) -> CloudWatchLogStorage:
return CloudWatchLogStorage(group="test-group")
@pytest.fixture
def mock_ensure_stream_exists(self, monkeypatch: pytest.MonkeyPatch) -> Mock:
mock = Mock()
monkeypatch.setattr(CloudWatchLogStorage, "_ensure_stream_exists", mock)
return mock
@pytest.fixture
def poll_logs_request(self) -> PollLogsRequest:
return PollLogsRequest(
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
start_time=None,
end_time=None,
limit=100,
)
def test_init_error_client_instantiation_exception(self, monkeypatch: pytest.MonkeyPatch):
monkeypatch.setattr(
"boto3.Session.client", Mock(side_effect=botocore.exceptions.NoRegionError)
)
with pytest.raises(LogStorageError, match="NoRegionError"):
CloudWatchLogStorage(group="test-group")
def test_init_error_client_request_error(self, mock_client: Mock):
mock_client.describe_log_streams.side_effect = botocore.exceptions.ClientError({}, "name")
with pytest.raises(LogStorageError, match="ClientError"):
CloudWatchLogStorage(group="test-group")
def test_init_error_group_not_found(self, mock_client: Mock):
mock_client.describe_log_streams.side_effect = botocore.exceptions.ClientError(
{"Error": {"Code": "ResourceNotFoundException"}}, "op_name"
)
with pytest.raises(LogStorageError, match=r"'test-group' does not exist"):
CloudWatchLogStorage(group="test-group")
def test_ensure_stream_exists_new(self, log_storage: CloudWatchLogStorage, mock_client: Mock):
mock_client.describe_log_streams.reset_mock()
mock_client.describe_log_streams.return_value = {
"logStreams": [{"logStreamName": "test-stream-1"}]
}
log_storage._ensure_stream_exists("test-stream")
assert "test-stream" in log_storage._streams
mock_client.describe_log_streams.assert_called_once_with(
logGroupName="test-group", logStreamNamePrefix="test-stream"
)
mock_client.create_log_stream.assert_called_once_with(
logGroupName="test-group", logStreamName="test-stream"
)
def test_ensure_stream_exists_existing(
self, log_storage: CloudWatchLogStorage, mock_client: Mock
):
mock_client.describe_log_streams.reset_mock()
mock_client.describe_log_streams.return_value = {
"logStreams": [{"logStreamName": "test-stream"}]
}
log_storage._ensure_stream_exists("test-stream")
assert "test-stream" in log_storage._streams
mock_client.describe_log_streams.assert_called_once_with(
logGroupName="test-group", logStreamNamePrefix="test-stream"
)
mock_client.create_log_stream.assert_not_called()
def test_ensure_stream_exists_cached(
self, log_storage: CloudWatchLogStorage, mock_client: Mock
):
mock_client.describe_log_streams.reset_mock()
log_storage._streams.add("test-stream")
log_storage._ensure_stream_exists("test-stream")
mock_client.describe_log_streams.assert_not_called()
mock_client.create_log_stream.assert_not_called()
def test_ensure_stream_exists_cached_forced(
self, log_storage: CloudWatchLogStorage, mock_client: Mock
):
mock_client.describe_log_streams.reset_mock()
mock_client.describe_log_streams.return_value = {"logStreams": []}
log_storage._streams.add("test-stream")
log_storage._ensure_stream_exists("test-stream", force=True)
assert "test-stream" in log_storage._streams
mock_client.describe_log_streams.assert_called_once_with(
logGroupName="test-group", logStreamNamePrefix="test-stream"
)
mock_client.create_log_stream.assert_called_once_with(
logGroupName="test-group", logStreamName="test-stream"
)
@pytest.mark.asyncio
@pytest.mark.parametrize("descending", [False, True])
async def test_poll_logs_empty_response(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
descending: bool,
):
mock_client.get_log_events.return_value["events"] = []
poll_logs_request.descending = descending
job_submission_logs = log_storage.poll_logs(project, poll_logs_request)
assert job_submission_logs.logs == []
assert mock_client.get_log_events.call_count == 1
@pytest.mark.asyncio
async def test_poll_logs_descending_some_responses_are_empty(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
# Test that the current implementation returns the events from a single API call
mock_client.get_log_events.return_value = {
"events": [
{"timestamp": 1696586513234, "message": "SGVsbG8="},
{"timestamp": 1696586513235, "message": "V29ybGQ="},
],
"nextBackwardToken": "bwd3",
"nextForwardToken": "fwd",
}
poll_logs_request.descending = True
poll_logs_request.limit = 3
job_submission_logs = log_storage.poll_logs(project, poll_logs_request)
assert job_submission_logs.logs == [
LogEvent(
timestamp=datetime(2023, 10, 6, 10, 1, 53, 235000, tzinfo=timezone.utc),
log_source=LogEventSource.STDOUT,
message="V29ybGQ=",
),
LogEvent(
timestamp=datetime(2023, 10, 6, 10, 1, 53, 234000, tzinfo=timezone.utc),
log_source=LogEventSource.STDOUT,
message="SGVsbG8=",
),
]
assert mock_client.get_log_events.call_count == 1
@pytest.mark.asyncio
async def test_poll_logs_descending_empty_response_with_same_token(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
# Test empty response from a single API call
mock_client.get_log_events.return_value = {
"events": [],
"nextBackwardToken": "bwd",
"nextForwardToken": "fwd",
}
poll_logs_request.descending = True
job_submission_logs = log_storage.poll_logs(project, poll_logs_request)
assert job_submission_logs.logs == []
assert mock_client.get_log_events.call_count == 1
@pytest.mark.asyncio
async def test_poll_logs_descending_empty_response_max_tries(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
# Test empty response from a single API call
mock_client.get_log_events.return_value = {
"events": [],
"nextBackwardToken": "bwd1",
"nextForwardToken": "fwd",
}
poll_logs_request.descending = True
job_submission_logs = log_storage.poll_logs(project, poll_logs_request)
assert job_submission_logs.logs == []
assert mock_client.get_log_events.call_count == 1
@pytest.mark.asyncio
async def test_poll_logs_request_params_asc_no_diag_no_dates(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
poll_logs_request.descending = False
poll_logs_request.limit = 5
poll_logs_request.diagnose = False
log_storage.poll_logs(project, poll_logs_request)
assert mock_client.get_log_events.call_count == 1
mock_client.get_log_events.assert_called_with(
logGroupName="test-group",
logStreamName="test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/job",
limit=5,
startFromHead=True,
endTime=mock_client.get_log_events.call_args.kwargs[
"endTime"
], # endTime is set to "now"
)
@pytest.mark.asyncio
async def test_poll_logs_request_params_desc_diag_with_dates(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
# Ensure the response has events
mock_client.get_log_events.return_value["events"] = [
{"timestamp": 1696586513234, "message": "SGVsbG8="}
]
poll_logs_request.start_time = datetime(
2023, 10, 6, 10, 1, 53, 234000, tzinfo=timezone.utc
)
poll_logs_request.end_time = datetime(2023, 10, 7, 10, 1, 53, 234000, tzinfo=timezone.utc)
poll_logs_request.descending = True
poll_logs_request.limit = 10
poll_logs_request.diagnose = True
log_storage.poll_logs(project, poll_logs_request)
assert mock_client.get_log_events.call_count == 1
mock_client.get_log_events.assert_called_with(
logGroupName="test-group",
logStreamName="test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/runner",
limit=10,
startFromHead=False,
startTime=1696586513235, # start_time + 1ms
endTime=1696672913234,
)
@pytest.mark.asyncio
async def test_poll_logs_exception_resource_not_found(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
mock_client.get_log_events.side_effect = botocore.exceptions.ClientError(
{"Error": {"Code": "ResourceNotFoundException"}}, "op_name"
)
job_submission_logs = log_storage.poll_logs(project, poll_logs_request)
assert job_submission_logs.logs == []
@pytest.mark.asyncio
async def test_poll_logs_exception_other(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
poll_logs_request: PollLogsRequest,
):
mock_client.get_log_events.side_effect = botocore.exceptions.ClientError(
{"Error": {"Code": "SomeError"}}, "op_name"
)
with pytest.raises(LogStorageError, match="ClientError"):
log_storage.poll_logs(project, poll_logs_request)
@pytest.mark.asyncio
@freeze_time(FAKE_NOW)
async def test_write_logs(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
mock_ensure_stream_exists: Mock,
):
log_storage.write_logs(
project=project,
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Hello"),
],
job_logs=[
RunnerLogEvent(timestamp=1696586513235, message=b"World"),
],
)
expected_runner_stream = "test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/runner"
expected_job_stream = "test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/job"
expected_ensure_stream_exists_calls = [
call(expected_runner_stream),
call(expected_job_stream),
]
expected_put_log_events_calls = [
call(
logGroupName="test-group",
logStreamName=expected_runner_stream,
logEvents=[
{"timestamp": 1696586513234, "message": "SGVsbG8="},
],
),
call(
logGroupName="test-group",
logStreamName=expected_job_stream,
logEvents=[
{"timestamp": 1696586513235, "message": "V29ybGQ="},
],
),
]
assert mock_ensure_stream_exists.call_count == 2
mock_ensure_stream_exists.assert_has_calls(
expected_ensure_stream_exists_calls, any_order=True
)
assert mock_client.put_log_events.call_count == 2
mock_client.put_log_events.assert_has_calls(expected_put_log_events_calls, any_order=True)
@pytest.mark.asyncio
@freeze_time(FAKE_NOW)
async def test_write_logs_resource_not_found(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
mock_ensure_stream_exists: Mock,
):
mock_client.put_log_events.side_effect = [
# First call -- exception
botocore.exceptions.ClientError(
{"Error": {"Code": "ResourceNotFoundException"}}, "op_name"
),
# Second call -- OK, stream has been recreated
None,
]
log_storage.write_logs(
project=project,
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Hello"),
],
job_logs=[],
)
assert mock_ensure_stream_exists.call_count == 2
mock_ensure_stream_exists.assert_has_calls(
[
call("test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/runner"),
call("test-proj/test-run/1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e/runner", force=True),
]
)
assert mock_client.put_log_events.call_count == 2
@pytest.mark.asyncio
@freeze_time(FAKE_NOW)
async def test_write_logs_other_exception(
self,
project: ProjectModel,
log_storage: CloudWatchLogStorage,
mock_client: Mock,
mock_ensure_stream_exists: Mock,
):
mock_ensure_stream_exists.side_effect = botocore.exceptions.ConnectionError(error="err")
with pytest.raises(LogStorageError, match="ConnectionError"):
log_storage.write_logs(
project=project,
run_name="test-run",
job_submission_id=UUID("1b0e1b45-2f8c-4ab6-8010-a0d1a3e44e0e"),
runner_logs=[
RunnerLogEvent(timestamp=1696586513234, message=b"Hello"),
],
job_logs=[],
)
@pytest.mark.asyncio