mirror of
https://github.com/caronc/apprise.git
synced 2025-12-15 10:04:06 +08:00
c9f0751b61
While the namespace is physically made of modules, it has been amended to be the namespace home for the corresponding notifier classes as well. This turned out to confuse both humans and machines on various ends. While it has apparently worked for a while, it croaks on Python 3.11 now, and is not considered to have been a good idea in general.
239 lines
8.9 KiB
Python
239 lines
8.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2021 Chris Caron <lead2gold@gmail.com>
|
|
# All rights reserved.
|
|
#
|
|
# This code is licensed under the MIT License.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files(the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions :
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
|
|
import re
|
|
import sys
|
|
import ssl
|
|
import pytest
|
|
from unittest import mock
|
|
|
|
import apprise
|
|
|
|
# Disable logging for a cleaner testing output
|
|
import logging
|
|
|
|
from apprise.plugins.NotifyMQTT import NotifyMQTT
|
|
|
|
logging.disable(logging.CRITICAL)
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
'paho' in sys.modules,
|
|
reason="Requires that cryptography NOT be installed")
|
|
@mock.patch('requests.post')
|
|
def test_plugin_mqtt_paho_import_error(mock_post):
|
|
"""
|
|
NotifyFCM Cryptography loading failure
|
|
"""
|
|
|
|
# without the library, the object can't be instantiated
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://user:pass@localhost/my/topic')
|
|
assert obj is None
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
'paho' not in sys.modules, reason="Requires paho-mqtt")
|
|
@mock.patch('paho.mqtt.client.Client')
|
|
def test_plugin_mqtt_general(mock_client, no_throttling):
|
|
"""
|
|
NotifyMQTT() General Checks
|
|
|
|
"""
|
|
|
|
# our call to publish() response object
|
|
publish_result = mock.Mock()
|
|
publish_result.rc = 0
|
|
publish_result.is_published.return_value = True
|
|
|
|
# Our mqtt.Client() object
|
|
_mock_client = mock.Mock()
|
|
_mock_client.connect.return_value = 0
|
|
_mock_client.reconnect.return_value = 0
|
|
_mock_client.is_connected.return_value = True
|
|
_mock_client.publish.return_value = publish_result
|
|
mock_client.return_value = _mock_client
|
|
|
|
# Instantiate our object
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost:1234/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtt://localhost:1234/my/topic')
|
|
# Detect our defaults
|
|
assert re.search(r'qos=0', obj.url())
|
|
assert re.search(r'version=v3.1.1', obj.url())
|
|
# Send a good notification
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# leverage the to= argument to identify our topic
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost?to=my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtt://localhost/my/topic')
|
|
# Detect our defaults
|
|
assert re.search(r'qos=0', obj.url())
|
|
assert re.search(r'version=v3.1.1', obj.url())
|
|
# Send a good notification
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# Send a notification in a situation where our publish failed
|
|
publish_result.rc = 2
|
|
assert obj.notify(body="test=test") is False
|
|
# Toggle our response object back to what it should be
|
|
publish_result.rc = 0
|
|
|
|
# Test case where we provide an invalid/unsupported mqtt version
|
|
with pytest.raises(TypeError):
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost?version=v1.0.0.0', suppress_exceptions=False)
|
|
|
|
# Test case where we provide an invalid/unsupported qos
|
|
with pytest.raises(TypeError):
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost?qos=123', suppress_exceptions=False)
|
|
with pytest.raises(TypeError):
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost?qos=invalid', suppress_exceptions=False)
|
|
|
|
# Test a bad URL
|
|
obj = apprise.Apprise.instantiate('mqtt://', suppress_exceptions=False)
|
|
assert obj is None
|
|
|
|
# Instantiate our object without any topics
|
|
# we also test that we can set our qos and version if we want from
|
|
# the URL
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost?qos=1&version=v3.1', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtt://localhost')
|
|
assert re.search(r'qos=1', obj.url())
|
|
assert re.search(r'version=v3.1', obj.url())
|
|
assert re.search(r'session=no', obj.url())
|
|
assert re.search(r'client_id=', obj.url()) is None
|
|
|
|
# Our notification will fail because we have no topics to notify
|
|
assert obj.notify(body="test=test") is False
|
|
|
|
# A Secure URL
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtts://user:pass@localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtts://user:pass@localhost/my/topic')
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# Clear CA Certificates
|
|
ca_certs_backup = \
|
|
list(NotifyMQTT.CA_CERTIFICATE_FILE_LOCATIONS)
|
|
NotifyMQTT.CA_CERTIFICATE_FILE_LOCATIONS = []
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtts://user:pass@localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtts://user:pass@localhost/my/topic')
|
|
|
|
# A notification is not possible now (without ca_certs)
|
|
assert obj.notify(body="test=test") is False
|
|
|
|
# Restore our certificates (for future tests)
|
|
NotifyMQTT.CA_CERTIFICATE_FILE_LOCATIONS = ca_certs_backup
|
|
|
|
# A single user (not password) + no verifying of host
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtts://user@localhost/my/topic,my/other/topic?verify=False',
|
|
suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtts://user@localhost')
|
|
assert re.search(r'my/other/topic', obj.url())
|
|
assert re.search(r'my/topic', obj.url())
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# Session and client_id handling
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtts://user@localhost/my/topic?session=yes&client_id=apprise',
|
|
suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.url().startswith('mqtts://user@localhost')
|
|
assert re.search(r'my/topic', obj.url())
|
|
assert re.search(r'client_id=apprise', obj.url())
|
|
assert re.search(r'session=yes', obj.url())
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# handle case where we fail to connect
|
|
_mock_client.connect.return_value = 2
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.notify(body="test=test") is False
|
|
# Restore our values
|
|
_mock_client.connect.return_value = 0
|
|
|
|
# handle case where we fail to reconnect
|
|
_mock_client.reconnect.return_value = 2
|
|
_mock_client.is_connected.return_value = False
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.notify(body="test=test") is False
|
|
# Restore our values
|
|
_mock_client.reconnect.return_value = 0
|
|
_mock_client.is_connected.return_value = True
|
|
|
|
# handle case where we fail to publish()
|
|
publish_result.rc = 2
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
assert obj.notify(body="test=test") is False
|
|
# Restore our values
|
|
publish_result.rc = 0
|
|
# Set another means of failing publish()
|
|
publish_result.is_published.return_value = False
|
|
assert obj.notify(body="test=test") is False
|
|
# Restore our values
|
|
publish_result.is_published.return_value = True
|
|
# Verify that was all we had to do
|
|
assert obj.notify(body="test=test") is True
|
|
# A slight variation on the same failure (but with recovery)
|
|
publish_result.is_published.return_value = None
|
|
publish_result.is_published.side_effect = (False, True)
|
|
# Our notification is still sent okay
|
|
assert obj.notify(body="test=test") is True
|
|
|
|
# Exception handling
|
|
obj = apprise.Apprise.instantiate(
|
|
'mqtt://localhost/my/topic', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMQTT)
|
|
_mock_client.connect.return_value = None
|
|
|
|
for side_effect in (
|
|
ValueError,
|
|
ConnectionError,
|
|
ssl.CertificateError):
|
|
_mock_client.connect.side_effect = side_effect
|
|
assert obj.notify(body="test=test") is False
|
|
|
|
# Restore our values
|
|
_mock_client.connect.side_effect = None
|
|
_mock_client.connect.return_value = 0
|