[WIP] pytest を利用した Momo の E2E テストを追加する

.github/workflows/build.yml

@@ -2,14 +2,14 @@ name: build-workflow
 
 on:
   workflow_dispatch:
-  push:
-    paths-ignore:
-      - "doc/**"
-      - "html/**"
-      - "**.md"
-      - "THANKS"
-      - "LICENSE"
-      - "NOTICE"
+  # push:
+  #   paths-ignore:
+  #     - "doc/**"
+  #     - "html/**"
+  #     - "**.md"
+  #     - "THANKS"
+  #     - "LICENSE"
+  #     - "NOTICE"
 
 jobs:
   build-windows:

.github/workflows/e2e-test.yml

@@ -0,0 +1,54 @@
+name: e2e-test
+
+on:
+  push:
+    paths-ignore:
+      - "doc/**"
+      - "html/**"
+      - "**.md"
+      - "THANKS"
+      - "LICENSE"
+      - "NOTICE"
+
+jobs:
+  e2e-test-ubuntu:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-22.04
+          # - ubuntu-24.04
+    env:
+      TEST_SIGNALING_URLS: ${{ secrets.TEST_SIGNALING_URLS }}
+      TEST_CHANNEL_ID_PREFIX: ${{ secrets.TEST_CHANNEL_ID_PREFIX }}
+      TEST_SECRET_KEY: ${{ secrets.TEST_SECRET_KEY }}
+      MOMO_VERSION: "2024.1.0"
+      MOMO_ARCH: "x86_64"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          sudo apt update
+          sudo apt install -y ffmpeg v4l2loopback-dkms v4l2loopback-utils linux-modules-extra-$(uname -r)
+      - run: |
+          curl -LO https://github.com/shiguredo/momo/releases/download/${{ env.MOMO_VERSION}}/momo-${{ env.MOMO_VERSION }}_${{ matrix.os }}_${{ env.MOMO_ARCH }}.tar.gz
+          tar -xzf momo-${{ env.MOMO_VERSION }}_${{ matrix.os }}_${{ env.MOMO_ARCH }}.tar.gz
+          mkdir -p _build/${{ matrix.os }}_${{ env.MOMO_ARCH }}/release/momo
+          # chmod 755 momo-${{ env.MOMO_VERSION }}_${{ matrix.os }}_${{ env.MOMO_ARCH }}/momo
+          chmod 755 momo/momo
+          # mv momo-${{ env.MOMO_VERSION }}_${{ matrix.os }}_${{ env.MOMO_ARCH }}/momo ${{ github.workspace }}/_build/${{ matrix.os }}_${{ env.MOMO_ARCH }}/release/momo/
+          mv momo/momo ${{ github.workspace }}/_build/${{ matrix.os }}_${{ env.MOMO_ARCH }}/release/momo/
+      - uses: astral-sh/setup-uv@v3
+      - name: setup v4l2loopback
+        run: |
+          sudo modprobe v4l2loopback devices=1 video_nr=0 exclusive_caps=1 card_label='VCamera'
+          ls -l /dev/video0
+      - run: |
+          sudo v4l2-ctl --device /dev/video0 --all
+          sudo v4l2-ctl --device /dev/video0 --list-formats-ext
+      - run: /home/runner/work/momo/momo/_build/ubuntu-22.04_x86_64/release/momo/momo --version
+      - run: uv sync
+        working-directory: ./test
+      - run: |
+          uv run pytest test_momo.py -s
+        working-directory: ./test

.gitignore

@@ -43,3 +43,15 @@ webrtc_logs_0
 /_source
 /_install
 /_package
+
+# python
+.venv
+.pytest_cache
+__pycache__
+
+# vscode
+build
+
+# .env
+.env
+!.env.template

CHANGES.md

@@ -97,6 +97,8 @@
 
 ### misc
 
+- [ADD] pytest を利用した E2E テストを追加
+  - @voluntas
 - [CHANGE] SDL2 のダウンロード先を GitHub に変更する
   - @voluntas
 - [UPDATE] Github Actions の actions/download-artifact をアップデート

test/.env.template

@@ -0,0 +1,4 @@
+TEST_SIGNALING_URLS=wss://sora.example.com/signaling
+TEST_CHANNEL_ID_PREFIX=momo_
+TEST_SECRET_KEY=secret
+TEST_API_URL=https://sora.example.com/api

test/.python-version

@@ -0,0 +1 @@
+3.13

test/conftest.py

