[tests] Added VCR-based integration test examples for JSON and YAML configurations

- Introduced integration tests using VCR for recording and replaying HTTP interactions with JSON and YAML formats.
- Applied class-specific VCR configurations to handle both JSON and YAML serializers for different test scenarios.

Author: Aryamanz29

pyatlan/test_utils/base_vcr.py

@@ -204,26 +204,6 @@ def deserialize(cassette_string: str) -> dict:
         return cassette_dict
 
 
-class VCRRemoveAllHeaders:
-    """
-    A class responsible for removing all headers from requests and responses.
-    This can be useful for scenarios where headers are not needed for matching or comparison
-    in VCR (Virtual Cassette Recorder) interactions, such as when recording or replaying HTTP requests.
-    """
-
-    @staticmethod
-    def remove_all_request_headers(request):
-        # Save only what's necessary for matching
-        request.headers = {}
-        return request
-
-    @staticmethod
-    def remove_all_response_headers(response):
-        # Save only what's necessary for matching
-        response["headers"] = {}
-        return response
-
-
 class BaseVCR:
     """
     A base class for configuring VCR (Virtual Cassette Recorder)
@@ -234,7 +214,37 @@ class BaseVCR:
     It also handles cassette directory configuration.
     """
 
+    class VCRRemoveAllHeaders:
+        """
+        A class responsible for removing all headers from requests and responses.
+        This can be useful for scenarios where headers are not needed for matching or comparison
+        in VCR (Virtual Cassette Recorder) interactions, such as when recording or replaying HTTP requests.
+        """
+
+        @staticmethod
+        def remove_all_request_headers(request):
+            # Save only what's necessary for matching
+            request.headers = {}
+            return request
+
+        @staticmethod
+        def remove_all_response_headers(response):
+            # Save only what's necessary for matching
+            response["headers"] = {}
+            return response
+
     _CASSETTES_DIR = None
+    _BASE_CONFIG = {
+        # More config options can be found at:
+        # https://vcrpy.readthedocs.io/en/latest/configuration.html#configuration
+        "record_mode": "once",  # (default: "once", "always", "none", "new_episodes")
+        "serializer": "pretty-yaml",  # (default: "yaml")
+        "decode_compressed_response": True,  # Decode compressed responses
+        # (optional) Replace the Authorization request header with "**REDACTED**" in cassettes
+        # "filter_headers": [("authorization", "**REDACTED**")],
+        "before_record_request": VCRRemoveAllHeaders.remove_all_request_headers,
+        "before_record_response": VCRRemoveAllHeaders.remove_all_response_headers,
+    }
 
     @pytest.fixture(scope="module")
     def vcr(self, vcr):
@@ -263,17 +273,7 @@ def vcr_config(self):
 
         :returns: a dictionary with VCR configuration options
         """
-        return {
-            # More config options can be found at:
-            # https://vcrpy.readthedocs.io/en/latest/configuration.html#configuration
-            "record_mode": "once",  # (default: "once", "always", "none", "new_episodes")
-            "serializer": "pretty-yaml",  # (default: "yaml")
-            "decode_compressed_response": True,  # Decode compressed responses
-            # (optional) Replace the Authorization request header with "**REDACTED**" in cassettes
-            # "filter_headers": [("authorization", "**REDACTED**")],
-            "before_record_request": VCRRemoveAllHeaders.remove_all_request_headers,
-            "before_record_response": VCRRemoveAllHeaders.remove_all_response_headers,
-        }
+        return self._BASE_CONFIG
 
     @pytest.fixture(scope="module")
     def vcr_cassette_dir(self, request):
@@ -290,5 +290,5 @@ def vcr_cassette_dir(self, request):
         """
         # Set self._CASSETTES_DIR or use the default directory path based on the test module name
         return self._CASSETTES_DIR or os.path.join(
-            "tests/cassettes", request.module.__name__
+            "tests/vcr_cassettes", request.module.__name__
         )

tests/unit/test_base_vcr_json.py

