feat(mdu): support yyyymmdd for startDateTime/stopDateTime (#953)

feat(mdu): support `yyyymmdd` for startDateTime/stopDateTime (#953)

- Refactored datetime validator to be more robust and validate formats in a loop
- Added tests for `startDateTime=yyyymmdd` and for invalid formats (expect ValueError)
- Updated tests to use `Time` model and added unit tests for `validate_datetime_string`

ref: #942

Author: jeroen-deltares

hydrolib/core/dflowfm/ini/util.py

@@ -271,7 +271,9 @@ def validate_conditionally(
 def validate_datetime_string(
     field_value: Optional[str], field: ModelField
 ) -> Optional[str]:
-    """Validate that a field value matches the YYYYmmddHHMMSS datetime format.
+    """Validate that a field value matches the expected datetime format.
+
+    The validation checks that the date formats conform to either 'YYYYmmddHHMMSS' or 'YYYYmmdd'.
 
     Args:
         field_value (Optional[str]): value of a Pydantic field, may be optional.
@@ -289,11 +291,19 @@ def validate_datetime_string(
         and len(field_value.strip()) > 0
         and field_value != "yyyymmddhhmmss"
     ):
-        try:
-            _ = datetime.strptime(field_value, r"%Y%m%d%H%M%S")
-        except ValueError:
+        formats = {14: "%Y%m%d%H%M%S", 8: "%Y%m%d"}
+        result = False
+        format_length = len(field_value)
+        if format_length in formats:
+            try:
+                datetime.strptime(field_value, formats[format_length])
+                result = True
+            except ValueError:
+                pass
+
+        if not result:
             raise ValueError(
-                f"Invalid datetime string for {field.alias}: '{field_value}', expecting 'YYYYmmddHHMMSS'."
+                f"Invalid datetime string for {field.alias}: '{field_value}', expecting 'YYYYmmddHHMMSS' or 'YYYYmmdd'."
             )
 
     return field_value  # this is the value written to the class field

tests/dflowfm/ini/test_util.py

@@ -15,6 +15,7 @@
     get_from_subclass_defaults,
     get_type_based_on_subclass_default_value,
     rename_keys_for_backwards_compatibility,
+    validate_datetime_string,
     validate_location_specification,
 )
 
@@ -481,3 +482,59 @@ def test_keyword_given_known_as_excluded_field_does_not_throw_exception(self):
             )
         except ValueError:
             pytest.fail("Exception is thrown, no exception is expected for this test.")
+
+
+class TestDateTimeValidator:
+    @pytest.mark.parametrize(
+        "date_value",
+        [
+            ("20230101"),
+            ("20231231"),
+            ("20230101000000"),
+            ("20231231235959"),
+        ],
+        ids=[
+            "Date start of year",
+            "Date end of year",
+            "DateTime start of year",
+            "DateTime end of year",
+        ],
+    )
+    def test_mdu_datetime_valid_format_returns_value(self, date_value):
+        field = Mock(spec=ModelField)
+        field.name = "timefield"
+        field.alias = "timeField"
+
+        returned_value = validate_datetime_string(date_value, field)
+
+        assert returned_value == date_value
+
+    @pytest.mark.parametrize(
+        "date_value",
+        [
+            ("invalid"),
+            ("2023010"),
+            ("202312311"),
+            ("2023010100000"),
+            ("202301010000000"),
+        ],
+        ids=[
+            "unknown format",
+            "Date too short",
+            "Date too long",
+            "DateTime too short",
+            "DateTime too long",
+        ],
+    )
+    def test_mdu_datetime_invalid_format_raises_valueerror(self, date_value):
+        field = Mock(spec=ModelField)
+        field.name = "timefield"
+        field.alias = "timeField"
+
+        with pytest.raises(ValueError) as exc_err:
+            validate_datetime_string(date_value, field)
+
+        assert (
+            f"Invalid datetime string for {field.alias}: '{date_value}', expecting 'YYYYmmddHHMMSS' or 'YYYYmmdd'."
+            in str(exc_err.value)
+        )

tests/dflowfm/test_mdu.py

@@ -9,6 +9,7 @@
     InfiltrationMethod,
     ParticlesThreeDType,
     ProcessFluxIntegration,
+    Time,
     VegetationModelNr,
 )
 from hydrolib.core.dflowfm.net.models import Network
@@ -472,3 +473,60 @@ def test_mdu_unknown_keywords_loading_thrown_valueerror_for_unknown_keyword_does
             assert len(excluded_fields) > 0
             for excluded_field in excluded_fields:
                 assert excluded_field not in str(exc_err.value)
+
+
+class TestTime:
+    @pytest.mark.parametrize(
+        "start_date_time, stop_date_time",
+        [
+            ("20230101", "20231231"),
+            ("20230101000000", "20231231235959"),
+        ],
+        ids=["YYYYmmdd", "YYYYmmddHHMMSS"],
+    )
+    def test_mdu_datetime_yyyymmdd_format(self, start_date_time, stop_date_time):
+        time_dict = {
+            "startDateTime": start_date_time,
+            "stopDateTime": stop_date_time,
+        }
+        time = Time(**time_dict)
+        assert time.startdatetime == start_date_time
+        assert time.stopdatetime == stop_date_time
+
+    @pytest.mark.parametrize(
+        "start_date_time, stop_date_time, invalid_fields",
+        [
+            ("invalid", "invalid", ["startDateTime", "stopDateTime"]),
+            ("20230101", "invalid", ["stopDateTime"]),
+            ("invalid", "20231231", ["startDateTime"]),
+            ("2023010100000", "20231231235959", ["startDateTime"]),
+            ("202301010000000", "20231231235959", ["startDateTime"]),
+            ("20230101000000", "2023123123595", ["stopDateTime"]),
+            ("20230101000000", "202312312359599", ["stopDateTime"]),
+        ],
+        ids=[
+            "both_invalid",
+            "stop_invalid",
+            "start_invalid",
+            "start_too_short",
+            "start_too_long",
+            "stop_too_short",
+            "stop_too_long",
+        ],
+    )
+    def test_mdu_datetime_invalid_format_raises_valueerror(
+        self, start_date_time, stop_date_time, invalid_fields
+    ):
+        time_dict = {
+            "startDateTime": start_date_time,
+            "stopDateTime": stop_date_time,
+        }
+
+        with pytest.raises(ValueError) as exc_err:
+            Time(**time_dict)
+
+        for invalid_field in invalid_fields:
+            assert (
+                f"Invalid datetime string for {invalid_field}: '{time_dict[invalid_field]}', expecting 'YYYYmmddHHMMSS' or 'YYYYmmdd'."
+                in str(exc_err.value)
+            )