[Communication] - SDK - Adding feature to make samples run in the pipeline (Azure#18234)

jbeauregardb · web-flow · commit 19da7a4f4ecd · 2021-04-29T12:50:39.000-05:00
* Adding feature to make samples run in the pipeline

* Refactored samples

* Refactored sms samples

* Ignoring chat samples

* Addressed comments

* README correction

* Readding new lines
diff --git a/scripts/devops_tasks/test_run_samples.py b/scripts/devops_tasks/test_run_samples.py
@@ -100,6 +100,18 @@
         "mgmt_topic_async.py",
         "proxy_async.py",
         "receive_deferred_message_queue_async.py"
+    ],
+    "azure-communication-chat": [
+        "chat_client_sample_async.py",
+        "chat_client_sample.py",
+        "chat_thread_client_sample_async.py",
+        "chat_thread_client_sample.py"
+    ],
+    "azure-communication-phonenumbers": [
+        "purchase_phone_number_sample_async.py",
+        "purchase_phone_number_sample.py",
+        "release_phone_number_sample_async.py",
+        "release_phone_number_sample.py"
     ]
 }
 
diff --git a/sdk/communication/azure-communication-identity/samples/identity_samples.py b/sdk/communication/azure-communication-identity/samples/identity_samples.py
@@ -14,19 +14,18 @@
 USAGE:
     python identity_samples.py
     Set the environment variables with your own values before running the sample:
-    1) AZURE_COMMUNICATION_SERVICE_ENDPOINT - Communication Service endpoint url
     2) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - the connection string in your ACS account
     3) AZURE_CLIENT_ID - the client ID of your active directory application
     4) AZURE_CLIENT_SECRET - the secret of your active directory application
     5) AZURE_TENANT_ID - the tenant ID of your active directory application
 """
 import os
+from azure.communication.identity._shared.utils import parse_connection_str
 
 class CommunicationIdentityClientSamples(object):
 
     def __init__(self):
         self.connection_string = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
-        self.endpoint = os.getenv('AZURE_COMMUNICATION_SERVICE_ENDPOINT')
         self.client_id = os.getenv('AZURE_CLIENT_ID')
         self.client_secret = os.getenv('AZURE_CLIENT_SECRET')
         self.tenant_id = os.getenv('AZURE_TENANT_ID')
@@ -39,7 +38,8 @@ def get_token(self):
 
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         user = identity_client.create_user()
@@ -55,7 +55,8 @@ def revoke_tokens(self):
 
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         user = identity_client.create_user()
@@ -69,7 +70,8 @@ def create_user(self):
 
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         print("Creating new user")
@@ -83,7 +85,8 @@ def create_user_and_token(self):
         )
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         print("Creating new user with token")
@@ -96,7 +99,8 @@ def delete_user(self):
 
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
         user = identity_client.create_user()
diff --git a/sdk/communication/azure-communication-identity/samples/identity_samples_async.py b/sdk/communication/azure-communication-identity/samples/identity_samples_async.py
@@ -20,7 +20,7 @@
     4) AZURE_CLIENT_SECRET - the secret of your active directory application
     5) AZURE_TENANT_ID - the tenant ID of your active directory application
 """
-
+from azure.communication.identity._shared.utils import parse_connection_str
 import asyncio
 import os
 
@@ -39,7 +39,8 @@ async def get_token(self):
         from azure.communication.identity import CommunicationTokenScope
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
 
@@ -54,7 +55,8 @@ async def revoke_tokens(self):
         from azure.communication.identity import CommunicationTokenScope
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
 
@@ -69,7 +71,8 @@ async def create_user(self):
         from azure.communication.identity.aio import CommunicationIdentityClient
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
 
@@ -83,7 +86,8 @@ async def create_user_and_token(self):
         from azure.communication.identity import CommunicationTokenScope
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
 
@@ -97,7 +101,8 @@ async def delete_user(self):
         from azure.communication.identity.aio import CommunicationIdentityClient
         if self.client_id is not None and self.client_secret is not None and self.tenant_id is not None:
             from azure.identity import DefaultAzureCredential