@@ -0,0 +1,65 @@
+import pytest
+import requests
+
+from pyatlan.test_utils.base_vcr import BaseVCR
+
+
+class TestBaseVCRJSON(BaseVCR):
+    """
+    Integration tests to demonstrate VCR.py capabilities
+    by recording and replaying HTTP interactions using
+    HTTPBin (https://httpbin.org) for GET, POST, PUT, and DELETE requests.
+    """
+
+    BASE_URL = "https://httpbin.org"
+
+    @pytest.fixture(scope="session")
+    def vcr_config(self):
+        """
+        Override the VCR configuration to use JSON serialization across the module.
+        """
+        config = self._BASE_CONFIG.copy()
+        config.update({"serializer": "pretty-json"})
+        return config
+
+    @pytest.mark.vcr()
+    def test_httpbin_get(self):
+        """
+        Test a simple GET request to httpbin.
+        """
+        url = f"{self.BASE_URL}/get"
+        response = requests.get(url, params={"test": "value"})
+        assert response.status_code == 200
+        assert response.json()["args"]["test"] == "value"
+
+    @pytest.mark.vcr()
+    def test_httpbin_post(self):
+        """
+        Test a simple POST request to httpbin.
+        """
+        url = f"{self.BASE_URL}/post"
+        payload = {"name": "atlan", "type": "integration-test"}
+        response = requests.post(url, json=payload)
+        assert response.status_code == 200
+        assert response.json()["json"] == payload
+
+    @pytest.mark.vcr()
+    def test_httpbin_put(self):
+        """
+        Test a simple PUT request to httpbin.
+        """
+        url = f"{self.BASE_URL}/put"
+        payload = {"update": "value"}
+        response = requests.put(url, json=payload)
+        assert response.status_code == 200
+        assert response.json()["json"] == payload
+
+    @pytest.mark.vcr()
+    def test_httpbin_delete(self):
+        """
+        Test a simple DELETE request to httpbin.
+        """
+        url = f"{self.BASE_URL}/delete"
+        response = requests.delete(url)
+        assert response.status_code == 200
+        assert response.json()["args"] == {}

tests/unit/test_base_vcr_yaml.py

@@ -0,0 +1,61 @@
+import pytest
+import requests
+
+from pyatlan.test_utils.base_vcr import BaseVCR
+
+
+class TestBaseVCRYAML(BaseVCR):
+    """
+    Integration tests to demonstrate VCR.py capabilities
+    by recording and replaying HTTP interactions using
+    HTTPBin (https://httpbin.org) for GET, POST, PUT, and DELETE requests.
+    """
+
+    BASE_URL = "https://httpbin.org"
+
+    @pytest.mark.vcr()
+    def test_httpbin_get(self):
+        """
+        Test a simple GET request to httpbin.
+        """
+        url = f"{self.BASE_URL}/get"
+        response = requests.get(url, params={"test": "value"})
+
+        assert response.status_code == 200
+        assert response.json()["args"]["test"] == "value"
+
+    @pytest.mark.vcr()
+    def test_httpbin_post(self):
+        """
+        Test a simple POST request to httpbin.
+        """
+        url = f"{self.BASE_URL}/post"
+        payload = {"name": "atlan", "type": "integration-test"}
+        response = requests.post(url, json=payload)
+
+        assert response.status_code == 200
+        assert response.json()["json"] == payload
+
+    @pytest.mark.vcr()
+    def test_httpbin_put(self):
+        """
+        Test a simple PUT request to httpbin.
+        """
+        url = f"{self.BASE_URL}/put"
+        payload = {"update": "value"}
+        response = requests.put(url, json=payload)
+
+        assert response.status_code == 200
+        assert response.json()["json"] == payload
+
+    @pytest.mark.vcr()
+    def test_httpbin_delete(self):
+        """
+        Test a simple DELETE request to httpbin.
+        """
+        url = f"{self.BASE_URL}/delete"
+        response = requests.delete(url)
+
+        assert response.status_code == 200
+        # HTTPBin returns an empty JSON object for DELETE
+        assert response.json()["args"] == {}

tests/vcr_cassettes/tests.unit.test_base_vcr_json/TestBaseVCRJSON.test_httpbin_delete.yaml

