pygeoapi/tests/test_parquet_provider.py

# =================================================================
#
# Authors: Leo Ghignone <leo.ghignone@gmail.com>
#
# Copyright (c) 2024 Leo Ghignone
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================

import pytest

from pygeoapi.provider.base import ProviderItemNotFoundError
from pygeoapi.provider.parquet import ParquetProvider

from .util import get_test_file_path

path = get_test_file_path(
    'data/random.parquet')

path_nogeom = get_test_file_path(
    'data/random_nogeom.parquet')


@pytest.fixture()
def config_parquet():
    return {
        'name': 'Parquet',
        'type': 'feature',
        'data': {
            'source_type': 'Parquet',
            'source': path,
        },
        'id_field': 'id',
        'time_field': 'time',
        'x_field': 'lon',
        'y_field': 'lat',
    }


@pytest.fixture()
def config_parquet_nogeom_notime():
    return {
        'name': 'ParquetNoGeomNoTime',
        'type': 'feature',
        'data': {
            'source_type': 'Parquet',
            'source': path_nogeom,
        },
        'id_field': 'id'
    }


def test_get_fields(config_parquet):
    """Testing field types"""

    p = ParquetProvider(config_parquet)
    results = p.get_fields()
    assert results['lat']['type'] == 'number'
    assert results['lon']['format'] == 'double'
    assert results['time']['format'] == 'date-time'


def test_get(config_parquet):
    """Testing query for a specific object"""

    p = ParquetProvider(config_parquet)
    result = p.get('42')
    assert result['id'] == '42'
    assert result['properties']['lon'] == 4.947447


def test_get_not_existing_feature_raise_exception(
    config_parquet
):
    """Testing query for a not existing object"""
    p = ParquetProvider(config_parquet)
    with pytest.raises(ProviderItemNotFoundError):
        p.get(-1)


def test_query_hits(config_parquet):
    """Testing query on entire collection for hits"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(resulttype='hits')
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 0
    hits = feature_collection.get('numberMatched')
    assert hits is not None
    assert hits == 100


def test_query_bbox_hits(config_parquet):
    """Testing query for a valid JSON object with geometry"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(
        bbox=[100, -50, 150, 0],
        resulttype='hits')
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 0
    hits = feature_collection.get('numberMatched')
    assert hits is not None
    assert hits == 6


def test_query_with_limit(config_parquet):
    """Testing query for a valid JSON object with geometry"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(limit=2, resulttype='results')
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 2
    hits = feature_collection.get('numberMatched')
    assert hits > 2
    feature = features[0]
    properties = feature.get('properties')
    assert properties is not None
    geometry = feature.get('geometry')
    assert geometry is not None


def test_query_with_offset(config_parquet):
    """Testing query for a valid JSON object with geometry"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(offset=20, limit=10, resulttype='results')
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 10
    hits = feature_collection.get('numberMatched')
    assert hits > 30
    feature = features[0]
    properties = feature.get('properties')
    assert properties is not None
    assert feature['id'] == '21'
    assert properties['lat'] == 66.264988
    geometry = feature.get('geometry')
    assert geometry is not None


def test_query_with_property(config_parquet):
    """Testing query for a valid JSON object with property filter"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(
        resulttype='results',
        properties=[('lon', -12.855022)])
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 1
    for feature in features:
        assert feature['properties']['lon'] == -12.855022


def test_query_with_skip_geometry(config_parquet):
    """Testing query for a valid JSON object with property filter"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(skip_geometry=True)
    for feature in feature_collection['features']:
        assert feature.get('geometry') is None


def test_query_with_datetime(config_parquet):
    """Testing query for a valid JSON object with time"""

    p = ParquetProvider(config_parquet)
    feature_collection = p.query(
        datetime_='2022-05-01T00:00:00Z/2022-05-31T23:59:59Z')
    assert feature_collection.get('type') == 'FeatureCollection'
    features = feature_collection.get('features')
    assert len(features) == 7
    for feature in feature_collection['features']:
        time = feature['properties'][config_parquet['time_field']]
        assert time.year == 2022
        assert time.month == 5


def test_query_nogeom(config_parquet_nogeom_notime):
    """Testing query for a valid JSON object without geometry"""

    p = ParquetProvider(config_parquet_nogeom_notime)
    feature_collection = p.query(resulttype='results')
    assert feature_collection.get('type') == 'FeatureCollection'
    assert len(feature_collection.get('features')) > 0
    for feature in feature_collection['features']:
        assert feature.get('geometry') is None