|
24 | 24 | from uuid import UUID |
25 | 25 |
|
26 | 26 | import pytest |
| 27 | +from pydantic import ValidationError as PydanticValidationError |
27 | 28 |
|
28 | 29 | from pyiceberg.exceptions import ValidationError |
29 | 30 | from pyiceberg.partitioning import PartitionField, PartitionSpec |
30 | 31 | from pyiceberg.schema import Schema |
31 | 32 | from pyiceberg.serializers import FromByteStream |
32 | 33 | from pyiceberg.table.metadata import ( |
| 34 | + EncryptedKey, |
33 | 35 | TableMetadataUtil, |
34 | 36 | TableMetadataV1, |
35 | 37 | TableMetadataV2, |
@@ -876,3 +878,117 @@ def test_new_table_metadata_format_v2_with_v3_schema_fails(field_type: Primitive |
876 | 878 | location="s3://some_v1_location/", |
877 | 879 | properties={"format-version": "2"}, |
878 | 880 | ) |
| 881 | + |
| 882 | + |
| 883 | +def test_encrypted_key_minimal() -> None: |
| 884 | + # Mirrors Java's TestEncryptedKeyParser, where the key metadata is base64 of b"key" |
| 885 | + key = EncryptedKey.model_validate_json('{"key-id": "a", "encrypted-key-metadata": "a2V5"}') |
| 886 | + |
| 887 | + assert key.key_id == "a" |
| 888 | + assert key.encrypted_key_metadata == b"key" |
| 889 | + assert key.encrypted_by_id is None |
| 890 | + assert key.properties == {} |
| 891 | + |
| 892 | + |
| 893 | +def test_encrypted_key_full() -> None: |
| 894 | + key = EncryptedKey.model_validate_json( |
| 895 | + '{"key-id": "a", "encrypted-key-metadata": "a2V5", "encrypted-by-id": "b", "properties": {"test": "value"}}' |
| 896 | + ) |
| 897 | + |
| 898 | + assert key.key_id == "a" |
| 899 | + assert key.encrypted_key_metadata == b"key" |
| 900 | + assert key.encrypted_by_id == "b" |
| 901 | + assert key.properties == {"test": "value"} |
| 902 | + |
| 903 | + |
| 904 | +def test_encrypted_key_serialize() -> None: |
| 905 | + key = EncryptedKey(key_id="a", encrypted_key_metadata=b"key", encrypted_by_id="b", properties={"test": "value"}) |
| 906 | + |
| 907 | + expected = '{"key-id":"a","encrypted-key-metadata":"a2V5","encrypted-by-id":"b","properties":{"test":"value"}}' |
| 908 | + assert key.model_dump_json() == expected |
| 909 | + |
| 910 | + |
| 911 | +def test_encrypted_key_serialize_minimal() -> None: |
| 912 | + key = EncryptedKey(key_id="a", encrypted_key_metadata=b"key") |
| 913 | + |
| 914 | + assert key.model_dump_json() == '{"key-id":"a","encrypted-key-metadata":"a2V5","properties":{}}' |
| 915 | + |
| 916 | + |
| 917 | +@pytest.mark.parametrize( |
| 918 | + "payload, missing", |
| 919 | + [ |
| 920 | + ('{"encrypted-key-metadata": "a2V5"}', "key-id"), |
| 921 | + ('{"key-id": "a"}', "encrypted-key-metadata"), |
| 922 | + ], |
| 923 | +) |
| 924 | +def test_encrypted_key_missing_required_field(payload: str, missing: str) -> None: |
| 925 | + with pytest.raises(PydanticValidationError) as exc_info: |
| 926 | + EncryptedKey.model_validate_json(payload) |
| 927 | + |
| 928 | + assert missing in str(exc_info.value) |
| 929 | + |
| 930 | + |
| 931 | +@pytest.mark.parametrize( |
| 932 | + "encrypted_key_metadata", |
| 933 | + [ |
| 934 | + "a2V*5", # character outside the base64 alphabet |
| 935 | + "a2V5=extra", |
| 936 | + "a2V", # incorrect padding |
| 937 | + "not base64", |
| 938 | + ], |
| 939 | +) |
| 940 | +def test_encrypted_key_malformed_base64(encrypted_key_metadata: str) -> None: |
| 941 | + with pytest.raises(PydanticValidationError, match="encrypted-key-metadata"): |
| 942 | + EncryptedKey.model_validate({"key-id": "a", "encrypted-key-metadata": encrypted_key_metadata}) |
| 943 | + |
| 944 | + |
| 945 | +def test_v3_metadata_parsing_encryption_keys(example_table_metadata_v3: dict[str, Any]) -> None: |
| 946 | + metadata = { |
| 947 | + **example_table_metadata_v3, |
| 948 | + "encryption-keys": [ |
| 949 | + { |
| 950 | + "key-id": "table-key-1", |
| 951 | + "encrypted-key-metadata": "a2V5", |
| 952 | + "encrypted-by-id": "external-key-1", |
| 953 | + "properties": {"a": "b"}, |
| 954 | + }, |
| 955 | + {"key-id": "table-key-2", "encrypted-key-metadata": "a2V5", "encrypted-by-id": "table-key-1"}, |
| 956 | + ], |
| 957 | + "snapshots": [ |
| 958 | + {**snapshot, "key-id": "table-key-2"} if snapshot["snapshot-id"] == 3055729675574597004 else snapshot |
| 959 | + for snapshot in example_table_metadata_v3["snapshots"] |
| 960 | + ], |
| 961 | + } |
| 962 | + |
| 963 | + table_metadata = TableMetadataUtil.parse_obj(metadata) |
| 964 | + |
| 965 | + assert isinstance(table_metadata, TableMetadataV3) |
| 966 | + assert [key.key_id for key in table_metadata.encryption_keys] == ["table-key-1", "table-key-2"] |
| 967 | + assert table_metadata.encryption_keys[0].encrypted_key_metadata == b"key" |
| 968 | + assert table_metadata.encryption_keys[0].properties == {"a": "b"} |
| 969 | + assert table_metadata.encryption_keys[1].encrypted_by_id == "table-key-1" |
| 970 | + |
| 971 | + current_snapshot = table_metadata.snapshot_by_id(3055729675574597004) |
| 972 | + assert current_snapshot is not None |
| 973 | + assert current_snapshot.key_id == "table-key-2" |
| 974 | + |
| 975 | + |
| 976 | +def test_v3_metadata_without_encryption_keys(example_table_metadata_v3: dict[str, Any]) -> None: |
| 977 | + table_metadata = TableMetadataUtil.parse_obj(example_table_metadata_v3) |
| 978 | + |
| 979 | + assert isinstance(table_metadata, TableMetadataV3) |
| 980 | + assert table_metadata.encryption_keys == [] |
| 981 | + for snapshot in table_metadata.snapshots: |
| 982 | + assert snapshot.key_id is None |
| 983 | + |
| 984 | + assert "encryption-keys" not in table_metadata.model_dump(mode="json") |
| 985 | + |
| 986 | + |
| 987 | +def test_v3_metadata_with_encryption_keys_serializes_them(example_table_metadata_v3: dict[str, Any]) -> None: |
| 988 | + table_metadata = TableMetadataUtil.parse_obj( |
| 989 | + {**example_table_metadata_v3, "encryption-keys": [{"key-id": "a", "encrypted-key-metadata": "a2V5"}]} |
| 990 | + ) |
| 991 | + |
| 992 | + assert table_metadata.model_dump(mode="json")["encryption-keys"] == [ |
| 993 | + {"key-id": "a", "encrypted-key-metadata": "a2V5", "properties": {}} |
| 994 | + ] |
0 commit comments