Merge pull request #14 from Bandwidth/DX-1793

DX-1793 added api integration tests

Author: jmulford-bw

.github/actions/validate/Dockerfile

@@ -3,7 +3,6 @@ FROM python:3
 
 # Copies your code file from your action repository to the filesystem path `/` of the container
 COPY entrypoint.sh /entrypoint.sh
-COPY bxml_tests.py /bxml_tests.py
 
 #Make entrypoint.sh exacutable
 RUN chmod +x /entrypoint.sh

.github/actions/validate/entrypoint.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
 
-pip install -e .
-cp /bxml_tests.py .
-python bxml_tests.py
+pip install -r requirements.txt
+python -m unittest tests.integration.bxml_tests
+python -m unittest tests.integration.api_tests

.github/workflows/validate.yaml

@@ -14,3 +14,15 @@ jobs:
       uses: actions/checkout@v2
     - name: Validate
       uses: ./.github/actions/validate
+      env:
+        USERNAME: ${{ secrets.USERNAME }}
+        PASSWORD: ${{ secrets.PASSWORD }}
+        ACCOUNT_ID: ${{ secrets.ACCOUNT_ID }}
+        VOICE_APPLICATION_ID: ${{ secrets.VOICE_APPLICATION_ID }}
+        MESSAGING_APPLICATION_ID: ${{ secrets.MESSAGING_APPLICATION_ID }}
+        CALLBACK_URL: ${{ secrets.CALLBACK_URL }}
+        PHONE_NUMBER_OUTBOUND: ${{ secrets.PHONE_NUMBER_OUTBOUND }}
+        PHONE_NUMBER_INBOUND: ${{ secrets.PHONE_NUMBER_INBOUND }}
+        MFA_MESSAGING_APPLICATION_ID: ${{ secrets.MFA_MESSAGING_APPLICATION_ID }}
+        MFA_VOICE_APPLICATION_ID: ${{ secrets.MFA_VOICE_APPLICATION_ID }}
+        PHONE_NUMBER_MFA: ${{ secrets.PHONE_NUMBER_MFA }}

.gitkeep

