test: Simplify OpenAPIServiceConnector run test (#7043)

* Simplify OpenAPIServiceConnector run test

* Fix linting

haystack/components/connectors/openapi_service.py

@@ -1,6 +1,6 @@
 import json
 import logging
-from typing import List, Dict, Any, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 from haystack import component
 from haystack.dataclasses import ChatMessage, ChatRole
@@ -150,11 +150,12 @@ class OpenAPIServiceConnector:
                     if auth_credentials:
                         openapi_service.authenticate(scheme_name, auth_credentials)
                         authenticated = True
-                    else:
+                        break
-                        raise ValueError(
+
-                            f"Service {service_name} requires {scheme_name} security scheme but no "
+                    raise ValueError(
-                            f"credentials were provided for it. Check the service configuration and credentials."
+                        f"Service {service_name} requires {scheme_name} security scheme but no "
-                        )
+                        f"credentials were provided for it. Check the service configuration and credentials."
+                    )
             if not authenticated:
                 raise ValueError(
                     f"Service {service_name} requires authentication but no credentials were provided "

test/components/connectors/test_openapi_service.py

@@ -1,11 +1,7 @@
 import json
-import os
+from unittest.mock import MagicMock, Mock, patch
-import time
-from unittest.mock import MagicMock, Mock
 
-import flaky
 import pytest
-import requests
 from openapi3 import OpenAPI
 from openapi3.schemas import Model
 
@@ -18,37 +14,6 @@ def openapi_service_mock():
     return MagicMock(spec=OpenAPI)
 
 
-@pytest.fixture
-def random_open_pull_request_head_branch() -> str:
-    token = os.getenv("GITHUB_TOKEN")
-    headers = {"Accept": "application/vnd.github.v3+json", "Authorization": f"token {token}"}
-    response = requests.get("https://api.github.com/repos/deepset-ai/haystack/pulls?state=open", headers=headers)
-
-    if response.status_code == 200:
-        pull_requests = response.json()
-        for pr in pull_requests:
-            if pr["base"]["ref"] == "main":
-                return pr["head"]["ref"]
-    else:
-        raise Exception(f"Failed to fetch pull requests. Status code: {response.status_code}")
-
-
-@pytest.fixture
-def genuine_fc_message(random_open_pull_request_head_branch):
-    basehead = "main..." + random_open_pull_request_head_branch
-    # arguments, see below, are always passed as a string representation of a JSON object
-    params = '{"parameters": {"basehead": "' + basehead + '", "owner": "deepset-ai", "repo": "haystack"}}'
-    payload_json = [
-        {
-            "id": "call_NJr1NBz2Th7iUWJpRIJZoJIA",
-            "function": {"arguments": params, "name": "compare_branches"},
-            "type": "function",
-        }
-    ]
-
-    return json.dumps(payload_json)
-
-
 class TestOpenAPIServiceConnector:
     @pytest.fixture
     def connector(self):
@@ -142,23 +107,38 @@ class TestOpenAPIServiceConnector:
             " to get the raw data from the service response"
         )
 
-    @flaky.flaky(max_runs=5, rerun_filter=lambda *_: time.sleep(5))
+    @patch("haystack.components.connectors.openapi_service.OpenAPI")
-    @pytest.mark.integration
+    def test_run(self, openapi_mock, test_files_path):
-    @pytest.mark.skipif(not os.getenv("GITHUB_TOKEN"), reason="GITHUB_TOKEN is not set")
+        connector = OpenAPIServiceConnector()
-    def test_run(self, genuine_fc_message, test_files_path):
+        spec_path = test_files_path / "json" / "github_compare_branch_openapi_spec.json"
-        openapi_service = OpenAPIServiceConnector()
+        spec = json.loads((spec_path).read_text())
 
-        open_api_spec_path = test_files_path / "json" / "github_compare_branch_openapi_spec.json"
+        mock_message = json.dumps(
-        with open(open_api_spec_path, "r") as file:
+            [
-            github_compare_schema = json.load(file)
+                {
-        messages = [ChatMessage.from_assistant(genuine_fc_message)]
+                    "id": "call_NJr1NBz2Th7iUWJpRIJZoJIA",
+                    "function": {
+                        "arguments": '{"parameters": {"basehead": "main...some_branch", "owner": "deepset-ai", "repo": "haystack"}}',
+                        "name": "compare_branches",
+                    },
+                    "type": "function",
+                }
+            ]
+        )
+        messages = [ChatMessage.from_assistant(mock_message)]
 
-        # genuine call to the GitHub OpenAPI service
+        mock_service = Mock(
-        result = openapi_service.run(messages, github_compare_schema, os.getenv("GITHUB_TOKEN"))
+            call_compare_branches=Mock(return_value=Mock(_raw_data="some_data")),
-        assert result
+            components=Mock(securitySchemes=Mock(raw_element={"apikey": {"type": "apiKey"}})),
+        )
+        openapi_mock.return_value = mock_service
 
-        # load json from the service response
+        result = connector.run(messages=messages, service_openapi_spec=spec, service_credentials="fake_key")
-        service_payload = json.loads(result["service_response"][0].content)
 
-        # verify that the service response contains the expected fields
+        openapi_mock.assert_called_once_with(spec)
-        assert "url" in service_payload and "files" in service_payload
+        mock_service.authenticate.assert_called_once_with("apikey", "fake_key")
+        mock_service.call_compare_branches.assert_called_once_with(
+            parameters={"basehead": "main...some_branch", "owner": "deepset-ai", "repo": "haystack"}
+        )
+
+        assert result == {"service_response": [ChatMessage.from_user('"some_data"')]}