File: test_plugin_wxpusher.py

package info (click to toggle)
apprise 1.9.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,792 kB
  • sloc: python: 74,226; sh: 132; makefile: 6
file content (351 lines) | stat: -rw-r--r-- 11,686 bytes parent folder | download
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# -*- 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 os
from json import loads, dumps
from unittest import mock

import requests
from apprise import Apprise
from apprise.plugins.wxpusher import NotifyWxPusher
from helpers import AppriseURLTester

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

WXPUSHER_GOOD_RESPONSE = dumps({"code": 1000})
WXPUSHER_BAD_RESPONSE = dumps({"code": 99})


# Attachment Directory
TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')

# Our Testing URLs
apprise_url_tests = (
    ('wxpusher://', {
        # No token specified
        'instance': TypeError,
    }),
    ('wxpusher://:@/', {
        # invalid url
        'instance': TypeError,
    }),
    ('wxpusher://invalid', {
        # invalid app token
        'instance': TypeError,
    }),
    ('wxpusher://AT_appid/123/', {
        # invalid 'to' phone number
        'instance': NotifyWxPusher,
        # Notify will fail because it couldn't send to anyone
        'response': False,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/123/',
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/%20/%20/', {
        # invalid 'to' phone number
        'instance': NotifyWxPusher,
        # Notify will fail because it couldn't send to anyone
        'response': False,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/',
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/123/', {
        # one phone number will notify ourselves
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://123?token=AT_abc1234', {
        # pass our token in as an argument and our host actually becomes a
        # target
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://?token=AT_abc1234', {
        # slightly different then test above; a token is defined, but
        # there are no targets
        'instance': NotifyWxPusher,
        # Notify will fail because it couldn't send to anyone
        'response': False,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://?token=AT_abc1234&to=UID_abc', {
        # all kwargs to load url with
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/UID_abcd/', {
        # a valid contact
        'instance': NotifyWxPusher,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/UID_abcd',
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/@/#/,/', {
        # Test case where we provide bad data
        'instance': NotifyWxPusher,
        # Our failed response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
        # as a result, we expect a failed notification
        'response': False,
    }),
    ('wxpusher://AT_appid/123/', {
        # Test case where we get a bad response
        'instance': NotifyWxPusher,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/123',
        # Our failed response
        'requests_response_text': WXPUSHER_BAD_RESPONSE,
        # as a result, we expect a failed notification
        'response': False,
    }),
    ('wxpusher://AT_appid/UID_345/', {
        # Test case where we get a bad response
        'instance': NotifyWxPusher,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/UID_345',
        # Our failed response
        'requests_response_text': None,
        # as a result, we expect a failed notification
        'response': False,
    }),
    ('wxpusher://AT_appid/UID_345/', {
        # Test case where we get a bad response
        'instance': NotifyWxPusher,
        # Our expected url(privacy=True) startswith() response:
        'privacy_url': 'wxpusher://****/UID_345',
        # Our failed response (bad json)
        'requests_response_text': '{',
        # as a result, we expect a failed notification
        'response': False,
    }),
    ('wxpusher://AT_appid/?to={},{}'.format(
        '2' * 11, '3' * 11), {
        # use get args to acomplish the same thing
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/?to={},{},{}'.format(
        '2' * 11, '3' * 11, '5' * 3), {
        # 2 good targets and one invalid one
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/{}/{}/'.format(
        '2' * 11, '3' * 11), {
        # If we have from= specified, then all elements take on the to= value
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/{}'.format('3' * 11), {
        # use get args to acomplish the same thing (use source instead of from)
        'instance': NotifyWxPusher,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/{}'.format('4' * 11), {
        'instance': NotifyWxPusher,
        # throw a bizzare code forcing us to fail to look it up
        'response': False,
        'requests_response_code': 999,
        # Our response expected server response
        'requests_response_text': WXPUSHER_GOOD_RESPONSE,
    }),
    ('wxpusher://AT_appid/{}'.format('4' * 11), {
        'instance': NotifyWxPusher,
        # 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_wxpusher_urls():
    """
    NotifyWxPusher() Apprise URLs

    """

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


@mock.patch('requests.post')
def test_plugin_wxpusher_edge_cases(mock_post):
    """
    NotifyWxPusher() Edge Cases

    """

    # Prepare our response
    response = requests.Request()
    response.status_code = requests.codes.ok
    response.content = WXPUSHER_GOOD_RESPONSE

    # Prepare Mock
    mock_post.return_value = response

    # Initialize some generic (but valid) tokens
    target = 'UID_abcd'
    body = "test body"
    title = "My Title"

    aobj = Apprise()
    assert aobj.add("wxpusher://AT_appid/{}".format(target))
    assert len(aobj) == 1
    assert aobj.notify(title=title, body=body)
    assert mock_post.call_count == 1

    details = mock_post.call_args_list[0]
    assert details[0][0] == 'https://wxpusher.zjiecode.com/api/send/message'
    payload = loads(details[1]['data'])
    assert payload == {
        'appToken': 'AT_appid',
        'content': 'test body',
        'summary': 'My Title',
        'contentType': 1,
        'topicIds': [],
        'uids': ['UID_abcd'],
        'url': None,
    }

    # Reset our mock object
    mock_post.reset_mock()


@mock.patch('requests.post')
def test_plugin_wxpusher_result_set(mock_post):
    """
    NotifyWxPusher() Result Sets

    """

    # Prepare our response
    response = requests.Request()
    response.status_code = requests.codes.ok
    response.content = WXPUSHER_GOOD_RESPONSE

    # Prepare Mock
    mock_post.return_value = response

    body = "test body"
    title = "My Title"

    aobj = Apprise()
    aobj.add('wxpusher://AT_appid/123/abc/UID_456')
    # One bad entry and 2 good
    assert len(aobj[0]) == 1

    assert aobj.notify(title=title, body=body)

    # 2 posts made
    assert mock_post.call_count == 1

    details = mock_post.call_args_list[0]
    assert details[0][0] == 'https://wxpusher.zjiecode.com/api/send/message'
    payload = loads(details[1]['data'])
    assert payload == {
        'appToken': 'AT_appid',
        'content': 'test body',
        'summary': 'My Title',
        'contentType': 1,
        'topicIds': [123],
        'uids': ['UID_456'],
        'url': None,
    }

    # Validate our information is also placed back into the assembled URL
    assert '/123' in aobj[0].url()
    assert '/UID_456' in aobj[0].url()
    assert '/abc' in aobj[0].url()

    mock_post.reset_mock()

    aobj = Apprise()
    aobj.add('wxpusher://AT_appid//UID_123/UID_abc/123456789')
    assert len(aobj[0]) == 1

    assert aobj.notify(title=title, body=body)

    # If batch is off then there is a post per entry
    assert mock_post.call_count == 1

    details = mock_post.call_args_list[0]
    assert details[0][0] == 'https://wxpusher.zjiecode.com/api/send/message'
    payload = loads(details[1]['data'])

    assert payload == {
        'appToken': 'AT_appid',
        'content': 'test body',
        'summary': 'My Title',
        'contentType': 1,
        'topicIds': [123456789],
        'uids': ['UID_123', 'UID_abc'],
        'url': None,
    }

    assert '/123456789' in aobj[0].url()
    assert '/UID_123' in aobj[0].url()
    assert '/UID_abc' in aobj[0].url()


@mock.patch('requests.post')
def test_notify_wxpusher_plugin_result_list(mock_post):
    """
    NotifyWxPusher() Result List Response

    """

    okay_response = requests.Request()
    okay_response.status_code = requests.codes.ok
    # We want to test the case where the `result` set returned is a list

    # Invalid JSON response
    okay_response.content = '{'

    # Assign our mock object our return value
    mock_post.return_value = okay_response

    obj = Apprise.instantiate('wxpusher://AT_apptoken/UID_abcd/')
    assert isinstance(obj, NotifyWxPusher)

    # We should now fail
    assert obj.notify("test") is False