File: conftest.py

package info (click to toggle)
stac-pydantic 3.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,332 kB
  • sloc: python: 1,849; makefile: 4
file content (87 lines) | stat: -rw-r--r-- 2,629 bytes parent folder | download
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
import json
import os
from copy import deepcopy
from typing import List, Optional, Type

import dictdiffer
import pytest
import requests
from click.testing import CliRunner
from pydantic import BaseModel, TypeAdapter

from stac_pydantic.shared import UtcDatetime


def request(url: str, path: Optional[List[str]] = None):
    if path is None:
        path = ["tests", "example_stac"]

    if url.startswith("http"):
        r = requests.get(url)
        r.raise_for_status()
        return r.json()
    else:
        _full_path = deepcopy(path)
        _full_path.append(url)
        full_path = os.path.join(*_full_path)
        with open(full_path, "r") as local_file:
            lines = local_file.readlines()
        full_file = "".join(lines)
        return json.loads(full_file)


# Use a TypeAdapter to parse any datetime strings in a consistent manner
UtcDatetimeAdapter = TypeAdapter(UtcDatetime)


def dict_match(d1: dict, d2: dict):
    test = dictdiffer.diff(d1, d2)
    for diff in test:
        # geojson-pydantic uses tuples for coordinates, but sometimes the example data are lists
        if "coordinates" in diff[1]:
            assert list(diff[2][0]) == list(diff[2][1])
        # same for bbox
        elif "bbox" in diff[1]:
            assert list(diff[2][0]) == list(diff[2][1])
        # RFC3339 is quite flexible and the test data uses various options to represent datetimes.
        # The datetime string stac-pydantic outputs may not be identical to the input. So we need
        # to compare the values as datetime objects.
        elif "datetime" in diff[1]:
            dates = [
                UtcDatetimeAdapter.validate_strings(date, strict=True)
                if isinstance(date, str)
                else date
                for date in diff[2]
            ]
            assert dates[0] == dates[1]
        # any other differences are errors
        elif "stac_extensions" in diff[1]:
            url1, url2 = map(str, diff[2])
            assert url1 == url2

        else:
            raise AssertionError("Unexpected difference: ", diff)


def compare_example(
    example_url: str,
    model: Type[BaseModel],
    fields: Optional[List[str]] = None,
    path: Optional[List[str]] = None,
) -> None:
    if path is None:
        path = ["tests", "example_stac"]

    example = request(example_url, path)
    model_dict = json.loads(model(**example).model_dump_json())

    if fields:
        for field in fields:
            assert model_dict.get(field) == example.get(field)
    else:
        dict_match(model_dict, example)


@pytest.fixture
def cli_runner():
    return CliRunner()