apprise/test/test_plugin_workflows.py

# -*- coding: utf-8 -*-
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2024, Chris Caron <lead2gold@gmail.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

from unittest import mock

import json
import requests
import pytest
from apprise import Apprise
from apprise import AppriseConfig
from apprise import NotifyType
from apprise.plugins.workflows import NotifyWorkflows
from helpers import AppriseURLTester
from inspect import cleandoc

# Disable logging for a cleaner testing output
import logging
logging.disable(logging.CRITICAL)

# Our Testing URLs
apprise_url_tests = (
    ##################################
    # NotifyWorkflows
    ##################################
    ('workflow://', {
        # invalid host details (parsing fails very early)
        'instance': None,
    }),
    ('workflow://:@/', {
        # invalid host details (parsing fails very early)
        'instance': None,
    }),
    ('workflow://host/workflow', {
        # workflow provided only, no signature
        'instance': TypeError,
    }),
    ('workflow://host:443/^(/signature', {
        # invalid workflow provided
        'instance': TypeError,
    }),
    ('workflow://host:443/workflow1a/signature/?image=no', {
        # All tokens provided - we're good
        # Tests case without image defined
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/workflow1b/signature/', {
        # support workflows (s added to end)
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/signature/?id=workflow1c', {
        # id= to store workflow id
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/signature/?workflow=workflow1d&wrap=yes', {
        # workflow= to store workflow id
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/signature/?workflow=workflow1d&wrap=no', {
        # workflow= to store workflow id
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/workflow1e/signature/?api-version=2024-01-01', {
        # support api-version which is extracted from webhook
        'instance': NotifyWorkflows,
        # Our expected url(privacy=True) startswith() response
        'privacy_url': 'workflow://host:443/w...e/s...e/',
    }),
    ('workflows://host:443/workflow1b/signature/?ver=2016-06-01', {
        # Support ver= (api-version alias)
        'instance': NotifyWorkflows,
    }),
    ('workflows://host:443/?id=workflow1b&signature=signature', {
        # Support signature= (sig= alias)
        'instance': NotifyWorkflows,
        # Our expected url(privacy=True) startswith() response
        'privacy_url': 'workflow://host:443/w...b/s...e/',
    }),
    # Support native URLs
    ('https://server.azure.com:443/workflows/643e69f83c8944/'
     'triggers/manual/paths/invoke?'
     'api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&'
     'sv=1.0&sig=KODuebWbDGYFr0z0eu', {
         # All tokens provided - we're good
         'instance': NotifyWorkflows,

         # Our expected url(privacy=True) startswith() response
         'privacy_url': 'workflow://server.azure.com:443/6...4/K...u/'}),

    ('workflow://host:443/workflow2/signature/', {
        'instance': NotifyWorkflows,
        # force a failure
        'response': False,
        'requests_response_code': requests.codes.internal_server_error,
    }),
    ('workflow://host:443/workflow3/signature/', {
        'instance': NotifyWorkflows,
        # throw a bizzare code forcing us to fail to look it up
        'response': False,
        'requests_response_code': 999,
    }),
    ('workflow://host:443/workflow4/signature/', {
        'instance': NotifyWorkflows,
        # Throws a series of connection and transfer exceptions when this flag
        # is set and tests that we gracfully handle them
        'test_requests_exceptions': True,
    }),
)


def test_plugin_workflows_urls():
    """
    NotifyWorkflows() Apprise URLs

    """

    # Run our general tests
    AppriseURLTester(tests=apprise_url_tests).run_all()


@pytest.fixture
def workflows_url():
    return 'workflow://host:443/workflow/signature'


@pytest.fixture
def request_mock(mocker):
    """
    Prepare requests mock.
    """
    mock_post = mocker.patch("requests.post")
    mock_post.return_value = requests.Request()
    mock_post.return_value.status_code = requests.codes.ok
    return mock_post