-            identity_client = CommunicationIdentityClient(self.endpoint, DefaultAzureCredential())
+            endpoint, _ = parse_connection_str(self.connection_string)
+            identity_client = CommunicationIdentityClient(endpoint, DefaultAzureCredential())
         else:
             identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)
 
diff --git a/sdk/communication/azure-communication-phonenumbers/README.md b/sdk/communication/azure-communication-phonenumbers/README.md
@@ -102,7 +102,7 @@ search_result = poller.result()
 
 ### Purchase Phone Numbers
 
-The result of your search can be used to purchase the specificied phone numbers. This can be done by passing the `search_id` from the search response to the purchase phone number API.
+The result of your search can be used to purchase the specified phone numbers. This can be done by passing the `search_id` from the search response to the purchase phone number API.
 
 ```python
 purchase_poller = phone_numbers_client.begin_purchase_phone_numbers(
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/get_purchased_phone_number_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/get_purchased_phone_number_sample_async.py
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/list_purchased_phone_numbers_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/list_purchased_phone_numbers_sample_async.py
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/managed_identity_authentication_sample.py b/sdk/communication/azure-communication-phonenumbers/samples/managed_identity_authentication_sample.py
@@ -13,17 +13,19 @@
 USAGE:
     python managed_identity_authentication_sample.py
     Set the environment variables with your own values before running the sample:
-    1) AZURE_COMMUNICATION_SERVICE_ENDPOINT - The endpoint of your Azure Communication Service
+    1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - The connection string of your Azure Communication Service resource
     2) AZURE_CLIENT_ID - The id of your registered Azure Active Directory application
     3) AZURE_CLIENT_SECRET - A client secret created for your registered AAD aplication
     4) AZURE_TENANT_ID - The tenant in which this application can be found
 """
 
 import os
 from azure.communication.phonenumbers import PhoneNumbersClient
+from azure.communication.phonenumbers._shared.utils import parse_connection_str
 from azure.identity import DefaultAzureCredential
 
-endpoint = os.getenv('AZURE_COMMUNICATION_SERVICE_ENDPOINT')
+connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
+endpoint, _ = parse_connection_str(connection_str)
 phone_numbers_client = PhoneNumbersClient(endpoint, DefaultAzureCredential())
 
 def list_purchased_phone_numbers_using_managed_identity():
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/purchase_phone_number_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/purchase_phone_number_sample_async.py
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/release_phone_number_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/release_phone_number_sample_async.py
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/search_available_phone_numbers_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/search_available_phone_numbers_sample_async.py
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/update_phone_number_capabilities_sample.py b/sdk/communication/azure-communication-phonenumbers/samples/update_phone_number_capabilities_sample.py
@@ -15,7 +15,7 @@
     Set the environment variables with your own values before running the sample:
     1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - The connection string including your endpoint and 
         access key of your Azure Communication Service
-    2) AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER_TO_UPDATE - The phone number you want to update
+    2) AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER - The phone number you want to update
 """
 
 import os
@@ -26,7 +26,7 @@
 
 connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
 phone_number_to_update = os.getenv(
-    "AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER_TO_UPDATE" # e.g. "+15551234567"
+    "AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER" # e.g. "+15551234567"
 ) 
 phone_numbers_client = PhoneNumbersClient.from_connection_string(connection_str)
 
diff --git a/sdk/communication/azure-communication-phonenumbers/samples/update_phone_number_capabilities_sample_async.py b/sdk/communication/azure-communication-phonenumbers/samples/update_phone_number_capabilities_sample_async.py
@@ -15,7 +15,7 @@
     Set the environment variables with your own values before running the sample:
     1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - The connection string including your endpoint and 
         access key of your Azure Communication Service
-    2) AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER_TO_UPDATE - The phone number you want to update
+    2) AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER - The phone number you want to update
 """
 
 import asyncio
@@ -25,16 +25,16 @@
 
 connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
 phone_number_to_update = os.getenv(
-    "AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER_TO_UPDATE" # e.g. "+15551234567"
+    "AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER" # e.g. "+15551234567"
 ) 
 phone_numbers_client = PhoneNumbersClient.from_connection_string(connection_str)
 
 async def update_phone_number_capabilities():
     async with phone_numbers_client:
         poller = await phone_numbers_client.begin_update_phone_number_capabilities(
             phone_number_to_update,
-            PhoneNumberCapabilityType.OUTBOUND,
             PhoneNumberCapabilityType.INBOUND_OUTBOUND,
+            PhoneNumberCapabilityType.INBOUND,
             polling = True
         )
         await poller.result()
diff --git a/sdk/communication/azure-communication-sms/samples/send_sms_to_multiple_recipients_sample.py b/sdk/communication/azure-communication-sms/samples/send_sms_to_multiple_recipients_sample.py
@@ -26,14 +26,15 @@
 class SmsMultipleRecipientsSample(object):
 
     connection_string = os.getenv("AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING")
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
         
     def send_sms_to_multiple_recipients(self):
         sms_client = SmsClient.from_connection_string(self.connection_string)
 
         # calling send() with sms values
         sms_responses = sms_client.send(
-            from_="<leased-phone-number>",
-            to=["<to-phone-number-1>", "<to-phone-number-2>", "<to-phone-number-3>"],
+            from_=self.phone_number,
+            to=[self.phone_number, self.phone_number],
             message="Hello World via SMS",
             enable_delivery_report=True, # optional property
             tag="custom-tag") # optional property
diff --git a/sdk/communication/azure-communication-sms/samples/send_sms_to_multiple_recipients_sample_async.py b/sdk/communication/azure-communication-sms/samples/send_sms_to_multiple_recipients_sample_async.py
@@ -27,6 +27,7 @@
 class SmsMultipleRecipientsSampleAsync(object):
 
     connection_string = os.getenv("AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING")
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
         
     async def send_sms_to_multiple_recipients_async(self):
         sms_client = SmsClient.from_connection_string(self.connection_string)
@@ -35,8 +36,8 @@ async def send_sms_to_multiple_recipients_async(self):
             try:
                 # calling send() with sms values 
                 sms_responses = await sms_client.send(
-                    from_="<leased-phone-number>",
-                    to=["<to-phone-number-1>", "<to-phone-number-2>", "<to-phone-number-3>"],
+                    from_=self.phone_number,
+                    to=[self.phone_number,self.phone_number],
                     message="Hello World via SMS",
                     enable_delivery_report=True, # optional property
                     tag="custom-tag") # optional property
diff --git a/sdk/communication/azure-communication-sms/samples/send_sms_to_single_recipient_sample.py b/sdk/communication/azure-communication-sms/samples/send_sms_to_single_recipient_sample.py
@@ -26,14 +26,15 @@
 class SmsSingleRecipientSample(object):
 
     connection_string = os.getenv("AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING")
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
     
     def send_sms_to_single_recipient(self):
         sms_client = SmsClient.from_connection_string(self.connection_string)
 
         # calling send() with sms values
         sms_responses = sms_client.send(
-            from_="<leased-phone-number>",
-            to="<to-phone-number>",
+            from_=self.phone_number,
+            to=self.phone_number,
             message="Hello World via SMS",
             enable_delivery_report=True, # optional property
             tag="custom-tag") # optional property
diff --git a/sdk/communication/azure-communication-sms/samples/send_sms_to_single_recipient_sample_async.py b/sdk/communication/azure-communication-sms/samples/send_sms_to_single_recipient_sample_async.py
@@ -27,6 +27,7 @@
 class SmsSingleRecipientSampleAsync(object):
 
     connection_string = os.getenv("AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING")
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
     
     async def send_sms_to_single_recipient_async(self):
         sms_client = SmsClient.from_connection_string(self.connection_string)
@@ -35,8 +36,8 @@ async def send_sms_to_single_recipient_async(self):
             try:
                 # calling send() with sms values 
                 sms_responses = await sms_client.send(
-                    from_="<leased-phone-number>",
-                    to="<to-phone-number>",
+                    from_=self.phone_number,
+                    to=self.phone_number,
                     message="Hello World via SMS",
                     enable_delivery_report=True, # optional property
                     tag="custom-tag") # optional property
diff --git a/sdk/communication/azure-communication-sms/samples/sms_token_credential_auth_sample.py b/sdk/communication/azure-communication-sms/samples/sms_token_credential_auth_sample.py
@@ -14,29 +14,32 @@
 USAGE:
     python sms_token_credential_auth_sample.py
     Set the environment variable with your own value before running the sample:
-    1) AZURE_COMMUNICATION_SERVICE_ENDPOINT - the endpoint in your ACS account
+    1) AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING - the connection string in your ACS account
 """
 
 import os
 import sys
 from azure.communication.sms import SmsClient
+from azure.communication.sms._shared.utils import parse_connection_str
 from azure.identity import DefaultAzureCredential
 
 sys.path.append("..")
 
 class SmsTokenCredentialAuthSample(object):
 
-    endpoint = os.getenv('AZURE_COMMUNICATION_SERVICE_ENDPOINT')
+    connection_str = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
     
     def sms_token_credential_auth(self):
         # To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have
         # AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables.
-        sms_client = SmsClient(self.endpoint, DefaultAzureCredential())
+        endpoint, _ = parse_connection_str(self.connection_str)
+        sms_client = SmsClient(endpoint, DefaultAzureCredential())
 
         # calling send() with sms values
         sms_responses = sms_client.send(
-            from_="<leased-phone-number>",
-            to=["<to-phone-number>"],
+            from_=self.phone_number,
+            to=self.phone_number,
             message="Hello World via SMS")
         sms_response = sms_responses[0]
         
diff --git a/sdk/communication/azure-communication-sms/samples/sms_token_credential_auth_sample_async.py b/sdk/communication/azure-communication-sms/samples/sms_token_credential_auth_sample_async.py
@@ -21,25 +21,28 @@
 import sys
 import asyncio
 from azure.communication.sms.aio import SmsClient
+from azure.communication.sms._shared.utils import parse_connection_str
 from azure.identity import DefaultAzureCredential
 
 sys.path.append("..")
 
 class SmsTokenCredentialAuthSampleAsync(object):
 
-    endpoint = os.getenv('AZURE_COMMUNICATION_SERVICE_ENDPOINT')
+    connection_string = os.getenv('AZURE_COMMUNICATION_SERVICE_CONNECTION_STRING')
+    phone_number = os.getenv("AZURE_COMMUNICATION_SERVICE_PHONE_NUMBER")
     
     async def sms_token_credential_auth_async(self):
         # To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have
         # AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables.
-        sms_client = SmsClient(self.endpoint, DefaultAzureCredential())
+        endpoint, _ = parse_connection_str(self.connection_string)
+        sms_client = SmsClient(endpoint, DefaultAzureCredential())
 
         async with sms_client:
             try:
                 # calling send() with sms values
                 sms_responses = await sms_client.send(
-                    from_="<leased-phone-number>",
-                    to=["<to-phone-number>"],
+                    from_=self.phone_number,
+                    to=self.phone_number,
                     message="Hello World via SMS")
                 sms_response = sms_responses[0]
                 
diff --git a/sdk/communication/tests.yml b/sdk/communication/tests.yml
@@ -22,6 +22,7 @@ stages:
         JobName: ${{ package }}
         ServiceDirectory: communication
         DeployArmTemplate: true
+        TestSamples: true
         EnvVars:
           AZURE_TEST_RUN_LIVE: 'true'
           AZURE_TENANT_ID: $(aad-azure-sdk-test-tenant-id)
