Test CMakePreset File Layout

Author: Behemyth

cppython/schema.py

@@ -6,11 +6,10 @@
 
 from abc import abstractmethod
 from dataclasses import dataclass
-from pathlib import PosixPath
+from pathlib import Path
 from typing import Any, Optional
 
-from pydantic import BaseModel, Extra, Field
-from pydantic.types import FilePath
+from pydantic import BaseModel, Extra, Field, validator
 
 
 class Preset(BaseModel):
@@ -19,36 +18,40 @@ class Preset(BaseModel):
     """
 
     name: str
-    hidden: Optional[bool] = None
+    hidden: Optional[bool]
     inherits: list[str] = []
-    displayName: Optional[str] = None
-    description: Optional[str] = None
+    displayName: Optional[str]
+    description: Optional[str]
 
 
 class ConfigurePreset(Preset):
     """
     Partial Configure Preset specification
     """
 
-    toolchainFile: Optional[FilePath] = None
+    toolchainFile: Optional[str]
+
+    @validator("toolchainFile")
+    def validate_path(cls, v):
+        return Path(v).as_posix()
 
 
 class BuildPreset(Preset):
     """
     Partial Build Preset specification
     """
 
-    configurePreset: Optional[str] = None
-    inheritConfigureEnvironment: Optional[bool] = None
+    configurePreset: Optional[str]
+    inheritConfigureEnvironment: Optional[bool]
 
 
 class TestPreset(Preset):
     """
     Partial Test Preset specification
     """
 
-    configurePreset: Optional[str] = None
-    inheritConfigureEnvironment: Optional[bool] = None
+    configurePreset: Optional[str]
+    inheritConfigureEnvironment: Optional[bool]
 
 
 class CMakeVersion(BaseModel, extra=Extra.forbid):
@@ -68,12 +71,19 @@ class CMakePresets(BaseModel, extra=Extra.forbid):
 
     version: int = Field(default=4, const=True)
     cmakeMinimumRequired: CMakeVersion = CMakeVersion()  # TODO: 'version' compatability validation
-    include: list[FilePath] = []
-    vendor: Optional[Any] = None
+    include: list[str] = []
+    vendor: Optional[Any]
     configurePresets: list[ConfigurePreset] = []
     buildPresets: list[BuildPreset] = []
     testPresets: list[TestPreset] = []
 
+    @validator("include")
+    def validate_path(cls, v):
+        output = []
+        for value in v:
+            output.append(Path(value).as_posix())
+        return output
+
 
 @dataclass
 class ProjectConfiguration:

cppython/utility.py

@@ -5,9 +5,6 @@
 import json
 from pathlib import Path
 
-from pydantic import FilePath
-from pydantic.types import DirectoryPath
-
 from cppython.schema import CMakePresets, ConfigurePreset
 
 
@@ -26,40 +23,44 @@ def write_preset(name: str, path: Path, presets: CMakePresets) -> Path:
     """
     file = path / f"{name}.json"
 
-    serialized = json.loads(presets.json())
+    serialized = json.loads(presets.json(exclude_none=True))
     with open(file, "w", encoding="utf8") as json_file:
         json.dump(serialized, json_file, ensure_ascii=False, indent=2)
 
     return file
 
 
-def write_presets(tool_path: DirectoryPath, generator_output: list[tuple[str, FilePath]]) -> None:
+def write_presets(tool_path: Path, generator_output: list[tuple[str, Path]]) -> None:
     """
     Write the cppython presets
     """
 
-    def write_generator_presets(tool_path: DirectoryPath, generator_name: str, toolchain_path: FilePath) -> FilePath:
+    def write_generator_presets(tool_path: Path, generator_name: str, toolchain_path: Path) -> Path:
         """
         Write a generator preset.
         @returns - The written json file
         """
         generator_tool_path = tool_path / generator_name
         generator_tool_path.mkdir(parents=True, exist_ok=True)
 
-        configure_preset = ConfigurePreset(name=generator_name, hidden=True, toolchainFile=toolchain_path)
+        configure_preset = ConfigurePreset(name=generator_name, hidden=True, toolchainFile=str(toolchain_path))
         presets = CMakePresets(configurePresets=[configure_preset])
 
         return write_preset(generator_name, generator_tool_path, presets)
 
     names = []
     includes = []
 
+    tool_path = tool_path / "cppython"
+
     for generator_name, toolchain in generator_output:
 
         preset_file = write_generator_presets(tool_path, generator_name, toolchain)
 
+        relative_file = preset_file.relative_to(tool_path)
+
         names.append(generator_name)
-        includes.append(preset_file)
+        includes.append(str(relative_file))
 
     configure_preset = ConfigurePreset(name="cppython", hidden=True, inherits=names)
     presets = CMakePresets(configurePresets=[configure_preset], include=includes)

tests/unit/test_utility.py

@@ -12,14 +12,16 @@ class TestBuilder:
     TODO
     """
 
-    def test_preset_read_write(self, tmpdir: Path):
+    def test_preset_read_write(self, tmpdir):
         """
         TODO
         """
 
+        temporary_directory = Path(tmpdir)
+
         presets = CMakePresets()
-        write_preset("test", tmpdir, presets)
-        output = read_preset("test", tmpdir)
+        write_preset("test", temporary_directory, presets)
+        output = read_preset("test", temporary_directory)
 
         assert presets == output
 
@@ -37,3 +39,15 @@ def test_presets(self, tmpdir):
 
         generator_output = [("test", input_toolchain)]
         write_presets(temporary_directory, generator_output)
+
+        cppython_tool = temporary_directory / "cppython"
+        assert cppython_tool.exists()
+
+        cppython_file = cppython_tool / "cppython.json"
+        assert cppython_file.exists()
+
+        test_tool = cppython_tool / "test"
+        assert test_tool.exists()
+
+        test_file = test_tool / "test.json"
+        assert test_file.exists()