File: test_storage.py

package info (click to toggle)
pystac 1.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 19,904 kB
  • sloc: python: 24,370; makefile: 124; sh: 7
file content (336 lines) | stat: -rw-r--r-- 10,445 bytes parent folder | download | duplicates (2)
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
import json
import random
from string import ascii_letters

import pytest

import pystac
from pystac import ExtensionTypeError, Item
from pystac.collection import Collection
from pystac.extensions.storage import CloudPlatform, StorageExtension
from tests.utils import TestCases, assert_to_from_dict

NAIP_EXAMPLE_URI = TestCases.get_path("data-files/storage/item-naip.json")
NAIP_COLLECTION_URI = TestCases.get_path("data-files/storage/collection-naip.json")


@pytest.fixture
def naip_item() -> Item:
    return Item.from_file(NAIP_EXAMPLE_URI)


@pytest.fixture
def naip_collection() -> Collection:
    return Collection.from_file(NAIP_COLLECTION_URI)


def test_to_from_dict() -> None:
    with open(NAIP_EXAMPLE_URI) as f:
        item_dict = json.load(f)
    assert_to_from_dict(Item, item_dict)


def test_add_to(sample_item: Item) -> None:
    assert StorageExtension.get_schema_uri() not in sample_item.stac_extensions
    # Check that the URI gets added to stac_extensions
    StorageExtension.add_to(sample_item)
    assert StorageExtension.get_schema_uri() in sample_item.stac_extensions

    # Check that the URI only gets added once, regardless of how many times add_to
    # is called.
    StorageExtension.add_to(sample_item)
    StorageExtension.add_to(sample_item)

    eo_uris = [
        uri
        for uri in sample_item.stac_extensions
        if uri == StorageExtension.get_schema_uri()
    ]
    assert len(eo_uris) == 1


@pytest.mark.vcr()
def test_validate_storage(naip_item: Item) -> None:
    naip_item.validate()


def test_extend_invalid_object() -> None:
    link = pystac.Link("child", "https://some-domain.com/some/path/to.json")

    with pytest.raises(pystac.ExtensionTypeError):
        StorageExtension.ext(link)  # type: ignore


def test_extension_not_implemented(sample_item: Item) -> None:
    # Should raise exception if Item does not include extension URI
    with pytest.raises(pystac.ExtensionNotImplemented):
        _ = StorageExtension.ext(sample_item)

    # Should raise exception if owning Item does not include extension URI
    asset = sample_item.assets["thumbnail"]

    with pytest.raises(pystac.ExtensionNotImplemented):
        _ = StorageExtension.ext(asset)

    # Should succeed if Asset has no owner
    ownerless_asset = pystac.Asset.from_dict(asset.to_dict())
    _ = StorageExtension.ext(ownerless_asset)


def test_item_ext_add_to(sample_item: Item) -> None:
    assert StorageExtension.get_schema_uri() not in sample_item.stac_extensions

    _ = StorageExtension.ext(sample_item, add_if_missing=True)

    assert StorageExtension.get_schema_uri() in sample_item.stac_extensions


def test_asset_ext_add_to(sample_item: Item) -> None:
    assert StorageExtension.get_schema_uri() not in sample_item.stac_extensions
    asset = sample_item.assets["thumbnail"]

    _ = StorageExtension.ext(asset, add_if_missing=True)

    assert StorageExtension.get_schema_uri() in sample_item.stac_extensions


def test_asset_ext_add_to_ownerless_asset(sample_item: Item) -> None:
    asset_dict = sample_item.assets["thumbnail"].to_dict()
    asset = pystac.Asset.from_dict(asset_dict)

    with pytest.raises(pystac.STACError):
        _ = StorageExtension.ext(asset, add_if_missing=True)


def test_should_raise_exception_when_passing_invalid_extension_object() -> None:
    with pytest.raises(
        ExtensionTypeError, match=r"^StorageExtension does not apply to type 'object'$"
    ):
        # calling it wrong purposely so ---------v
        StorageExtension.ext(object())  # type: ignore


def test_summaries_platform(naip_collection: Collection) -> None:
    col_dict = naip_collection.to_dict()
    storage_summaries = StorageExtension.summaries(naip_collection)

    # Get
    assert storage_summaries.platform == col_dict["summaries"]["storage:platform"]
    # Set
    new_platform_summary = [random.choice([v for v in CloudPlatform])]
    assert storage_summaries.platform != new_platform_summary
    storage_summaries.platform = new_platform_summary
    assert storage_summaries.platform == new_platform_summary

    col_dict = naip_collection.to_dict()
    assert col_dict["summaries"]["storage:platform"] == new_platform_summary


def test_summaries_region(naip_collection: Collection) -> None:
    col_dict = naip_collection.to_dict()
    storage_summaries = StorageExtension.summaries(naip_collection)

    # Get
    assert storage_summaries.region == col_dict["summaries"]["storage:region"]
    # Set
    new_region_summary = [random.choice(ascii_letters)]
    assert storage_summaries.region != new_region_summary
    storage_summaries.region = new_region_summary
    assert storage_summaries.region == new_region_summary

    col_dict = naip_collection.to_dict()
    assert col_dict["summaries"]["storage:region"] == new_region_summary


