added tests workflow

Author: chenkasirer

.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: |
+          ruff check .
+          ruff format --check .
+
+  test:
+    name: test (${{ matrix.os }}, ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python: ["3.9", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Test
+        run: pytest -m "not dotnet"
+
+  # Builds the example bundles into actual .ghuser components and reads them
+  # back. Windows is what the downstream `compas-actions/ghpython-components`
+  # runs on; macOS is where the runtime needs the setup this package does itself.
+  components:
+    name: components (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest]
+
+    env:
+      GHPYTHON_COMPONENTIZER_REQUIRE_DOTNET: "1"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Mono and libgdiplus
+        if: runner.os == 'macOS'
+        run: brew install mono mono-libgdiplus
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Build the example components
+        run: pytest -m dotnet -v

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+* Changed `discover_source_bundles` to skip folders that contain none of `code.py`, `icon.png` and `metadata.json`, so a build target inside the source directory no longer breaks the build.
+
 ### Removed
 
 

README.md

@@ -239,7 +239,15 @@ ruff check .
 ruff format .
 ```
 
-The test suite covers the parts that do not require a .NET runtime, so it runs on any platform.
+Most of the test suite covers the parts that do not require a .NET runtime, so it runs on any
+platform. The tests marked `dotnet` build the [examples](examples/cpy) into actual components and
+read them back, and skip themselves when there is no runtime to do it with:
+
+```bash
+pytest -m "not dotnet"    # unit tests only
+pytest -m dotnet          # build the example components
+```
+
 Linting and formatting follow the same [ruff](https://docs.astral.sh/ruff/) rules as the other
 COMPAS packages, configured in `pyproject.toml`.
 

pyproject.toml

@@ -105,3 +105,6 @@ docstring-code-line-length = "dynamic"
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+markers = [
+    "dotnet: tests that build actual components, and need a .NET runtime for it",
+]

src/ghpython_componentizer/bundle.py

@@ -23,10 +23,25 @@
 
 IGNORED_DIRS = ("__pycache__", ".git")
 
+BUNDLE_FILES = ("code.py", "icon.png", "metadata.json")
+
+
+def _looks_like_bundle(path):
+    """Tell a source bundle from any other folder that happens to be around.
+
+    A folder holding none of the bundle files is not a bundle at all, typically
+    a build target sitting inside the source directory. One holding only some of
+    them is an incomplete bundle, which :func:`validate_source_bundle` reports.
+    """
+    return any(os.path.exists(os.path.join(path, name)) for name in BUNDLE_FILES)
+
 
 def discover_source_bundles(sourcedir):
     """List the names of all component bundles found in a source directory.
 
+    Folders that contain none of ``code.py``, ``icon.png`` and ``metadata.json``
+    are not bundles, and are left out.
+
     Parameters
     ----------
     sourcedir : str
@@ -37,7 +52,11 @@ def discover_source_bundles(sourcedir):
     list of str
         Bundle folder names, sorted alphabetically.
     """
-    return sorted(d for d in os.listdir(sourcedir) if os.path.isdir(os.path.join(sourcedir, d)) and d not in IGNORED_DIRS and not d.startswith("."))
+    return sorted(
+        d
+        for d in os.listdir(sourcedir)
+        if os.path.isdir(os.path.join(sourcedir, d)) and d not in IGNORED_DIRS and not d.startswith(".") and _looks_like_bundle(os.path.join(sourcedir, d))
+    )
 
 
 def validate_source_bundle(source):

tests/test_build_examples.py

@@ -0,0 +1,86 @@
+"""End to end: build the example bundles and read the components back.
+
+These tests need a working .NET runtime, so they are marked `dotnet` and skip
+themselves when there is none. Set `GHPYTHON_COMPONENTIZER_REQUIRE_DOTNET=1` to
+turn that skip into a failure, which is what CI does.
+"""
+
+import json
+import os
+from pathlib import Path
+
+import pytest
+
+from ghpython_componentizer import run_componentizer
+from ghpython_componentizer.bundle import discover_source_bundles
+
+EXAMPLES = Path(__file__).resolve().parent.parent / "examples" / "cpy"
+PREFIX = "(TEST) "
+VERSION = "1.2.3"
+
+pytestmark = pytest.mark.dotnet
+
+
+def dotnet_is_available():
+    try:
+        import clr  # noqa: F401
+    except Exception:
+        return False
+
+    return True
+
+
+if not EXAMPLES.exists():
+    pytest.skip("example bundles are not part of the distribution", allow_module_level=True)
+
+if not dotnet_is_available() and os.environ.get("GHPYTHON_COMPONENTIZER_REQUIRE_DOTNET") != "1":
+    pytest.skip("no .NET runtime available", allow_module_level=True)
+
+
+def read_component(path):
+    """Read a .ghuser file back into the chunk it was serialized from."""
+    from ghpython_componentizer.ghio import ensure_ghio
+
+    ensure_ghio()
+
+    import System
+    from GH_IO.Serialization import GH_LooseChunk
+
+    chunk = GH_LooseChunk("UserObject")
+    chunk.Deserialize_Binary(System.IO.File.ReadAllBytes(str(path)))
+
+    return chunk
+
+
+@pytest.fixture(scope="module")
+def built(tmp_path_factory):
+    """Build every example bundle once, and return the target folder."""
+    target = tmp_path_factory.mktemp("ghuser")
+    run_componentizer(EXAMPLES, target, version=VERSION, prefix=PREFIX)
+
+    return target
+
+
+def test_builds_one_component_per_bundle(built):
+    expected = sorted(name + ".ghuser" for name in discover_source_bundles(str(EXAMPLES)))
+
+    assert sorted(p.name for p in built.iterdir()) == expected
+
+
+def test_components_are_readable_by_gh_io(built):
+    for bundle in discover_source_bundles(str(EXAMPLES)):
+        metadata = json.loads((EXAMPLES / bundle / "metadata.json").read_text())
+        component = read_component(built / (bundle + ".ghuser"))
+
+        assert component.GetString("Name") == PREFIX + metadata["name"]
+        assert component.GetString("NickName") == metadata["nickname"]
+        assert component.GetString("Category") == metadata["category"]
+        assert component.GetString("SubCategory") == metadata["subcategory"]
+
+
+def test_components_carry_their_icon(built):
+    for bundle in discover_source_bundles(str(EXAMPLES)):
+        component = read_component(built / (bundle + ".ghuser"))
+
+        icon = component.GetByteArray("Icon")
+        assert icon.Length == (EXAMPLES / bundle / "icon.png").stat().st_size

tests/test_bundle.py

@@ -91,8 +91,10 @@ def test_validate_source_bundle_rejects_invalid_exposure(make_bundle):
         validate_source_bundle(bundle)
 
 
-def test_discover_source_bundles(tmp_path):
-    for name in ("B_Component", "A_Component", "__pycache__", ".hidden"):
+def test_discover_source_bundles(make_bundle, tmp_path):
+    for name in ("B_Component", "A_Component"):
+        make_bundle(name=name)
+    for name in ("__pycache__", ".hidden"):
         (tmp_path / name).mkdir()
     (tmp_path / "README.md").write_text("not a bundle")
 
@@ -104,3 +106,19 @@ def test_discover_source_bundles_finds_valid_bundles(make_bundle, tmp_path):
 
     assert discover_source_bundles(str(tmp_path)) == ["Test_Component"]
     validate_source_bundle(str(tmp_path / "Test_Component"))
+
+
+def test_discover_source_bundles_skips_a_target_folder(make_bundle, tmp_path):
+    make_bundle(name="Test_Component")
+    (tmp_path / "ghuser").mkdir()
+    (tmp_path / "ghuser" / "Test_Component.ghuser").write_bytes(b"a built component")
+
+    assert discover_source_bundles(str(tmp_path)) == ["Test_Component"]
+
+
+def test_discover_source_bundles_keeps_incomplete_bundles(make_bundle, tmp_path):
+    make_bundle(name="Test_Component", files=("code", "metadata"))
+
+    assert discover_source_bundles(str(tmp_path)) == ["Test_Component"]
+    with pytest.raises(ValueError, match="icon missing"):
+        validate_source_bundle(str(tmp_path / "Test_Component"))

tests/test_runtime.py

@@ -21,6 +21,8 @@ def macos(monkeypatch):
 @pytest.fixture
 def not_macos(monkeypatch):
     monkeypatch.setattr(runtime.platform, "system", lambda: "Windows")
+    # Anything that loaded the .NET runtime before may have selected mono.
+    monkeypatch.delenv("PYTHONNET_RUNTIME", raising=False)
     monkeypatch.setattr(runtime, "_drawing_checked", False)