Merge pull request #84 from shiguredo/feature/e2e-test-ca-cert

Feature/e2e test ca cert

.github/workflows/e2e-test.yml

@@ -16,17 +16,12 @@ env:
 
 jobs:
   e2e_test_ubuntu:
-    # if: >-
-    #   ${{
-    #     contains(github.event.head_commit.message, '[e2e]') ||
-    #     github.event_name == 'schedule'
-    #   }}
     strategy:
       matrix:
         python_version: ["3.10", "3.11", "3.12"]
         os: ["ubuntu-22.04", "ubuntu-24.04"]
     runs-on: ${{ matrix.os}}
-    timeout-minutes: 30
+    timeout-minutes: 15
     steps:
       - uses: actions/checkout@v4
       # libx11-dev は Ubuntu 24.04 の時に必要になる模様
@@ -49,21 +44,17 @@ jobs:
       - run: uv run pytest tests/test_signaling_message.py -s
       - run: uv run pytest tests/test_re_offer_re_answer_sdp.py -s
       - run: uv run pytest tests/test_messaging.py -s
+      - run: uv run pytest tests/test_ca_cert.py -s
       - run: uv run pytest tests/test_vad.py -s
 
   e2e_test_macos:
-    # if: >-
-    #   ${{
-    #     contains(github.event.head_commit.message, '[e2e]') ||
-    #     github.event_name == 'schedule'
-    #   }}
     strategy:
       matrix:
         python_version: ["3.10", "3.11", "3.12"]
         # macos-13 は test_macos.py が上手くテストが動かないのでスキップ
         os: ["macos-14"]
     runs-on: ${{ matrix.os }}
-    timeout-minutes: 30
+    timeout-minutes: 15
     steps:
       - uses: actions/checkout@v4
       - name: Download openh264
@@ -83,19 +74,15 @@ jobs:
       - run: uv run pytest tests/test_signaling_message.py -s
       - run: uv run pytest tests/test_re_offer_re_answer_sdp.py -s
       - run: uv run pytest tests/test_messaging.py -s
+      - run: uv run pytest tests/test_ca_cert.py -s
       - run: uv run pytest tests/test_vad.py -s
 
   e2e_test_windows:
-    # if: >-
-    #   ${{
-    #     contains(github.event.head_commit.message, '[e2e]') ||
-    #     github.event_name == 'schedule'
-    #   }}
     strategy:
       matrix:
         python_version: ["3.10", "3.11", "3.12"]
     runs-on: windows-2022
-    timeout-minutes: 30
+    timeout-minutes: 15
     env:
       # Python を強制的に UTF-8 で利用するおまじない
       PYTHONUTF8: 1
@@ -118,6 +105,7 @@ jobs:
       - run: uv run pytest tests/test_signaling_message.py -s
       - run: uv run pytest tests/test_re_offer_re_answer_sdp.py -s
       - run: uv run pytest tests/test_messaging.py -s
+      - run: uv run pytest tests/test_ca_cert.py -s
       - run: uv run pytest tests/test_vad.py -s
 
   slack_notify_succeeded:

tests/client.py

@@ -39,6 +39,7 @@ def __init__(
         audio_sample_rate: int = 16000,
         video_width: int = 640,
         video_height: int = 480,
+        ca_cert: Optional[str] = None,
     ):
         self._signaling_urls: list[str] = signaling_urls
         self._channel_id: str = channel_id
@@ -72,6 +73,7 @@ def __init__(
             data_channel_signaling=data_channel_signaling,
             audio_source=self._audio_source,
             video_source=self._video_source,
+            ca_cert=ca_cert,
         )
         self._connection_id: Optional[str] = None
 

tests/test_ca_cert.py

