Add vcr for youtube test

.pre-commit-config.yaml

@@ -16,6 +16,7 @@ repos:
             -   id: trailing-whitespace
             -   id: check-yaml
             -   id: check-added-large-files
+                exclude: '^tests/cassettes'
             -   id: debug-statements
             -   id: end-of-file-fixer
                 exclude: '^.+?\.json$'

setup.py

@@ -51,6 +51,16 @@
         "filetype>=1.1.0",
         "urllib3==2.3.0",
     ],
+    extras_require={
+        "test": [
+            "requests-cache==1.2.1",
+            "pytest==8.3.4",
+            "pycountry==24.6.1",
+            "pytest-env==1.1.5",
+            "vcrpy==7.0.0; python_version >='3.10'",
+            "mock==5.1.0",
+        ],
+    },
     python_requires=">=3.9, <3.13",
     license="MIT license",
     zip_safe=False,

tests/conftest.py

@@ -12,6 +12,11 @@
 from le_utils.constants import licenses
 from le_utils.constants import roles
 
+try:
+    from vcr.stubs import VCRHTTPResponse
+except ImportError:
+    VCRHTTPResponse = None
+
 from ricecooker.__init__ import __version__
 from ricecooker.classes.files import _ExerciseBase64ImageFile
 from ricecooker.classes.files import _ExerciseGraphieFile
@@ -77,6 +82,18 @@ def global_fixture():
             pass
 
 
+# Monkey patch VCRHTTPResponse to handle kwargs that are not compatible with BufferIO
+# This can be removed when this issue has been resolved: https://github.com/kevin1024/vcrpy/issues/902
+def _new_read(self, *args, **kwargs):
+    # urllib3 allows the kwarg 'decode_content' but BytesIO does not support it
+    kwargs.pop("decode_content", None)
+    return self._content.read(*args, **kwargs)
+
+
+if VCRHTTPResponse is not None:
+    VCRHTTPResponse.read = _new_read
+
+
 # CHANNEL FIXTURES
 ################################################################################
 
@@ -428,9 +445,9 @@ def invalid_video_file():
 @pytest.fixture
 def youtube_video_dict():
     """
-    A short 17 sec video that won't slow down tests too much.
+    A short 1 sec video that won't store too much data locally.
     """
-    return {"youtube_id": "C0DPdy98e4c"}
+    return {"youtube_id": "tPEE9ZwTmy0"}
 
 
 @pytest.fixture

tests/test_files.py

@@ -17,6 +17,7 @@
 from PIL import Image
 from requests import HTTPError
 from test_pdfutils import _save_file_url_to_path
+from vcr_config import my_vcr
 
 from ricecooker import config
 from ricecooker.classes.files import _ExerciseGraphieFile
@@ -744,7 +745,7 @@ def test_create_many_predictable_zip_files(ndirs=8193):
 """ *********** YOUTUBEVIDEOFILE TESTS *********** """
 
 
-@pytest.mark.skipif(True, reason="Requires connecting to youtube.")
+@my_vcr.use_cassette
 def test_youtubevideo_process_file(youtube_video_dict):
     video_file = YouTubeVideoFile(youtube_id=youtube_video_dict["youtube_id"])
     filename = video_file.process_file()

tests/vcr_config.py

@@ -0,0 +1,17 @@
+import pytest
+
+try:
+    import vcr
+
+    my_vcr = vcr.VCR(
+        cassette_library_dir="tests/cassettes",
+        record_mode="new_episodes",
+        path_transformer=vcr.VCR.ensure_suffix(".yaml"),
+    )
+except ImportError:
+
+    class VCR:
+        def use_cassette(self, *args, **kwargs):
+            return pytest.mark.skip("vcrpy is not available on this Python version")
+
+    my_vcr = VCR()

tox.ini

@@ -7,8 +7,7 @@ basepython =
     py3.10: python3.10
     py3.11: python3.11
     py3.12: python3.12
-deps =
-    -r{toxinidir}/requirements_test.txt
+extras = test
 setenv =
     PYTHONPATH = {toxinidir}
 commands =