-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Expand file tree
/
Copy pathtest_artifact_service.py
More file actions
957 lines (838 loc) · 27.3 KB
/
test_artifact_service.py
File metadata and controls
957 lines (838 loc) · 27.3 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
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# pylint: disable=missing-class-docstring,missing-function-docstring
"""Tests for the artifact service."""
from datetime import datetime
import enum
import json
from pathlib import Path
from typing import Any
from typing import Optional
from typing import Union
from unittest import mock
from unittest.mock import patch
from urllib.parse import unquote
from urllib.parse import urlparse
from google.adk.artifacts.base_artifact_service import ArtifactVersion
from google.adk.artifacts.base_artifact_service import ensure_part
from google.adk.artifacts.file_artifact_service import FileArtifactService
from google.adk.artifacts.gcs_artifact_service import GcsArtifactService
from google.adk.artifacts.in_memory_artifact_service import InMemoryArtifactService
from google.adk.errors.input_validation_error import InputValidationError
from google.genai import types
import pytest
Enum = enum.Enum
# Define a fixed datetime object to be returned by datetime.now()
FIXED_DATETIME = datetime(2025, 1, 1, 12, 0, 0)
class ArtifactServiceType(Enum):
FILE = "FILE"
IN_MEMORY = "IN_MEMORY"
GCS = "GCS"
class MockBlob:
"""Mocks a GCS Blob object.
This class provides mock implementations for a few common GCS Blob methods,
allowing the user to test code that interacts with GCS without actually
connecting to a real bucket.
"""
def __init__(self, name: str) -> None:
"""Initializes a MockBlob.
Args:
name: The name of the blob.
"""
self.name = name
self.content: Optional[bytes] = None
self.content_type: Optional[str] = None
self.time_created = FIXED_DATETIME
self.metadata: dict[str, Any] = {}
def upload_from_string(
self, data: Union[str, bytes], content_type: Optional[str] = None
) -> None:
"""Mocks uploading data to the blob (from a string or bytes).
Args:
data: The data to upload (string or bytes).
content_type: The content type of the data (optional).
"""
if isinstance(data, str):
self.content = data.encode("utf-8")
elif isinstance(data, bytes):
self.content = data
else:
raise TypeError("data must be str or bytes")
if content_type:
self.content_type = content_type
def download_as_bytes(self) -> bytes:
"""Mocks downloading the blob's content as bytes.
Returns:
bytes: The content of the blob as bytes.
Raises:
Exception: If the blob doesn't exist (hasn't been uploaded to).
"""
if self.content is None:
return b""
return self.content
def delete(self) -> None:
"""Mocks deleting a blob."""
self.content = None
self.content_type = None
class MockBucket:
"""Mocks a GCS Bucket object."""
def __init__(self, name: str) -> None:
"""Initializes a MockBucket.
Args:
name: The name of the bucket.
"""
self.name = name
self.blobs: dict[str, MockBlob] = {}
def blob(self, blob_name: str) -> MockBlob:
"""Mocks getting a Blob object (doesn't create it in storage).
Args:
blob_name: The name of the blob.
Returns:
A MockBlob instance.
"""
if blob_name not in self.blobs:
self.blobs[blob_name] = MockBlob(blob_name)
return self.blobs[blob_name]
def get_blob(self, blob_name: str) -> Optional[MockBlob]:
"""Mocks getting a blob from storage if it exists and has content."""
blob = self.blobs.get(blob_name)
if blob and blob.content is not None:
return blob
return None
class MockClient:
"""Mocks the GCS Client."""
def __init__(self) -> None:
"""Initializes MockClient."""
self.buckets: dict[str, MockBucket] = {}
def bucket(self, bucket_name: str) -> MockBucket:
"""Mocks getting a Bucket object."""
if bucket_name not in self.buckets:
self.buckets[bucket_name] = MockBucket(bucket_name)
return self.buckets[bucket_name]
def list_blobs(self, bucket: MockBucket, prefix: Optional[str] = None):
"""Mocks listing blobs in a bucket, optionally with a prefix."""
if prefix:
return [
blob
for name, blob in bucket.blobs.items()
if name.startswith(prefix) and blob.content is not None
]
return [blob for blob in bucket.blobs.values() if blob.content is not None]
def mock_gcs_artifact_service():
with mock.patch("google.cloud.storage.Client", return_value=MockClient()):
return GcsArtifactService(bucket_name="test_bucket")
@pytest.fixture
def artifact_service_factory(tmp_path: Path):
"""Provides an artifact service constructor bound to the test tmp path."""
def factory(
service_type: ArtifactServiceType = ArtifactServiceType.IN_MEMORY,
):
if service_type == ArtifactServiceType.GCS:
return mock_gcs_artifact_service()
if service_type == ArtifactServiceType.FILE:
return FileArtifactService(root_dir=tmp_path / "artifacts")
return InMemoryArtifactService()
return factory
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_load_empty(service_type, artifact_service_factory):
"""Tests loading an artifact when none exists."""
artifact_service = artifact_service_factory(service_type)
assert not await artifact_service.load_artifact(
app_name="test_app",
user_id="test_user",
session_id="session_id",
filename="filename",
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_save_load_delete(service_type, artifact_service_factory):
"""Tests saving, loading, and deleting an artifact."""
artifact_service = artifact_service_factory(service_type)
artifact = types.Part.from_bytes(data=b"test_data", mime_type="text/plain")
app_name = "app0"
user_id = "user0"
session_id = "123"
filename = "file456"
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=artifact,
)
assert (
await artifact_service.load_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
== artifact
)
# Attempt to load a version that doesn't exist
assert not await artifact_service.load_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
version=3,
)
await artifact_service.delete_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
assert not await artifact_service.load_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_list_keys(service_type, artifact_service_factory):
"""Tests listing keys in the artifact service."""
artifact_service = artifact_service_factory(service_type)
artifact = types.Part.from_bytes(data=b"test_data", mime_type="text/plain")
app_name = "app0"
user_id = "user0"
session_id = "123"
filename = "filename"
filenames = [filename + str(i) for i in range(5)]
for f in filenames:
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=f,
artifact=artifact,
)
assert (
await artifact_service.list_artifact_keys(
app_name=app_name, user_id=user_id, session_id=session_id
)
== filenames
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_list_versions(service_type, artifact_service_factory):
"""Tests listing versions of an artifact."""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "123"
filename = "with/slash/filename"
versions = [
types.Part.from_bytes(
data=i.to_bytes(2, byteorder="big"), mime_type="text/plain"
)
for i in range(3)
]
versions.append(types.Part.from_text(text="hello"))
for i in range(4):
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=versions[i],
)
response_versions = await artifact_service.list_versions(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
assert response_versions == list(range(4))
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_list_keys_preserves_user_prefix(
service_type, artifact_service_factory
):
"""Tests that list_artifact_keys preserves 'user:' prefix in returned names."""
artifact_service = artifact_service_factory(service_type)
artifact = types.Part.from_bytes(data=b"test_data", mime_type="text/plain")
app_name = "app0"
user_id = "user0"
session_id = "123"
# Save artifacts with "user:" prefix (cross-session artifacts)
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename="user:document.pdf",
artifact=artifact,
)
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename="user:image.png",
artifact=artifact,
)
# Save session-scoped artifact without prefix
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename="session_file.txt",
artifact=artifact,
)
# List artifacts should return names with "user:" prefix for user-scoped artifacts
artifact_keys = await artifact_service.list_artifact_keys(
app_name=app_name, user_id=user_id, session_id=session_id
)
# Should contain prefixed names and session file
expected_keys = ["user:document.pdf", "user:image.png", "session_file.txt"]
assert sorted(artifact_keys) == sorted(expected_keys)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type", [ArtifactServiceType.IN_MEMORY, ArtifactServiceType.GCS]
)
async def test_list_artifact_versions_and_get_artifact_version(
service_type, artifact_service_factory
):
"""Tests listing artifact versions and getting a specific version."""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "123"
filename = "filename"
versions = [
types.Part.from_bytes(
data=i.to_bytes(2, byteorder="big"), mime_type="text/plain"
)
for i in range(4)
]
with patch(
"google.adk.artifacts.base_artifact_service.platform_time"
) as mock_platform_time:
mock_platform_time.get_time.return_value = FIXED_DATETIME.timestamp()
for i in range(4):
custom_metadata = {"key": "value" + str(i)}
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=versions[i],
custom_metadata=custom_metadata,
)
artifact_versions = await artifact_service.list_artifact_versions(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
expected_artifact_versions = []
for i in range(4):
metadata = {"key": "value" + str(i)}
if service_type == ArtifactServiceType.GCS:
uri = (
f"gs://test_bucket/{app_name}/{user_id}/{session_id}/{filename}/{i}"
)
else:
uri = f"memory://apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{filename}/versions/{i}"
expected_artifact_versions.append(
ArtifactVersion(
version=i,
canonical_uri=uri,
custom_metadata=metadata,
mime_type="text/plain",
create_time=FIXED_DATETIME.timestamp(),
)
)
assert artifact_versions == expected_artifact_versions
# Get latest artifact version when version is not specified
assert (
await artifact_service.get_artifact_version(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
== expected_artifact_versions[-1]
)
# Get artifact version by version number
assert (
await artifact_service.get_artifact_version(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
version=2,
)
== expected_artifact_versions[2]
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type", [ArtifactServiceType.IN_MEMORY, ArtifactServiceType.GCS]
)
async def test_list_artifact_versions_with_user_prefix(
service_type, artifact_service_factory
):
"""Tests listing artifact versions with user prefix."""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "123"
user_scoped_filename = "user:document.pdf"
versions = [
types.Part.from_bytes(
data=i.to_bytes(2, byteorder="big"), mime_type="text/plain"
)
for i in range(4)
]
with patch(
"google.adk.artifacts.base_artifact_service.platform_time"
) as mock_platform_time:
mock_platform_time.get_time.return_value = FIXED_DATETIME.timestamp()
for i in range(4):
custom_metadata = {"key": "value" + str(i)}
# Save artifacts with "user:" prefix (cross-session artifacts)
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=user_scoped_filename,
artifact=versions[i],
custom_metadata=custom_metadata,
)
artifact_versions = await artifact_service.list_artifact_versions(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=user_scoped_filename,
)
expected_artifact_versions = []
for i in range(4):
metadata = {"key": "value" + str(i)}
if service_type == ArtifactServiceType.GCS:
uri = f"gs://test_bucket/{app_name}/{user_id}/user/{user_scoped_filename}/{i}"
else:
uri = f"memory://apps/{app_name}/users/{user_id}/artifacts/{user_scoped_filename}/versions/{i}"
expected_artifact_versions.append(
ArtifactVersion(
version=i,
canonical_uri=uri,
custom_metadata=metadata,
mime_type="text/plain",
create_time=FIXED_DATETIME.timestamp(),
)
)
assert artifact_versions == expected_artifact_versions
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type", [ArtifactServiceType.IN_MEMORY, ArtifactServiceType.GCS]
)
async def test_get_artifact_version_artifact_does_not_exist(
service_type, artifact_service_factory
):
"""Tests getting an artifact version when artifact does not exist."""
artifact_service = artifact_service_factory(service_type)
assert not await artifact_service.get_artifact_version(
app_name="test_app",
user_id="test_user",
session_id="session_id",
filename="filename",
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type", [ArtifactServiceType.IN_MEMORY, ArtifactServiceType.GCS]
)
async def test_get_artifact_version_out_of_index(
service_type, artifact_service_factory
):
"""Tests loading an artifact with an out-of-index version."""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "123"
filename = "filename"
artifact = types.Part.from_bytes(data=b"test_data", mime_type="text/plain")
await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=artifact,
)
# Attempt to get a version that doesn't exist
assert not await artifact_service.get_artifact_version(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
version=3,
)
@pytest.mark.asyncio
async def test_file_metadata_camelcase(tmp_path, artifact_service_factory):
"""Ensures FileArtifactService writes camelCase metadata without newlines."""
artifact_service = artifact_service_factory(ArtifactServiceType.FILE)
artifact = types.Part.from_bytes(
data=b"binary-content", mime_type="application/octet-stream"
)
await artifact_service.save_artifact(
app_name="myapp",
user_id="user123",
session_id="sess789",
filename="docs/report.txt",
artifact=artifact,
)
metadata_path = (
tmp_path
/ "artifacts"
/ "users"
/ "user123"
/ "sessions"
/ "sess789"
/ "artifacts"
/ "docs"
/ "report.txt"
/ "versions"
/ "0"
/ "metadata.json"
)
raw_metadata = metadata_path.read_text(encoding="utf-8")
assert "\n" not in raw_metadata
metadata = json.loads(raw_metadata)
payload_path = (metadata_path.parent / "report.txt").resolve()
expected_canonical_uri = payload_path.as_uri()
create_time = metadata.pop("createTime", None)
assert create_time is not None
assert metadata == {
"fileName": "docs/report.txt",
"mimeType": "application/octet-stream",
"canonicalUri": expected_canonical_uri,
"version": 0,
"customMetadata": {},
}
parsed_canonical = urlparse(metadata["canonicalUri"])
canonical_path = Path(unquote(parsed_canonical.path))
assert canonical_path.name == "report.txt"
assert canonical_path.read_bytes() == b"binary-content"
@pytest.mark.asyncio
async def test_file_list_artifact_versions(tmp_path, artifact_service_factory):
"""FileArtifactService exposes canonical URIs and metadata for each version."""
artifact_service = artifact_service_factory(ArtifactServiceType.FILE)
artifact = types.Part.from_bytes(
data=b"binary-content", mime_type="application/octet-stream"
)
custom_metadata = {"origin": "unit-test"}
await artifact_service.save_artifact(
app_name="myapp",
user_id="user123",
session_id="sess789",
filename="docs/report.txt",
artifact=artifact,
custom_metadata=custom_metadata,
)
versions = await artifact_service.list_artifact_versions(
app_name="myapp",
user_id="user123",
session_id="sess789",
filename="docs/report.txt",
)
assert len(versions) == 1
version_meta = versions[0]
assert version_meta.version == 0
version_payload_path = (
tmp_path
/ "artifacts"
/ "users"
/ "user123"
/ "sessions"
/ "sess789"
/ "artifacts"
/ "docs"
/ "report.txt"
/ "versions"
/ "0"
/ "report.txt"
).resolve()
assert version_meta.canonical_uri == version_payload_path.as_uri()
assert version_meta.custom_metadata == custom_metadata
parsed_version_uri = urlparse(version_meta.canonical_uri)
version_uri_path = Path(unquote(parsed_version_uri.path))
assert version_uri_path.read_bytes() == b"binary-content"
fetched = await artifact_service.get_artifact_version(
app_name="myapp",
user_id="user123",
session_id="sess789",
filename="docs/report.txt",
version=0,
)
assert fetched is not None
assert fetched.version == version_meta.version
assert fetched.canonical_uri == version_meta.canonical_uri
assert fetched.custom_metadata == version_meta.custom_metadata
latest = await artifact_service.get_artifact_version(
app_name="myapp",
user_id="user123",
session_id="sess789",
filename="docs/report.txt",
)
assert latest is not None
assert latest.version == version_meta.version
assert latest.canonical_uri == version_meta.canonical_uri
assert latest.custom_metadata == version_meta.custom_metadata
@pytest.mark.asyncio
@pytest.mark.parametrize(
("filename", "session_id"),
[
("../escape.txt", "sess123"),
("user:../escape.txt", "sess123"),
("/absolute/path.txt", "sess123"),
("user:/absolute/path.txt", None),
],
)
async def test_file_save_artifact_rejects_out_of_scope_paths(
tmp_path, filename, session_id
):
"""FileArtifactService prevents path traversal outside of its storage roots."""
artifact_service = FileArtifactService(root_dir=tmp_path / "artifacts")
part = types.Part(text="content")
with pytest.raises(InputValidationError):
await artifact_service.save_artifact(
app_name="myapp",
user_id="user123",
session_id=session_id,
filename=filename,
artifact=part,
)
@pytest.mark.asyncio
async def test_file_save_artifact_rejects_absolute_path_within_scope(tmp_path):
"""Absolute filenames are rejected even when they point inside the scope."""
artifact_service = FileArtifactService(root_dir=tmp_path / "artifacts")
absolute_in_scope = (
tmp_path
/ "artifacts"
/ "apps"
/ "myapp"
/ "users"
/ "user123"
/ "artifacts"
/ "diagram.png"
)
part = types.Part(text="content")
with pytest.raises(InputValidationError):
await artifact_service.save_artifact(
app_name="myapp",
user_id="user123",
session_id=None,
filename=str(absolute_in_scope),
artifact=part,
)
class TestEnsurePart:
"""Tests for the ensure_part normalization helper."""
def test_returns_part_unchanged(self):
"""A types.Part instance passes through without modification."""
part = types.Part.from_bytes(data=b"hello", mime_type="text/plain")
result = ensure_part(part)
assert result is part
def test_converts_camel_case_dict(self):
"""A camelCase dict (Agentspace format) is converted to types.Part."""
raw = {"inlineData": {"mimeType": "image/png", "data": "dGVzdA=="}}
result = ensure_part(raw)
assert isinstance(result, types.Part)
assert result.inline_data is not None
assert result.inline_data.mime_type == "image/png"
def test_converts_snake_case_dict(self):
"""A snake_case dict is converted to types.Part."""
raw = {"inline_data": {"mime_type": "text/plain", "data": "aGVsbG8="}}
result = ensure_part(raw)
assert isinstance(result, types.Part)
assert result.inline_data is not None
assert result.inline_data.mime_type == "text/plain"
def test_converts_text_dict(self):
"""A dict with 'text' key is converted to types.Part."""
raw = {"text": "hello world"}
result = ensure_part(raw)
assert isinstance(result, types.Part)
assert result.text == "hello world"
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_save_artifact_with_camel_case_dict(
service_type, artifact_service_factory
):
"""Artifact services accept camelCase dicts (Agentspace format).
Regression test for https://github.com/google/adk-python/issues/2886
"""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "sess0"
filename = "uploaded.png"
# Simulate what Agentspace sends: a plain dict with camelCase keys.
raw_artifact = {
"inlineData": {
"mimeType": "image/png",
"data": "dGVzdF9pbWFnZV9kYXRh",
}
}
version = await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=raw_artifact,
)
assert version == 0
loaded = await artifact_service.load_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
assert loaded is not None
assert loaded.inline_data is not None
assert loaded.inline_data.mime_type == "image/png"
@pytest.mark.asyncio
@pytest.mark.parametrize(
"service_type",
[
ArtifactServiceType.IN_MEMORY,
ArtifactServiceType.GCS,
ArtifactServiceType.FILE,
],
)
async def test_save_artifact_with_snake_case_dict(
service_type, artifact_service_factory
):
"""Artifact services accept snake_case dicts."""
artifact_service = artifact_service_factory(service_type)
app_name = "app0"
user_id = "user0"
session_id = "sess0"
filename = "uploaded.txt"
raw_artifact = {
"inline_data": {
"mime_type": "text/plain",
"data": "aGVsbG8=",
}
}
version = await artifact_service.save_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
artifact=raw_artifact,
)
assert version == 0
loaded = await artifact_service.load_artifact(
app_name=app_name,
user_id=user_id,
session_id=session_id,
filename=filename,
)
assert loaded is not None
assert loaded.inline_data is not None
assert loaded.inline_data.mime_type == "text/plain"
@pytest.mark.asyncio
@pytest.mark.parametrize(
"user_id",
[
"../../escape",
"../sibling",
"valid/../../../etc",
],
)
async def test_file_save_rejects_traversal_user_id(tmp_path, user_id):
"""FileArtifactService rejects user_id values that escape the storage root."""
artifact_service = FileArtifactService(root_dir=tmp_path / "artifacts")
part = types.Part(text="content")
with pytest.raises(InputValidationError):
await artifact_service.save_artifact(
app_name="myapp",
user_id=user_id,
session_id="sess1",
filename="file.txt",
artifact=part,
)
@pytest.mark.asyncio
@pytest.mark.parametrize(
"session_id",
[
"../../escape",
"../sibling",
"valid/../../../tmp",
],
)
async def test_file_save_rejects_traversal_session_id(tmp_path, session_id):
"""FileArtifactService rejects session_id values that escape the storage root."""
artifact_service = FileArtifactService(root_dir=tmp_path / "artifacts")
part = types.Part(text="content")
with pytest.raises(InputValidationError):
await artifact_service.save_artifact(
app_name="myapp",
user_id="user1",
session_id=session_id,
filename="file.txt",
artifact=part,
)
@pytest.mark.asyncio
async def test_file_delete_rejects_traversal_session_id(tmp_path):
"""Traversal session_id is caught before shutil.rmtree can be reached."""
artifact_service = FileArtifactService(root_dir=tmp_path / "artifacts")
with pytest.raises(InputValidationError):
await artifact_service.delete_artifact(
app_name="myapp",
user_id="user1",
session_id="../../escape",
filename="file.txt",
)