Adding missing tests for JSON schema validation

Author: AntoineBuirey

config/config/config.py

@@ -67,6 +67,9 @@ def get(self, key: str, /, default: Any = None, set_if_not_found: bool = False)
         # elif not isinstance(config, (int, float, bool)):
         #     raise KeyError(f"The provided key '{key}' is not a valid endpoint for a configuration value.")
         _trace(f"Config value for key '{key}': {config}")
+        
+        if not isinstance(config, (str, int, float, bool)):
+            raise KeyError(f"The provided key '{key}' is not a valid endpoint for a configuration value.")
         return config
 
     def set(self, key: str, value : Any) -> 'BaseConfig':
@@ -398,7 +401,7 @@ class MemoryConfig(BaseConfig):
     This class provides methods to load, save, and manage configuration settings in memory.
     Does not persist to a file.
     """
-    def __init__(self, initial: Dict[str, Any] = None):
+    def __init__(self, initial: Dict[str, Any]|None = None):
         super().__init__()
         if initial is not None:
             self._config = initial

config/tests/json_tests.py

@@ -179,3 +179,90 @@ def test_load_json_list(temp_json_file):
     # Act
     with pytest.raises(ValueError):
         JSONConfig(temp_json_file)
+
+
+def test_json_schema_validation_success(temp_json_file, monkeypatch):
+    # Arrange
+    schema = {
+        "type": "object",
+        "properties": {
+            "foo": {"type": "string"}
+        },
+        "required": ["foo"]
+    }
+
+    content = {"$schema": "http://example.com/schema", "foo": "bar"}
+    with open(temp_json_file, "w", encoding="utf-8") as f:
+        json.dump(content, f)
+
+    class DummyResponse:
+        def raise_for_status(self):
+            return None
+
+        def json(self):
+            return schema
+
+    monkeypatch.setattr("requests.get", lambda url: DummyResponse())
+
+    # Act / Assert - should not raise
+    JSONConfig(temp_json_file)
+
+
+def test_json_schema_fetch_failure(temp_json_file, monkeypatch):
+    # Arrange
+    content = {"$schema": "http://example.com/schema", "foo": "bar"}
+    with open(temp_json_file, "w", encoding="utf-8") as f:
+        json.dump(content, f)
+
+    def raise_exc(url):
+        raise Exception("network error")
+
+    monkeypatch.setattr("requests.get", raise_exc)
+
+    # Act / Assert
+    with pytest.raises(ValueError) as exc:
+        JSONConfig(temp_json_file)
+    assert "An error occurred during schema validation" in str(exc.value)
+
+
+def test_json_schema_validation_failure(temp_json_file, monkeypatch):
+    # Arrange: schema requires foo to be integer but file has string
+    schema = {
+        "type": "object",
+        "properties": {
+            "foo": {"type": "integer"}
+        },
+        "required": ["foo"]
+    }
+
+    content = {"$schema": "http://example.com/schema", "foo": "not-an-int"}
+    with open(temp_json_file, "w", encoding="utf-8") as f:
+        json.dump(content, f)
+
+    class DummyResponse:
+        def raise_for_status(self):
+            return None
+
+        def json(self):
+            return schema
+
+    monkeypatch.setattr("requests.get", lambda url: DummyResponse())
+
+    # Act / Assert - validation should fail and raise ValueError
+    with pytest.raises(ValueError) as exc:
+        JSONConfig(temp_json_file)
+    assert "Configuration validation against schema failed" in str(exc.value)
+
+
+def test_require_validation_without_schema(tmp_path):
+    # Arrange
+    file_path = tmp_path / "no_schema.json"
+    with open(file_path, "w", encoding="utf-8") as f:
+        json.dump({"foo": "bar"}, f)
+
+    # Act / Assert
+    with pytest.raises(ValueError) as exc:
+        JSONConfig(str(file_path), True)
+    assert "JSON schema validation is required but no '$schema' key found in configuration" in str(exc.value)
+
+

makefile

@@ -1,15 +1,32 @@
 
 VERSION = $(shell python get_version.py)
 
+DEPENDENCIES_NAMES = jsonschema requests tomlkit coverage pytest
+
 MODULES = cache colors config http_code version singleton
 
 TARGETS = $(addprefix dist/,$(addsuffix -$(VERSION).tar.gz,$(MODULES)))
 TARGETS += $(addprefix dist/,$(addsuffix -$(VERSION)-py3-none-any.whl,$(MODULES)))
 
+PYTHON_PATH = $(shell if [ -d env/bin ]; then echo "env/bin/"; elif [ -d env/Scripts ]; then echo "env/Scripts/"; else echo ""; fi)
+PYTHON_LIB = $(shell find env/lib -type d -name "site-packages" | head -n 1; if [ -d env/Lib/site-packages ]; then echo "env/Lib/site-packages/"; fi)
+PYTHON = $(PYTHON_PATH)python
+
 .PHONY: all clean tests
 
 all: $(TARGETS)
 
+
+# Dependencies handling
+
+DEPENDENCIES_PATHS = $(addprefix $(PYTHON_LIB)/,$(DEPENDENCIES_NAMES))
+
+$(PYTHON_LIB)/%: 
+	$(PYTHON) -m pip install $*
+
+install: $(DEPENDENCIES_PATHS)
+
+
 dist/%-$(VERSION)-py3-none-any.whl: % %/pyproject.toml
 	python build_package.py --version $(VERSION) --wheel --outdir dist $<
 	@rm -rf $</$<.egg-info $</build
@@ -18,7 +35,7 @@ dist/%-$(VERSION).tar.gz: % %/pyproject.toml
 	python build_package.py --version $(VERSION) --sdist --outdir dist $<
 	@rm -rf $</$<.egg-info $</build
 
-tests/%: % #with pytest
+tests/%: % install
 	-@coverage run --data-file $<.coverage --branch -m pytest --tb=short --disable-warnings --junitxml=tests_reports/$*/report.xml $<
 	@coverage html -d tests_reports/$*/coverage --data-file $<.coverage
 	@coverage xml -o tests_reports/$*/coverage.xml --data-file $<.coverage