tests/test_gateways.py

from unittest.mock import Mock, patch
from urllib.parse import urlencode
from xml.etree import ElementTree

from django.template.loader import render_to_string
from django.test import TestCase
from django.test.utils import override_settings
from django.urls import reverse
from django.utils import translation
from phonenumber_field.phonenumber import PhoneNumber

from two_factor.gateways.fake import Fake
from two_factor.gateways.twilio.gateway import Twilio


class TwilioGatewayTest(TestCase):
    def test_call_app(self):
        self.maxDiff = None
        url = reverse('two_factor_twilio:call_app', args=['123456'])
        response = self.client.get(url)
        content = response.content.decode('utf-8')
        # raises an exception if invalid xml
        ElementTree.fromstring(content)
        self.assertEqual(content, """<?xml version="1.0" encoding="UTF-8" ?>
<Response>
  <Gather timeout="15" numDigits="1" finishOnKey="">
    <Say language="en">Hi, this is testserver calling. Press any key to continue.</Say>
  </Gather>
  <Say language="en">You didn’t press any keys. Good bye.</Say>
</Response>\n""")

        url = reverse('two_factor_twilio:call_app', args=['123456'])
        response = self.client.post(url)
        content = response.content.decode('utf-8')
        # raises an exception if invalid xml
        ElementTree.fromstring(content)
        self.assertEqual(content, """<?xml version="1.0" encoding="UTF-8" ?>
<Response>
  <Say language="en">Your token is:</Say>
  <Pause/>
  <Say language="en">1</Say>
  <Pause/>
  <Say language="en">2</Say>
  <Pause/>
  <Say language="en">3</Say>
  <Pause/>
  <Say language="en">4</Say>
  <Pause/>
  <Say language="en">5</Say>
  <Pause/>
  <Say language="en">6</Say>
  <Pause/>
  <Say language="en">Repeat:</Say>
  <Pause/>
  <Say language="en">1</Say>
  <Pause/>
  <Say language="en">2</Say>
  <Pause/>
  <Say language="en">3</Say>
  <Pause/>
  <Say language="en">4</Say>
  <Pause/>
  <Say language="en">5</Say>
  <Pause/>
  <Say language="en">6</Say>
  <Pause/>
  <Say language="en">Good bye.</Say>
</Response>\n""")

        # there is a en-gb voice
        response = self.client.get('%s?%s' % (url, urlencode({'locale': 'en-gb'})))
        self.assertContains(response, '<Say language="en-gb">')

        # there is no Frysian voice
        response = self.client.get('%s?%s' % (url, urlencode({'locale': 'fy-nl'})))
        self.assertContains(response, '<Say language="en">')

    @override_settings(
        TWILIO_ACCOUNT_SID='SID',
        TWILIO_AUTH_TOKEN='TOKEN',
        TWILIO_CALLER_ID='+456',
    )
    @patch('two_factor.gateways.twilio.gateway.Client')
    def test_gateway(self, client):
        twilio = Twilio()
        client.assert_called_with('SID', 'TOKEN')

        for code in ['654321', '054321', '87654321', '07654321']:
            twilio.make_call(device=Mock(number=PhoneNumber.from_string('+123')), token=code)
            client.return_value.calls.create.assert_called_with(
                from_='+456', to='+123', method='GET', timeout=15,
                url='http://testserver/twilio/inbound/two_factor/%s/?locale=en-us' % code)

            twilio.send_sms(
                device=Mock(number=PhoneNumber.from_string('+123')),
                token=code
            )

            client.return_value.messages.create.assert_called_with(
                to='+123',
                body=render_to_string(
                    'two_factor/twilio/sms_message.html',
                    {'token': code}
                ),
                from_='+456'
            )

            client.return_value.calls.create.reset_mock()
            with translation.override('en-gb'):
                twilio.make_call(device=Mock(number=PhoneNumber.from_string('+123')), token=code)
                client.return_value.calls.create.assert_called_with(
                    from_='+456', to='+123', method='GET', timeout=15,
                    url='http://testserver/twilio/inbound/two_factor/%s/?locale=en-gb' % code)

            client.return_value.calls.create.reset_mock()
            with translation.override('en-gb'):
                twilio.make_call(device=Mock(number=PhoneNumber.from_string('+123')), token=code)
                client.return_value.calls.create.assert_called_with(
                    from_='+456', to='+123', method='GET', timeout=15,
                    url='http://testserver/twilio/inbound/two_factor/%s/?locale=en-gb' % code)

    @override_settings(
        TWILIO_ACCOUNT_SID='SID',
        TWILIO_AUTH_TOKEN='TOKEN',
        TWILIO_CALLER_ID='+456',
        TWILIO_MESSAGING_SERVICE_SID='ID'
    )
    @patch('two_factor.gateways.twilio.gateway.Client')
    def test_messaging_sid(self, client):
        twilio = Twilio()

        device = Mock(number=PhoneNumber.from_string('+123'))
        code = '123456'

        # Making a call if the Messaging Service SID is set should not affect the caller ID
        twilio.make_call(device=device, token=code)
        client.return_value.calls.create.assert_called_with(
            from_='+456', to='+123', method='GET', timeout=15,
            url='http://testserver/twilio/inbound/two_factor/%s/?locale=en-us' % code)

        # Sending an SMS should originate from the messaging service SID
        twilio.send_sms(device=device, token=code)

        client.return_value.messages.create.assert_called_with(
            to='+123',
            body=render_to_string(
                'two_factor/twilio/sms_message.html',
                {'token': code}
            ),
            messaging_service_sid='ID'
        )

    @override_settings(
        TWILIO_ACCOUNT_SID='SID',
        TWILIO_AUTH_TOKEN='TOKEN',
        TWILIO_CALLER_ID='+456',
    )
    @patch('two_factor.gateways.twilio.gateway.Client')
    def test_invalid_twilio_language(self, client):
        # This test assumes an invalid twilio voice language being present in
        # the Arabic translation. Might need to create a faux translation when
        # the translation is fixed.

        url = reverse('two_factor_twilio:call_app', args=['123456'])
        with self.assertRaises(NotImplementedError):
            self.client.get('%s?%s' % (url, urlencode({'locale': 'ar'})))

        # make_call doesn't use the voice_language, but it should raise early
        # to ease debugging.
        with self.assertRaises(NotImplementedError):
            twilio = Twilio()
            with translation.override('ar'):
                twilio.make_call(device=Mock(number='+123'), token='654321')


class FakeGatewayTest(TestCase):
    @patch('two_factor.gateways.fake.logger')
    def test_gateway(self, logger):
        fake = Fake()

        for code in ['654321', '87654321']:
            fake.make_call(device=Mock(number=PhoneNumber.from_string('+123')), token=code)
            logger.info.assert_called_with(
                'Fake call to %s: "Your token is: %s"', '+123', code)

            fake.send_sms(device=Mock(number=PhoneNumber.from_string('+123')), token=code)
            logger.info.assert_called_with(
                'Fake SMS to %s: "Your token is: %s"', '+123', code)