Run headed browser tests under xvfb

Author: Miskler

docs/msra-app.md

@@ -17,7 +17,7 @@
 | `version` | Версия клиента или API-контракта | Копируется в generated package и используется как версия артефакта. Значение должно быть статическим. |
 | `timeout_ms` | Глобальный таймаут по умолчанию | Становится базовым лимитом для runtime-операций и используется, если локальный блок не переопределяет timeout. |
 | `browser` | Браузер по умолчанию | Определяет, какой движок запустит runtime для warmup и browser-backed функций. Если не указан, runtime использует `camoufox` по умолчанию. |
-| `@DisallowHeadless` | Запрещает headless-запуск | Меняет дефолт `headless` на `False` и заставляет runtime выбрасывать ошибку, если caller всё же просит `headless=True`. |
+| `@DisallowHeadless` | Запрещает headless-запуск | Меняет дефолт `headless` на `False`, заставляет runtime выбрасывать ошибку, если caller всё же просит `headless=True`, и переключает generated test pipeline на headed запуск под `xvfb-run` (runner должен предоставлять `xvfb-run`). |
 | `@Humanize` | Включает humanized-режим браузера | Передаёт `humanize=` в `AsyncCamoufox`, снижает “ботоподобность” поведения и требует `browser="camoufox"`. Разрешена либо как пустая аннотация, либо с положительным числом интенсивности, например `@Humanize(0.5)`. |
 | `@BlockImages` | Блокирует загрузку изображений | Передаёт `block_images=` в `AsyncCamoufox`, ускоряет старт и экономит трафик. Аннотация работает только с `browser="camoufox"`. |
 
@@ -42,7 +42,7 @@
 ### Что меняется
 
 - `browser` определяет движок, на котором запускаются warmup и browser-backed функции.
-- `@DisallowHeadless` меняет значение по умолчанию для `headless` на `False` и запрещает запуск с `headless=True`.
+- `@DisallowHeadless` меняет значение по умолчанию для `headless` на `False`, запрещает запуск с `headless=True` и переключает generated test workflow на headed запуск под `xvfb-run`.
 - `@Humanize` и `@BlockImages` валидны только при `browser="camoufox"`.
 - Если значение не задано, runtime и generated client используют `camoufox` как дефолтный режим.
 - `package_name` задаёт имя generated Python-пакета; generator больше не пытается выводить его из `name`.
@@ -62,4 +62,4 @@
 `@BlockImages` блокирует загрузку изображений при старте браузера.
 `@DisallowHeadless` делает `headless=False` значением по умолчанию и выбрасывает runtime error, если клиент всё же стартует с `headless=True`.
 
-`@Humanize` и `@BlockImages` работают только с `browser="camoufox"`. `@DisallowHeadless` не зависит от выбранного браузера.
+`@Humanize` и `@BlockImages` работают только с `browser="camoufox"`. `@DisallowHeadless` не зависит от выбранного браузера, но влияет на generated CI pipeline, который начинает запускать браузерные тесты через `xvfb-run`.

msra_codegen/config.toml

@@ -68,6 +68,8 @@ install_commands = [
     "venv/bin/python -m pip install -U pip",
     "venv/bin/python -m pip install -r requirements-dev.txt",
 ]
+run_command_shell = "bash -e -lc"
+headed_run_command_shell = "xvfb-run -a bash -e -lc"
 run_commands = [
     "set -o pipefail",
     "venv/bin/python -m pytest --jsss-ci-cd --save-original --tb=short 2>&1 | tee error.log",

msra_codegen/github_workflows.py

@@ -10,6 +10,7 @@
 
 
 def build_github_workflows_context(project: dict[str, Any], package_name: str) -> dict[str, Any]:
+    app = project.get("app", {})
     github_config = config_section("github", "workflows")
     tests_config = github_config["tests"]
     publish_config = github_config["publish"]
@@ -21,6 +22,8 @@ def build_github_workflows_context(project: dict[str, Any], package_name: str) -
     tests_python_version = str(tests_config["python_version"])
     publish_python_version = str(publish_config["python_version"])
     source_sync_python_version = str(source_sync_config["python_version"])
+    tests_run_command_shell = str(tests_config["run_command_shell"])
+    tests_headed_run_command_shell = str(tests_config["headed_run_command_shell"])
     preserved_target_paths = app_sync_config.get("preserved_target_paths", [])
     if not isinstance(preserved_target_paths, list):
         raise RuntimeError("app.sync.preserved_target_paths must be a list.")
@@ -41,6 +44,9 @@ def build_github_workflows_context(project: dict[str, Any], package_name: str) -
             "setup_python_action": str(tests_config["setup_python_action"]),
             "install_commands": list(tests_config["install_commands"]),
             "run_commands": list(tests_config["run_commands"]),
+            "run_command_shell": tests_run_command_shell,
+            "headed_run_command_shell": tests_headed_run_command_shell,
+            "requires_xvfb": bool(app["disallow_headless"]),
             "report_playwright_failure_action": str(tests_config["report_playwright_failure_action"]),
             "report_schema_action": str(tests_config["report_schema_action"]),
             "github_token_expr": "${{ secrets." + str(tests_config["github_token_secret"]) + " }}",

msra_codegen/templates/github/workflows/tests.yml.tpl

@@ -41,10 +41,17 @@ jobs:
 {% endfor %}
 
       - name: Run tests (venv)
-        run: |
+        env:
+          MSRA_RUN_COMMANDS: |
 {% for line in tests.run_commands %}
-          {{ line }}
+            {{ line }}
 {% endfor %}
+        run: |
+{% if tests.requires_xvfb %}
+          {{ tests.headed_run_command_shell }} "$MSRA_RUN_COMMANDS"
+{% else %}
+          {{ tests.run_command_shell }} "$MSRA_RUN_COMMANDS"
+{% endif %}
 
       - name: report playwright failure
         if: failure()

tests/codegen.test.js

@@ -1017,10 +1017,14 @@ test("python codegen builds the demo project", () => {
     assert.strictEqual(validateResult.status, 0, validateResult.stderr || validateResult.stdout);
 
     const readmeText = readFileSync(path.join(outputDir, "README.md"), "utf8");
+    const testsWorkflowText = normalizeNewlines(
+      readFileSync(path.join(outputDir, ".github", "workflows", "tests.yml"), "utf8"),
+    );
     assert.match(
       readmeText,
       /\[!\[Ruff\]\(https:\/\/img\.shields\.io\/badge\/linting-Ruff-blue\?logo=ruff&logoColor=white\)\]\(https:\/\/github\.com\/astral-sh\/ruff\)/,
     );
+    assert.match(testsWorkflowText, /xvfb-run -a bash -e -lc "\$MSRA_RUN_COMMANDS"/);
 
     const probeScript = [
       buildGeneratedPackageProbeScript({ expectedHeadlessDefault: false }),