hestia-earth-models 0.64.6__py3-none-any.whl → 0.64.8__py3-none-any.whl

tests/models/environmentalFootprintV3/test_soilQualityIndexLandTransformation.py

@@ -0,0 +1,113 @@
+import json
+from unittest.mock import patch
+
+from hestia_earth.models.environmentalFootprintV3.soilQualityIndexLandTransformation import MODEL, TERM_ID, run, \
+    _should_run
+from tests.utils import fixtures_path, fake_new_indicator
+
+class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
+
+
+def fake_rounded_indicator(value: float):
+    indicator = fake_new_indicator(TERM_ID, MODEL)
+    indicator['value'] = round(value, 7)
+    return indicator
+
+
+def test_should_run_ocean(*args):
+    """
+    Should not run if a LandCover has no CF (ocean)
+    """
+    with open(f"{fixtures_folder}/bad-sites/site-LandCover-has-no-CF.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    should_run, *args = _should_run(site)
+    assert should_run is False
+
+
+def test_should_run_no_management_entries(*args):
+    """
+    no management => no run
+    """
+    with open(f"{fixtures_folder}/bad-sites/site-no-management.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    should_run, *args = _should_run(site)
+    assert should_run is False
+
+
+def test_should_run_no_sites(*args):
+    """
+    impact assessment with no site => no run
+    """
+    with open(f"{fixtures_path}/impact_assessment/emissions/impact-assessment.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    should_run, *args = _should_run(site)
+    assert should_run is False
+
+
+def test_should_run_no_transformation(*args):
+    """
+    1 management with no transformation => no run
+    """
+    with open(f"{fixtures_folder}/bad-sites/site-no-transformations.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    should_run, *args = _should_run(site)
+    assert should_run is False
+
+
+@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+def test_run_in_cycle(*args):
+    with open(f"{fixtures_folder}/Italy/site-italy-inside-cycle.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{fixtures_folder}/Italy/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(site)
+    assert value == expected
+
+
+@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+def test_run_other_sites(*args):
+    with open(f"{fixtures_folder}/Italy/site-italy-otherSites.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{fixtures_folder}/Italy/result-otherSites.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(site)
+    assert value == expected
+
+
+@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+def test_run_with_region(*args):
+    """
+    When given valid sub-region or country not in the lookup file should default to 'region-world'
+    """
+    with open(f"{fixtures_folder}/region-world/region-europe.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{fixtures_folder}/region-world/result-default-region-world.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(site)
+    assert value == expected
+
+
+@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+def test_run_with_no_region(*args):
+    """
+    When no location is specified, defaults to region world.
+    """
+    with open(f"{fixtures_folder}/region-world/no-region.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{fixtures_folder}/region-world/result-default-region-world.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(site)
+    assert value == expected

tests/models/environmentalFootprintV3/test_soilQualityIndexTotalLandUseEffects.py

@@ -0,0 +1,50 @@
+import json
+from unittest.mock import patch
+
+from pytest import mark
+
+from hestia_earth.models.environmentalFootprintV3.soilQualityIndexTotalLandUseEffects import MODEL, TERM_ID, run, \
+    _should_run
+from tests.utils import fixtures_path, fake_new_indicator
+
+class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
+
+transform_indicator = {'term': {'@id': 'soilQualityIndexLandTransformation'}, 'value': 10}
+occupation_indicator = {'term': {'@id': 'soilQualityIndexLandOccupation'}, 'value': 10}
+missing_value_indicator = {'term': {'@id': 'soilQualityIndexLandOccupation'}}
+bad_value_indicator = {'term': {'@id': 'soilQualityIndexLandOccupation'}, 'value': "42"}
+
+
+@mark.parametrize(
+    "emissions_resource_use, expected",
+    [
+        ([], False),
+        ([transform_indicator], False),
+        ([transform_indicator, transform_indicator], False),
+        ([transform_indicator, missing_value_indicator], False),
+        ([transform_indicator, bad_value_indicator], False),
+        ([transform_indicator, occupation_indicator], True),
+    ],
+    ids=["Empty", "missing entry", "duplicate entry", "no value in entry", "bad value in entry", "correct assessment"]
+)
+def test_should_run(emissions_resource_use, expected):
+    with open(f"{fixtures_folder}/impactassessment.jsonld", encoding='utf-8') as f:
+        impactassessment = json.load(f)
+
+    impactassessment['emissionsResourceUse'] = emissions_resource_use
+
+    should_run, *args = _should_run(impactassessment)
+    assert should_run is expected
+
+
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
+def test_run(*args):
+    with open(f"{fixtures_folder}/impactassessment.jsonld", encoding='utf-8') as f:
+        impactassessment = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(impactassessment)
+    assert value == expected

tests/models/ipcc2019/test_co2ToAirAboveGroundBiomassStockChangeLandUseChange.py

@@ -0,0 +1,83 @@
+from functools import reduce
+import json
+from os.path import isfile
+from pytest import mark
+from unittest.mock import patch
+
+from hestia_earth.models.ipcc2019.co2ToAirAboveGroundBiomassStockChangeLandUseChange import MODEL, run, TERM_ID
+
+from tests.utils import fake_new_emission, fixtures_path
+
+class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+utils_path = f"hestia_earth.models.{MODEL}.co2ToAirCarbonStockChange_utils"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
+
+RUN_SCENARIOS = [
+    ("no-overlapping-cycles", 3),
+    ("overlapping-cycles", 4),
+    ("complex-overlapping-cycles", 5),
+    ("missing-measurement-dates", 3),
+    ("no-biomass-measurements", 1),               # Closes issue #700
+    ("non-consecutive-biomass-measurements", 1),  # Closes issue #827
+    ("multiple-method-classifications", 5),              # Closes issue #764
+    ("non-soil-based-gohac-system", 3),                  # Closes issue #848
+    ("soil-based-gohac-system", 3)                       # Closes issue #848
+]
+"""List of (subfolder: str, num_cycles: int)."""
+
+
+def _load_fixture(path: str, default=None):
+    if isfile(path):
+        with open(path, encoding="utf-8") as f:
+            return json.load(f)
+    return default
+
+
+RUN_PARAMS = reduce(
+    lambda params, scenario: params + [(scenario[0], scenario[1], i) for i in range(scenario[1])],
+    RUN_SCENARIOS,
+    list()
+)
+"""List of (subfolder: str, num_cycles: int, cycle_index: int)."""
+
+RUN_IDS = [f"{param[0]}, cycle{param[2]}" for param in RUN_PARAMS]
+
+
+@mark.parametrize("subfolder, num_cycles, cycle_index", RUN_PARAMS, ids=RUN_IDS)
+@patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")  # TODO: rationalise order of patches
+def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder, num_cycles, cycle_index):
+    """
+    Test `run` function for each cycle in each scenario.
+    """
+    site = _load_fixture(f"{fixtures_folder}/{subfolder}/site.jsonld")
+    cycle = _load_fixture(f"{fixtures_folder}/{subfolder}/cycle{cycle_index}.jsonld")
+    expected = _load_fixture(f"{fixtures_folder}/{subfolder}/result{cycle_index}.jsonld", default=[])
+
+    cycles = [
+        _load_fixture(f"{fixtures_folder}/{subfolder}/cycle{i}.jsonld") for i in range(num_cycles)
+    ]
+
+    _get_site_mock.return_value = site
+    related_cycles_mock.return_value = cycles
+
+    result = run(cycle)
+    assert result == expected
+
+
+@patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")  # TODO: rationalise order of patches
+def test_run_empty(_get_site_mock, related_cycles_mock, _new_emission_mock):
+    """
+    Test `run` function for each cycle in each scenario.
+    """
+    CYCLE = {}
+    EXPECTED = []
+
+    _get_site_mock.return_value = {}
+    related_cycles_mock.return_value = [CYCLE]
+
+    result = run(CYCLE)
+    assert result == EXPECTED

tests/models/ipcc2019/test_co2ToAirBelowGroundBiomassStockChangeLandUseChange.py

@@ -0,0 +1,83 @@
+from functools import reduce
+import json
+from os.path import isfile
+from pytest import mark
+from unittest.mock import patch
+
+from hestia_earth.models.ipcc2019.co2ToAirBelowGroundBiomassStockChangeLandUseChange import MODEL, run, TERM_ID
+
+from tests.utils import fake_new_emission, fixtures_path
+
+class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+utils_path = f"hestia_earth.models.{MODEL}.co2ToAirCarbonStockChange_utils"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
+
+RUN_SCENARIOS = [
+    ("no-overlapping-cycles", 3),
+    ("overlapping-cycles", 4),
+    ("complex-overlapping-cycles", 5),
+    ("missing-measurement-dates", 3),
+    ("no-biomass-measurements", 1),               # Closes issue #700
+    ("non-consecutive-biomass-measurements", 1),  # Closes issue #827
+    ("multiple-method-classifications", 5),              # Closes issue #764
+    ("non-soil-based-gohac-system", 3),                  # Closes issue #848
+    ("soil-based-gohac-system", 3)                       # Closes issue #848
+]
+"""List of (subfolder: str, num_cycles: int)."""
+
+
+def _load_fixture(path: str, default=None):
+    if isfile(path):
+        with open(path, encoding="utf-8") as f:
+            return json.load(f)
+    return default
+
+
+RUN_PARAMS = reduce(
+    lambda params, scenario: params + [(scenario[0], scenario[1], i) for i in range(scenario[1])],
+    RUN_SCENARIOS,
+    list()
+)
+"""List of (subfolder: str, num_cycles: int, cycle_index: int)."""
+
+RUN_IDS = [f"{param[0]}, cycle{param[2]}" for param in RUN_PARAMS]
+
+
+@mark.parametrize("subfolder, num_cycles, cycle_index", RUN_PARAMS, ids=RUN_IDS)
+@patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")
+def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder, num_cycles, cycle_index):
+    """
+    Test `run` function for each cycle in each scenario.
+    """
+    site = _load_fixture(f"{fixtures_folder}/{subfolder}/site.jsonld")
+    cycle = _load_fixture(f"{fixtures_folder}/{subfolder}/cycle{cycle_index}.jsonld")
+    expected = _load_fixture(f"{fixtures_folder}/{subfolder}/result{cycle_index}.jsonld", default=[])
+
+    cycles = [
+        _load_fixture(f"{fixtures_folder}/{subfolder}/cycle{i}.jsonld") for i in range(num_cycles)
+    ]
+
+    _get_site_mock.return_value = site
+    related_cycles_mock.return_value = cycles
+
+    result = run(cycle)
+    assert result == expected
+
+
+@patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")
+def test_run_empty(_get_site_mock, related_cycles_mock, _new_emission_mock):
+    """
+    Test `run` function for each cycle in each scenario.
+    """
+    CYCLE = {}
+    EXPECTED = []
+
+    _get_site_mock.return_value = {}
+    related_cycles_mock.return_value = [CYCLE]
+
+    result = run(CYCLE)
+    assert result == EXPECTED

tests/models/ipcc2019/test_co2ToAirCarbonStockChange_utils.py

@@ -1,8 +1,8 @@
 from hestia_earth.schema import EmissionMethodTier, MeasurementMethodClassification
 
 from hestia_earth.models.ipcc2019.co2ToAirCarbonStockChange_utils import (
-    add_carbon_stock_change_emissions, calc_carbon_stock_change, calc_carbon_stock_change_emission, _convert_c_to_co2,
-    lerp_carbon_stocks, CarbonStock, CarbonStockChange, CarbonStockChangeEmission
+    _add_carbon_stock_change_emissions, _calc_carbon_stock_change, _calc_carbon_stock_change_emission,
+    _convert_c_to_co2, _lerp_carbon_stocks, CarbonStock, CarbonStockChange, CarbonStockChangeEmission
 )
 
 
@@ -20,7 +20,7 @@ def test_lerp_carbon_stocks():
         21000, "2001-12-31", MeasurementMethodClassification.ON_SITE_PHYSICAL_MEASUREMENT
     )
 
-    result = lerp_carbon_stocks(START, END, TARGET_DATE)
+    result = _lerp_carbon_stocks(START, END, TARGET_DATE)
     assert result == EXPECTED
 
 
@@ -29,7 +29,7 @@ def test_calc_carbon_stock_change():
     END = CarbonStock(21000,  "2001", MeasurementMethodClassification.TIER_1_MODEL)
     EXPECTED = CarbonStockChange(1000, "2000", "2001", MeasurementMethodClassification.TIER_1_MODEL)
 
-    result = calc_carbon_stock_change(START, END)
+    result = _calc_carbon_stock_change(START, END)
     assert result == EXPECTED
 
 
@@ -37,7 +37,7 @@ def test_calc_carbon_stock_change_emission():
     SOC_STOCK_CHANGE = CarbonStockChange(-1000, "2000", "2001", MeasurementMethodClassification.TIER_1_MODEL)
     EXPECTED = CarbonStockChangeEmission(3663.836163836164, "2000", "2001", EmissionMethodTier.TIER_1)
 
-    result = calc_carbon_stock_change_emission(SOC_STOCK_CHANGE)
+    result = _calc_carbon_stock_change_emission(SOC_STOCK_CHANGE)
     assert result == EXPECTED
 
 
@@ -46,5 +46,5 @@ def test_add_carbon_stock_change_emissions():
     EMISSION_2 = CarbonStockChangeEmission(2000, "2001", "2002", EmissionMethodTier.TIER_1)
     EXPECTED = CarbonStockChangeEmission(5000, "2000", "2002", EmissionMethodTier.TIER_1)
 
-    result = add_carbon_stock_change_emissions(EMISSION_1, EMISSION_2)
+    result = _add_carbon_stock_change_emissions(EMISSION_1, EMISSION_2)
     assert result == EXPECTED

tests/models/ipcc2019/test_co2ToAirSoilOrganicCarbonStockChangeManagementChange.py

@@ -9,6 +9,7 @@ from hestia_earth.models.ipcc2019.co2ToAirSoilOrganicCarbonStockChangeManagement
 from tests.utils import fake_new_emission, fixtures_path
 
 class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+utils_path = f"hestia_earth.models.{MODEL}.co2ToAirCarbonStockChange_utils"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
 RUN_SCENARIOS = [
@@ -44,8 +45,8 @@ RUN_IDS = [f"{param[0]}, cycle{param[2]}" for param in RUN_PARAMS]
 
 @mark.parametrize("subfolder, num_cycles, cycle_index", RUN_PARAMS, ids=RUN_IDS)
 @patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
-@patch(f"{class_path}.related_cycles")
-@patch(f"{class_path}._get_site")
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")
 def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder, num_cycles, cycle_index):
     """
     Test `run` function for each cycle in each scenario.
@@ -66,8 +67,8 @@ def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder,
 
 
 @patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
-@patch(f"{class_path}.related_cycles")
-@patch(f"{class_path}._get_site")
+@patch(f"{utils_path}.related_cycles")
+@patch(f"{utils_path}._get_site")
 def test_run_empty(_get_site_mock, related_cycles_mock, _new_emission_mock):
     """
     Test `run` function for each cycle in each scenario.

tests/models/pooreNemecek2018/test_landOccupationDuringCycle.py

@@ -9,8 +9,9 @@ class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
 
+@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
 @patch(f"{class_path}.land_occupation_per_kg", return_value=None)
-def test_should_run(mock_land_occupation):
+def test_should_run(mock_land_occupation, *args):
     # with a cycle and functionalUnit = 1 ha => no run
     impact = {'cycle': {'functionalUnit': CycleFunctionalUnit._1_HA.value}}
     should_run, *args = _should_run(impact)
@@ -22,6 +23,7 @@ def test_should_run(mock_land_occupation):
     assert should_run is True
 
 
+@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run(*args):
     with open(f"{fixtures_folder}/impact-assessment.jsonld", encoding='utf-8') as f:
@@ -34,6 +36,7 @@ def test_run(*args):
     assert value == expected
 
 
+@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run_with_plantation(*args):
     with open(f"{fixtures_folder}/with-orchard-crop/impact-assessment.jsonld", encoding='utf-8') as f:

tests/models/site/test_management.py

@@ -25,7 +25,10 @@ TERM_BY_ID = {
     }
 }
 
-LAND_COVER_TERM_BY_SITE_TYPE = {SiteSiteType.ANIMAL_HOUSING.value: "animalHousing"}
+LAND_COVER_TERM_BY_SITE_TYPE = {
+    SiteSiteType.ANIMAL_HOUSING.value: "animalHousing",
+    SiteSiteType.CROPLAND.value: "cropland"
+}
 
 
 def lookup_side_effect(*args, **kwargs):

tests/models/utils/test_input.py

@@ -1,7 +1,9 @@
+import pytest
 from unittest.mock import patch
+from hestia_earth.schema import TermTermType
 from tests.utils import TERM
 
-from hestia_earth.models.utils.input import _new_input
+from hestia_earth.models.utils.input import _new_input, get_feed_inputs
 
 class_path = 'hestia_earth.models.utils.input'
 
@@ -22,3 +24,65 @@ def test_new_input(*args):
         '@type': 'Input',
         'term': TERM
     }
+
+
+@pytest.mark.parametrize(
+    'test_name,cycle,expected_input_length',
+    [
+        (
+            'no inputs',
+            {},
+            0
+        ),
+        (
+            'with crop feed',
+            {
+                'inputs': [{
+                    'term': {'units': 'kg', 'termType': TermTermType.CROP.value, '@id': 'wheatGrain'},
+                    'isAnimalFeed': True,
+                    'value': [10]
+                }]
+            },
+            1
+        ),
+        (
+            'with crop no feed',
+            {
+                'inputs': [{
+                    'term': {'units': 'kg', 'termType': TermTermType.CROP.value, '@id': 'wheatGrain'},
+                    'isAnimalFeed': False,
+                    'value': [10]
+                }]
+            },
+            0
+        ),
+        (
+            'with feed food additive and energy content',
+            {
+                'inputs': [{
+                    'term': {
+                        'units': 'kg', 'termType': TermTermType.FEEDFOODADDITIVE.value, '@id': 'aminoAcidsUnspecified'
+                    },
+                    'isAnimalFeed': True,
+                    'value': [10]
+                }]
+            },
+            1
+        ),
+        (
+            'with feed food additive not energy content',
+            {
+                'inputs': [{
+                    'term': {
+                        'units': 'kg', 'termType': TermTermType.FEEDFOODADDITIVE.value, '@id': 'premixUnspecified'
+                    },
+                    'isAnimalFeed': True,
+                    'value': [10]
+                }]
+            },
+            0
+        ),
+    ]
+)
+def test_get_feed_inputs(test_name, cycle, expected_input_length):
+    assert len(get_feed_inputs(cycle)) == expected_input_length, test_name