hestia-earth-models 0.59.4__py3-none-any.whl → 0.59.6__py3-none-any.whl

tests/models/utils/test_blank_node.py

@@ -1,8 +1,10 @@
 from datetime import datetime
 import pytest
+from pytest import mark
 from unittest.mock import patch
 
 from hestia_earth.schema import SiteSiteType
+from hestia_earth.utils.tools import parse
 
 from hestia_earth.models.utils.blank_node import (
     _calc_datetime_range_intersection_duration,
@@ -552,13 +554,31 @@ GROUP_NODES_BY_YEAR_SCENARIO_A_CYCLES = [
 ]
 
 
-def test_group_nodes_by_year_scenario_a():
+@mark.parametrize(
+    "system_datetime",
+    [
+        datetime(2024, 5, 1),  # Closes issue 772
+        datetime(2024, 1, 1),  # Jan 1st
+        datetime(2024, 2, 29),  # Leap year
+        datetime(2024, 12, 31),  # Dec 31st
+        # 3 random dates...
+        datetime(2030, 5, 4),
+        datetime(2035, 7, 22),
+        datetime(2047, 8, 14)
+    ],
+    ids=lambda system_datetime: f"system_datetime = {datetime.strftime(system_datetime, r'%Y-%m-%d')}"
+)
+@patch("hestia_earth.utils.tools.parse")
+def test_group_nodes_by_year_scenario_a(mock_parse, system_datetime):
     """
     Datestr in format `YYYY`. Some nodes missing `startDate` field. One multi-year cycle.
 
     Incomplete datestrs are gapfilled by default; with `endDate` datestrs snapping to the end
     of the calendar year, and `startDate` datestrs snapping to the beginning of the calendar
     year.
+
+    A bug used to occur in this function when it was run on the first day of a calendar month (e.g., 2024-04-01). To
+    verify that the bug is fixed we have simulated running the function on a variety of different dates.
     """
 
     EXPECTED = {
@@ -597,6 +617,9 @@ def test_group_nodes_by_year_scenario_a():
         }]
     }
 
+    # As we can't mock builtin method datetime.now(), we have to pass our test system_datetime into the parse function.
+    mock_parse.side_effect = lambda *args, **kwargs: parse(*args, default=system_datetime, **kwargs)
+
     result = group_nodes_by_year(GROUP_NODES_BY_YEAR_SCENARIO_A_CYCLES)
     assert result == EXPECTED
 
@@ -965,7 +988,26 @@ def test_group_nodes_by_year_missing_dates():
     assert result == EXPECTED
 
 
-def test_group_nodes_by_year_multiple_values_and_dates():
+@mark.parametrize(
+    "system_datetime",
+    [
+        datetime(2024, 5, 1),  # Closes issue 772
+        datetime(2024, 1, 1),  # Jan 1st
+        datetime(2024, 2, 29),  # Leap year
+        datetime(2024, 12, 31),  # Dec 31st
+        # 3 random dates...
+        datetime(2026, 5, 14),
+        datetime(2032, 10, 10),
+        datetime(2043, 8, 22)
+    ],
+    ids=lambda system_datetime: f"system_datetime = {datetime.strftime(system_datetime, r'%Y-%m-%d')}"
+)
+@patch("hestia_earth.utils.tools.parse")
+def test_group_nodes_by_year_multiple_values_and_dates(mock_parse, system_datetime):
+    """
+    A bug used to occur in this function when it was run on the first day of a calendar month (e.g., 2024-04-01). To
+    verify that the bug is fixed we have simulated running the function on a variety of different dates.
+    """
 
     NODES = [{
         "value": [1, 2, 3, 4, 5],
@@ -1005,11 +1047,34 @@ def test_group_nodes_by_year_multiple_values_and_dates():
         }]
     }
 
+    # As we can't mock builtin method datetime.now(), we have to pass our test system_datetime into the parse function.
+    mock_parse.side_effect = lambda *args, **kwargs: parse(*args, default=system_datetime, **kwargs)
+
     result = group_nodes_by_year(NODES, mode=GroupNodesByYearMode.DATES)
     assert result == EXPECTED
 
 
-def test_group_nodes_by_year_and_month():
+@mark.parametrize(
+    "system_datetime",
+    [
+        datetime(2024, 5, 1),  # Closes issue 772
+        datetime(2024, 1, 1),  # Jan 1st
+        datetime(2024, 2, 29),  # Leap year
+        datetime(2024, 12, 31),  # Dec 31st
+        # 3 random dates...
+        datetime(2026, 4, 6),
+        datetime(2034, 7, 24),
+        datetime(2049, 10, 10)
+    ],
+    ids=lambda system_datetime: f"system_datetime = {datetime.strftime(system_datetime, r'%Y-%m-%d')}"
+)
+@patch("hestia_earth.utils.tools.parse")
+def test_group_nodes_by_year_and_month(mock_parse, system_datetime):
+    """
+    A bug used to occur in this function when it was run on the first day of a calendar month (e.g., 2024-04-01). To
+    verify that the bug is fixed we have simulated running the function on a variety of different dates.
+    """
+
     MANAGEMENT = [
         {
             "term.@id": "fullTillage",
@@ -1064,5 +1129,8 @@ def test_group_nodes_by_year_and_month():
         }
     }
 