@@ -1,3 +1,4 @@
 README.md
 bandwidth/voice/bxml/*
 bandwidth/webrtc/utils/*
+tests/integration/*

requirements.txt

@@ -3,3 +3,4 @@ jsonpickle~=1.4, >= 1.4.1
 cachecontrol~=0.12.6
 python-dateutil~=2.8.1
 enum34~=1.1, >=1.1.10
+lxml==4.6.2

tests/integration/__init__.py

@@ -0,0 +1,158 @@
+"""
+api_tests.py
+
+Integration tests for API requests
+
+@copyright Bandwidth INC
+"""
+from bandwidth.bandwidth_client import BandwidthClient
+from bandwidth.messaging.exceptions.messaging_exception import MessagingException
+from bandwidth.voice.exceptions.api_error_response_exception import ApiErrorResponseException
+from bandwidth.messaging.models.message_request import MessageRequest
+from bandwidth.voice.models.api_create_call_request import ApiCreateCallRequest
+from bandwidth.twofactorauth.models.two_factor_code_request_schema import TwoFactorCodeRequestSchema
+from bandwidth.twofactorauth.models.two_factor_verify_request_schema import TwoFactorVerifyRequestSchema
+
+import unittest
+
+import os
+
+try:
+    USERNAME = os.environ["USERNAME"]
+    PASSWORD = os.environ["PASSWORD"]
+    ACCOUNT_ID = os.environ["ACCOUNT_ID"]
+    VOICE_APPLICATION_ID = os.environ["VOICE_APPLICATION_ID"]
+    MESSAGING_APPLICATION_ID = os.environ["MESSAGING_APPLICATION_ID"]
+    CALLBACK_URL = os.environ["CALLBACK_URL"]
+    PHONE_NUMBER_OUTBOUND = os.environ["PHONE_NUMBER_OUTBOUND"]
+    PHONE_NUMBER_INBOUND = os.environ["PHONE_NUMBER_INBOUND"]
+    MFA_MESSAGING_APPLICATION_ID = os.environ["MFA_MESSAGING_APPLICATION_ID"]
+    MFA_VOICE_APPLICATION_ID = os.environ["MFA_VOICE_APPLICATION_ID"]
+    PHONE_NUMBER_MFA = os.environ["PHONE_NUMBER_MFA"]
+except:
+    raise Exception("Environmental variables not found")
+
+class MonitorTest(unittest.TestCase):
+    """
+    Class that holds basic monitoring tests for the Python SDK. Makes requests to cover JSON call and response,
+    error handling, and binary string uploads and downloads
+    """
+    def setUp(self):
+        """
+        Creates the client object
+        """
+        self.bandwidth_client = BandwidthClient(
+            voice_basic_auth_user_name=USERNAME,
+            voice_basic_auth_password=PASSWORD,
+            messaging_basic_auth_user_name=USERNAME,
+            messaging_basic_auth_password=PASSWORD,
+            two_factor_auth_basic_auth_user_name=USERNAME,
+            two_factor_auth_basic_auth_password=PASSWORD
+        )
+        self.voice_client = self.bandwidth_client.voice_client.client
+        self.messaging_client = self.bandwidth_client.messaging_client.client
+        self.auth_client = self.bandwidth_client.two_factor_auth_client.mfa
+
+    def test_create_message(self):
+        body = MessageRequest()
+        body.application_id = MESSAGING_APPLICATION_ID
+        body.to = [PHONE_NUMBER_INBOUND]
+        body.mfrom = PHONE_NUMBER_OUTBOUND
+        body.text = "Python Monitoring"
+        response = self.messaging_client.create_message(ACCOUNT_ID, body)
+        self.assertTrue(len(response.body.id) > 0) #validate that _some_ id was returned
+
+    def test_create_message_invalid_phone_number(self):
+        body = MessageRequest()
+        body.application_id = MESSAGING_APPLICATION_ID
+        body.to = ["+1invalid"]
+        body.mfrom = PHONE_NUMBER_OUTBOUND
+        body.text = "Python Monitoring"
+        try:
+            self.messaging_client.create_message(ACCOUNT_ID, body)
+            self.assertTrue(False)
+        except MessagingException as e:
+            self.assertTrue(len(e.description) > 0)
+        except:
+            self.assertTrue(False)
+
+    def test_upload_download_media(self):
+        #define constants for upload media and download media
+        media_file_name = 'python_monitoring' #future update to add special symbols
+        media_file = b'12345'
+
+        #media upload
+        self.messaging_client.upload_media(ACCOUNT_ID, media_file_name, str(len(media_file)), body=media_file)
+
+        #media download
+        downloaded_media_file = self.messaging_client.get_media(ACCOUNT_ID, media_file_name).body
+
+        #validate that the response is the same as the upload
+        self.assertEqual(media_file, downloaded_media_file)
+
+    def test_create_call_and_get_call_state(self):
+        body = ApiCreateCallRequest()
+        body.mfrom = PHONE_NUMBER_OUTBOUND
+        body.to = PHONE_NUMBER_INBOUND
+        body.application_id = VOICE_APPLICATION_ID
+        body.answer_url = CALLBACK_URL
+        response = self.voice_client.create_call(ACCOUNT_ID, body)
+        self.assertTrue(len(response.body.call_id) > 1)
+
+        #get phone call information
+        import time
+        time.sleep(1) #No guarantee that the info will be immediately available
+        response = self.voice_client.get_call_state(ACCOUNT_ID, response.body.call_id)
+        self.assertTrue(len(response.body.state) > 1)
+
+    def test_create_call_invalid_phone_number(self):
+        body = ApiCreateCallRequest()
+        body.mfrom = PHONE_NUMBER_OUTBOUND
+        body.to = "+1invalid"
+        body.application_id = VOICE_APPLICATION_ID
+        body.answer_url = CALLBACK_URL
+        try:
+            self.voice_client.create_call(ACCOUNT_ID, body)
+            self.assertTrue(False)
+        except ApiErrorResponseException as e:
+            self.assertTrue(len(e.description) > 0)
+        except:
+            self.assertTrue(False);
+
+    def test_mfa_messaging(self):
+        body = TwoFactorCodeRequestSchema(
+            mfrom = PHONE_NUMBER_MFA,
+            to = PHONE_NUMBER_INBOUND,
+            application_id = MFA_MESSAGING_APPLICATION_ID,
+            scope = "scope",
+            digits = 6,
+            message = "Your temporary {NAME} {SCOPE} code is {CODE}"
+        )
+        response = self.auth_client.create_messaging_two_factor(ACCOUNT_ID, body)
+        self.assertTrue(len(response.body.message_id) > 0)
+
+    def test_mfa_voice(self):
+        body = TwoFactorCodeRequestSchema(
+            mfrom = PHONE_NUMBER_MFA,
+            to = PHONE_NUMBER_INBOUND,
+            application_id = MFA_VOICE_APPLICATION_ID,
+            scope = "scope",
+            digits = 6,
+            message = "Your temporary {NAME} {SCOPE} code is {CODE}"
+        )
+        response = self.auth_client.create_voice_two_factor(ACCOUNT_ID, body)
+        self.assertTrue(len(response.body.call_id) > 0)
+
+    def test_mfa_verify(self):
+        body = TwoFactorVerifyRequestSchema(
+            to = PHONE_NUMBER_INBOUND,
+            application_id = MFA_VOICE_APPLICATION_ID,
+            scope = "scope",
+            code = "123456",
+            expiration_time_in_minutes = 3
+        )
+        response = self.auth_client.create_verify_two_factor(ACCOUNT_ID, body)
+        self.assertTrue(isinstance(response.body.valid, bool))
+
+if __name__ == '__main__':
+    unittest.main()