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
|
# -*- 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
import urllib
import pytest
from apprise import exception
from apprise.attachment.base import AttachBase
from apprise.attachment.memory import AttachMemory
from apprise import AppriseAttachment
from apprise.common import ContentLocation
# Disable logging for a cleaner testing output
import logging
logging.disable(logging.CRITICAL)
def test_attach_memory_parse_url():
"""
API: AttachMemory().parse_url()
"""
# Bad Entry
assert AttachMemory.parse_url(object) is None
# Our filename is detected automatically
assert AttachMemory.parse_url('memory://')
# pass our content in as a string
mem = AttachMemory(content='string')
# it loads a string type by default
mem.mimetype == 'text/plain'
# Our filename is automatically generated (with .txt)
assert re.match(r'^[a-z0-9-]+\.txt$', mem.name, re.I)
# open our file
with mem as fp:
assert fp.getbuffer().nbytes == len(mem)
# pass our content in as a string
mem = AttachMemory(
content='<html/>', name='test.html', mimetype='text/html')
# it loads a string type by default
mem.mimetype == 'text/html'
mem.name == 'test.html'
# Stub function
assert mem.download()
with pytest.raises(TypeError):
# garbage in, garbage out
AttachMemory(content=3)
# pointer to our data
pointer = mem.open()
assert pointer.read() == b'<html/>'
# pass our content in as a string
mem = AttachMemory(content=b'binary-data', name='raw.dat')
# it loads a string type by default
assert mem.mimetype == 'application/octet-stream'
mem.name == 'raw'
# pass our content in as a string
mem = AttachMemory(content=b'binary-data')
# it loads a string type by default
assert mem.mimetype == 'application/octet-stream'
# Our filename is automatically generated (with .dat)
assert re.match(r'^[a-z0-9-]+\.dat$', mem.name, re.I)
def test_attach_memory():
"""
API: AttachMemory()
"""
# A url we can test with
fname = 'testfile'
url = 'memory:///ignored/path/{fname}'.format(fname=fname)
# Simple gif test
response = AppriseAttachment.instantiate(url)
assert isinstance(response, AttachMemory)
# There is no path yet as we haven't written anything to our memory object
# yet
assert response.path is None
assert bool(response) is False
with response as memobj:
memobj.write(b'content')
# Memory object defaults
assert response.name == fname
assert response.path == response.name
assert response.mimetype == 'application/octet-stream'
assert bool(response) is True
#
fname_in_url = urllib.parse.quote(response.name)
assert response.url().startswith('memory://{}'.format(fname_in_url))
# Mime is always part of url
assert re.search(r'[?&]mime=', response.url()) is not None
# Test case where location is simply set to INACCESSIBLE
# Below is a bad example, but it proves the section of code properly works.
# Ideally a server admin may wish to just disable all File based
# attachments entirely. In this case, they simply just need to change the
# global singleton at the start of their program like:
#
# import apprise
# apprise.attachment.AttachMemory.location = \
# apprise.ContentLocation.INACCESSIBLE
#
response = AppriseAttachment.instantiate(url)
assert isinstance(response, AttachMemory)
with response as memobj:
memobj.write(b'content')
response.location = ContentLocation.INACCESSIBLE
assert response.path is None
# Downloads just don't work period
assert response.download() is False
# File handling (even if image is set to maxium allowable)
response = AppriseAttachment.instantiate(url)
assert isinstance(response, AttachMemory)
with response as memobj:
memobj.write(b'content')
# Memory handling when size is to large
response = AppriseAttachment.instantiate(url)
assert isinstance(response, AttachMemory)
with response as memobj:
memobj.write(b'content')
# Test case where we exceed our defined max_file_size in memory
prev_value = AttachBase.max_file_size
AttachBase.max_file_size = len(response) - 1
# We can't work in this case
assert response.path is None
assert response.download() is False
# Restore our file_size
AttachBase.max_file_size = prev_value
response = AppriseAttachment.instantiate(
'memory://apprise-file.gif?mime=image/gif')
assert isinstance(response, AttachMemory)
with response as memobj:
memobj.write(b'content')
assert response.name == 'apprise-file.gif'
assert response.path == response.name
assert response.mimetype == 'image/gif'
# No mime-type and/or filename over-ride was specified, so therefore it
# won't show up in the generated URL
assert re.search(r'[?&]mime=', response.url()) is not None
assert 'image/gif' in response.url()
# Force a mime-type and new name
response = AppriseAttachment.instantiate(
'memory://{}?mime={}&name={}'.format(
'ignored.gif', 'image/jpeg', 'test.jpeg'))
assert isinstance(response, AttachMemory)
with response as memobj:
memobj.write(b'content')
assert response.name == 'test.jpeg'
assert response.path == response.name
assert response.mimetype == 'image/jpeg'
# We will match on mime type now (%2F = /)
assert re.search(r'[?&]mime=image/jpeg', response.url(), re.I)
assert response.url().startswith('memory://test.jpeg')
# Test hosted configuration and that we can't add a valid memory file
aa = AppriseAttachment(location=ContentLocation.HOSTED)
assert aa.add(response) is False
# now test our base64 output
assert isinstance(response.base64(), str)
# No encoding if we choose
assert isinstance(response.base64(encoding=None), bytes)
response.invalidate()
with pytest.raises(exception.AppriseFileNotFound):
response.base64()
|