def test_summaries_requester_pays(naip_collection: Collection) -> None:
    col_dict = naip_collection.to_dict()
    storage_summaries = StorageExtension.summaries(naip_collection)

    # Get
    assert (
        storage_summaries.requester_pays
        == col_dict["summaries"]["storage:requester_pays"]
    )

    # Set
    new_requester_pays_summary = [True]
    assert storage_summaries.requester_pays != new_requester_pays_summary
    storage_summaries.requester_pays = new_requester_pays_summary
    assert storage_summaries.requester_pays == new_requester_pays_summary

    col_dict = naip_collection.to_dict()
    assert col_dict["summaries"]["storage:requester_pays"] == new_requester_pays_summary


def test_summaries_tier(naip_collection: Collection) -> None:
    col_dict = naip_collection.to_dict()
    storage_summaries = StorageExtension.summaries(naip_collection)

    # Get
    assert storage_summaries.tier == col_dict["summaries"]["storage:tier"]

    # Set
    new_tier_summary = [random.choice(ascii_letters)]
    assert storage_summaries.tier != new_tier_summary
    storage_summaries.tier = new_tier_summary
    assert storage_summaries.tier == new_tier_summary

    col_dict = naip_collection.to_dict()
    assert col_dict["summaries"]["storage:tier"] == new_tier_summary


def test_summaries_adds_uri(naip_collection: Collection) -> None:
    naip_collection.stac_extensions = []
    with pytest.raises(
        pystac.ExtensionNotImplemented,
        match="Extension 'storage' is not implemented",
    ):
        StorageExtension.summaries(naip_collection, add_if_missing=False)

    _ = StorageExtension.summaries(naip_collection, add_if_missing=True)

    assert StorageExtension.get_schema_uri() in naip_collection.stac_extensions

    StorageExtension.remove_from(naip_collection)
    assert StorageExtension.get_schema_uri() not in naip_collection.stac_extensions


def test_item_apply(naip_item: Item) -> None:
    asset = random.choice(list(naip_item.assets.values()))

    storage_ext = StorageExtension.ext(asset)

    new_platform = random.choice(
        [v for v in CloudPlatform if v != storage_ext.platform]
    )
    new_region = random.choice(ascii_letters)
    new_requestor_pays = random.choice(
        [v for v in {True, False} if v != storage_ext.requester_pays]
    )
    new_tier = random.choice(ascii_letters)

    storage_ext.apply(
        platform=new_platform,
        region=new_region,
        requester_pays=new_requestor_pays,
        tier=new_tier,
    )

    assert storage_ext.platform == new_platform
    assert storage_ext.region == new_region
    assert storage_ext.requester_pays == new_requestor_pays
    assert storage_ext.tier == new_tier


@pytest.mark.vcr()
def test_asset_platform(naip_item: Item) -> None:
    # Grab a random asset with the platform property
    asset = random.choice(
        [
            _asset
            for _asset in naip_item.assets.values()
            if "storage:platform" in _asset.to_dict()
        ]
    )

    storage_ext = StorageExtension.ext(asset)

    # Get
    assert storage_ext.platform == asset.extra_fields.get("storage:platform")

    # Set
    new_platform = random.choice(
        [val for val in CloudPlatform if val != storage_ext.platform]
    )
    storage_ext.platform = new_platform
    assert storage_ext.platform == new_platform

    naip_item.validate()


@pytest.mark.vcr()
def test_asset_region(naip_item: Item) -> None:
    # Grab a random asset with the platform property
    asset = random.choice(
        [
            _asset
            for _asset in naip_item.assets.values()
            if "storage:region" in _asset.to_dict()
        ]
    )

    storage_ext = StorageExtension.ext(asset)

    # Get
    assert storage_ext.region == asset.extra_fields.get("storage:region")

    # Set
    new_region = random.choice(
        [val for val in CloudPlatform if val != storage_ext.region]
    )
    storage_ext.region = new_region
    assert storage_ext.region == new_region

    naip_item.validate()

    # Set to None
    storage_ext.region = None
    assert "storage:region" not in asset.extra_fields


@pytest.mark.vcr()
def test_asset_requester_pays(naip_item: Item) -> None:
    # Grab a random asset with the platform property
    asset = random.choice(
        [
            _asset
            for _asset in naip_item.assets.values()
            if "storage:requester_pays" in _asset.to_dict()
        ]
    )

    storage_ext = StorageExtension.ext(asset)

    # Get
    assert storage_ext.requester_pays == asset.extra_fields.get(
        "storage:requester_pays"
    )

    # Set
    new_requester_pays = True if not storage_ext.requester_pays else False
    storage_ext.requester_pays = new_requester_pays
    assert storage_ext.requester_pays == new_requester_pays

    naip_item.validate()

    # Set to None
    storage_ext.requester_pays = None
    assert "storage:requester_pays" not in asset.extra_fields


@pytest.mark.vcr()
def test_asset_tier(naip_item: Item) -> None:
    # Grab a random asset with the platform property
    asset = random.choice(
        [
            _asset
            for _asset in naip_item.assets.values()
            if "storage:tier" in _asset.to_dict()
        ]
    )

    storage_ext = StorageExtension.ext(asset)

    # Get
    assert storage_ext.tier == asset.extra_fields.get("storage:tier")

    # Set
    new_tier = random.choice(ascii_letters)
    storage_ext.tier = new_tier
    assert storage_ext.tier == new_tier

    naip_item.validate()

    # Set to None
    storage_ext.tier = None
    assert "storage:tier" not in asset.extra_fields