@@ -0,0 +1,107 @@
+import sys
+import time
+import uuid
+
+import pytest
+from client import Sendonly
+
+"""
+このテストは、Sora の CA 証明書が有効かどうかを確認するためのものです。
+接続先の Sora が Let's Encrypt の CA 証明書を使用している前提のテストになっています。
+"""
+
+# https://letsencrypt.org/certificates/
+# ISRG Root X1
+
+letsencrypt_org_ca_cert = """
+-----BEGIN CERTIFICATE-----
+MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw
+TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh
+cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4
+WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu
+ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY
+MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc
+h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+
+0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U
+A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW
+T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH
+B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC
+B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv
+KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn
+OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn
+jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw
+qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI
+rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV
+HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq
+hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL
+ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ
+3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK
+NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5
+ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur
+TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC
+jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc
+oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq
+4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA
+mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d
+emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc=
+-----END CERTIFICATE-----
+"""
+
+# https://pki.goog/repository/
+
+pki_goog_ca_cert = """
+-----BEGIN CERTIFICATE-----
+MIICCTCCAY6gAwIBAgINAgPlwGjvYxqccpBQUjAKBggqhkjOPQQDAzBHMQswCQYD
+VQQGEwJVUzEiMCAGA1UEChMZR29vZ2xlIFRydXN0IFNlcnZpY2VzIExMQzEUMBIG
+A1UEAxMLR1RTIFJvb3QgUjQwHhcNMTYwNjIyMDAwMDAwWhcNMzYwNjIyMDAwMDAw
+WjBHMQswCQYDVQQGEwJVUzEiMCAGA1UEChMZR29vZ2xlIFRydXN0IFNlcnZpY2Vz
+IExMQzEUMBIGA1UEAxMLR1RTIFJvb3QgUjQwdjAQBgcqhkjOPQIBBgUrgQQAIgNi
+AATzdHOnaItgrkO4NcWBMHtLSZ37wWHO5t5GvWvVYRg1rkDdc/eJkTBa6zzuhXyi
+QHY7qca4R9gq55KRanPpsXI5nymfopjTX15YhmUPoYRlBtHci8nHc8iMai/lxKvR
+HYqjQjBAMA4GA1UdDwEB/wQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQW
+BBSATNbrdP9JNqPV2Py1PsVq8JQdjDAKBggqhkjOPQQDAwNpADBmAjEA6ED/g94D
+9J+uHXqnLrmvT/aDHQ4thQEd0dlq7A/Cr8deVl5c1RxYIigL9zC2L7F8AjEA8GE8
+p/SgguMh1YQdc4acLa/KNJvxn7kjNuK8YAOdgLOaVsjh4rsUecrNIdSUtUlD
+-----END CERTIFICATE-----
+"""
+
+
+def test_ca_cert(setup):
+    signaling_urls = setup.get("signaling_urls")
+    channel_id_prefix = setup.get("channel_id_prefix")
+    metadata = setup.get("metadata")
+
+    channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
+
+    sendonly = Sendonly(
+        signaling_urls,
+        channel_id,
+        audio=True,
+        video=True,
+        metadata=metadata,
+        ca_cert=letsencrypt_org_ca_cert,
+    )
+    sendonly.connect(fake_audio=True, fake_video=True)
+
+    time.sleep(5)
+
+    sendonly.disconnect()
+
+
+@pytest.mark.xfail(reason="Invalid CA certificate")
+def test_ca_cert_invalid(setup):
+    signaling_urls = setup.get("signaling_urls")
+    channel_id_prefix = setup.get("channel_id_prefix")
+    metadata = setup.get("metadata")
+
+    channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
+
+    sendonly = Sendonly(
+        signaling_urls,
+        channel_id,
+        audio=True,
+        video=True,
+        metadata=metadata,
+        ca_cert=pki_goog_ca_cert,
+    )
+    sendonly.connect(fake_audio=True, fake_video=True)

tests/test_signaling_message.py

@@ -1,29 +1,25 @@
-import random
 import sys
 import time
 import uuid
 
 from client import Sendonly
 
 
-def test_random_signaling_message(setup):
+def test_signaling_message(setup):
     signaling_urls = setup.get("signaling_urls")
     channel_id_prefix = setup.get("channel_id_prefix")
     metadata = setup.get("metadata")
 
     channel_id = f"{channel_id_prefix}_{__name__}_{sys._getframe().f_code.co_name}_{uuid.uuid4()}"
 
-    selected_audio = random.choice([True, False])
-    selected_video = random.choice([True, False])
-
     sendonly = Sendonly(
         signaling_urls,
         channel_id,
-        audio=selected_audio,
-        video=selected_video,
+        audio=True,
+        video=True,
         metadata=metadata,
     )
-    sendonly.connect(fake_audio=selected_audio, fake_video=selected_video)
+    sendonly.connect(fake_audio=True, fake_video=True)
 
     time.sleep(5)
 
@@ -34,7 +30,7 @@ def test_random_signaling_message(setup):
     assert sendonly.answer_message is not None
 
     assert sendonly.connect_message["role"] == "sendonly"
-    assert sendonly.connect_message["channel_id"] is channel_id
-    assert sendonly.connect_message["audio"] is selected_audio
-    assert sendonly.connect_message["video"] is selected_video
+    assert sendonly.connect_message["channel_id"] == channel_id
+    assert sendonly.connect_message["audio"] is True
+    assert sendonly.connect_message["video"] is True
     assert sendonly.connect_message["metadata"] == metadata