awx/awx/main/tests/functional/test_notifications.py

from unittest import mock
import pytest

from requests.adapters import HTTPAdapter
from requests.utils import select_proxy
from requests.exceptions import ConnectionError

from awx.api.versioning import reverse
from awx.main.models.notifications import NotificationTemplate, Notification
from awx.main.models.inventory import Inventory, InventorySource
from awx.main.models.jobs import JobTemplate

from django.test.utils import override_settings


@pytest.mark.django_db
def test_get_notification_template_list(get, user, notification_template):
    url = reverse('api:notification_template_list')
    response = get(url, user('admin', True))
    assert response.status_code == 200
    assert len(response.data['results']) == 1


@pytest.mark.django_db
def test_basic_parameterization(get, post, user, organization):
    u = user('admin-poster', True)
    url = reverse('api:notification_template_list')
    response = post(
        url,
        dict(
            name="test-webhook",
            description="test webhook",
            organization=organization.id,
            notification_type="webhook",
            notification_configuration=dict(url="http://localhost", disable_ssl_verification=False, headers={"Test": "Header"}),
        ),
        u,
    )
    assert response.status_code == 201
    url = reverse('api:notification_template_detail', kwargs={'pk': response.data['id']})
    response = get(url, u)
    assert 'related' in response.data
    assert 'organization' in response.data['related']
    assert 'summary_fields' in response.data
    assert 'organization' in response.data['summary_fields']
    assert 'notifications' in response.data['related']
    assert 'notification_configuration' in response.data
    assert 'url' in response.data['notification_configuration']
    assert 'headers' in response.data['notification_configuration']
    assert 'messages' in response.data
    assert response.data['messages'] == {'started': None, 'success': None, 'error': None, 'workflow_approval': None}


@pytest.mark.django_db
def test_encrypted_subfields(get, post, user, organization):
    def assert_send(self, messages):
        assert self.account_token == "shouldhide"
        return 1

    u = user('admin-poster', True)
    url = reverse('api:notification_template_list')
    response = post(
        url,
        dict(
            name="test-twilio",
            description="test twilio",
            organization=organization.id,
            notification_type="twilio",
            notification_configuration=dict(account_sid="dummy", account_token="shouldhide", from_number="+19999999999", to_numbers=["9998887777"]),
        ),
        u,
    )
    assert response.status_code == 201
    notification_template_actual = NotificationTemplate.objects.get(id=response.data['id'])
    url = reverse('api:notification_template_detail', kwargs={'pk': response.data['id']})
    response = get(url, u)
    assert response.data['notification_configuration']['account_token'] == "$encrypted$"
    with mock.patch.object(notification_template_actual.notification_class, "send_messages", assert_send):
        notification_template_actual.send("Test", {'body': "Test"})


@pytest.mark.django_db
def test_inherited_notification_templates(get, post, user, organization, project):
    u = user('admin-poster', True)
    url = reverse('api:notification_template_list')
    notification_templates = []
    for nfiers in range(3):
        response = post(
            url,
            dict(
                name="test-webhook-{}".format(nfiers),
                description="test webhook {}".format(nfiers),
                organization=organization.id,
                notification_type="webhook",
                notification_configuration=dict(url="http://localhost", disable_ssl_verification=False, headers={"Test": "Header"}),
            ),
            u,
        )
        assert response.status_code == 201
        notification_templates.append(response.data['id'])
    i = Inventory.objects.create(name='test', organization=organization)
    i.save()
    isrc = InventorySource.objects.create(name='test', inventory=i, source='ec2')
    isrc.save()
    jt = JobTemplate.objects.create(name='test', inventory=i, project=project, playbook='debug.yml')
    jt.save()


@pytest.mark.django_db
def test_notification_template_simple_patch(patch, notification_template, admin):
    patch(reverse('api:notification_template_detail', kwargs={'pk': notification_template.id}), {'name': 'foo'}, admin, expect=200)


@pytest.mark.django_db
def test_notification_template_invalid_notification_type(patch, notification_template, admin):
    patch(reverse('api:notification_template_detail', kwargs={'pk': notification_template.id}), {'notification_type': 'invalid'}, admin, expect=400)


@pytest.mark.django_db
def test_disallow_delete_when_notifications_pending(delete, user, notification_template):
    u = user('superuser', True)
    url = reverse('api:notification_template_detail', kwargs={'pk': notification_template.id})
    Notification.objects.create(notification_template=notification_template, status='pending')
    response = delete(url, user=u)
    assert response.status_code == 405


@pytest.mark.django_db
def test_notification_template_list_includes_notification_errors(get, user, notification_template):
    Notification.objects.create(notification_template=notification_template, status='failed', error='failed to send')
    Notification.objects.create(notification_template=notification_template, status='pending')
    Notification.objects.create(notification_template=notification_template, status='successful')
    url = reverse('api:notification_template_list')
    u = user('superuser', True)
    response = get(url, user=u)

    assert response.status_code == 200
    notifications = response.data['results'][0]['summary_fields']['recent_notifications']
    assert len(notifications) == 3
    statuses = [n['status'] for n in notifications]
    assert set(statuses) == set(['failed', 'pending', 'successful'])
    for n in notifications:
        if n['status'] == 'successful':
            assert n['error'] == ''
        elif n['status'] == 'pending':
            assert n['error'] == ''
        elif n['status'] == 'failed':
            assert n['error'] == 'failed to send'


@pytest.mark.django_db
def test_custom_environment_injection(post, user, organization):
    u = user('admin-poster', True)
    url = reverse('api:notification_template_list')
    response = post(
        url,
        dict(
            name="test-webhook",
            description="test webhook",
            organization=organization.id,
            notification_type="webhook",
            notification_configuration=dict(url="https://example.org", disable_ssl_verification=False, http_method="POST", headers={"Test": "Header"}),
        ),
        u,
    )
    assert response.status_code == 201
    template = NotificationTemplate.objects.get(pk=response.data['id'])
    with pytest.raises(ConnectionError), override_settings(AWX_TASK_ENV={'HTTPS_PROXY': '192.168.50.100:1234'}), mock.patch.object(
        HTTPAdapter, 'send'
    ) as fake_send:

        def _send_side_effect(request, **kw):
            assert select_proxy(request.url, kw['proxies']) == '192.168.50.100:1234'
            raise ConnectionError()

        fake_send.side_effect = _send_side_effect
        template.send('subject', 'message')