Add tests for Twilio update credentials

temba/channels/types/twilio/tests.py

@@ -247,8 +247,10 @@ def test_claim(self):
             True,
         )
 
+        update_credentials_url = reverse("channels.types.twilio.update_credentials", args=[channel.uuid])
+
         self.assertUpdateFetch(
-            reverse("channels.types.twilio.update_credentials", args=[channel.uuid]),
+            update_credentials_url,
             allow_viewers=False,
             allow_editors=True,
             form_fields=("account_sid", "account_token"),

temba/tests/twilio.py

@@ -80,13 +80,19 @@ def __init__(self, short_code):
             self.short_code = short_code
             self.sid = "ShortSid"
 
+        def update(self, *args, **kwargs):
+            print("Updating short code with sid %s, short code %s" % (self.sid, self.short_code))
+
     class MockShortCodes(MockInstanceResource):
         def __init__(self, *args):
             pass
 
         def list(self, short_code=None):
             return [MockTwilioClient.MockShortCode(short_code)]
 
+        def get(self, sid):
+            return MockTwilioClient.MockShortCode("1122")
+
         def stream(self, *args, **kwargs):
             return iter([MockTwilioClient.MockShortCode("1122")])
 
@@ -128,6 +134,9 @@ class MockAccounts(MockInstanceResource):
         def __init__(self, *args):
             pass
 
+        def fetch(self, account_type):
+            return MockTwilioClient.MockAccount(account_type)
+
         def get(self, account_type):
             return MockTwilioClient.MockAccount(account_type)
 
@@ -159,6 +168,12 @@ def create(self, *args, **kwargs):
             phone_number = kwargs["phone_number"]
             return MockTwilioClient.MockPhoneNumber(phone_number)
 
+        def get(self, *args, **kwargs):
+            return MockTwilioClient.MockPhoneNumber("+12062345678")
+
+        def update(self, *args, **kwargs):
+            print("Updating phone number with sid %s, number %s" % (self.sid, self.phone_number))
+
     class MockApplications(MockInstanceResource):
         def __init__(self, *args):
             pass

temba/utils/twilio/tests.py

@@ -0,0 +1,162 @@
+from unittest.mock import patch
+
+from django.urls import reverse
+
+from temba.channels.models import Channel
+from temba.tests import CRUDLTestMixin, TembaTest
+from temba.tests.twilio import MockRequestValidator, MockTwilioClient
+
+
+class TwilioUtilsTest(TembaTest, CRUDLTestMixin):
+    @patch("temba.utils.twilio.views.TwilioClient", MockTwilioClient)
+    @patch("twilio.request_validator.RequestValidator", MockRequestValidator)
+    def test_twilio_update_credentials(self):
+        self.login(self.admin)
+
+        config = {
+            Channel.CONFIG_APPLICATION_SID: "app-sid",
+            Channel.CONFIG_NUMBER_SID: "number-sid",
+            Channel.CONFIG_ACCOUNT_SID: "account-sid",
+            Channel.CONFIG_AUTH_TOKEN: "account-token",
+            Channel.CONFIG_CALLBACK_DOMAIN: "rapidpro.io",
+        }
+
+        channel = self.create_channel("T", "channel", "1234", config=config)
+
+        update_credentials_url = reverse("channels.types.twilio.update_credentials", args=[channel.uuid])
+
+        self.assertUpdateFetch(
+            update_credentials_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields={"account_sid": "account-sid", "account_token": "account-token"},
+        )
+
+        with patch("temba.tests.twilio.MockTwilioClient.MockPhoneNumbers.stream") as mock_numbers:
+            mock_numbers.return_value = iter([])
+
+            with patch("temba.tests.twilio.MockTwilioClient.MockShortCodes.stream") as mock_short_codes:
+                mock_short_codes.return_value = iter([MockTwilioClient.MockShortCode("8080")])
+
+                self.assertUpdateSubmit(
+                    update_credentials_url,
+                    {"account_sid": "AccountSid", "account_token": "AccountToken"},
+                )
+                channel.refresh_from_db()
+                channel_config = channel.config
+                self.assertEqual(channel_config[Channel.CONFIG_ACCOUNT_SID], "AccountSid")
+                self.assertEqual(channel_config[Channel.CONFIG_AUTH_TOKEN], "AccountToken")
+                self.assertEqual(channel_config[Channel.CONFIG_APPLICATION_SID], "TwilioTestSid")
+                self.assertEqual(channel_config[Channel.CONFIG_NUMBER_SID], "ShortSid")
+
+        channel = self.create_channel("T", "channel", "12062345678", config=config)
+
+        update_credentials_url = reverse("channels.types.twilio.update_credentials", args=[channel.uuid])
+
+        self.assertUpdateFetch(
+            update_credentials_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields={"account_sid": "account-sid", "account_token": "account-token"},
+        )
+
+        channel.refresh_from_db()
+        channel_config = channel.config
+        self.assertEqual(channel_config[Channel.CONFIG_ACCOUNT_SID], "account-sid")
+        self.assertEqual(channel_config[Channel.CONFIG_AUTH_TOKEN], "account-token")
+        self.assertEqual(channel_config[Channel.CONFIG_APPLICATION_SID], "app-sid")
+        self.assertEqual(channel_config[Channel.CONFIG_NUMBER_SID], "number-sid")
+
+        with patch("temba.tests.twilio.MockTwilioClient.MockPhoneNumbers.stream") as mock_numbers:
+            mock_numbers.return_value = iter([MockTwilioClient.MockPhoneNumber("+12062345678")])
+
+            with patch("temba.tests.twilio.MockTwilioClient.MockShortCodes.stream") as mock_short_codes:
+                mock_short_codes.return_value = iter([])
+
+                self.assertUpdateSubmit(
+                    update_credentials_url,
+                    {"account_sid": "AccountSid", "account_token": "AccountToken"},
+                )
+                channel.refresh_from_db()
+                channel_config = channel.config
+                self.assertEqual(channel_config[Channel.CONFIG_ACCOUNT_SID], "AccountSid")
+                self.assertEqual(channel_config[Channel.CONFIG_AUTH_TOKEN], "AccountToken")
+                self.assertEqual(channel_config[Channel.CONFIG_APPLICATION_SID], "TwilioTestSid")
+                self.assertEqual(channel_config[Channel.CONFIG_NUMBER_SID], "PhoneNumberSid")
+
+    @patch("temba.utils.twilio.views.TwilioClient", MockTwilioClient)
+    @patch("twilio.request_validator.RequestValidator", MockRequestValidator)
+    def test_twilio_whatsapp_update_credentials(self):
+        self.login(self.admin)
+
+        config = {
+            Channel.CONFIG_NUMBER_SID: "number-sid",
+            Channel.CONFIG_ACCOUNT_SID: "account-sid",
+            Channel.CONFIG_AUTH_TOKEN: "account-token",
+            Channel.CONFIG_CALLBACK_DOMAIN: "rapidpro.io",
+        }
+
+        channel = self.create_channel("TWA", "channel", "1234", config=config)
+
+        update_credentials_url = reverse("channels.types.twilio_whatsapp.update_credentials", args=[channel.uuid])
+
+        self.assertUpdateFetch(
+            update_credentials_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields={"account_sid": "account-sid", "account_token": "account-token"},
+        )
+
+        with patch("temba.tests.twilio.MockTwilioClient.MockPhoneNumbers.stream") as mock_numbers:
+            mock_numbers.return_value = iter([MockTwilioClient.MockPhoneNumber("+12062345678")])
+
+            self.assertUpdateSubmit(
+                update_credentials_url,
+                {"account_sid": "AccountSid", "account_token": "AccountToken"},
+            )
+            channel.refresh_from_db()
+            channel_config = channel.config
+            self.assertEqual(channel_config[Channel.CONFIG_ACCOUNT_SID], "AccountSid")
+            self.assertEqual(channel_config[Channel.CONFIG_AUTH_TOKEN], "AccountToken")
+            # TWA number SID should have not changedon the same Twilio account, no support for number moved on Twilio
+            self.assertEqual(channel_config[Channel.CONFIG_NUMBER_SID], "number-sid")
+            self.assertFalse(Channel.CONFIG_APPLICATION_SID in channel_config)
+
+    @patch("temba.utils.twilio.views.TwilioClient", MockTwilioClient)
+    @patch("twilio.request_validator.RequestValidator", MockRequestValidator)
+    def test_twilio_messaging_service_update_credentials(self):
+        self.login(self.admin)
+
+        config = {
+            Channel.CONFIG_MESSAGING_SERVICE_SID: "messaging-sid",
+            Channel.CONFIG_ACCOUNT_SID: "account-sid",
+            Channel.CONFIG_AUTH_TOKEN: "account-token",
+            Channel.CONFIG_CALLBACK_DOMAIN: "rapidpro.io",
+        }
+
+        channel = self.create_channel("TMS", "channel", "1234", config=config)
+
+        update_credentials_url = reverse(
+            "channels.types.twilio_messaging_service.update_credentials", args=[channel.uuid]
+        )
+
+        self.assertUpdateFetch(
+            update_credentials_url,
+            allow_viewers=False,
+            allow_editors=True,
+            form_fields={"account_sid": "account-sid", "account_token": "account-token"},
+        )
+
+        self.assertUpdateSubmit(
+            update_credentials_url,
+            {"account_sid": "AccountSid", "account_token": "AccountToken"},
+        )
+        channel.refresh_from_db()
+        channel_config = channel.config
+        self.assertEqual(channel_config[Channel.CONFIG_ACCOUNT_SID], "AccountSid")
+        self.assertEqual(channel_config[Channel.CONFIG_AUTH_TOKEN], "AccountToken")
+        self.assertEqual(
+            channel_config[Channel.CONFIG_MESSAGING_SERVICE_SID], "messaging-sid"
+        )  # we do not change that
+        self.assertFalse(Channel.CONFIG_APPLICATION_SID in channel_config)
+        self.assertFalse(Channel.CONFIG_NUMBER_SID in channel_config)

temba/utils/twilio/views.py

@@ -100,7 +100,7 @@ def form_valid(self, form):
             if config_app_id:
                 try:
                     twilio_app = client.api.applications.get(sid=config_app_id).fetch()
-                except Exception:
+                except Exception:  # pragma: no cover
                     twilio_app = client.api.applications.create(
                         friendly_name="%s/%s" % (callback_domain.lower(), channel_uuid),
                         sms_method="POST",
@@ -132,7 +132,10 @@ def form_valid(self, form):
                         )
                     )
             else:
+                twilio_phones = client.api.incoming_phone_numbers.stream(phone_number=phone_number)
+                twilio_phone = next(twilio_phones, None)
                 if twilio_phone:
+                    number_sid = twilio_phone.sid
 
                     client.api.incoming_phone_numbers.get(twilio_phone.sid).update(
                         voice_application_sid=twilio_app.sid, sms_application_sid=twilio_app.sid
@@ -146,6 +149,7 @@ def form_valid(self, form):
                     )
 
             self.object.config[Channel.CONFIG_APPLICATION_SID] = twilio_app.sid
+            self.object.config[Channel.CONFIG_NUMBER_SID] = number_sid
 
         self.object.config[Channel.CONFIG_ACCOUNT_SID] = data["account_sid"]
         self.object.config[Channel.CONFIG_AUTH_TOKEN] = data["account_token"]