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
|
"""Tests for pystac.tests.extensions.datacube"""
import json
from typing import Any
import pytest
import pystac
import pystac.extensions.datacube as dc
from pystac import Asset, Item
from pystac.errors import ExtensionTypeError
from tests.conftest import get_data_file
@pytest.fixture
def ext_item_uri() -> str:
return get_data_file("datacube/item.json")
@pytest.fixture
def ext_item(ext_item_uri: str) -> Item:
return Item.from_file(ext_item_uri)
@pytest.fixture
def horizontal_dimension(ext_item: Item) -> dc.Dimension:
return dc.DatacubeExtension.ext(ext_item).dimensions["x"]
@pytest.fixture
def temporal_dimension(ext_item: Item) -> dc.Dimension:
return dc.DatacubeExtension.ext(ext_item).dimensions["time"]
@pytest.fixture
def additional_dimension(ext_item: Item) -> dc.Dimension:
return dc.DatacubeExtension.ext(ext_item).dimensions["spectral"]
@pytest.mark.parametrize(
"field,value",
[
("axis", "y"),
("extent", [-102, -120]),
("reference_system", 100),
],
)
def test_horizontal_dimension_fields(
horizontal_dimension: dc.Dimension, field: str, value: Any
) -> None:
dim = horizontal_dimension
original = dim.properties[field]
assert original == getattr(dim, field)
setattr(dim, field, value)
new = dim.properties[field]
assert new != original
assert new == value
def test_horizontal_dimension_values(
horizontal_dimension: dc.HorizontalSpatialDimension,
) -> None:
dim = horizontal_dimension
assert dim.values is None
dim.values = [0, 180]
assert dim.values == [0, 180]
assert dim.properties["values"] == [0, 180]
dim.values = None
assert dim.values is None
assert "values" not in dim.properties
def test_horizontal_dimension_step(
horizontal_dimension: dc.HorizontalSpatialDimension,
) -> None:
dim = horizontal_dimension
assert dim.step is None
dim.step = 3
assert dim.step == 3
assert dim.properties["step"] == 3
dim.clear_step()
assert dim.step is None
assert "step" not in dim.properties
def test_temporal_dimension_type(temporal_dimension: dc.TemporalDimension) -> None:
assert isinstance(temporal_dimension, dc.TemporalDimension)
assert temporal_dimension.dim_type == "temporal"
temporal_dimension.dim_type = "foo"
assert temporal_dimension.dim_type == "foo"
def test_temporal_dimension_description(
temporal_dimension: dc.TemporalDimension,
) -> None:
assert temporal_dimension.description is None
value = "Dimension in time"
temporal_dimension.description = value
assert temporal_dimension.properties["description"] == value
temporal_dimension.description = None
assert "description" not in temporal_dimension.properties
def test_stac_extensions(ext_item: Item) -> None:
assert dc.DatacubeExtension.has_extension(ext_item)
def test_get_schema_uri(ext_item: Item) -> None:
assert dc.DatacubeExtension.get_schema_uri() in ext_item.stac_extensions
def test_ext_raises_if_item_does_not_conform(item: Item) -> None:
with pytest.raises(pystac.errors.ExtensionNotImplemented):
dc.DatacubeExtension.ext(item)
def test_ext_raises_if_asset_does_not_conform(sample_item: Item) -> None:
asset = sample_item.assets["analytic"]
with pytest.raises(pystac.errors.ExtensionNotImplemented):
dc.DatacubeExtension.ext(asset)
def test_ext_always_passes_if_asset_has_no_owner(sample_item: Item) -> None:
asset = sample_item.assets["analytic"]
ownerless_asset = pystac.Asset.from_dict(asset.to_dict())
dc.DatacubeExtension.ext(ownerless_asset)
def test_ext_raises_if_passed_a_non_stac_object() -> None:
with pytest.raises(
ExtensionTypeError, match="DatacubeExtension does not apply to type 'object'"
):
dc.DatacubeExtension.ext(object()) # type: ignore
def test_to_from_dict(ext_item_uri: str, ext_item: Item) -> None:
with open(ext_item_uri) as f:
d = json.load(f)
actual = ext_item.to_dict(include_self_link=False)
assert d.keys() == actual.keys()
for k, v in d.items():
if k not in ["links"]:
assert actual[k] == v
def test_add_to_collection(collection: pystac.Collection) -> None:
assert not dc.DatacubeExtension.has_extension(collection)
dc.DatacubeExtension.add_to(collection)
assert dc.DatacubeExtension.has_extension(collection)
assert dc.DatacubeExtension.get_schema_uri() in collection.stac_extensions
def test_add_ext_to_collection(collection: pystac.Collection) -> None:
assert not dc.DatacubeExtension.has_extension(collection)
dc.DatacubeExtension.ext(collection, add_if_missing=True)
assert dc.DatacubeExtension.has_extension(collection)
assert dc.DatacubeExtension.get_schema_uri() in collection.stac_extensions
def test_add_to_item(item: Item) -> None:
assert not dc.DatacubeExtension.has_extension(item)
dc.DatacubeExtension.add_to(item)
assert dc.DatacubeExtension.has_extension(item)
assert dc.DatacubeExtension.get_schema_uri() in item.stac_extensions
def test_add_ext_to_item(item: Item) -> None:
assert not dc.DatacubeExtension.has_extension(item)
dc.DatacubeExtension.ext(item, add_if_missing=True)
assert dc.DatacubeExtension.has_extension(item)
assert dc.DatacubeExtension.get_schema_uri() in item.stac_extensions
def test_add_ext_to_asset(sample_item: Item) -> None:
assert not dc.DatacubeExtension.has_extension(sample_item)
asset = sample_item.assets["analytic"]
dc.DatacubeExtension.ext(asset, add_if_missing=True)
assert dc.DatacubeExtension.has_extension(sample_item)
assert dc.DatacubeExtension.get_schema_uri() in sample_item.stac_extensions
def test_apply(item: Item) -> None:
dc.DatacubeExtension.add_to(item)
dc.DatacubeExtension.ext(item).apply(
dimensions={
"time": dc.Dimension.from_dict(
{"type": "temporal", "values": ["2016-05-03T13:21:30.040Z"]}
),
},
variables={
"temp": dc.Variable.from_dict(
{
"dimensions": [
"time",
],
}
),
},
)
assert dc.DatacubeExtension.ext(item).dimensions
assert dc.DatacubeExtension.ext(item).variables
def test_apply_without_required_fields_raises(item: Item) -> None:
dc.DatacubeExtension.add_to(item)
with pytest.raises(TypeError, match="missing 1 required positional argument"):
dc.DatacubeExtension.ext(item).apply() # type: ignore
@pytest.mark.vcr()
def test_validate(ext_item: Item) -> None:
assert ext_item.validate()
def test_get_variables(ext_item: Item) -> None:
prop = ext_item.properties[dc.VARIABLES_PROP]
attr = dc.DatacubeExtension.ext(ext_item).variables
assert attr is not None
assert isinstance(attr["temp"], dc.Variable)
assert attr["temp"].to_dict() == prop["temp"]
def test_get_dimensions(ext_item: Item) -> None:
prop = ext_item.properties[dc.DIMENSIONS_PROP]
attr = dc.DatacubeExtension.ext(ext_item).dimensions
assert attr is not None
assert isinstance(attr["spectral"], dc.Dimension)
assert attr["spectral"].to_dict() == prop["spectral"]
assert attr["x"].to_dict() == prop["x"]
@pytest.mark.vcr()
def test_set_variables(ext_item: Item) -> None:
original = ext_item.properties[dc.VARIABLES_PROP]
value = dc.Variable({"dimensions": ["foo"]})
dc.DatacubeExtension.ext(ext_item).variables = {"temp": value}
new = ext_item.properties[dc.VARIABLES_PROP]
assert new != original
assert new == {"temp": value.to_dict()}
assert ext_item.validate()
@pytest.mark.vcr()
def test_set_dimensions(ext_item: Item) -> None:
original = ext_item.properties[dc.DIMENSIONS_PROP]
value = dc.Dimension(
{"type": "bands", "values": ["red", "coastal", "green", "blue"]}
)
dc.DatacubeExtension.ext(ext_item).dimensions = {"spectral": value}
new = ext_item.properties[dc.DIMENSIONS_PROP]
assert new != original
assert new == {"spectral": value.to_dict()}
assert ext_item.validate()
@pytest.mark.parametrize("version", ["v1.0.0", "v2.0.0", "v2.1.0"])
def test_migrate(version: str, ext_item: Item) -> None:
item_dict = ext_item.to_dict(include_self_link=False, transform_hrefs=False)
item_dict["stac_extensions"] = [
f"https://stac-extensions.github.io/datacube/{version}/schema.json"
]
item = Item.from_dict(item_dict, migrate=True)
assert (
"https://stac-extensions.github.io/datacube/v2.2.0/schema.json"
in item.stac_extensions
)
def test_asset(item: Item) -> None:
asset = Asset(href="data.tif")
item.add_asset("data", asset)
assert not asset.ext.has("cube")
asset.ext.add("cube")
assert asset.ext.has("cube")
def test_spatial_vector_object(item: Item) -> None:
item.ext.add("cube")
vector = dc.VectorSpatialDimension.from_dict(
{
"type": "geometries",
"axes": ["x", "y"],
"description": "A test vector spatial dimension",
"bbox": [-180, -90, 180, 90],
"values": ["POINT (-105.1019 40.1672)"],
"geometry_types": ["Point"],
"reference_system": 4326,
}
)
item.ext.cube.dimensions = {"vector": vector}
dimension = item.ext.cube.dimensions["vector"]
assert isinstance(dimension, dc.VectorSpatialDimension)
assert dimension.dim_type == "geometries"
assert dimension.axes == ["x", "y"]
assert dimension.description == "A test vector spatial dimension"
assert dimension.bbox == [-180, -90, 180, 90]
assert dimension.values == ["POINT (-105.1019 40.1672)"]
assert dimension.geometry_types == ["Point"]
assert dimension.reference_system == 4326
|