Add file component

README.md

@@ -98,6 +98,11 @@ You can test the SDK by running
 poetry run ci_test
 ```
 
+In local development you can use
+```
+poetry run pytest -m "not file_component_sources"
+```
+
 ## Format & Lint
 You can format code by running
 ```console

docker-compose-test.yaml

@@ -25,6 +25,8 @@ services:
       - "5002:5002"
       - "49999:49999"
       - "50000-50050:50000-50050/udp"
+    volumes:
+      - ./tests/fixtures:/app/jellyfish_resources/file_component_sources
 
   test:
     container_name: test

pyproject.toml

@@ -55,3 +55,8 @@ ignore = []
 
 [tool.ruff.extend-per-file-ignores]
 "jellyfish/_openapi_client/**" = ["E501"]
+
+[tool.pytest.ini_options]
+markers = [
+    "file_component_sources: Tests requiring files uploaded for File Component"
+]

tests/test_room_api.py

@@ -3,6 +3,7 @@
 
 import os
 import uuid
+from dataclasses import dataclass
 
 import pytest
 
@@ -41,10 +42,28 @@
 CODEC_H264 = "h264"
 
 HLS_OPTIONS = ComponentOptionsHLS()
+HLS_PROPERTIES = ComponentPropertiesHLS(
+    low_latency=False,
+    persistent=False,
+    playable=False,
+    subscribe_mode=ComponentPropertiesHLSSubscribeMode("auto"),
+    target_window_duration=None,
+)
+HLS_PROPERTIES.additional_properties = {"s3": None}
+
 RTSP_OPTIONS = ComponentOptionsRTSP(
     source_uri="rtsp://ef36c6dff23ecc5bbe311cc880d95dc8.se:2137/does/not/matter"
 )
+RTSP_PROPERTIES = ComponentPropertiesRTSP(
+    source_uri=RTSP_OPTIONS.source_uri,
+    keep_alive_interval=15000,
+    reconnect_delay=15000,
+    rtp_port=20000,
+    pierce_nat=True,
+)
+
 FILE_OPTIONS = ComponentOptionsFile(file_path="video.h264")
+FILE_PROPERTIES = ComponentPropertiesFile(file_path=FILE_OPTIONS.file_path)
 
 
 class TestAuthentication:
@@ -192,70 +211,49 @@ def test_invalid(self, room_api: RoomApi):
             room_api.get_room("invalid_id")
 
 
-class TestAddComponent:
-    def test_with_options_hls(self, room_api: RoomApi):
-        _, room = room_api.create_room(video_codec=CODEC_H264)
+@dataclass
+class ComponentTestData:
+    component: any
+    type: str
+    options: any
+    properties: any
 
-        response = room_api.add_component(room.id, options=HLS_OPTIONS)
 
-        component = room_api.get_room(room.id).components[0]
+class TestAddComponent:
+    def test_with_options_hls(self, room_api):
+        data = ComponentTestData(ComponentHLS, "hls", HLS_OPTIONS, HLS_PROPERTIES)
+        self._test_component(room_api, data)
 
-        properties = ComponentPropertiesHLS(
-            low_latency=False,
-            persistent=False,
-            playable=False,
-            subscribe_mode=ComponentPropertiesHLSSubscribeMode("auto"),
-            target_window_duration=None,
-        )
-        properties.additional_properties = {"s3": None}
-        component_hls = ComponentHLS(id=component.id, type="hls", properties=properties)
+    def test_with_options_rtsp(self, room_api):
+        data = ComponentTestData(ComponentRTSP, "rtsp", RTSP_OPTIONS, RTSP_PROPERTIES)
+        self._test_component(room_api, data)
 
-        assert response == component_hls
-        assert component == component_hls
+    @pytest.mark.file_component_sources
+    def test_with_options_file(self, room_api):
+        data = ComponentTestData(ComponentFile, "file", FILE_OPTIONS, FILE_PROPERTIES)
+        self._test_component(room_api, data)
 
-    def test_with_options_rtsp(self, room_api: RoomApi):
+    def test_invalid_type(self, room_api: RoomApi):
         _, room = room_api.create_room(video_codec=CODEC_H264)
 
-        response = room_api.add_component(room.id, options=RTSP_OPTIONS)
-        component = room_api.get_room(room.id).components[0]
-
-        component_rtsp = ComponentRTSP(
-            id=component.id,
-            type="rtsp",
-            properties=ComponentPropertiesRTSP(
-                source_uri=RTSP_OPTIONS.source_uri,
-                keep_alive_interval=RTSP_OPTIONS.keep_alive_interval,
-                reconnect_delay=RTSP_OPTIONS.reconnect_delay,
-                rtp_port=RTSP_OPTIONS.rtp_port,
-                pierce_nat=RTSP_OPTIONS.pierce_nat,
-            ),
-        )
-
-        assert response == component_rtsp
-        assert component == component_rtsp
-
-    def test_with_options_file(self, room_api: RoomApi):
-        _, room = room_api.create_room()
+        with pytest.raises(ValueError):
+            room_api.add_component(room.id, options=PeerOptionsWebRTC())
 
-        response = room_api.add_component(room.id, options=FILE_OPTIONS)
+    def _test_component(self, room_api: RoomApi, test_data: ComponentTestData):
+        _, room = room_api.create_room(video_codec=CODEC_H264)
 
+        response = room_api.add_component(room.id, options=test_data.options)
         component = room_api.get_room(room.id).components[0]
 
-        component_file = ComponentFile(
+        component_file = test_data.component(
             id=component.id,
-            type="file",
-            properties=ComponentPropertiesFile(file_path=FILE_OPTIONS.file_path),
+            type=test_data.type,
+            properties=test_data.properties,
         )
 
         assert response == component_file
         assert component == component_file
 
-    def test_invalid_type(self, room_api: RoomApi):
-        _, room = room_api.create_room(video_codec=CODEC_H264)
-
-        with pytest.raises(ValueError):
-            room_api.add_component(room.id, options=PeerOptionsWebRTC())
-
 
 class TestDeleteComponent:
     def test_valid_component(self, room_api: RoomApi):