xrlint/tests/plugins/core/rules/test_content_desc.py at b2df51271033472214863a08521c7a7e0a812335 · bcdev/xrlint · GitHub

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
#  Copyright © 2025 Brockmann Consult GmbH.
#  This software is distributed under the terms and conditions of the
#  MIT license (https://mit-license.org/).

import xarray as xr

from xrlint.plugins.core.rules.content_desc import ContentDesc
from xrlint.testing import RuleTest, RuleTester

global_attrs = dict(
    title="OC-Climatology",
    history="2025-01-26: created",
)

common_attrs = dict(
    institution="ESA",
    source="a.nc; b.nc",
    references="!",
    comment="?",
)

all_attrs = global_attrs | common_attrs

time_coord = xr.DataArray(
    [1, 2, 3], dims="time", attrs=dict(units="days since 2025-01-01")
)

valid_dataset_0 = xr.Dataset(
    attrs=all_attrs,
    data_vars=dict(chl=xr.DataArray([1, 2, 3], dims="time", attrs=dict())),
    coords=dict(time=time_coord),
)
valid_dataset_1 = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(chl=xr.DataArray([1, 2, 3], dims="time", attrs=common_attrs)),
    coords=dict(time=time_coord),
)
valid_dataset_1a = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(
        chl=xr.DataArray([1, 2, 3], dims="time", attrs=common_attrs),
        crs=xr.DataArray(0, attrs=dict(grid_mapping_name="...")),
    ),
    coords=dict(time=time_coord),
)
valid_dataset_1b = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(
        chl=xr.DataArray([1, 2, 3], dims="time", attrs=common_attrs),
        chl_unc=xr.DataArray(0, attrs=dict(units="...")),
    ),
    coords=dict(time=time_coord),
)
valid_dataset_2 = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(chl=xr.DataArray([1, 2, 3], dims="time", attrs=dict())),
    coords=dict(time=time_coord),
)
valid_dataset_3 = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(
        chl=xr.DataArray([1, 2, 3], dims="time", attrs=dict(description="Bla!"))
    ),
    coords=dict(time=time_coord),
)

invalid_dataset_0 = xr.Dataset()
invalid_dataset_1 = xr.Dataset(
    attrs=dict(),
    data_vars=dict(chl=xr.DataArray([1, 2, 3], dims="time", attrs=dict())),
    coords=dict(time=time_coord),
)
invalid_dataset_2 = xr.Dataset(
    attrs=global_attrs,
    data_vars=dict(chl=xr.DataArray([1, 2, 3], dims="time", attrs=dict())),
    coords=dict(time=time_coord),
)

ContentDescTest = RuleTester.define_test(
    "content-desc",
    ContentDesc,
    valid=[
        RuleTest(dataset=valid_dataset_0, name="0"),
        RuleTest(dataset=valid_dataset_1, name="1"),
        RuleTest(dataset=valid_dataset_1a, name="1a"),
        RuleTest(
            dataset=valid_dataset_1b, name="1b", kwargs={"ignored_vars": ["chl_unc"]}
        ),
        RuleTest(dataset=valid_dataset_2, name="2", kwargs={"commons": []}),
        RuleTest(
            dataset=valid_dataset_2, name="2", kwargs={"commons": [], "skip_vars": True}
        ),
        RuleTest(
            dataset=valid_dataset_3, name="3", kwargs={"commons": ["description"]}
        ),
    ],
    invalid=[
        RuleTest(dataset=invalid_dataset_0, expected=2),
        RuleTest(dataset=invalid_dataset_1, expected=6),
        RuleTest(dataset=invalid_dataset_2, kwargs={"skip_vars": True}, expected=4),
    ],
)