DEVEXP-729: E2E Tests - Available Numbers (#45)

Author: asein-sinch

.github/scripts/wait-for-mockserver.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+wait_for_server() {
+  local url=$1
+  echo "Waiting for $url to be ready..."
+
+  MAX_RETRIES="${MAX_RETRIES:-30}"
+  SLEEP_SECONDS="${SLEEP_SECONDS:-2}"
+
+  for ((i = 1; i <= MAX_RETRIES; i++)); do
+    if curl -sSf "$url" > /dev/null; then
+      echo "$url is ready!"
+      return 0
+    fi
+    echo "Attempt $i/$MAX_RETRIES: Still waiting for $url..."
+    sleep "$SLEEP_SECONDS"
+  done
+
+  echo "Error: $url was not available after $((MAX_RETRIES * SLEEP_SECONDS)) seconds"
+  exit 1
+}
+
+# Wait for auth mock servers
+wait_for_server "http://localhost:3011/health"
+# Wait for numbers mock servers
+wait_for_server "http://localhost:3013/health"
+
+echo "All mock servers are ready!"

.github/workflows/run-tests.yml

@@ -45,3 +45,33 @@ jobs:
     - name: Coverage Test Report
       run: |
         python -m coverage report --skip-empty
+
+    - name: Checkout sinch-sdk-mockserver repository
+      uses: actions/checkout@v3
+      with:
+        repository: sinch/sinch-sdk-mockserver
+        token: ${{ secrets.PAT_CI }}
+        fetch-depth: 0
+        path: sinch-sdk-mockserver
+
+    - name: Install Docker Compose
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y docker-compose
+
+    - name: Start mock servers with Docker Compose
+      run: |
+        cd sinch-sdk-mockserver
+        docker-compose up -d
+
+    - name: Copy feature files
+      run: |
+        cp sinch-sdk-mockserver/features/numbers/numbers.feature ./tests/e2e/numbers/features/
+
+    - name: Wait for mock server
+      run: .github/scripts/wait-for-mockserver.sh
+      shell: bash
+
+    - name: Run e2e tests
+      run: behave tests/e2e/**/features
+      

.gitignore

@@ -52,6 +52,9 @@ coverage.xml
 .pytest_cache/
 cover/
 
+# E2E features
+*.feature
+
 # Translations
 *.mo
 *.pot

requirements-dev.txt

@@ -3,6 +3,7 @@ pytest
 pytest-asyncio
 pytest-mock
 coverage
+behave
 
 # Code Quality
 flake8

sinch/core/clients/sinch_client_configuration.py

@@ -20,7 +20,6 @@ def __init__(
         token_manager: Union[TokenManager, TokenManagerAsync],
         logger: Logger = None,
         logger_name: str = None,
-        disable_https=False,
         connection_timeout=10,
         application_key: str = None,
         application_secret: str = None,
@@ -51,7 +50,6 @@ def __init__(
         self._templates_region = "eu"
         self._templates_domain = ".template.api.sinch.com"
         self.token_manager = token_manager
-        self.disable_https = disable_https
         self.transport: HTTPTransport = transport
 
         self._set_conversation_origin()

sinch/core/endpoint.py

@@ -4,19 +4,34 @@
 
 class HTTPEndpoint(ABC):
     ENDPOINT_URL = None
-    HTTP_METHOD = None
-    HTTP_AUTHENTICATION = None
 
-    def __init__(self, project_id, request_data):
+    @property
+    @abstractmethod
+    def HTTP_METHOD(self) -> str:
+        pass
+
+    @property
+    @abstractmethod
+    def HTTP_AUTHENTICATION(self) -> str:
         pass
 
+    def __init__(self, project_id, request_data):
+        self.project_id = project_id
+        self.request_data = request_data
+
     def get_url_without_origin(self, sinch):
         return '/' + '/'.join(self.build_url(sinch).split('/')[1:])
 
     def build_url(self, sinch):
         return
 
     def build_query_params(self):
+        """
+        Constructs the query parameters for the endpoint.
+
+        Returns:
+            dict: The query parameters to be sent with the API request.
+        """
         pass
 
     def request_body(self):

sinch/core/models/http_request.py

@@ -4,7 +4,6 @@
 @dataclass
 class HttpRequest:
     headers: dict
-    protocol: str
     url: str
     http_method: str
     request_body: dict

sinch/core/ports/http_transport.py

@@ -81,16 +81,14 @@ def authenticate(self, endpoint, request_data):
         return request_data
 
     def prepare_request(self, endpoint: HTTPEndpoint) -> HttpRequest:
-        protocol = "http://" if self.sinch.configuration.disable_https else "https://"
         url_query_params = endpoint.build_query_params()
 
         return HttpRequest(
             headers={
                 "User-Agent": f"sinch-sdk/{sdk_version} (Python/{python_version()};"
                               f" {self.__class__.__name__};)"
             },
-            protocol=protocol,
-            url=protocol + endpoint.build_url(self.sinch),
+            url=endpoint.build_url(self.sinch),
             http_method=endpoint.HTTP_METHOD,
             request_body=endpoint.request_body(),
             query_params=url_query_params,

sinch/domains/numbers/available_numbers.py

@@ -1,20 +1,20 @@
 from typing import Optional, TypedDict, overload, Literal, Union, Annotated
 from typing_extensions import NotRequired
 from pydantic import StrictInt, StrictStr, Field
-from sinch.domains.numbers.endpoints.available.search_for_number import SearchForNumberEndpoint
-from sinch.domains.numbers.endpoints.available.list_available_numbers import AvailableNumbersEndpoint
-from sinch.domains.numbers.endpoints.available.activate_number import ActivateNumberEndpoint
-from sinch.domains.numbers.endpoints.available.rent_any_number import RentAnyNumberEndpoint
+from sinch.domains.numbers.endpoints.available.search_for_number_endpoint import SearchForNumberEndpoint
+from sinch.domains.numbers.endpoints.available.list_available_numbers_endpoint import AvailableNumbersEndpoint
+from sinch.domains.numbers.endpoints.available.activate_number_endpoint import ActivateNumberEndpoint
+from sinch.domains.numbers.endpoints.available.rent_any_number_endpoint import RentAnyNumberEndpoint
 
 from sinch.domains.numbers.models.available.list_available_numbers_request import ListAvailableNumbersRequest
 from sinch.domains.numbers.models.available.activate_number_request import ActivateNumberRequest
 from sinch.domains.numbers.models.available.check_number_availability_request import CheckNumberAvailabilityRequest
 from sinch.domains.numbers.models.available.rent_any_number_request import RentAnyNumberRequest
 
-from sinch.domains.numbers.models.available.list_available_numbers_response import ListAvailableNumbersResponse
 from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 from sinch.domains.numbers.models.available.check_number_availability_response import CheckNumberAvailabilityResponse
 from sinch.domains.numbers.models.available.rent_any_number_response import RentAnyNumberResponse
+from sinch.domains.numbers.models.numbers import Number
 
 from sinch.domains.numbers.models.numbers import NumberTypeValues, CapabilityTypeValues, NumberSearchPatternTypeValues
 
@@ -86,7 +86,7 @@ def list(
         capabilities: Optional[CapabilityTypeValues] = None,
         page_size: Optional[StrictInt] = None,
         **kwargs
-    ) -> ListAvailableNumbersResponse:
+    ) -> list[Number]:
         """
         Search for available virtual numbers for you to activate using a variety of parameters to filter results.
 
@@ -101,7 +101,7 @@ def list(
             **kwargs: Additional filters for the request.
 
         Returns:
-            ListAvailableNumbersResponse: A response object with available numbers and their details.
+            list[Number]: A response array with available numbers and their details.
 
         For detailed documentation, visit https://developers.sinch.com
         """
@@ -121,8 +121,8 @@ def list(
     def activate(
             self,
             phone_number: StrictStr,
-            sms_configuration: None,
-            voice_configuration: None,
+            sms_configuration: Optional[SmsConfigurationDict] = None,
+            voice_configuration: Optional[VoiceConfigurationDictType] = None,
             callback_url: Optional[StrictStr] = None
     ) -> ActivateNumberResponse:
         pass

sinch/domains/numbers/endpoints/available/activate_number.py sinch/domains/numbers/endpoints/available/activate_number_endpoint.py

@@ -1,6 +1,7 @@
 from sinch.core.enums import HTTPAuthentication, HTTPMethods
 from sinch.core.models.http_response import HTTPResponse
 from sinch.domains.numbers.endpoints.numbers_endpoint import NumbersEndpoint
+from sinch.domains.numbers.exceptions import NumberNotFoundException, NumbersException
 from sinch.domains.numbers.models.available.activate_number_request import ActivateNumberRequest
 from sinch.domains.numbers.models.available.activate_number_response import ActivateNumberResponse
 
@@ -17,5 +18,9 @@ def __init__(self, project_id: str, request_data: ActivateNumberRequest):
         super(ActivateNumberEndpoint, self).__init__(project_id, request_data)
 
     def handle_response(self, response: HTTPResponse) -> ActivateNumberResponse:
-        super(ActivateNumberEndpoint, self).handle_response(response)
+        try:
+            super(ActivateNumberEndpoint, self).handle_response(response)
+        except NumbersException as ex:
+            raise NumberNotFoundException(message=ex.args[0], response=ex.http_response,
+                                          is_from_server=ex.is_from_server)
         return self.process_response_model(response.body, ActivateNumberResponse)

sinch/domains/numbers/endpoints/available/list_available_numbers.py sinch/domains/numbers/endpoints/available/list_available_numbers_endpoint.py

@@ -3,6 +3,7 @@
 from sinch.domains.numbers.endpoints.numbers_endpoint import NumbersEndpoint
 from sinch.domains.numbers.models.available.list_available_numbers_request import ListAvailableNumbersRequest
 from sinch.domains.numbers.models.available.list_available_numbers_response import ListAvailableNumbersResponse
+from sinch.domains.numbers.models.numbers import Number
 
 
 class AvailableNumbersEndpoint(NumbersEndpoint):
@@ -15,30 +16,26 @@ class AvailableNumbersEndpoint(NumbersEndpoint):
 
     def __init__(self, project_id: str, request_data: ListAvailableNumbersRequest):
         super(AvailableNumbersEndpoint, self).__init__(project_id, request_data)
+        self.request_data = request_data
 
     def build_query_params(self) -> dict:
-        """
-        Constructs the query parameters for the endpoint.
-
-        Returns:
-            dict: The query parameters to be sent with the API request.
-        """
         # Serialize fields
         query_params = self.request_data.model_dump(exclude_none=True, by_alias=True)
         return query_params
 
     def request_body(self):
         pass
 
-    def handle_response(self, response: HTTPResponse) -> ListAvailableNumbersResponse:
+    def handle_response(self, response: HTTPResponse) -> list[Number]:
         """
         Processes the API response and maps it to a response model.
 
         Args:
             response (HTTPResponse): The raw HTTP response object received from the API.
 
         Returns:
-            ListAvailableNumbersResponse: The response model containing the parsed response data.
+            list[Number]: The response model containing the parsed response data.
         """
         super(AvailableNumbersEndpoint, self).handle_response(response)
-        return self.process_response_model(response.body, ListAvailableNumbersResponse)
+        response = self.process_response_model(response.body, ListAvailableNumbersResponse)
+        return response.available_numbers

sinch/domains/numbers/endpoints/available/rent_any_number.py sinch/domains/numbers/endpoints/available/rent_any_number_endpoint.py

@@ -15,6 +15,7 @@ class RentAnyNumberEndpoint(NumbersEndpoint):
 
     def __init__(self, project_id: str, request_data: RentAnyNumberRequest):
         super(RentAnyNumberEndpoint, self).__init__(project_id, request_data)
+        self.request_data = request_data
 
     def handle_response(self, response: HTTPResponse) -> RentAnyNumberResponse:
         """
@@ -26,5 +27,7 @@ def handle_response(self, response: HTTPResponse) -> RentAnyNumberResponse:
         Returns:
             RentAnyNumberResponse: The response data mapped to the RentAnyNumberResponse model.
         """
-        super(RentAnyNumberEndpoint, self).handle_response(response)
+        error = super(RentAnyNumberEndpoint, self).handle_response(response)
+        if error:
+            return error
         return self.process_response_model(response.body, RentAnyNumberResponse)

sinch/domains/numbers/endpoints/available/search_for_number.py sinch/domains/numbers/endpoints/available/search_for_number_endpoint.py

@@ -1,6 +1,7 @@
 from sinch.core.models.http_response import HTTPResponse
 from sinch.domains.numbers.endpoints.numbers_endpoint import NumbersEndpoint
 from sinch.core.enums import HTTPAuthentication, HTTPMethods
+from sinch.domains.numbers.exceptions import NumberNotFoundException, NumbersException
 from sinch.domains.numbers.models.available.check_number_availability_response import CheckNumberAvailabilityResponse
 from sinch.domains.numbers.models.available.check_number_availability_request import CheckNumberAvailabilityRequest
 
@@ -30,5 +31,8 @@ def handle_response(self, response: HTTPResponse) -> CheckNumberAvailabilityResp
             CheckNumberAvailabilityResponse: The response model containing the parsed response data
             of the requested phone number.
         """
-        super(SearchForNumberEndpoint, self).handle_response(response)
+        try:
+            super(SearchForNumberEndpoint, self).handle_response(response)
+        except NumbersException as e:
+            raise NumberNotFoundException(message=e.args[0], response=e.http_response, is_from_server=e.is_from_server)
         return self.process_response_model(response.body, CheckNumberAvailabilityResponse)

sinch/domains/numbers/endpoints/numbers_endpoint.py

@@ -1,33 +1,19 @@
 import json
+from abc import ABC
 from pydantic import BaseModel
+from typing import TypeVar, Type
 from sinch.core.models.http_response import HTTPResponse
 from sinch.core.endpoint import HTTPEndpoint
 from sinch.domains.numbers.exceptions import NumbersException
+from sinch.domains.numbers.models.numbers import NotFoundError
 
 
-class NumbersEndpoint(HTTPEndpoint):
-    """
-        A base class for all endpoints, providing reusable logic for URL building
-        and response parsing.
-        """
-    ENDPOINT_URL: str = ""
-    HTTP_METHOD: str = ""
-    HTTP_AUTHENTICATION: str = ""
+class NumbersEndpoint(HTTPEndpoint, ABC):
 
     def __init__(self, project_id: str, request_data: object):
-        self.project_id = project_id
-        self.request_data = request_data
+        super().__init__(project_id, request_data)
 
     def build_url(self, sinch) -> str:
-        """
-        Constructs the URL for the endpoint.
-
-        Args:
-            sinch: The Sinch client instance.
-
-        Returns:
-            str: Fully constructed endpoint URL.
-        """
         if not self.ENDPOINT_URL:
             raise NotImplementedError("ENDPOINT_URL must be defined in the subclass.")
 
@@ -48,7 +34,9 @@ def request_body(self):
         request_data = self.request_data.model_dump(by_alias=True, exclude_none=True)
         return json.dumps(request_data)
 
-    def process_response_model(self, response_body: dict, response_model: type[BaseModel]) -> BaseModel:
+    BM = TypeVar("BM", bound=BaseModel)
+
+    def process_response_model(self, response_body: dict, response_model: Type[BM]) -> BM:
         """
         Processes the response body and maps it to a response model.
 
@@ -65,6 +53,10 @@ def process_response_model(self, response_body: dict, response_model: type[BaseM
             raise ValueError(f"Invalid response structure: {e}") from e
 
     def handle_response(self, response: HTTPResponse):
+        if response.status_code == 404:
+            error = NotFoundError(**response.body['error'])
+            raise NumbersException(message=error, response=response, is_from_server=True)
+
         if response.status_code >= 400:
             raise NumbersException(
                 message=f"{response.body['error'].get('message')}  {response.body['error'].get('status')}",

sinch/domains/numbers/exceptions.py

@@ -3,3 +3,7 @@
 
 class NumbersException(SinchException):
     pass
+
+
+class NumberNotFoundException(NumbersException):
+    pass