[DO NOT MERGE] E2E テスト

.github/workflows/build.yml

@@ -3,6 +3,8 @@ name: build
 on:
   workflow_dispatch:
   push:
+    branches-ignore:
+      - feature/e2e-test
     paths-ignore:
       - "examples/**"
       - "**.md"

.github/workflows/e2e-test.yml

@@ -0,0 +1,138 @@
+name: e2e-test
+
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+      - "doc/**"
+      - "**.md"
+
+jobs:
+  e2e_ubuntu_test:
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12"]
+        os: ["ubuntu-22.04", "ubuntu-24.04"]
+    runs-on: ${{ matrix.os}}
+    timeout-minutes: 20
+    env:
+      TEST_SIGNALING_URL: ${{ secrets.TEST_SIGNALING_URL }}
+      TEST_SECRET_KEY: ${{ secrets.TEST_SECRET_KEY }}
+      TEST_CHANNEL_ID_PREFIX: ${{ secrets.TEST_CHANNEL_ID_PREFIX }}
+    steps:
+      - uses: actions/checkout@v4
+      # libx11-dev は Ubuntu 24.04 の時に必要になる模様
+      - run: |
+          sudo apt-get update
+          sudo apt-get -y install libva-dev libdrm-dev libx11-dev
+      - name: Download openh264
+        run: |
+          curl -LO http://ciscobinary.openh264.org/libopenh264-2.4.1-linux64.7.so.bz2
+          bzip2 -d libopenh264-2.4.1-linux64.7.so.bz2
+          mv libopenh264-2.4.1-linux64.7.so libopenh264.so
+          echo "OPENH264_PATH=$(pwd)/libopenh264.so" >> $GITHUB_ENV
+        working-directory: ./tests
+      - uses: eifinger/setup-rye@v4
+      - run: rye pin ${{ matrix.python_version }}
+      - run: rye sync
+      - run: rye run python run.py ${{ matrix.os }}_x86_64
+      # - run: rye test
+      - run: rye run pytest tests/test_sendonly_recvonly.py -s
+      - run: rye run pytest tests/test_messaging.py -s
+      - run: rye run pytest tests/test_openh264.py -s
+      - run: rye run pytest tests/test_vad.py -s
+
+  e2e_macos_test:
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12"]
+        # macos-13 は test_macos.py が上手くテストが動かないのでスキップ
+        os: ["macos-14"]
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 20
+    env:
+      TEST_SIGNALING_URL: ${{ secrets.TEST_SIGNALING_URL }}
+      TEST_SECRET_KEY: ${{ secrets.TEST_SECRET_KEY }}
+      TEST_CHANNEL_ID_PREFIX: ${{ secrets.TEST_CHANNEL_ID_PREFIX }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download openh264
+        run: |
+          curl -LO http://ciscobinary.openh264.org/libopenh264-2.4.1-mac-arm64.dylib.bz2
+          bzip2 -d libopenh264-2.4.1-mac-arm64.dylib.bz2
+          mv libopenh264-2.4.1-mac-arm64.dylib libopenh264.dylib
+          echo "OPENH264_PATH=$(pwd)/libopenh264.dylib" >> $GITHUB_ENV
+        working-directory: ./tests
+      - uses: eifinger/setup-rye@v4
+      - run: rye pin ${{ matrix.python_version }}
+      - run: rye sync
+      - run: rye run python run.py macos_arm64
+      # - run: rye test
+      # macOS のテストを先にする
+      - run: rye run pytest tests/test_macos.py -s
+      - run: rye run pytest tests/test_sendonly_recvonly.py -s
+      - run: rye run pytest tests/test_messaging.py -s
+      - run: rye run pytest tests/test_openh264.py -s
+      - run: rye run pytest tests/test_vad.py -s
+
+  # まだ Windows で E2E テストは早かったかもしれない
+  e2e_windows_test:
+    strategy:
+      matrix:
+        python_version: ["3.10", "3.11", "3.12"]
+    runs-on: windows-2022
+    timeout-minutes: 20
+    env:
+      # Python を強制的に UTF-8 で利用するおまじない
+      PYTHONUTF8: 1
+      TEST_SIGNALING_URL: ${{ secrets.TEST_SIGNALING_URL }}
+      TEST_SECRET_KEY: ${{ secrets.TEST_SECRET_KEY }}
+      TEST_CHANNEL_ID_PREFIX: ${{ secrets.TEST_CHANNEL_ID_PREFIX }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download openh264
+        shell: pwsh
+        run: |
+          $url = "http://ciscobinary.openh264.org/openh264-2.4.1-win64.dll.bz2"
+          Invoke-WebRequest -Uri $url -OutFile "openh264-2.4.1-win64.dll.bz2"
+          7z e openh264-2.4.1-win64.dll.bz2
+          Rename-Item -Path "openh264-2.4.1-win64.dll" -NewName "libopenh264.dll"
+          echo "OPENH264_PATH=$PWD\libopenh264.dll" >> $env:GITHUB_ENV
+        working-directory: ./tests
+      - uses: eifinger/setup-rye@v4
+      - run: rye pin ${{ matrix.python_version }}
+      - run: rye sync
+      - run: rye run python run.py windows_x86_64
+      - run: rye run pytest tests/test_sendonly_recvonly.py -s
+      - run: rye run pytest tests/test_messaging.py -s
+      # FIXME: OpenH264 + Windows は対応していないのでコメントアウト
+      # - run: rye run pytest tests/test_openh264.py -s
+      - run: rye run pytest tests/test_vad.py -s
+
+  slack_notify_succeeded:
+    needs: [e2e_ubuntu_test, e2e_macos_test, e2e_windows_test]
+    runs-on: ubuntu-latest
+    if: success()
+    steps:
+      - name: Slack Notification
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: sora-python-sdk
+          SLACK_COLOR: good
+          SLACK_TITLE: SUCCEEDED
+          SLACK_ICON_EMOJI: ":star-struck:"
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+
+  slack_notify_failed:
+    needs: [e2e_ubuntu_test, e2e_macos_test, e2e_windows_test]
+    runs-on: ubuntu-latest
+    if: failure()
+    steps:
+      - name: Slack Notification
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: sora-python-sdk
+          SLACK_COLOR: danger
+          SLACK_TITLE: "FAILED"
+          SLACK_ICON_EMOJI: ":japanese_ogre:"
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}  

.gitignore

@@ -22,6 +22,5 @@ src/sora_sdk/py.typed
 # E2E テスト用
 .env
 
-
 # libopenh264
 libopenh264*

CHANGES.md

@@ -9,6 +9,11 @@
 - FIX
   - バグ修正
 
+## feature/test
+
+- [ADD] python-dotenv を追加
+  - @voluntas
+
 ## develop
 
 - [FIX] examples の設定に virtual = true を指定するようにする
@@ -163,6 +168,7 @@
   - @tnoho
 - [FIX] `pyproject.toml` の `[rye.tool]` に `virtual = true` を追加する
   - これで Windows ビルド失敗の原因である `--e file:.` が消える
+  - ただし E2E テストが動作しなくなる問題あり
   - @voluntas
 - [ADD]H.265 に対応
   - Sora C++ SDK のバージョンアップに伴い macOS で H.265 が利用可能になる

examples/requirements-dev.lock

@@ -2,7 +2,7 @@
 # use `rye lock` or `rye sync` to update this lockfile
 #
 # last locked with the following flags:
-#   pre: false
+#   pre: true
 #   features: []
 #   all-features: false
 #   with-sources: false

examples/requirements.lock

@@ -2,7 +2,7 @@
 # use `rye lock` or `rye sync` to update this lockfile
 #
 # last locked with the following flags:
-#   pre: false
+#   pre: true
 #   features: []
 #   all-features: false
 #   with-sources: false

pyproject.toml

@@ -61,6 +61,9 @@ dev-dependencies = [
     "wheel~=0.43.0",
     "auditwheel~=6.0.0",
     "pytest>=8.3",
+    "python-dotenv>=1.0.1",
+    "opencv-python>=4.9.0.80",
+    "numpy>=2.0.0",
     "ruff>=0.5",
     "typing-extensions>=4.12.2",
 ]

requirements-dev.lock

@@ -17,6 +17,9 @@ exceptiongroup==1.2.2
 iniconfig==2.0.0
     # via pytest
 nanobind==2.1.0
+numpy==2.0.1
+    # via opencv-python
+opencv-python==4.10.0.84
 packaging==24.1
     # via auditwheel
     # via build
@@ -28,6 +31,7 @@ pyelftools==0.31
 pyproject-hooks==1.1.0
     # via build
 pytest==8.3.2
+python-dotenv==1.0.1
 ruff==0.5.7
 setuptools==72.2.0
 tomli==2.0.1

tests/README.md

@@ -0,0 +1,34 @@
+# E2E テスト
+
+## ローカル時の環境変数の設定
+
+`.env` ファイルをローカル向けに作成してください。
+
+```bash
+TEST_SIGNALING_URL=wss://sora.example.com/signaling
+TEST_CHANNEL_ID_PREFIX=sora
+TEST_SECRET_KEY=secret
+# これはオプションです
+OPENH264_PATH=/usr/local/lib/libopenh264.so
+```
+
+## 実行方法
+
+基本個別で実行することをお勧めします。
+
+```bash
+rye sync
+rye run python run.py
+rye run pytest -m tests/test_messaging.py -s
+```
+
+## 課題
+
+### macOS
+
+- macos-13 で Video Toolbox の H.264/H.265 のテストが動作しない
+
+### Windows
+
+- 日本語を print する文があると pytest が動作しない
+- OpenH264 のテストが動作しない