Add ability to record cassettes with refresh_tokens

Author: LilSpazJoekp

tests/conftest.py

@@ -4,11 +4,13 @@
 import socket
 import time
 from base64 import b64encode
+from functools import wraps
 from sys import platform
 from urllib.parse import quote_plus
 
 import betamax
 import pytest
+from betamax.cassette.cassette import Cassette, dispatch_hooks
 from betamax.serializers import JSONSerializer
 
 
@@ -55,7 +57,7 @@ def filter_access_token(interaction, current_cassette):
     x: env_default(x)
     for x in (
         "auth_code client_id client_secret password redirect_uri test_subreddit"
-        " user_agent username"
+        " user_agent username refresh_token"
     ).split()
 }
 
@@ -83,6 +85,28 @@ def serialize(self, cassette_data):
         config.define_cassette_placeholder(f"<{key.upper()}>", value)
 
 
+def add_init_hook(original_init):
+    """Wrap an __init__ method to also call some hooks."""
+
+    @wraps(original_init)
+    def wrapper(self, *args, **kwargs):
+        original_init(self, *args, **kwargs)
+        dispatch_hooks("after_init", self)
+
+    return wrapper
+
+
+Cassette.__init__ = add_init_hook(Cassette.__init__)
+
+
+def init_hook(cassette):
+    if cassette.is_recording():
+        pytest.set_up_record()  # dynamically defined in __init__.py
+
+
+Cassette.hooks["after_init"].append(init_hook)
+
+
 class Placeholders:
     def __init__(self, _dict):
         self.__dict__ = _dict

tests/integration/__init__.py

@@ -16,6 +16,7 @@ class IntegrationTest:
 
     def setup(self):
         """Setup runs before all test cases."""
+        self._overrode_reddit_setup = True
         self.setup_reddit()
         self.setup_betamax()
 
@@ -31,7 +32,11 @@ def setup_betamax(self):
         # Require tests to explicitly disable read_only mode.
         self.reddit.read_only = True
 
+        pytest.set_up_record = self.set_up_record  # used in conftest.py
+
     def setup_reddit(self):
+        self._overrode_reddit_setup = False
+
         self._session = requests.Session()
 
         self.reddit = Reddit(
@@ -43,6 +48,17 @@ def setup_reddit(self):
             username=pytest.placeholders.username,
         )
 
+    def set_up_record(self):
+        if not self._overrode_reddit_setup:
+            if pytest.placeholders.refresh_token != "placeholder_refresh_token":
+                self.reddit = Reddit(
+                    requestor_kwargs={"session": self._session},
+                    client_id=pytest.placeholders.client_id,
+                    client_secret=pytest.placeholders.client_secret,
+                    user_agent=pytest.placeholders.user_agent,
+                    refresh_token=pytest.placeholders.refresh_token,
+                )
+
     def use_cassette(self, cassette_name=None, **kwargs):
         """Use a cassette. The cassette name is dynamically generated.