1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# -*- coding: utf-8 -*-
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2025, 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.
import re
from unittest import mock
import pytest
import apprise
import socket
# Disable logging for a cleaner testing output
import logging
logging.disable(logging.CRITICAL)
from apprise.plugins.rsyslog import NotifyRSyslog # noqa E402
@mock.patch('socket.socket')
@mock.patch('os.getpid')
def test_plugin_rsyslog_by_url(mock_getpid, mock_socket):
"""
NotifyRSyslog() Apprise URLs
"""
payload = "test"
mock_connection = mock.Mock()
# Fix pid response since it can vary in length and this impacts the
# sendto() payload response
mock_getpid.return_value = 123
# our payload length
mock_connection.sendto.return_value = 16
mock_socket.return_value = mock_connection
# an invalid URL
assert NotifyRSyslog.parse_url(object) is None
assert NotifyRSyslog.parse_url(42) is None
assert NotifyRSyslog.parse_url(None) is None
# localhost does not lookup to any of the facility codes so this
# gets interpreted as a host
obj = apprise.Apprise.instantiate('rsyslog://localhost')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
mock_connection.sendto.return_value = 18
obj = apprise.Apprise.instantiate('rsyslog://localhost/?facility=local5')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost/local5') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
# Invalid instantiation
assert apprise.Apprise.instantiate(
'rsyslog://localhost/?facility=invalid') is None
mock_connection.sendto.return_value = 17
# j will cause a search to take place and match to daemon
obj = apprise.Apprise.instantiate('rsyslog://localhost/?facility=d')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost/daemon') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
# Test bad return count
mock_connection.sendto.return_value = 0
assert obj.notify(body=payload) is False
# Test with port
mock_connection.sendto.return_value = 17
obj = apprise.Apprise.instantiate('rsyslog://localhost:518')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost:518') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
# Set length to include title (for test)
mock_connection.sendto.return_value = 39
assert obj.notify(body=payload, title="Testing a title entry") is True
# Return length back to where it was
mock_connection.sendto.return_value = 16
# Test with default port
obj = apprise.Apprise.instantiate('rsyslog://localhost:514')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
# Specify a facility
obj = apprise.Apprise.instantiate('rsyslog://localhost/kern')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost/kern') is True
assert re.search(r'logpid=yes', obj.url()) is not None
assert obj.notify(body=payload) is True
# Specify a facility requiring a lookup and having the port identified
# resolves any ambiguity
obj = apprise.Apprise.instantiate('rsyslog://localhost:514/d')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost/daemon') is True
assert re.search(r'logpid=yes', obj.url()) is not None
mock_connection.sendto.return_value = 17 # daemon is one more byte in size
assert obj.notify(body=payload) is True
obj = apprise.Apprise.instantiate('rsyslog://localhost:9000/d?logpid=no')
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost:9000/daemon') is True
assert re.search(r'logpid=no', obj.url()) is not None
# Verify our URL ID is generated
assert isinstance(obj.url_id(), str)
# Test notifications
# + 1 byte in size due to user
# + length of pid returned
mock_connection.sendto.return_value = len(payload) + 5 \
+ len(str(mock_getpid.return_value))
assert obj.notify(body=payload) is True
# This only fails because the underlining sendto() will return a
# length different then what was expected
assert obj.notify(body="a different payload size") is False
# Test timeouts and errors that can occur
mock_connection.sendto.return_value = None
mock_connection.sendto.side_effect = socket.gaierror
assert obj.notify(body=payload) is False
mock_connection.sendto.side_effect = socket.timeout
assert obj.notify(body=payload) is False
def test_plugin_rsyslog_edge_cases():
"""
NotifyRSyslog() Edge Cases
"""
# Default
obj = NotifyRSyslog(host="localhost", facility=None)
assert isinstance(obj, NotifyRSyslog)
assert obj.url().startswith('rsyslog://localhost/user') is True
assert re.search(r'logpid=yes', obj.url()) is not None
# Exception should be thrown about the fact no bot token was specified
with pytest.raises(TypeError):
NotifyRSyslog(host="localhost", facility='invalid')
with pytest.raises(TypeError):
NotifyRSyslog(host="localhost", facility=object)
|
