Basic E2E test

Author: UnsignedArduino

.github/workflows/e2e.yaml

@@ -0,0 +1,29 @@
+name: CI
+on: [ push, pull_request ]
+
+jobs:
+  e2e:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests with pytest
+        run: uv run pytest

.github/workflows/lint.yaml

@@ -7,11 +7,26 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with: { python-version: "3.14" }
-      - uses: astral-sh/setup-uv@v5
-      - run: uv sync
-      - run: uv run ruff check .
-      - run: uv run ruff format --check .
-      - run: uv run mypy .
+      - name: Check out repo
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run ruff linter check
+        run: uv run ruff check .
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+      - name: Run mypy check
+        run: uv run mypy .

pyproject.toml

@@ -28,6 +28,8 @@ packages = ["src/mkcd2app"]
 dev = [
     "mypy>=2.3.0",
     "pre-commit>=4.6.1",
+    "pytest>=9.1.1",
+    "pytest-timeout>=2.4.0",
     "ruff>=0.16.0",
     "types-pyyaml>=6.0.12.20260724",
 ]

tests/e2e/test_statics.py

@@ -0,0 +1,77 @@
+import shutil
+import subprocess
+import time
+from collections.abc import Generator
+from pathlib import Path
+
+import pytest
+
+
+def run_build(config_path: Path) -> subprocess.CompletedProcess[str]:
+    return subprocess.run(
+        ["mkcd2app", "build", str(config_path)],
+        capture_output=True,
+        text=True,
+        timeout=300,
+        check=True,
+    )
+
+
+def run_empty_game_build() -> subprocess.CompletedProcess[str]:
+    yaml_path = Path.cwd() / "tests" / "fixtures" / "empty_game_build_to_statics.yaml"
+    return run_build(yaml_path)
+
+
+@pytest.fixture(scope="module")
+def empty_game_build_to_statics() -> Generator[None]:
+    run_empty_game_build()
+
+    yield
+
+    dir_path = Path.cwd() / "examples" / "testing" / "empty_game_build"
+    shutil.rmtree(dir_path)
+
+
+def test_empty_game_build_to_statics_static(empty_game_build_to_statics: None) -> None:
+    build_dir = Path("examples/testing/empty_game_build")
+    static_dist = build_dir / "empty-game-website-filled-built" / "dist"
+
+    # check for index.html and assets dir
+    assert (static_dist / "index.html").is_file(), "expected index.html file present"
+    assert (static_dist / "assets").is_dir(), "expected assets directory present"
+    # ensure nonzero amount of css and js files
+    css_files = list((static_dist / "assets").glob("*.css"))
+    js_files = list((static_dist / "assets").glob("*.js"))
+    assert css_files, "expected css files present"
+    assert js_files, "expected js files present"
+
+
+def test_empty_game_build_to_statics_static_singlefile(
+    empty_game_build_to_statics: None,
+) -> None:
+    build_dir = Path("examples/testing/empty_game_build")
+    static_singlefile_dist = (
+        build_dir / "empty-game-website-filled-singlefile-built" / "dist"
+    )
+
+    # ensure no other files or directories are present in the dist
+    items = list(static_singlefile_dist.iterdir())
+    assert len(items) == 1, (
+        f"expected only index.html in {static_singlefile_dist}, found: {[p.name for p in items]}"
+    )
+    only = items[0]
+    assert only.is_file(), "expected only index.html present"
+    assert only.name == "index.html", "expected only index.html present"
+
+
+def test_empty_game_build_to_statics_second_build_caches(
+    empty_game_build_to_statics: None,
+) -> None:
+    start_time = time.monotonic()
+    run_empty_game_build()  # this should do nothing file wise, all hit caches
+    end_time = time.monotonic()
+    elapsed_time = end_time - start_time
+
+    assert elapsed_time < 5, (
+        f"expected second build to all hit cache and take less than 5s, took {elapsed_time}s"
+    )

tests/fixtures/empty_game/README.md

@@ -0,0 +1 @@
+ 

tests/fixtures/empty_game/assets.json

@@ -0,0 +1 @@
+<xml xmlns="https://developers.google.com/blockly/xml"><variables></variables><block type="pxt-on-start" x="0" y="0"></block></xml>

tests/fixtures/empty_game/main.blocks

@@ -0,0 +1 @@
+

tests/fixtures/empty_game/main.ts

@@ -0,0 +1,21 @@
+{
+    "name": "test",
+    "description": "",
+    "dependencies": {
+        "device": "*"
+    },
+    "files": [
+        "main.blocks",
+        "main.ts",
+        "README.md",
+        "assets.json"
+    ],
+    "targetVersions": {
+        "branch": "stable4.0",
+        "tag": "v4.0.14",
+        "commits": "https://github.com/microsoft/pxt-arcade/commits/a33ec9537bc6c5fada2a3b02aac57a4bc9a10803",
+        "target": "4.0.14",
+        "pxt": "12.2.34"
+    },
+    "preferredEditor": "blocksprj"
+}

tests/fixtures/empty_game/pxt.json

@@ -0,0 +1,55 @@
+# Example configuration file for MakeCode Arcade to App to compile to static
+# HTML, CSS, and JS files
+
+# Config version (single number, incremented if breaking change to schema is
+# made)
+version: 1
+
+project:
+  name: Empty Game
+  path_friendly_name: empty-game
+  description: "Empty game used for E2E testing"
+  author: Cyrus Yiu
+  version: 0.0.1
+  # This is what the window title will be
+  # This will also be used for the executable file name for Electron outputs
+  # You can use {NAME} or {VERSION} or {AUTHOR} to substitute the correct
+  # values
+  title: "{NAME} v{VERSION}"
+
+inputs:
+  # Can be share_link, github, or path
+  code:
+    type: path
+    value: "tests/fixtures/empty_game"
+
+  assets: {}
+    # Icon is optional but highly recommended, it will be used as the favicon
+    # and app icon
+#    icon:
+#       Can be url or path
+#      type: url
+#      value: https://raw.githubusercontent.com/UnsignedArduino/MakeCode-Arcade-to-App/refs/heads/main/examples/Racers%20icon.png
+
+#    icon:
+#      type: path
+#      value: "./examples/Racers icon.png"
+
+# Path where the build process will take place
+build_dir: "./examples/testing/empty_game_build"
+
+# You can have multiple outputs
+# Currently available options are static, static-singlefile, electron, and
+# tauri
+outputs:
+  - type: static
+  - type: static-singlefile
+#  - type: electron
+#    window:
+#      width: 640
+#      height: 480
+#  - type: tauri
+#    identifier: com.unsignedarduino.racers
+#    window:
+#      width: 640
+#      height: 480