@pytest.fixture
def simple_template(tmpdir):
    template = tmpdir.join("simple.json")
    template.write(cleandoc("""
    {
        "type": "message",
        "attachments": [{
            "contentType": "application/vnd.microsoft.card.adaptive",
            "contentUrl": None,
            "content": {
                "$schema":"http://adaptivecards.io/schemas/adaptive-card.json",
                "type": "AdaptiveCard",
                "version": "1.4",
                "msteams": { "width": "full" },
                "body": [
                    {
                        "type": "TextBlock",
                        "text": "**Test**",
                        "style": "heading"
                    },
                ]
            }
        ]
    }
    """))
    return template


def test_plugin_workflows_templating_basic_success(
        request_mock, workflows_url, tmpdir):
    """
    NotifyWorkflows() Templating - success.
    Test cases where URL and JSON is valid.
    """

    template = tmpdir.join("simple.json")
    template.write(cleandoc("""
    {
      "@type": "MessageCard",
      "@context": "https://schema.org/extensions",
      "summary": "{{app_id}}",
      "themeColor": "{{app_color}}",
      "sections": [
        {
          "activityImage": null,
          "activityTitle": "{{app_title}}",
          "text": "{{app_body}}"
        }
      ]
    }
    """))

    # Instantiate our URL
    obj = Apprise.instantiate('{url}/?template={template}&{kwargs}'.format(
        url=workflows_url,
        template=str(template),
        kwargs=':key1=token&:key2=token',
    ))

    assert isinstance(obj, NotifyWorkflows)
    assert obj.notify(
        body="body", title='title',
        notify_type=NotifyType.INFO) is True

    assert request_mock.called is True
    assert request_mock.call_args_list[0][0][0].startswith(
        'https://host:443/workflows/workflow/triggers/manual/paths/invoke')

    # Our Posted JSON Object
    posted_json = json.loads(request_mock.call_args_list[0][1]['data'])
    assert 'summary' in posted_json
    assert posted_json['summary'] == 'Apprise'
    assert posted_json['themeColor'] == '#3AA3E3'
    assert posted_json['sections'][0]['activityTitle'] == 'title'
    assert posted_json['sections'][0]['text'] == 'body'


def test_plugin_workflows_templating_invalid_json(
        request_mock, workflows_url, tmpdir):
    """
    NotifyWorkflows() Templating - invalid JSON.
    """

    template = tmpdir.join("invalid.json")
    template.write("}")

    # Instantiate our URL
    obj = Apprise.instantiate('{url}/?template={template}&{kwargs}'.format(
        url=workflows_url,
        template=str(template),
        kwargs=':key1=token&:key2=token',
    ))

    assert isinstance(obj, NotifyWorkflows)
    # We will fail to preform our notifcation because the JSON is bad
    assert obj.notify(
        body="body", title='title',
        notify_type=NotifyType.INFO) is False


def test_plugin_workflows_templating_load_json_failure(
        request_mock, workflows_url, tmpdir):
    """
    NotifyWorkflows() Templating - template loading failure.
    Test a case where we can not access the file.
    """

    template = tmpdir.join("empty.json")
    template.write("")

    obj = Apprise.instantiate('{url}/?template={template}'.format(
        url=workflows_url,
        template=str(template),
    ))

    with mock.patch('json.loads', side_effect=OSError):
        # we fail, but this time it's because we couldn't
        # access the cached file contents for reading
        assert obj.notify(
            body="body", title='title',
            notify_type=NotifyType.INFO) is False