@@ -0,0 +1,39 @@
+{
+  "version": 1,
+  "interactions": [
+    {
+      "request": {
+        "method": "DELETE",
+        "uri": "https://httpbin.org/delete",
+        "body": null,
+        "headers": {}
+      },
+      "response": {
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "headers": {},
+        "body": {
+          "parsed_json": {
+            "args": {},
+            "data": "",
+            "files": {},
+            "form": {},
+            "headers": {
+              "Accept": "*/*",
+              "Accept-Encoding": "gzip, deflate",
+              "Content-Length": "0",
+              "Host": "httpbin.org",
+              "User-Agent": "python-requests/2.32.3",
+              "X-Amzn-Trace-Id": "Root=1-680f7263-439ec4f97dc37ffe07c63697"
+            },
+            "json": null,
+            "origin": "x.x.x.x",
+            "url": "https://httpbin.org/delete"
+          }
+        }
+      }
+    }
+  ]
+}

tests/vcr_cassettes/tests.unit.test_base_vcr_json/TestBaseVCRJSON.test_httpbin_get.yaml

@@ -0,0 +1,36 @@
+{
+  "version": 1,
+  "interactions": [
+    {
+      "request": {
+        "method": "GET",
+        "uri": "https://httpbin.org/get?test=value",
+        "body": null,
+        "headers": {}
+      },
+      "response": {
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "headers": {},
+        "body": {
+          "parsed_json": {
+            "args": {
+              "test": "value"
+            },
+            "headers": {
+              "Accept": "*/*",
+              "Accept-Encoding": "gzip, deflate",
+              "Host": "httpbin.org",
+              "User-Agent": "python-requests/2.32.3",
+              "X-Amzn-Trace-Id": "Root=1-680f7259-4e5c927e25a0aa78202e04e1"
+            },
+            "origin": "x.x.x.x",
+            "url": "https://httpbin.org/get?test=value"
+          }
+        }
+      }
+    }
+  ]
+}

tests/vcr_cassettes/tests.unit.test_base_vcr_json/TestBaseVCRJSON.test_httpbin_post.yaml

@@ -0,0 +1,43 @@
+{
+  "version": 1,
+  "interactions": [
+    {
+      "request": {
+        "method": "POST",
+        "uri": "https://httpbin.org/post",
+        "body": "{\"name\": \"atlan\", \"type\": \"integration-test\"}",
+        "headers": {}
+      },
+      "response": {
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "headers": {},
+        "body": {
+          "parsed_json": {
+            "args": {},
+            "data": "{\"name\": \"atlan\", \"type\": \"integration-test\"}",
+            "files": {},
+            "form": {},
+            "headers": {
+              "Accept": "*/*",
+              "Accept-Encoding": "gzip, deflate",
+              "Content-Length": "45",
+              "Content-Type": "application/json",
+              "Host": "httpbin.org",
+              "User-Agent": "python-requests/2.32.3",
+              "X-Amzn-Trace-Id": "Root=1-680f725c-53119e7d4121a80069c14836"
+            },
+            "json": {
+              "name": "atlan",
+              "type": "integration-test"
+            },
+            "origin": "x.x.x.x",
+            "url": "https://httpbin.org/post"
+          }
+        }
+      }
+    }
+  ]
+}

tests/vcr_cassettes/tests.unit.test_base_vcr_json/TestBaseVCRJSON.test_httpbin_put.yaml

@@ -0,0 +1,42 @@
+{
+  "version": 1,
+  "interactions": [
+    {
+      "request": {
+        "method": "PUT",
+        "uri": "https://httpbin.org/put",
+        "body": "{\"update\": \"value\"}",
+        "headers": {}
+      },
+      "response": {
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "headers": {},
+        "body": {
+          "parsed_json": {
+            "args": {},
+            "data": "{\"update\": \"value\"}",
+            "files": {},
+            "form": {},
+            "headers": {
+              "Accept": "*/*",
+              "Accept-Encoding": "gzip, deflate",
+              "Content-Length": "19",
+              "Content-Type": "application/json",
+              "Host": "httpbin.org",
+              "User-Agent": "python-requests/2.32.3",
+              "X-Amzn-Trace-Id": "Root=1-680f7261-631f6aae6a8ae85365354c87"
+            },
+            "json": {
+              "update": "value"
+            },
+            "origin": "x.x.x.x",
+            "url": "https://httpbin.org/put"
+          }
+        }
+      }
+    }
+  ]
+}