Make fail a disallow_hard_code

Add `test_disallow_hardcoded` to cover these type of settings

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

README.md

@@ -335,7 +335,7 @@ minimum-version = "0.11"  # current version
 build-dir = ""
 
 # Immediately fail the build. This is only useful in overrides.
-fail = false
+fail = ""
 
 ```
 

docs/reference/configs.md

@@ -76,7 +76,6 @@ print(mk_skbuild_docs())
 ```{eval-rst}
 .. confval:: fail
   :type: ``bool``
-  :default: false
 
   Immediately fail the build. This is only useful in overrides.
 ```

src/scikit_build_core/resources/scikit-build.schema.json

@@ -491,7 +491,6 @@
     },
     "fail": {
       "type": "boolean",
-      "default": false,
       "description": "Immediately fail the build. This is only useful in overrides."
     },
     "overrides": {

src/scikit_build_core/settings/skbuild_model.py

@@ -416,7 +416,12 @@ class ScikitBuildSettings:
     The build directory. Defaults to a temporary directory, but can be set.
     """
 
-    fail: bool = False
+    fail: Optional[bool] = dataclasses.field(
+        default=None,
+        metadata=SettingsFieldMetadata(
+            disallow_hard_code=True,
+        ),
+    )
     """
     Immediately fail the build. This is only useful in overrides.
     """

tests/test_settings_docs.py

@@ -12,7 +12,6 @@ def test_skbuild_docs() -> None:
         in docs
     )
     assert "DEPRECATED in 0.10, use build.verbose instead." in docs
-    assert "fail = false" in docs
 
 
 def test_mk_docs() -> None:

tests/test_settings_overrides.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import sysconfig
 import typing
 from pathlib import Path
@@ -22,6 +23,53 @@ class VersionInfo(typing.NamedTuple):
     releaselevel: str = "final"
 
 
+def test_disallow_hardcoded(
+    tmp_path: Path,
+    caplog: pytest.LogCaptureFixture,
+    capsys: pytest.CaptureFixture[str],
+):
+    caplog.set_level(logging.WARNING)
+    pyproject_toml = tmp_path / "pyproject.toml"
+    template = dedent(
+        """\
+        [tool.scikit-build]
+        strict-config = {strict_config}
+        fail = false
+        """
+    )
+
+    # First check without strict-config to make sure all fields are disallowed
+    strict_config = "false"
+    pyproject_toml.write_text(
+        template.format(strict_config=strict_config),
+        encoding="utf-8",
+    )
+
+    settings_reader = SettingsReader.from_file(pyproject_toml)
+    settings_reader.validate_may_exit()
+    assert caplog.records
+    for idx, key in enumerate(["fail"]):
+        assert (
+            f"{key} is not allowed to be hard-coded in the pyproject.toml file"
+            in str(caplog.records[idx].msg)
+        )
+
+    # Next check that this exits if string-config is set
+    strict_config = "true"
+    pyproject_toml.write_text(
+        template.format(strict_config=strict_config),
+        encoding="utf-8",
+    )
+    # Flush the capsys just in case
+    capsys.readouterr()
+    settings_reader = SettingsReader.from_file(pyproject_toml)
+    with pytest.raises(SystemExit) as exc:
+        settings_reader.validate_may_exit()
+    assert exc.value.code == 7
+    out, _ = capsys.readouterr()
+    assert "is not allowed to be hard-coded in the pyproject.toml file" in out
+
+
 @pytest.mark.parametrize("python_version", ["3.9", "3.10"])
 def test_skbuild_overrides_pyver(
     python_version: str, tmp_path: Path, monkeypatch: pytest.MonkeyPatch