@@ -0,0 +1,36 @@
+import os
+
+import pytest
+from dotenv import load_dotenv
+
+
+@pytest.fixture
+def setup():
+    # 環境変数読み込み
+    load_dotenv()
+
+    # signaling_url 単体か複数かをランダムで決めてテストする
+    if (test_signaling_urls := os.environ.get("TEST_SIGNALING_URLS")) is None:
+        raise ValueError("TEST_SIGNALING_URLS is required.")
+
+    # , で区切って ['wss://...', ...] に変換
+    test_signaling_urls = test_signaling_urls.split(",")
+
+    if (test_channel_id_prefix := os.environ.get("TEST_CHANNEL_ID_PREFIX")) is None:
+        raise ValueError("TEST_CHANNEL_ID_PREFIX is required.")
+
+    if (test_secret_key := os.environ.get("TEST_SECRET_KEY")) is None:
+        raise ValueError("TEST_SECRET_KEY is required.")
+
+    # if (test_api_url := os.environ.get("TEST_API_URL")) is None:
+    #     raise ValueError("TEST_API_URL is required.")
+
+    return {
+        "signaling_urls": test_signaling_urls,
+        "channel_id_prefix": test_channel_id_prefix,
+        # "secret": test_secret_key,
+        # "api_url": test_api_url,
+        "metadata": {"access_token": test_secret_key},
+        # openh264_path は str | None でよい
+        # "openh264_path": os.environ.get("OPENH264_PATH"),
+    }

test/momo_sora.py

@@ -0,0 +1,113 @@
+import json
+import platform
+import signal
+import subprocess
+import sys
+import threading
+import time
+import uuid
+from pathlib import Path
+
+# プラットフォームに応じたリリースディレクトリの設定
+RELEASE_DIR = Path(__file__).resolve().parent.parent / Path("_build/")
+
+# TODO: 環境変数で CI か Local で見に行くパスを変えるようにする
+if platform.system() == "Darwin":
+    if platform.machine() == "arm64":
+        RELEASE_DIR = RELEASE_DIR / "macos_arm64/release/momo"
+elif platform.system() == "Linux":
+    # ubuntu 24.04 かどうかの確認が必要
+    # ubuntu 22.04 と 24.04 がある
+    RELEASE_DIR = RELEASE_DIR / "ubuntu-22.04_x86_64/release/momo"
+else:
+    raise OSError(f"Unsupported platform: {platform.system()}")
+
+
+class Momo:
+    signaling_urls: list[str]
+    channel_id_prefix: str
+    metadata: dict[str, str]
+    port: int
+
+    def __init__(
+        self,
+        signaling_urls: list[str],
+        channel_id_prefix: str,
+        metadata: dict[str, str],
+    ):
+        self.signaling_urls = signaling_urls
+        self.channel_id_prefix = channel_id_prefix
+        self.metadata = metadata
+
+        self.channel_id = f"{self.channel_id_prefix}_{uuid.uuid4()}"
+
+        self.port = 5000
+
+        self.executable = RELEASE_DIR / "momo"
+        assert self.executable.exists()
+        self.process = None
+        self.thread = None
+        self.is_running = False
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.stop()
+
+    def run_app(self):
+        print(self.executable)
+        args = [
+            str(self.executable),
+            "sora",
+            "--signaling-urls",
+            ",".join(self.signaling_urls),
+            "--channel-id",
+            self.channel_id_prefix,
+            # "--video-device",
+            # これは GitHub Actions 用
+            # "VCamera",
+            "--metadata",
+            json.dumps(self.metadata),
+        ]
+        try:
+            self.process = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            self.process.wait()
+        except Exception as e:
+            print(f"Error running momo: {e}", file=sys.stderr)
+        finally:
+            self.is_running = False
+
+    def start(self):
+        if not self.executable.exists():
+            raise FileNotFoundError(f"Executable file not found: {self.executable}")
+
+        self.thread = threading.Thread(target=self.run_app)
+        self.thread.start()
+        self.is_running = True
+
+        # momoの起動を確認
+        start_time = time.time()
+        while time.time() - start_time < 10:  # 10秒のタイムアウト
+            if self.process and self.process.poll() is None:
+                print("Momo started")
+                return
+            time.sleep(0.1)
+
+        raise TimeoutError("Momo failed to start within the timeout period")
+
+    def stop(self):
+        if self.is_running and self.process:
+            # SIGINT を送信 (Ctrl+C と同等)
+            self.process.send_signal(signal.SIGINT)
+            try:
+                # プロセスが終了するのを最大5秒間待つ
+                self.process.wait(timeout=5)
+            except subprocess.TimeoutExpired:
+                # タイムアウトした場合、強制終了
+                print("Momo did not terminate gracefully. Forcing termination.", file=sys.stderr)
+                self.process.kill()
+
+            self.thread.join(timeout=5)
+            self.is_running = False
+            print("Momo stopped")

test/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "momo-e2e-test"
+version = "2013.3.8"
+requires-python = ">= 3.12"
+dependencies = [
+    "pytest>=8.3",
+    "pytest-timeout>=2.3",
+    "python-dotenv>=1.0",
+]
+
+[tool.uv]
+package = false
+managed = true
+dev-dependencies = ["ruff"]
+
+[tool.pytest.ini_options]
+timeout = 45
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100

test/test_momo.py

@@ -0,0 +1,12 @@
+import time
+
+from momo_sora import Momo
+
+
+def test_start_and_stop(setup):
+    with Momo(**setup) as momo:
+        momo.start()
+
+        time.sleep(3)
+
+        momo.stop()