feat: add schema and validate-pyproject support (#1622)

* feat: add schema and validate-pyproject support Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * fix: address review comments, fix bug, add tests Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * fix: add test of examples in docs and fix Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * fix: nicer titles Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
2023-09-26 11:23:20 -05:00
parent 7da7df1efc
commit d4af0ac229
11 changed files with 1864 additions and 10 deletions
@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+import pytest
+import validate_pyproject.api
+
+from cibuildwheel._compat import tomllib
+
+DIR = Path(__file__).parent.resolve()
+
+
+def test_validate_default_schema():
+    filepath = DIR.parent / "cibuildwheel/resources/defaults.toml"
+    with filepath.open("rb") as f:
+        example = tomllib.load(f)
+
+    validator = validate_pyproject.api.Validator()
+    assert validator(example) is not None
+
+
+def test_validate_bad_container_engine():
+    example = tomllib.loads(
+        """
+        [tool.cibuildwheel.linux]
+        container-engine = "docker"
+        """
+    )
+
+    validator = validate_pyproject.api.Validator()
+    with pytest.raises(validate_pyproject.error_reporting.ValidationError):
+        validator(example)
+
+
+def test_overrides_select():
+    example = tomllib.loads(
+        """
+        [[tool.cibuildwheel.overrides]]
+        select = "somestring"
+        repair-wheel-command = "something"
+        """
+    )
+
+    validator = validate_pyproject.api.Validator()
+    assert validator(example) is not None
+
+
+def test_overrides_no_select():
+    example = tomllib.loads(
+        """
+        [[tool.cibuildwheel.overrides]]
+        repair-wheel-command = "something"
+        """
+    )
+
+    validator = validate_pyproject.api.Validator()
+    with pytest.raises(validate_pyproject.error_reporting.ValidationError):
+        validator(example)
+
+
+def test_docs_examples():
+    """
+    Parse out all the configuration examples, build valid TOML out of them, and
+    make sure they pass.
+    """
+
+    expr = re.compile(
+        r"""
+!!! tab examples "pyproject.toml"
+\s*
+\s*```toml
+(.*?)```""",
+        re.MULTILINE | re.DOTALL,
+    )
+
+    txt = DIR.parent.joinpath("docs/options.md").read_text()
+
+    blocks: list[str] = []
+    for match in expr.finditer(txt):
+        lines = (line.strip() for line in match.group(1).strip().splitlines() if line.strip())
+        block: list[str] = []
+        header = ""
+        for line in lines:
+            if line.startswith(("[tool.cibuildwheel", "[[tool.cibuildwheel")):
+                header = line
+            elif line.startswith("#"):
+                if block:
+                    blocks.append("\n".join([header, *block]))
+                    block = []
+            elif " = " in line and any(x.startswith(line.partition(" = ")[0]) for x in block):
+                blocks.append("\n".join([header, *block]))
+                block = [line]
+            else:
+                block.append(line)
+        blocks.append("\n".join([header, *block]))
+
+    for example_txt in blocks:
+        print(example_txt)
+        print()
+        example = tomllib.loads(example_txt)
+        validator = validate_pyproject.api.Validator()
+        assert validator(example) is not None