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
|
import copy
import json
import pytest
from internetarchive.iarequest import (
MetadataRequest,
S3Request,
prepare_files_patch,
prepare_metadata,
prepare_patch,
prepare_target_patch,
)
from tests.conftest import PROTOCOL, IaRequestsMock
@pytest.fixture
def sample_metadata():
return copy.deepcopy({
"metadata": {"title": "Test"},
"files": [
{"name": "test.txt", "custom": {"tags": ["old"]}, "foo": "bar"},
],
"dupe_pallet_index": {
"IA9999": ["IA999901"]
}
})
@pytest.mark.parametrize(("metadata", "expected"), [
({"custom": ["new"]}, [{'op': 'add', 'path': '/custom', 'value': ['new']}]),
({"title": "New Title"}, [{'op': 'replace', 'path': '/title', 'value': 'New Title'}]),
({"title": "REMOVE_TAG"}, [{'op': 'remove', 'path': '/title'}]),
])
def test_metadata_patch_operations(metadata, expected, sample_metadata):
patch = prepare_patch(
metadata=metadata,
source_metadata=sample_metadata["metadata"],
append=False,
append_list=False,
insert=False,
)
assert patch == expected
@pytest.mark.parametrize(("metadata", "expected"), [
({"new-key": ["new", "new2"]}, [{'op': 'add', 'path': '/new-key', 'value': ['new', 'new2']}]),
({"custom": "foo new"}, [{'op': 'replace', 'path': '/custom', 'value': 'foo new'}]),
({"custom": "REMOVE_TAG"}, [{'op': 'remove', 'path': '/custom'}]),
])
def test_file_metadata_patch_operations(metadata, expected, sample_metadata):
patch = prepare_files_patch(
metadata=metadata,
files_metadata=sample_metadata["files"],
target="files/test.txt",
append=False,
append_list=False,
insert=False,
expect={}
)
assert patch == expected
@pytest.mark.parametrize(("metadata", "expected"), [
(
{"IA9999": ["UPDATED"], "NEW_ITEM": ["NEW123"]},
[
{'op': 'add', 'path': '/NEW_ITEM', 'value': ['NEW123']},
{'op': 'replace', 'path': '/IA9999/0', 'value': 'UPDATED'}
]
),
])
def test_target_patch_add_and_replace(metadata, expected, sample_metadata):
patch = prepare_target_patch(
metadata=metadata,
source_metadata=sample_metadata,
target="dupe_pallet_index",
append=False,
append_list=False,
insert=False,
expect={}
)
assert patch == expected
@pytest.mark.parametrize(("metadata", "expected"), [
(
{"IA9999": ["IA999901", "IA999902", "IA999903"]},
[{'op': 'add', 'path': '/IA9999/1', 'value': ['IA999901', 'IA999902', 'IA999903']}]
),
(
{"IA9999": "IA999902"},
[{'op': 'add', 'path': '/IA9999/1', 'value': 'IA999902'}]
),
])
def test_target_patch_append_list(metadata, expected, sample_metadata):
patch = prepare_target_patch(
metadata=metadata,
source_metadata=sample_metadata,
target="dupe_pallet_index",
append=False,
append_list=True,
insert=False,
expect={}
)
assert patch == expected
def test_metadata_request_patch_key(sample_metadata):
with IaRequestsMock() as rsps:
rsps.add_metadata_mock('test_item', body=json.dumps(sample_metadata))
req = MetadataRequest(
metadata={"title": "New Title"},
url=f"{PROTOCOL}//archive.org/metadata/test_item"
)
prepared = req.prepare()
assert any(k.endswith('-patch') for k in prepared.data)
@pytest.mark.parametrize(("test_value", "expected"), [
(
"http://example.com/foo bar?q=✓",
"uri(http%3A//example.com/foo%20bar%3Fq%3D%E2%9C%93)"
),
])
def test_metadata_header_uri_encoding(test_value, expected):
req = S3Request(
method='PUT',
url=f"{PROTOCOL}//s3.us.archive.org/test_item",
metadata={"source": test_value},
access_key='test_access',
secret_key='test_secret'
)
prepared = req.prepare()
header = prepared.headers.get('x-archive-meta00-source', '')
assert header == expected
@pytest.mark.parametrize(("metadata", "source", "insert", "expected"), [
# Shift existing elements in insert mode
({"collection[0]": "noaa-hawaii"},
{"collection": ["internetarchivebooks", "noaa-hawaii", "noaa", "democracys-library"]},
True,
{"collection": ["noaa-hawaii", "internetarchivebooks", "noaa", "democracys-library"]}),
# Simple overwrite of an indexed key
({"subject[0]": "Math"},
{"subject": "Science"},
False,
{"subject": ["Math"]}),
# Indexed key overwriting existing list
({"subject[1]": "Science"},
{"subject": ["Math"]},
False,
{"subject": ["Math", "Science"]}),
# Insert mode: shifts existing elements
({"subject[1]": "History"},
{"subject": ["Math", "Science"]},
True,
{"subject": ["Math", "History", "Science"]}),
# REMOVE_TAG removes an element
({"subject[0]": "REMOVE_TAG"},
{"subject": ["Math", "Science"]},
False,
{"subject": ["Science"]}),
# Multiple indexed keys out of order
({"subject[2]": "Art", "subject[0]": "Math"},
{},
False,
{"subject": ["Math", "Art"]}),
# Insert at beginning of an existing list
({"subject[0]": "Physics"},
{"subject": ["Math", "Chemistry"]},
True,
{"subject": ["Physics", "Math", "Chemistry"]}),
# Insert at end of an existing list
({"subject[2]": "Biology"},
{"subject": ["Math", "Chemistry"]},
True,
{"subject": ["Math", "Chemistry", "Biology"]}),
# Overwrite numeric value
({"page[0]": 42},
{"page": [1]},
False,
{"page": [42]}),
# Mixed non-indexed and indexed keys
({"subject": "History", "topic[0]": "Algebra"},
{"subject": "Math", "topic": ["English", "Geometry"]},
False,
{"subject": "History", "topic": ["Algebra", "Geometry"]}),
# Remove multiple elements with REMOVE_TAG
({"subject[0]": "REMOVE_TAG", "subject[1]": "REMOVE_TAG"},
{"subject": ["Math", "Science", "History"]},
False,
{"subject": ["History"]}),
# Indexed key beyond current list length
({"subject[5]": "Philosophy"},
{"subject": ["Math"]},
False,
{"subject": ["Math", "Philosophy"]}),
# Insert mode with duplicate prevention
({"subject[1]": "Math"},
{"subject": ["Math", "Science"]},
True,
{"subject": ["Science", "Math"]}),
])
def test_prepare_metadata_indexed_keys(metadata, source, insert, expected):
result = prepare_metadata(metadata, source_metadata=source, insert=insert)
# remove None placeholders for comparison
for k, v in result.items():
if isinstance(v, list):
result[k] = [i for i in v if i is not None]
assert result == expected
def test_prepare_metadata_insert_mode_and_duplicates():
source = {"tags": ["foo", "bar"]}
metadata = {"tags[1]": "foo"} # duplicate value
result = prepare_metadata(metadata, source_metadata=source, insert=True)
# Duplicate should be removed and value inserted at index 1
assert result["tags"] == ["bar", "foo"]
def test_prepare_metadata_with_preallocation_and_none_cleanup():
source = {"keywords": ["python"]}
metadata = {"keywords[3]": "testing"}
result = prepare_metadata(metadata, source_metadata=source)
# Index 1 and 2 are None and should be removed
assert result["keywords"] == ["python", "testing"]
def test_prepare_metadata_numeric_conversion_and_append():
source = {"page": 5}
metadata = {"page": 10}
result = prepare_metadata(metadata, source_metadata=source, append=True)
# Numeric values should be converted to strings and concatenated
assert result["page"] == "5 10"
def test_prepare_metadata_append_list():
source = {"tags": ["foo"]}
metadata = {"tags": ["bar"]}
result = prepare_metadata(metadata, source_metadata=source, append_list=True)
assert result["tags"] == ["foo", ["bar"]]
@pytest.mark.parametrize(("metadata", "source", "insert", "expected"), [
# Multiple REMOVE_TAGs interleaved with inserts
({"tags[0]": "REMOVE_TAG", "tags[2]": "new", "tags[1]": "REMOVE_TAG"},
{"tags": ["foo", "bar", "baz"]},
True,
{"tags": ["new", "baz"]}),
# Sparse indices beyond current list length, insert mode
({"keywords[5]": "python", "keywords[2]": "pytest"},
{"keywords": ["testing"]},
True,
{"keywords": ["testing", "pytest", "python"]}),
# Duplicate prevention with insert mode
({"categories[1]": "Tech"},
{"categories": ["Tech", "Science"]},
True,
{"categories": ["Science", "Tech"]}),
# Indexed key overwrite where source is a non-list
({"page[0]": 99},
{"page": 42},
False,
{"page": [99]}),
# Mixed string and list in source
({"authors[1]": "Alice"},
{"authors": "Bob"},
True,
{"authors": ["Bob", "Alice"]}),
# REMOVE_TAG at the end of list
({"items[2]": "REMOVE_TAG"},
{"items": ["A", "B", "C"]},
False,
{"items": ["A", "B"]}),
# Multiple sparse inserts with duplicates
({"tags[0]": "python", "tags[3]": "python"},
{"tags": ["python", "pytest"]},
True,
{"tags": ["pytest", "python"]}),
])
def test_prepare_metadata_edge_cases(metadata, source, insert, expected):
result = prepare_metadata(metadata, source_metadata=source, insert=insert)
# remove None placeholders for comparison
for k, v in result.items():
if isinstance(v, list):
result[k] = [i for i in v if i is not None]
assert result == expected
|