put back Path validation in Settings

Author: Leobouloc

src/ralph/api/routers/statements.py

@@ -340,7 +340,7 @@ async def get(  # noqa: PLR0912,PLR0913
             json.loads(query_params["agent"])
         ).model_dump(mode="json", exclude_none=True)
 
-    # Coerce `verb` and `activity` as IRI #TODO: check why this is necessary
+    # Coerce `verb` and `activity` as IRI
     if query_params.get("verb"):
         query_params["verb"] = IRI(query_params["verb"])
 

src/ralph/conf.py

@@ -227,15 +227,15 @@ def LOCALE_ENCODING(self) -> str:
         """Return Ralph's default locale encoding."""
         return self._CORE.LOCALE_ENCODING
 
-    # @model_validator(mode="before") # TODO: remove
-    # @classmethod
-    # def validate_paths(cls, values):
-    #     """Coerce fields to `Path`."""
-    #     for field in ["AUTH_FILE", "HISTORY_FILE"]:
-    #         if field in values:
-    #             if isinstance(values[field], str):
-    #                 values[field] = Path(values[field])
-    #     return values
+    @model_validator(mode="before")
+    @classmethod
+    def validate_paths(cls, values):
+        """Coerce fields to `Path`."""
+        for field in ["AUTH_FILE", "HISTORY_FILE"]:
+            if field in values:
+                if isinstance(values[field], str):
+                    values[field] = Path(values[field])
+        return values
 
     @model_validator(mode="after")
     def check_restriction_compatibility(self):

src/ralph/models/xapi/base/ifi.py

@@ -50,7 +50,7 @@ class BaseXapiOpenIdIFI(BaseModelWithConfig):
         openid (URI): Consists of an openID that uniquely identifies the Agent.
     """
 
-    openid: str  # TODO: AnyUrl (different because it may be a bare url) NB: modified as str was working
+    openid: str
 
 
 class BaseXapiAccountIFI(BaseModelWithConfig):

tests/backends/lrs/test_clickhouse.py

@@ -57,7 +57,7 @@ def test_backends_lrs_clickhouse_default_instantiation(monkeypatch, fs):
                     "limit": 0,
                     "related_activities": False,
                     "related_agents": False,
-                    "statementId": "test_id",  # TODO: look into removing this parameter
+                    "statementId": "test_id",
                     "statement_id": "test_id",
                 },
                 "limit": 0,
@@ -196,7 +196,7 @@ def test_backends_lrs_clickhouse_default_instantiation(monkeypatch, fs):
                     "limit": 100,
                     "related_activities": False,
                     "related_agents": False,
-                    "verb": "http://adlnet.gov/expapi/verbs/attended",  # TODO: check why verb cant be input as IRI
+                    "verb": "http://adlnet.gov/expapi/verbs/attended",
                 },
                 "limit": 100,
                 "sort": "emission_time DESCENDING, event_id DESCENDING",

tests/factories.py

@@ -55,8 +55,6 @@ def prune(d: Any, exemptions: Optional[list] = None):
     elif isinstance(d, list):
         d_list = [prune(v) for v in d]
         return [v for v in d_list if v]
-    # if d not in [[], {}, ""]: # TODO: put back ?
-    #     return d
     if d:
         return d
     return False

tests/models/edx/converters/xapi/test_navigational.py

@@ -21,7 +21,6 @@ def test_models_edx_converters_xapi_navigational_ui_page_close_to_page_terminate
     """
     event = mock_instance(UIPageClose)
     platform_url = mock_url()
-    assert platform_url is not None  # TODO: remove this
 
     event.context.user_id = "1"
     event_str = event.model_dump_json()

tests/models/edx/test_browser.py

@@ -17,7 +17,7 @@ def test_models_edx_base_browser_model_with_valid_statement():
     assert re.match(r"^[a-f0-9]{32}$", statement.session) or statement.session == ""
 
 
-@pytest.mark.parametrize(  # TODO: clean up
+@pytest.mark.parametrize(
     "session,error",
     [
         # less than 32 characters

tests/models/test_validator.py

@@ -121,7 +121,7 @@ def test_models_validator_validate_with_an_invalid_page_close_event_writes_an_er
         assert not list(result)
     errors = [
         "Input event is not valid."
-    ]  # TODO: put back ["Input event is not a valid UIPageClose event."]
+    ]
     assert errors == [message for _, _, message in caplog.record_tuples]
 
 
@@ -191,7 +191,6 @@ def test_models_validator_validate_typing_cleanup():
 
     invalid_event = copy.deepcopy(valid_event)
     invalid_event["host"] = 1  # not string
-    # invalid_event["accept_language"] = False  # not string # TODO: check if removing this is acceptable
     invalid_event["context"]["course_user_tags"] = {"foo": 1}  # not string
     invalid_event["context"]["user_id"] = "123"  # not integer
     invalid_event_str = json.dumps(invalid_event)

tests/models/xapi/base/test_statements.py

@@ -58,7 +58,7 @@ def test_models_xapi_base_statement_with_invalid_null_values(path, value):
 )
 @pytest.mark.parametrize(
     "value", [None, {}]
-)  # TODO: REGRESSION: put back `""` as valid null value
+)
 def test_models_xapi_base_statement_with_valid_null_values(path, value):
     """Test that the statement does accept valid null values in extensions fields.
 
@@ -365,7 +365,7 @@ def test_models_xapi_base_statement_with_invalid_group_objects(klass):
     statement = statement.model_dump(**kwargs)
     statement["actor"]["member"] = [
         mock_xapi_instance(klass).model_dump(**kwargs)
-    ]  # TODO: check that nothing was lost
+    ]
 
     for class_ in [
         "BaseXapiAgentWithMbox",
@@ -573,7 +573,7 @@ def test_models_xapi_base_statement_should_consider_valid_all_defined_xapi_model
     statement = mock_xapi_instance(model)
     statement = statement.json(
         exclude_none=True, by_alias=True
-    )  # TODO: check that we are not losing info by mocking random model
+    )
     try:
         BaseXapiStatement(**json.loads(statement))
     except ValidationError as err:

tests/models/xapi/test_lms.py

@@ -223,7 +223,6 @@ def test_models_xapi_lms_context_context_activities_with_valid_category(category
         )
 
 
-# TODO: check that this test is still valid
 @pytest.mark.parametrize(
     "category,msg",
     [

tests/models/xapi/test_video.py

@@ -211,7 +211,6 @@ def test_models_xapi_video_context_activities_with_valid_category(category):
         )
 
 
-# TODO: check that this test is still valid
 @pytest.mark.parametrize(
     "category,msg",
     [

tests/models/xapi/test_virtual_classroom.py

@@ -284,7 +284,6 @@ def test_models_xapi_virtual_classroom_context_activities_with_valid_category(ca
         )
 
 
-# TODO: check that this test is valid
 @pytest.mark.parametrize(
     "category,msg",
     [

tests/test_cli.py

@@ -725,7 +725,7 @@ def test_cli_read_command_with_es_backend_query(es):
         "Invalid MongoQuery query string: [{'type': 'value_error.jsondecode',"
         " 'loc': ('__root__',), 'msg': 'Expecting value: line 1 column 1 (char 0)',"
         " 'input': 'wrong_query_string'}]"
-    )  # TODO: validate change in message
+    )
 
     assert str(result.exception) == msg