mirror of
https://github.com/caronc/apprise.git
synced 2024-11-22 08:04:02 +01:00
213 lines
8.2 KiB
Python
213 lines
8.2 KiB
Python
# -*- 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.
|
|
|
|
import re
|
|
import time
|
|
import urllib
|
|
from unittest import mock
|
|
|
|
from os.path import dirname
|
|
from os.path import join
|
|
from apprise.attachment.base import AttachBase
|
|
from apprise.attachment.file import AttachFile
|
|
from apprise import AppriseAttachment
|
|
from apprise.common import ContentLocation
|
|
|
|
# Disable logging for a cleaner testing output
|
|
import logging
|
|
logging.disable(logging.CRITICAL)
|
|
|
|
TEST_VAR_DIR = join(dirname(__file__), 'var')
|
|
|
|
|
|
def test_attach_file_parse_url():
|
|
"""
|
|
API: AttachFile().parse_url()
|
|
|
|
"""
|
|
|
|
# bad entry
|
|
assert AttachFile.parse_url('garbage://') is None
|
|
|
|
# no file path specified
|
|
assert AttachFile.parse_url('file://') is None
|
|
|
|
|
|
def test_file_expiry(tmpdir):
|
|
"""
|
|
API: AttachFile Expiry
|
|
"""
|
|
path = join(TEST_VAR_DIR, 'apprise-test.gif')
|
|
image = tmpdir.mkdir("apprise_file").join("test.jpg")
|
|
with open(path, 'rb') as data:
|
|
image.write(data)
|
|
|
|
aa = AppriseAttachment.instantiate(str(image), cache=30)
|
|
|
|
# Our file is now available
|
|
assert aa.exists()
|
|
|
|
# Our second call has the file already downloaded, but now compares
|
|
# it's date against when we consider it to have expire. We're well
|
|
# under 30 seconds here (our set value), so this will succeed
|
|
assert aa.exists()
|
|
|
|
with mock.patch('time.time', return_value=time.time() + 31):
|
|
# This will force a re-download as our cache will have
|
|
# expired
|
|
assert aa.exists()
|
|
|
|
with mock.patch('time.time', side_effect=OSError):
|
|
# We will throw an exception
|
|
assert aa.exists()
|
|
|
|
|
|
def test_attach_file():
|
|
"""
|
|
API: AttachFile()
|
|
|
|
"""
|
|
# Simple gif test
|
|
path = join(TEST_VAR_DIR, 'apprise-test.gif')
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
assert response.path == path
|
|
assert response.name == 'apprise-test.gif'
|
|
assert response.mimetype == 'image/gif'
|
|
# Download is successful and has already been called by now; below pulls
|
|
# results from cache
|
|
assert response.download()
|
|
|
|
# On Windows, it is `file://D%3A%5Ca%5Capprise%5Capprise%5Ctest%5Cvar%5Capprise-test.gif`. # noqa E501
|
|
# TODO: Review - is this correct?
|
|
path_in_url = urllib.parse.quote(path)
|
|
assert response.url().startswith('file://{}'.format(path_in_url))
|
|
|
|
# No mime-type and/or filename over-ride was specified, so it
|
|
# won't show up in the generated URL
|
|
assert re.search(r'[?&]mime=', response.url()) is None
|
|
assert re.search(r'[?&]name=', response.url()) is 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.AttachFile.location = \
|
|
# apprise.ContentLocation.INACCESSIBLE
|
|
#
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
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(path)
|
|
assert isinstance(response, AttachFile)
|
|
with mock.patch('os.path.getsize', return_value=AttachBase.max_file_size):
|
|
# It will still work
|
|
assert response.path == path
|
|
|
|
# File handling when size is to large
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
with mock.patch(
|
|
'os.path.getsize', return_value=AttachBase.max_file_size + 1):
|
|
# We can't work in this case
|
|
assert response.path is None
|
|
|
|
# File handling when image is not available
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
with mock.patch('os.path.isfile', return_value=False):
|
|
# This triggers a full check and will fail the isfile() check
|
|
assert response.path is None
|
|
|
|
# The call to AttachBase.path automatically triggers a call to download()
|
|
# but this same is done with a call to AttachBase.name as well. Above
|
|
# test cases reference 'path' right after instantiation; here we reference
|
|
# 'name'
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert response.name == 'apprise-test.gif'
|
|
assert response.path == path
|
|
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 None
|
|
assert re.search(r'[?&]name=', response.url()) is None
|
|
|
|
# continuation to cheking 'name' instead of 'path' first where our call
|
|
# to download() fails
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
with mock.patch('os.path.isfile', return_value=False):
|
|
# This triggers a full check and will fail the isfile() check
|
|
assert response.name is None
|
|
|
|
# The call to AttachBase.path automatically triggers a call to download()
|
|
# but this same is done with a call to AttachBase.mimetype as well. Above
|
|
# test cases reference 'path' right after instantiation; here we reference
|
|
# 'mimetype'
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert response.mimetype == 'image/gif'
|
|
assert response.name == 'apprise-test.gif'
|
|
assert response.path == path
|
|
# 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 None
|
|
assert re.search(r'[?&]name=', response.url()) is None
|
|
|
|
# continuation to cheking 'name' instead of 'path' first where our call
|
|
# to download() fails
|
|
response = AppriseAttachment.instantiate(path)
|
|
assert isinstance(response, AttachFile)
|
|
with mock.patch('os.path.isfile', return_value=False):
|
|
# download() fails so we don't have a mimetpe
|
|
assert response.mimetype is None
|
|
assert response.name is None
|
|
assert response.path is None
|
|
# This triggers a full check and will fail the isfile() check
|
|
|
|
# Force a mime-type and new name
|
|
response = AppriseAttachment.instantiate(
|
|
'file://{}?mime={}&name={}'.format(path, 'image/jpeg', 'test.jpeg'))
|
|
assert isinstance(response, AttachFile)
|
|
assert response.path == path
|
|
assert response.name == 'test.jpeg'
|
|
assert response.mimetype == 'image/jpeg'
|
|
assert re.search(r'[?&]mime=image/jpeg', response.url(), re.I)
|
|
assert re.search(r'[?&]name=test\.jpeg', response.url(), re.I)
|
|
|
|
# Test hosted configuration and that we can't add a valid file
|
|
aa = AppriseAttachment(location=ContentLocation.HOSTED)
|
|
assert aa.add(path) is False
|