+    # As we can't mock builtin method datetime.now(), we have to pass our test system date into the parse function.
+    mock_parse.side_effect = lambda *args, **kwargs: parse(*args, default=system_datetime, **kwargs)
+
     result = group_nodes_by_year_and_month(MANAGEMENT)
     assert result == EXPECTED

tests/models/utils/test_term.py

@@ -4,7 +4,7 @@ from hestia_earth.models.utils.term import (
     get_liquid_fuel_terms, get_irrigation_terms, get_urea_terms, get_excreta_N_terms, get_excreta_VS_terms,
     get_generic_crop, get_rice_paddy_terms, get_tillage_terms, get_crop_residue_terms, get_cover_crop_property_terms,
     get_crop_residue_incorporated_or_left_on_field_terms, get_irrigated_terms, get_residue_removed_or_burnt_terms,
-    get_upland_rice_land_cover_terms, get_upland_rice_crop_terms, get_long_fallow_land_cover_terms
+    get_upland_rice_land_cover_terms, get_upland_rice_crop_terms
 )
 
 class_path = 'hestia_earth.models.utils.term'
@@ -113,10 +113,3 @@ def test_get_upland_rice_crop_terms(mock_find_node):
     id = 'term-id'
     mock_find_node.return_value = [{'@id': id}]
     assert get_upland_rice_crop_terms() == [id]
-
-
-@patch(f"{class_path}.search")
-def test_get_long_fallow_land_cover_terms(mock_find_node):
-    id = 'term-id'
-    mock_find_node.return_value = [{'@id': id}]
-    assert get_long_fallow_land_cover_terms() == [id]

hestia_earth/models/cycle/pre_checks/startDate.py

@@ -1,52 +0,0 @@
-"""
-Pre Checks Start Date
-
-This model calculates the
-[startDate](https://hestia.earth/schema/Cycle#startDate) from the
-[endDate](https://hestia.earth/schema/Cycle#endDate) and
-[cycleDuration](https://hestia.earth/schema/Cycle#cycleDuration).
-"""
-from dateutil.relativedelta import relativedelta
-from hestia_earth.utils.date import is_in_days
-from hestia_earth.utils.tools import safe_parse_date
-
-from hestia_earth.models.log import logRequirements, logShouldRun
-from .. import MODEL
-
-REQUIREMENTS = {
-    "Cycle": {
-        "endDate": "",
-        "cycleDuration": ""
-    }
-}
-RETURNS = {
-    "Cycle": {
-        "startDate": ""
-    }
-}
-MODEL_KEY = 'startDate'
-
-
-def _run(cycle: dict):
-    days = -float(cycle.get('cycleDuration'))
-    return (safe_parse_date(cycle.get('endDate')) + relativedelta(days=days)).strftime('%Y-%m-%d')
-
-
-def _should_run(cycle: dict):
-    has_full_date = is_in_days(cycle.get('endDate'))
-    cycleDuration = cycle.get('cycleDuration')
-
-    logRequirements(cycle, model=MODEL, key=MODEL_KEY,
-                    has_full_date=has_full_date,
-                    cycleDuration=cycleDuration)
-
-    should_run = all([
-        has_full_date,
-        cycleDuration is not None,
-        cycle.get(MODEL_KEY) is None
-    ])
-    logShouldRun(cycle, MODEL, None, should_run, key=MODEL_KEY)
-    return should_run
-
-
-def run(cycle: dict): return {**cycle, MODEL_KEY: _run(cycle)} if _should_run(cycle) else cycle

tests/models/cycle/pre_checks/test_startDate.py

@@ -1,44 +0,0 @@
-import json
-from tests.utils import fixtures_path
-
-from hestia_earth.models.cycle.pre_checks.startDate import run, _should_run
-
-fixtures_folder = f"{fixtures_path}/cycle/pre_checks/startDate"
-
-
-def test_should_run():
-    cycle = {}
-
-    # no endDate => no run
-    cycle['endDate'] = None
-    assert not _should_run(cycle)
-
-    cycle['endDate'] = '2010'
-    # no cycleDuration => no run
-    cycle['cycleDuration'] = None
-    assert not _should_run(cycle)
-
-    cycle['cycleDuration'] = 120
-    # with a startDate => no run
-    cycle['startDate'] = '2010'
-    assert not _should_run(cycle)
-
-    cycle['startDate'] = None
-    # endDate not precise enough => no run
-    cycle['endDate'] = '2020-01'
-    assert not _should_run(cycle)
-
-    # endDate is precise enough => run
-    cycle['endDate'] = '2020-01-01'
-    assert _should_run(cycle) is True
-
-
-def test_run():
-    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
-        cycle = json.load(f)
-
-    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
-        expected = json.load(f)
-
-    value = run(cycle)
-    assert value == expected