# BSD 2-Clause License # # Apprise - Push Notification Library. # Copyright (c) 2025, Chris Caron # # 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. # Disable logging for a cleaner testing output import logging from helpers import AppriseURLTester import pytest import requests from apprise.plugins.lametric import NotifyLametric logging.disable(logging.CRITICAL) # a test UUID we can use UUID4 = "8b799edf-6f98-4d3a-9be7-2862fb4e5752" # Our Testing URLs apprise_url_tests = ( ( "lametric://", { # No APIKey or App ID specified "instance": TypeError, }, ), ( "lametric://:@/", { # No APIKey or App ID specified "instance": TypeError, }, ), ( "lametric://{}/".format( "com.lametric.941c51dff3135bd87aa72db9d855dd50" ), { # No APIKey specified "instance": TypeError, }, ), ( f"lametric://root:{UUID4}@192.168.0.5:8080/", { # Everything is okay; this would be picked up in Device Mode # We're using a default port and enforcing a special user "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://root:8...2@192.168.0.5/", }, ), ( f"lametric://{UUID4}@192.168.0.4:8000/", { # Everything is okay; this would be picked up in Device Mode # Port is enforced "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://8...2@192.168.0.4:8000/", }, ), ( f"lametric://{UUID4}@192.168.0.5/", { # Everything is okay; this would be picked up in Device Mode "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://8...2@192.168.0.5/", }, ), ( f"lametrics://{UUID4}@192.168.0.6/?mode=device", { # Everything is okay; Device mode forced "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametrics://8...2@192.168.0.6/", }, ), # Support Native URL (with Access Token Argument) ( "https://developer.lametric.com/api/v1/dev/widget/update/" "com.lametric.ABCD123/1?token={}==".format("D" * 88), { # Everything is okay; Device mode forced "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://D...=@A...3/1/", }, ), ( "lametric://192.168.2.8/?mode=device&apikey=abc123", { # Everything is okay; Device mode forced "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://a...3@192.168.2.8/", }, ), ( "lametrics://{}==@com.lametric.941c51dff3135bd87aa72db9d855dd50/" "?mode=cloud&app_ver=2".format("A" * 88), { # Everything is okay; Cloud mode forced # We gracefully strip off the com.lametric. part as well # We also set an application version of 2 "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://A...=@9...0/", }, ), ( "lametrics://{}==@com.lametric.941c51dff3135bd87aa72db9d855dd50/" "?app_ver=invalid".format("A" * 88), { # We set invalid app version "instance": TypeError, }, ), # our lametric object initialized via argument ( "lametric://?app=com.lametric.941c51dff3135bd87aa72db9d855dd50&token={}==" "&mode=cloud".format("B" * 88), { # Everything is okay; Cloud mode forced "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://B...=@9...0/", }, ), ( "lametrics://{}==@abcd/?mode=cloud&sound=knock&icon_type=info" "&priority=critical&cycles=10".format("C" * 88), { # Cloud mode forced, sound, icon_type, and priority not supported # with cloud mode so warnings are created "instance": NotifyLametric, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://C...=@a...d/", }, ), ( f"lametrics://{UUID4}@192.168.0.7/?mode=invalid", { # Invalid Mode "instance": TypeError, }, ), ( f"lametrics://{UUID4}@192.168.0.6/?sound=alarm1", { # Device mode with sound set to alarm1 "instance": NotifyLametric, }, ), ( f"lametrics://{UUID4}@192.168.0.7/?sound=bike", { # Device mode with sound set to bicycle using alias "instance": NotifyLametric, # Bike is an alias, "url_matches": r"sound=bicycle", }, ), ( f"lametrics://{UUID4}@192.168.0.8/?sound=invalid!", { # Invalid sounds just produce warnings... object still loads "instance": NotifyLametric, }, ), ( f"lametrics://{UUID4}@192.168.0.9/?icon_type=alert", { # Icon Type Changed "instance": NotifyLametric, # icon=alert exists somewhere on our generated URL "url_matches": r"icon_type=alert", }, ), ( f"lametrics://{UUID4}@192.168.0.10/?icon_type=invalid", { # Invalid icon types just produce warnings... object still loads "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.1/?priority=warning", { # Priority changed "instance": NotifyLametric, }, ), ( f"lametrics://{UUID4}@192.168.1.2/?priority=invalid", { # Invalid priority just produce warnings... object still loads "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.2/?icon=230", { # Our custom icon by it's ID "instance": NotifyLametric, }, ), ( f"lametrics://{UUID4}@192.168.1.2/?icon=#230", { # Our custom icon by it's ID; the hashtag at the front is ignored "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.2/?icon=Heart", { # Our custom icon; the hashtag at the front is ignored "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.2/?icon=#", { # a hashtag and nothing else "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.2/?icon=#%20%20%20", { # a hashtag and some spaces "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.3/?cycles=2", { # Cycles changed "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@192.168.1.4/?cycles=-1", { # Cycles changed (out of range) "instance": NotifyLametric, }, ), ( f"lametrics://{UUID4}@192.168.1.5/?cycles=invalid", { # Invalid priority just produce warnings... object still loads "instance": NotifyLametric, }, ), ( f"lametric://{UUID4}@example.com/", { "instance": NotifyLametric, # force a failure "response": False, "requests_response_code": requests.codes.internal_server_error, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametric://8...2@example.com/", }, ), ( f"lametrics://{UUID4}@example.ca/", { "instance": NotifyLametric, # throw a bizzare code forcing us to fail to look it up "response": False, "requests_response_code": 999, # Our expected url(privacy=True) startswith() response: "privacy_url": "lametrics://8...2@example.ca/", }, ), ( f"lametrics://{UUID4}@example.net/", { "instance": NotifyLametric, # Throws a series of i/o exceptions with this flag # is set and tests that we gracfully handle them "test_requests_exceptions": True, }, ), ) def test_plugin_lametric_urls(): """NotifyLametric() Apprise URLs.""" # Run our general tests AppriseURLTester(tests=apprise_url_tests).run_all() def test_plugin_lametric_edge_cases(): """NotifyLametric() Edge Cases.""" # Initializes the plugin with an invalid API Key with pytest.raises(TypeError): NotifyLametric(apikey=None, mode="device") # Initializes the plugin with an invalid Client Secret with pytest.raises(TypeError): NotifyLametric(client_id="valid", secret=None, mode="cloud")