def test_plugin_workflows_templating_target_success(
        request_mock, workflows_url, tmpdir):
    """
    NotifyWorkflows() Templating - success with target.
    A more complicated example; uses a target.
    """

    template = tmpdir.join("more_complicated_example.json")
    template.write(cleandoc("""
    {
      "@type": "MessageCard",
      "@context": "https://schema.org/extensions",
      "summary": "{{app_desc}}",
      "themeColor": "{{app_color}}",
      "sections": [
        {
          "activityImage": null,
          "activityTitle": "{{app_title}}",
          "text": "{{app_body}}"
        }
      ],
     "potentialAction": [{
        "@type": "ActionCard",
        "name": "Add a comment",
        "inputs": [{
            "@type": "TextInput",
            "id": "comment",
            "isMultiline": false,
            "title": "Add a comment here for this task."
        }],
        "actions": [{
            "@type": "HttpPOST",
            "name": "Add Comment",
            "target": "{{ target }}"
        }]
     }]
    }
    """))

    # Instantiate our URL
    obj = Apprise.instantiate('{url}/?template={template}&{kwargs}'.format(
        url=workflows_url,
        template=str(template),
        kwargs=':key1=token&:key2=token&:target=http://localhost',
    ))

    assert isinstance(obj, NotifyWorkflows)
    assert obj.notify(
        body="body", title='title',
        notify_type=NotifyType.INFO) is True

    assert request_mock.called is True
    assert request_mock.call_args_list[0][0][0].startswith(
        'https://host:443/workflows/workflow/triggers/manual/paths/invoke')

    # Our Posted JSON Object
    posted_json = json.loads(request_mock.call_args_list[0][1]['data'])
    assert 'summary' in posted_json
    assert posted_json['summary'] == 'Apprise Notifications'
    assert posted_json['themeColor'] == '#3AA3E3'
    assert posted_json['sections'][0]['activityTitle'] == 'title'
    assert posted_json['sections'][0]['text'] == 'body'

    # We even parsed our entry out of the URL
    assert posted_json['potentialAction'][0]['actions'][0]['target'] \
        == 'http://localhost'


def test_workflows_yaml_config_missing_template_filename(
        request_mock, workflows_url, simple_template, tmpdir):
    """
    NotifyWorkflows() YAML Configuration Entries - Missing template reference.
    """

    config = tmpdir.join("workflow01.yml")
    config.write(cleandoc("""
    urls:
      - {url}:
        - tag: 'workflow'
          template: {template}.missing
          :name: 'Template.Missing'
          :body: 'test body'
          :title: 'test title'
    """.format(url=workflows_url, template=str(simple_template))))

    # Config still loads okay
    cfg = AppriseConfig()
    cfg.add(str(config))
    assert len(cfg) == 1
    assert len(cfg[0]) == 1

    obj = cfg[0][0]
    assert isinstance(obj, NotifyWorkflows)

    # However we can't send notification since the template couldn't be loaded
    assert obj.notify(
        body="body", title='title',
        notify_type=NotifyType.INFO) is False
    assert request_mock.called is False


def test_plugin_workflows_edge_cases():
    """
    NotifyWorkflows() Edge Cases

    """
    # Initializes the plugin with an invalid token
    with pytest.raises(TypeError):
        NotifyWorkflows(workflow='@', signature='@')
    with pytest.raises(TypeError):
        NotifyWorkflows(workflow='', signature='abcd')

    with pytest.raises(TypeError):
        NotifyWorkflows(workflow=None, signature='abcd')
    # Whitespace also acts as an invalid token value
    with pytest.raises(TypeError):
        NotifyWorkflows(workflow='  ', signature='abcd')

    with pytest.raises(TypeError):
        NotifyWorkflows(workflow='abcd', signature=None)
    # Whitespace also acts as an invalid token value
    with pytest.raises(TypeError):
        NotifyWorkflows(workflow='abcd', signature='  ')

    # test case where invalid tokens are specified
    with pytest.raises(TypeError):
        NotifyWorkflows(
            workflow='workflow', signature='signature', tokens='not-a-dict')

    # test case where no tokens are specified
    obj = NotifyWorkflows(workflow='workflow', signature='signature')
    assert isinstance(obj, NotifyWorkflows)


def test_plugin_workflows_azure_webhooks(request_mock):
    """
    NotifyWorkflows() Azure Webhooks
    """
    url = 'https://prod-15.uksouth.logic.azure.com:443' \
        '/workflows/3XXX5/triggers/manual/paths/invoke' \
        '?api-version=2016-06-01&' \
        'sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=iXXXU'

    #
    # Initialize
    #
    obj = Apprise.instantiate(url)
    assert isinstance(obj, NotifyWorkflows)
    assert obj.workflow == "3XXX5"
    assert obj.signature == "iXXXU"
    assert obj.api_version == "2016-06-01"