Install xvfb for headed browser tests

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`, и переключает generated test pipeline на headed запуск под `xvfb-run` (runner должен предоставлять `xvfb-run`). |
+| `@DisallowHeadless` | Запрещает headless-запуск | Меняет дефолт `headless` на `False`, заставляет runtime выбрасывать ошибку, если caller всё же просит `headless=True`, и переключает generated test pipeline на headed запуск под `xvfb-run` с установкой Xvfb из `github.workflows.tests.xvfb_install_commands` (runner должен уметь выполнить эти команды). |
 | `@Humanize` | Включает humanized-режим браузера | Передаёт `humanize=` в `AsyncCamoufox`, снижает “ботоподобность” поведения и требует `browser="camoufox"`. Разрешена либо как пустая аннотация, либо с положительным числом интенсивности, например `@Humanize(0.5)`. |
 | `@BlockImages` | Блокирует загрузку изображений | Передаёт `block_images=` в `AsyncCamoufox`, ускоряет старт и экономит трафик. Аннотация работает только с `browser="camoufox"`. |
 
@@ -62,4 +62,4 @@
 `@BlockImages` блокирует загрузку изображений при старте браузера.
 `@DisallowHeadless` делает `headless=False` значением по умолчанию и выбрасывает runtime error, если клиент всё же стартует с `headless=True`.
 
-`@Humanize` и `@BlockImages` работают только с `browser="camoufox"`. `@DisallowHeadless` не зависит от выбранного браузера, но влияет на generated CI pipeline, который начинает запускать браузерные тесты через `xvfb-run`.
+`@Humanize` и `@BlockImages` работают только с `browser="camoufox"`. `@DisallowHeadless` не зависит от выбранного браузера, но влияет на generated CI pipeline, который начинает запускать браузерные тесты через `xvfb-run` и установку Xvfb.

msra_codegen/config.toml

@@ -68,6 +68,10 @@ install_commands = [
     "venv/bin/python -m pip install -U pip",
     "venv/bin/python -m pip install -r requirements-dev.txt",
 ]
+xvfb_install_commands = [
+    "sudo apt-get update",
+    "sudo apt-get install -y xvfb xauth",
+]
 run_command_shell = "bash -e -lc"
 headed_run_command_shell = "xvfb-run -a bash -e -lc"
 run_commands = [

msra_codegen/github_workflows.py

@@ -24,6 +24,7 @@ def build_github_workflows_context(project: dict[str, Any], package_name: str) -
     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"])
+    tests_xvfb_install_commands = list(tests_config["xvfb_install_commands"])
     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.")
@@ -43,6 +44,7 @@ def build_github_workflows_context(project: dict[str, Any], package_name: str) -
             "checkout_action": str(tests_config["checkout_action"]),
             "setup_python_action": str(tests_config["setup_python_action"]),
             "install_commands": list(tests_config["install_commands"]),
+            "xvfb_install_commands": tests_xvfb_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,

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

@@ -40,6 +40,15 @@ jobs:
           {{ line }}
 {% endfor %}
 
+{% if tests.requires_xvfb %}
+      - name: Install Xvfb
+        run: |
+{% for line in tests.xvfb_install_commands %}
+          {{ line }}
+{% endfor %}
+
+{% endif %}
+
       - name: Run tests (venv)
         env:
           MSRA_RUN_COMMANDS: |

tests/codegen.test.js

@@ -1024,6 +1024,8 @@ test("python codegen builds the demo project", () => {
       readmeText,
       /\[!\[Ruff\]\(https:\/\/img\.shields\.io\/badge\/linting-Ruff-blue\?logo=ruff&logoColor=white\)\]\(https:\/\/github\.com\/astral-sh\/ruff\)/,
     );
+    assert.match(testsWorkflowText, /name: Install Xvfb/);
+    assert.match(testsWorkflowText, /sudo apt-get install -y xvfb xauth/);
     assert.match(testsWorkflowText, /xvfb-run -a bash -e -lc "\$MSRA_RUN_COMMANDS"/);
 
     const probeScript = [