Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

###

- added tests for the fields extension, which were previously missing ([#902](https://github.com/stac-utils/stac-fastapi/pull/902))

### Fixed

- fix mypy type errors in transaction extension for Python 3.14 compatibility (mypy 1.20.0) ([#895](https://github.com/stac-utils/stac-fastapi/pull/895))
Expand Down
68 changes: 68 additions & 0 deletions stac_fastapi/extensions/tests/test_fields.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
"""Tests for the Fields extension."""

import pytest
from fastapi import FastAPI

from stac_fastapi.extensions.core.fields import (
FieldsConformanceClasses,
FieldsExtension,
)
from stac_fastapi.extensions.core.fields.request import (
FieldsExtensionGetRequest,
FieldsExtensionPostRequest,
)


def test_fields_conformance_classes():
"""Test that the enum values match the official STAC API spec URIs."""
assert (
FieldsConformanceClasses.SEARCH
== "https://api.stacspec.org/v1.0.0/item-search#fields"
)
assert (
FieldsConformanceClasses.ITEMS
== "https://api.stacspec.org/v1.0.0/ogcapi-features#fields"
)
assert (
FieldsConformanceClasses.COLLECTIONS
== "https://api.stacspec.org/v1.0.0-rc.1/collection-search#fields"
)


def test_fields_extension_defaults():
"""Test the default instantiation of the FieldsExtension."""
ext = FieldsExtension()

assert ext.schema_href is None
assert ext.conformance_classes == [FieldsConformanceClasses.SEARCH]

assert ext.GET == FieldsExtensionGetRequest
assert ext.POST == FieldsExtensionPostRequest


def test_fields_extension_customization():
"""Test instantiating FieldsExtension with custom arguments."""
custom_conformance = [
FieldsConformanceClasses.SEARCH,
FieldsConformanceClasses.ITEMS,
]
custom_schema = "https://example.com/fields-schema.json"

ext = FieldsExtension(
conformance_classes=custom_conformance,
schema_href=custom_schema,
)

assert ext.conformance_classes == custom_conformance
assert ext.schema_href == custom_schema


def test_fields_extension_register():
"""Test the register method with a dummy FastAPI app."""
ext = FieldsExtension()
app = FastAPI()

try:
ext.register(app)
except Exception as e:
pytest.fail(f"FieldsExtension.register() raised an exception: {e}")
63 changes: 63 additions & 0 deletions stac_fastapi/extensions/tests/test_fields_request.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
from stac_fastapi.extensions.core.fields.request import (
FieldsExtensionGetRequest,
FieldsExtensionPostRequest,
PostFieldsExtension,
)


def test_post_fields_extension_defaults():
"""Test the default instantiation."""
ext = PostFieldsExtension()
assert ext.include == set()
assert ext.exclude == set()


def test_get_field_dict_empty():
"""Test field dict generation with empty/None inputs."""
assert PostFieldsExtension._get_field_dict(None) == {}
assert PostFieldsExtension._get_field_dict(set()) == {}


def test_get_field_dict_simple_fields():
"""Test field dict generation with top-level fields."""
fields = {"id", "type", "geometry"}
result = PostFieldsExtension._get_field_dict(fields)

assert result == {"id": ..., "type": ..., "geometry": ...}


def test_get_field_dict_nested_fields():
"""Test field dict generation with dot-notation nested fields."""
fields = {"properties.datetime", "properties.cloud_cover", "assets.visual"}
result = PostFieldsExtension._get_field_dict(fields)

assert result == {"properties": {"datetime", "cloud_cover"}, "assets": {"visual"}}


def test_get_field_dict_mixed_fields():
"""Test field dict generation with a mix of top-level and nested fields."""
fields = {"id", "properties", "properties.datetime"}

result = PostFieldsExtension._get_field_dict(fields)

assert "id" in result
assert result["id"] is ...
assert "properties" in result


def test_fields_extension_get_request():
"""Test that the GET request properly uses the converter
for comma-separated strings."""
req = FieldsExtensionGetRequest(fields="id,type,properties.datetime")
assert req.fields == ["id", "type", "properties.datetime"]

req_none = FieldsExtensionGetRequest(fields=None)
assert req_none.fields is None


def test_fields_extension_post_request():
"""Test POST request model defaults."""
req = FieldsExtensionPostRequest()
assert isinstance(req.fields, PostFieldsExtension)
assert req.fields.include == set()
assert req.fields.exclude == set()