add tests for deprecation warnings

Author: twishabansal

packages/toolbox-core/tests/test_client.py

@@ -1443,23 +1443,41 @@ async def test_add_headers_success(
         )
 
         async with ToolboxClient(TEST_BASE_URL) as client:
-            client.add_headers(static_header)
+            with pytest.warns(
+                DeprecationWarning,
+                match="Use the `client_headers` parameter in the ToolboxClient constructor instead.",
+            ):
+                client.add_headers(static_header)
             assert client._ToolboxClient__client_headers == static_header
 
             tool = await client.load_tool(tool_name)
             result = await tool(param1="test")
             assert result == expected_payload["result"]
 
+    @pytest.mark.asyncio
+    async def test_add_headers_deprecation_warning(self):
+        """Tests that add_headers issues a DeprecationWarning."""
+        async with ToolboxClient(TEST_BASE_URL) as client:
+            with pytest.warns(
+                DeprecationWarning,
+                match="Use the `client_headers` parameter in the ToolboxClient constructor instead.",
+            ):
+                client.add_headers({"X-Deprecated-Test": "value"})
+
     @pytest.mark.asyncio
     async def test_add_headers_duplicate_fail(self, static_header):
         """Tests that adding a duplicate header via add_headers raises
         ValueError."""
         async with ToolboxClient(TEST_BASE_URL, client_headers=static_header) as client:
-            with pytest.raises(
-                ValueError,
-                match=f"Client header\\(s\\) `X-Static-Header` already registered",
+            with pytest.warns(
+                DeprecationWarning,
+                match="Use the `client_headers` parameter in the ToolboxClient constructor instead.",
             ):
-                await client.add_headers(static_header)
+                with pytest.raises(
+                    ValueError,
+                    match=f"Client header\\(s\\) `X-Static-Header` already registered",
+                ):
+                    client.add_headers(static_header)
 
     @pytest.mark.asyncio
     async def test_client_header_auth_token_conflict_fail(

packages/toolbox-core/tests/test_sync_client.py

@@ -383,7 +383,11 @@ def post_callback(url, **kwargs):
             f"{TEST_BASE_URL}/api/tool/{tool_name}/invoke", callback=post_callback
         )
 
-        sync_client.add_headers(headers_to_add)
+        with pytest.warns(
+            DeprecationWarning,
+            match="Use the `client_headers` parameter in the ToolboxClient constructor instead.",
+        ):
+            sync_client.add_headers(headers_to_add)
         tool = sync_client.load_tool(tool_name)
         result = tool(param1="test")
         assert result == expected_payload["result"]
@@ -409,11 +413,15 @@ def mock_add_headers(headers):
             with ToolboxSyncClient(
                 TEST_BASE_URL, client_headers=initial_headers
             ) as client:
-                with pytest.raises(
-                    ValueError,
-                    match="Client header\\(s\\) `X-Initial-Header` already registered",
+                with pytest.warns(
+                    DeprecationWarning,
+                    match="Use the `client_headers` parameter in the ToolboxClient constructor instead.",
                 ):
-                    client.add_headers({"X-Initial-Header": "another_value"})
+                    with pytest.raises(
+                        ValueError,
+                        match="Client header\\(s\\) `X-Initial-Header` already registered",
+                    ):
+                        client.add_headers({"X-Initial-Header": "another_value"})
 
 
 class TestSyncAuth: