fix: error message when model/facility input does not exist

Refs: https://equinor-ecalc.atlassian.net/browse/ECALC-501

Author: jsolaas

src/libecalc/common/errors/exceptions.py

@@ -62,3 +62,10 @@ class IllegalStateException(EcalcError):
 
     def __init__(self, message: str):
         super().__init__("Illegal state", message, error_type=EcalcErrorType.SERVER_ERROR)
+
+
+class InvalidReferenceException(EcalcError):
+    """This exception should hopefully never occur, and indicates a bug in the code."""
+
+    def __init__(self, message: str):
+        super().__init__("Invalid reference", message, error_type=EcalcErrorType.CLIENT_ERROR)

src/libecalc/presentation/yaml/mappers/component_mapper.py

@@ -13,7 +13,7 @@
 from libecalc.presentation.yaml.mappers.consumer_function_mapper import (
     ConsumerFunctionMapper,
 )
-from libecalc.presentation.yaml.mappers.utils import resolve_reference
+from libecalc.presentation.yaml.mappers.utils import resolve_and_validate_reference
 from libecalc.presentation.yaml.validation_errors import (
     DataValidationError,
     DtoValidationError,
@@ -70,13 +70,10 @@ def _resolve_fuel(
 
     temporal_fuel_model = {}
     for start_time, fuel in time_adjusted_fuel.items():
-        resolved_fuel = resolve_reference(
+        resolved_fuel = resolve_and_validate_reference(
             fuel,
             references=references.fuel_types,
-            none_if_not_found=True,
         )
-        if resolved_fuel is None:
-            raise ValueError("Fuel not found")
 
         temporal_fuel_model[start_time] = resolved_fuel
 
@@ -131,7 +128,7 @@ def from_yaml_to_dto(
                 except ValidationError as e:
                     raise DtoValidationError(data=data, validation_error=e) from e
 
-        energy_usage_model = resolve_reference(
+        energy_usage_model = resolve_and_validate_reference(
             data.get(EcalcYamlKeywords.energy_usage_model),
             references=self.__references.models,
         )
@@ -198,7 +195,7 @@ def from_yaml_to_dto(
             data.get(EcalcYamlKeywords.el2fuel), target_period=self._target_period
         )
         generator_set_model = {
-            start_time: resolve_reference(
+            start_time: resolve_and_validate_reference(
                 model_timestep,
                 references=self.__references.models,
             )

src/libecalc/presentation/yaml/mappers/consumer_function_mapper.py

@@ -13,7 +13,6 @@
 from libecalc.expression import Expression
 from libecalc.presentation.yaml.mappers.utils import (
     resolve_and_validate_reference,
-    resolve_reference,
 )
 from libecalc.presentation.yaml.validation_errors import DataValidationError
 from libecalc.presentation.yaml.yaml_entities import References
@@ -146,7 +145,10 @@ def _pump_system_mapper(energy_usage_model: Dict, references: References = None)
     """
     pumps = []
     for pump in energy_usage_model.get(EcalcYamlKeywords.pump_system_pumps, []):
-        pump_model = resolve_reference(pump.get(EcalcYamlKeywords.pump_system_pump_model), references=references.models)
+        pump_model = resolve_and_validate_reference(
+            pump.get(EcalcYamlKeywords.pump_system_pump_model),
+            references=references.models,
+        )
         pumps.append(dto.PumpSystemPump(name=pump.get(EcalcYamlKeywords.name), pump_model=pump_model))
 
     return dto.PumpSystemConsumerFunction(
@@ -201,7 +203,7 @@ def _direct_mapper(energy_usage_model: Dict, references: References = None) -> d
 
 
 def _tabulated_mapper(energy_usage_model: Dict, references: References = None) -> dto.TabulatedConsumerFunction:
-    energy_model = resolve_reference(
+    energy_model = resolve_and_validate_reference(
         energy_usage_model.get(EcalcYamlKeywords.energy_model),
         references.models,
     )
@@ -223,7 +225,7 @@ def _tabulated_mapper(energy_usage_model: Dict, references: References = None) -
 
 
 def _pump_mapper(energy_usage_model: Dict, references: References = None) -> dto.PumpConsumerFunction:
-    energy_model = resolve_reference(
+    energy_model = resolve_and_validate_reference(
         energy_usage_model.get(EcalcYamlKeywords.energy_model),
         references=references.models,
     )
@@ -337,7 +339,7 @@ def create_model(model: Dict, references: References = None):
             raise ValueError(f"Unknown model type: {model.get(EcalcYamlKeywords.type)}")
         return model_creator(model, references)
 
-    def from_yaml_to_dto(self, data: Dict) -> Optional[Dict[datetime, dto.ConsumerFunction]]:
+    def from_yaml_to_dto(self, data: dto.EnergyModel) -> Optional[Dict[datetime, dto.ConsumerFunction]]:
         if data is None:
             return None
 

src/libecalc/presentation/yaml/mappers/utils.py

@@ -3,6 +3,7 @@
 
 import pandas as pd
 
+from libecalc.common.errors.exceptions import InvalidReferenceException
 from libecalc.common.logger import logger
 from libecalc.common.units import Unit
 from libecalc.dto.types import (
@@ -33,10 +34,8 @@
 def resolve_reference(
     value: Any,
     references: Dict[str, Any],
-    none_if_not_found: bool = False,
 ) -> Any:
     """Check if value is a reference and return it, if not a reference return the original value
-    :param none_if_not_found: return None if reference is not found
     :param value: reference or value
     :param references: mapping from reference name to reference data
         {
@@ -49,10 +48,8 @@ def resolve_reference(
         resolved = references.get(value, None)
         if resolved is not None:
             return resolved
-        elif none_if_not_found:
-            return None
         else:
-            return value
+            return None
     else:
         return value
 
@@ -61,9 +58,10 @@ def resolve_reference(
 
 
 def resolve_and_validate_reference(value: str, references: Dict[str, ReferenceValue]) -> ReferenceValue:
-    model = resolve_reference(value, references, none_if_not_found=True)
+    model = resolve_reference(value, references)
     if model is None:
-        raise ValueError(f"Reference '{value}' not found. \nAvailable: {', '.join(references.keys())}")
+        available_references = ",\n".join(references.keys())
+        raise InvalidReferenceException(f"'{value}' not found. \n\nAvailable references:\n{available_references}")
     return model