# coding: utf-8 # ------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for # license information. # -------------------------------------------------------------------------- import pytest import os from azure.communication.administration import ( PhoneNumberAdministrationClient, PstnConfiguration, NumberUpdateCapabilities, CreateSearchOptions ) from phone_number_helper import PhoneNumberUriReplacer from phone_number_testcase import PhoneNumberCommunicationTestCase from _shared.testcase import BodyReplacerProcessor SKIP_PHONE_NUMBER_TESTS = True PHONE_NUMBER_TEST_SKIP_REASON= "Phone Number Administration live tests infra not ready yet" class PhoneNumberAdministrationClientTest(PhoneNumberCommunicationTestCase): def setUp(self): super(PhoneNumberAdministrationClientTest, self).setUp() self.recording_processors.extend([ BodyReplacerProcessor( keys=["id", "token", "capabilitiesUpdateId", "phoneNumber", "phonePlanIds", "phoneNumberCapabilitiesUpdates", "releaseId", "phoneNumberReleaseStatusDetails", "searchId", "phoneNumbers", "entities", "phonePlanGroups", "phonePlans", "phoneNumberCapabilitiesUpdate"] ), PhoneNumberUriReplacer()]) self._phone_number_administration_client = PhoneNumberAdministrationClient.from_connection_string( self.connection_str) if self.is_live: self.country_code = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_COUNTRY_CODE') self.locale = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_LOCALE') self.phone_plan_group_id = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONE_PLAN_GROUP_ID') self.phone_plan_id = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONE_PLAN_ID') self.phone_plan_id_area_codes = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONE_PLAN_ID_AREA_CODES') self.area_code_for_reservation = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_AREA_CODE_FOR_RESERVATION') self.reservation_id = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_RESERVATION_ID') self.reservation_id_to_purchase = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_RESERVATION_ID_TO_PURCHASE') self.reservation_id_to_cancel = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_RESERVATION_ID_TO_CANCEL') self.phonenumber_to_configure = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONENUMBER_TO_CONFIGURE') self.phonenumber_to_get_config = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONENUMBER_TO_GET_CONFIG') self.phonenumber_to_unconfigure = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONENUMBER_TO_UNCONFIGURE') self.phonenumber_for_capabilities = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONENUMBER_FOR_CAPABILITIES') self.phonenumber_to_release = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_PHONENUMBER_TO_RELEASE') self.capabilities_id = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_CAPABILITIES_ID') self.release_id = os.getenv('AZURE_COMMUNICATION_SERVICE_PHONENUMBERS_RELEASE_ID') self.scrubber.register_name_pair( self.phone_plan_group_id, "phone_plan_group_id" ) self.scrubber.register_name_pair( self.phone_plan_id, "phone_plan_id" ) self.scrubber.register_name_pair( self.phone_plan_id_area_codes, "phone_plan_id_area_codes" ) self.scrubber.register_name_pair( self.area_code_for_reservation, "area_code_for_reservation" ) self.scrubber.register_name_pair( self.reservation_id, "reservation_id" ) self.scrubber.register_name_pair( self.reservation_id_to_purchase, "reservation_id_to_purchase" ) self.scrubber.register_name_pair( self.reservation_id_to_cancel, "reservation_id_to_cancel" ) self.scrubber.register_name_pair( self.phonenumber_to_configure, "phonenumber_to_configure" ) self.scrubber.register_name_pair( self.phonenumber_to_get_config, "phonenumber_to_get_config" ) self.scrubber.register_name_pair( self.phonenumber_to_unconfigure, "phonenumber_to_unconfigure" ) self.scrubber.register_name_pair( self.phonenumber_for_capabilities, "phonenumber_for_capabilities" ) self.scrubber.register_name_pair( self.phonenumber_to_release, "phonenumber_to_release" ) self.scrubber.register_name_pair( self.capabilities_id, "capabilities_id" ) self.scrubber.register_name_pair( self.release_id, "release_id" ) else: self.connection_str = "endpoint=https://sanitized.communication.azure.com/;accesskey=fake===" self.country_code = "US" self.locale = "en-us" self.phone_plan_group_id = "phone_plan_group_id" self.phone_plan_id = "phone_plan_id" self.phone_plan_id_area_codes = "phone_plan_id_area_codes" self.area_code_for_reservation = "area_code_for_reservation" self.reservation_id = "reservation_id" self.reservation_id_to_purchase = "reservation_id_to_purchase" self.reservation_id_to_cancel = "reservation_id_to_cancel" self.phonenumber_to_configure = "phonenumber_to_configure" self.phonenumber_to_get_config = "phonenumber_to_get_config" self.phonenumber_to_unconfigure = "phonenumber_to_unconfigure" self.phonenumber_for_capabilities = "phonenumber_for_capabilities" self.phonenumber_to_release = "phonenumber_to_release" self.capabilities_id = "capabilities_id" self.release_id = "release_id" @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_all_phone_numbers(self): pages = self._phone_number_administration_client.list_all_phone_numbers() assert pages.next() @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_all_area_codes(self): area_codes = self._phone_number_administration_client.get_all_area_codes( location_type="NotRequired", country_code=self.country_code, phone_plan_id=self.phone_plan_id_area_codes ) assert area_codes.primary_area_codes @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_capabilities_update(self): capability_response = self._phone_number_administration_client.get_capabilities_update( capabilities_update_id=self.capabilities_id ) assert capability_response.capabilities_update_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_update_capabilities(self): update = NumberUpdateCapabilities(add=iter(["InboundCalling"])) phone_number_capabilities_update = { self.phonenumber_for_capabilities: update } capability_response = self._phone_number_administration_client.update_capabilities( phone_number_capabilities_update=phone_number_capabilities_update ) assert capability_response.capabilities_update_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_all_supported_countries(self): countries = self._phone_number_administration_client.list_all_supported_countries() assert countries.next().localized_name @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_number_configuration(self): phone_number_response = self._phone_number_administration_client.get_number_configuration( phone_number=self.phonenumber_to_get_config ) assert phone_number_response.pstn_configuration @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_configure_number(self): pstnConfig = PstnConfiguration( callback_url="https://callbackurl", application_id="ApplicationId" ) configure_number_response = self._phone_number_administration_client.configure_number( pstn_configuration=pstnConfig, phone_number=self.phonenumber_to_configure ) assert not configure_number_response @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_phone_plan_groups(self): phone_plan_group_response = self._phone_number_administration_client.list_phone_plan_groups( country_code=self.country_code ) assert phone_plan_group_response.next().phone_plan_group_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_phone_plans(self): phone_plan_response = self._phone_number_administration_client.list_phone_plans( country_code=self.country_code, phone_plan_group_id=self.phone_plan_group_id ) assert phone_plan_response.next().phone_plan_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_phone_plan_location_options(self): location_options_response = self._phone_number_administration_client.get_phone_plan_location_options( country_code=self.country_code, phone_plan_group_id=self.phone_plan_group_id, phone_plan_id=self.phone_plan_id ) assert location_options_response.location_options.label_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_release_by_id(self): phone_number_release_response = self._phone_number_administration_client.get_release_by_id( release_id=self.release_id ) assert phone_number_release_response.release_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_all_releases(self): releases_response = self._phone_number_administration_client.list_all_releases() assert releases_response.next().id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_release_phone_numbers(self): poller = self._phone_number_administration_client.begin_release_phone_numbers( phone_numbers=[self.phonenumber_to_release] ) assert poller.result() @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_get_reservation_by_id(self): phone_number_reservation_response = self._phone_number_administration_client.get_reservation_by_id( reservation_id=self.reservation_id ) assert phone_number_reservation_response.reservation_id @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_reserve_phone_numbers(self): poller = self._phone_number_administration_client.begin_reserve_phone_numbers( area_code=self.area_code_for_reservation, description="testreservation20200014", display_name="testreservation20200014", phone_plan_ids=[self.phone_plan_id], quantity=1 ) assert poller.result() @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_cancel_reservation(self): cancel_reservation_response = self._phone_number_administration_client.cancel_reservation( reservation_id=self.reservation_id_to_cancel ) assert not cancel_reservation_response @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_purchase_reservation(self): poller = self._phone_number_administration_client.begin_purchase_reservation( reservation_id=self.reservation_id_to_purchase ) assert poller.result() @pytest.mark.live_test_only @pytest.mark.skipif(SKIP_PHONE_NUMBER_TESTS, reason=PHONE_NUMBER_TEST_SKIP_REASON) def test_list_reservations(self): pages = self._phone_number_administration_client.list_all_reservations() assert pages.next()