Initial commit

apprise_api/api/tests/test_add.py

@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from django.test import SimpleTestCase
+from apprise import ConfigFormat
+from unittest.mock import patch
+import json
+
+
+class AddTests(SimpleTestCase):
+
+    def test_add_invalid_key_status_code(self):
+        """
+        Test GET requests to invalid key
+        """
+        response = self.client.get('/add/**invalid-key**')
+        assert response.status_code == 404
+
+    def test_save_config_by_urls(self):
+        """
+        Test adding an configuration by URLs
+        """
+
+        # our key to use
+        key = 'test_save_config_by_urls'
+
+        # GET returns 405 (not allowed)
+        response = self.client.get('/add/{}'.format(key))
+        assert response.status_code == 405
+
+        # no data
+        response = self.client.post('/add/{}'.format(key))
+        assert response.status_code == 400
+
+        # No entries specified
+        response = self.client.post(
+            '/add/{}'.format(key), {'urls': ''})
+        assert response.status_code == 400
+
+        # Added successfully
+        response = self.client.post(
+            '/add/{}'.format(key), {'urls': 'mailto://user:pass@yahoo.ca'})
+        assert response.status_code == 200
+
+        # URL is actually not a valid one (invalid Slack tokens specified
+        # below)
+        response = self.client.post(
+            '/add/{}'.format(key), {'urls': 'slack://TokenA/TokenB/TokenC'})
+        assert response.status_code == 400
+
+        # Test with JSON
+        response = self.client.post(
+            '/add/{}'.format(key),
+            data=json.dumps({'urls': 'mailto://user:pass@yahoo.ca'}),
+            content_type='application/json',
+        )
+        assert response.status_code == 200
+
+        # Invalid JSON
+        response = self.client.post(
+            '/add/{}'.format(key),
+            data='{',
+            content_type='application/json',
+        )
+        assert response.status_code == 400
+
+        # Test the handling of underlining disk/write exceptions
+        with patch('gzip.open') as mock_open:
+            mock_open.side_effect = OSError()
+            # We'll fail to write our key now
+            response = self.client.post(
+                '/add/{}'.format(key),
+                data=json.dumps({'urls': 'mailto://user:pass@yahoo.ca'}),
+                content_type='application/json',
+            )
+
+            # internal errors are correctly identified
+            assert response.status_code == 500
+
+    def test_save_config_by_config(self):
+        """
+        Test adding an configuration by a config file
+        """
+
+        # our key to use
+        key = 'test_save_config_by_config'
+
+        # Empty Text Configuration
+        config = """
+           
+        """  # noqa W293
+        response = self.client.post(
+            '/add/{}'.format(key), {
+                'format': ConfigFormat.TEXT, 'config': config})
+        assert response.status_code == 400
+
+        # Valid Text Configuration
+        config = """
+        browser,media=notica://VToken
+        home=mailto://user:pass@hotmail.com
+        """
+        response = self.client.post(
+            '/add/{}'.format(key),
+            {'format': ConfigFormat.TEXT, 'config': config})
+        assert response.status_code == 200
+
+        # Test with JSON
+        response = self.client.post(
+            '/add/{}'.format(key),
+            data=json.dumps({'format': ConfigFormat.TEXT, 'config': config}),
+            content_type='application/json',
+        )
+        assert response.status_code == 200
+
+        # Test invalid config format
+        response = self.client.post(
+            '/add/{}'.format(key),
+            data=json.dumps({'format': 'INVALID', 'config': config}),
+            content_type='application/json',
+        )
+        assert response.status_code == 400
+
+        with patch('tempfile._TemporaryFileWrapper') as mock_ntf:
+            mock_ntf.side_effect = OSError()
+            # we won't be able to write our retrieved configuration
+            # to disk for processing; we'll get a 500 error
+            response = self.client.post(
+                '/add/{}'.format(key),
+                data=json.dumps(
+                    {'format': ConfigFormat.TEXT, 'config': config}),
+                content_type='application/json',
+            )
+
+            # internal errors are correctly identified
+            assert response.status_code == 500
+
+        # Test the handling of underlining disk/write exceptions
+        with patch('gzip.open') as mock_open:
+            mock_open.side_effect = OSError()
+            # We'll fail to write our key now
+            response = self.client.post(
+                '/add/{}'.format(key),
+                data=json.dumps(
+                    {'format': ConfigFormat.TEXT, 'config': config}),
+                content_type='application/json',
+            )
+
+            # internal errors are correctly identified
+            assert response.status_code == 500
+
+    def test_save_with_bad_input(self):
+        """
+        Test adding with bad input in general
+        """
+
+        # our key to use
+        key = 'test_save_with_bad_input'
+        # Test with JSON
+        response = self.client.post(
+            '/add/{}'.format(key),
+            data=json.dumps({'garbage': 'input'}),
+            content_type='application/json',
+        )
+        assert response.status_code == 400

apprise_api/api/tests/test_config_cache.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+import os
+from ..utils import AppriseConfigCache
+from apprise import ConfigFormat
+from unittest.mock import patch
+import errno
+
+
+def test_apprise_config_io(tmpdir):
+    """
+    Test Apprise Config Disk Put/Get
+    """
+    content = 'mailto://test:pass@gmail.com'
+    key = 'test_apprise_config_io'
+
+    # Create our object to work with
+    acc_obj = AppriseConfigCache(str(tmpdir))
+
+    # Verify that the content doesn't already exist
+    assert acc_obj.get(key) == (None, '')
+
+    # Write our content assigned to our key
+    assert acc_obj.put(key, content, ConfigFormat.TEXT)
+
+    # Test the handling of underlining disk/write exceptions
+    with patch('gzip.open') as mock_open:
+        mock_open.side_effect = OSError()
+        # We'll fail to write our key now
+        assert not acc_obj.put(key, content, ConfigFormat.TEXT)
+
+    # Get path details
+    conf_dir, _ = acc_obj.path(key)
+
+    # List content of directory
+    contents = os.listdir(conf_dir)
+
+    # There should be just 1 new file in this directory
+    assert len(contents) == 1
+    assert contents[0].endswith('.{}'.format(ConfigFormat.TEXT))
+
+    # Verify that the content is retrievable
+    assert acc_obj.get(key) == (content, ConfigFormat.TEXT)
+
+    # Test the handling of underlining disk/read exceptions
+    with patch('gzip.open') as mock_open:
+        mock_open.side_effect = OSError()
+        # We'll fail to read our key now
+        assert acc_obj.get(key) == (None, None)
+
+    # Tidy up our content
+    assert acc_obj.clear(key) is True
+
+    # But the second time is okay as it no longer exists
+    assert acc_obj.clear(key) is None
+
+    with patch('os.remove') as mock_remove:
+        mock_remove.side_effect = OSError(errno.EPERM)
+        # OSError
+        assert acc_obj.clear(key) is False
+
+    # Now test with YAML file
+    content = """
+    version: 1
+
+    urls:
+       - windows://
+    """
+
+    # Write our content assigned to our key
+    # This should gracefully clear the TEXT entry that was
+    # previously in the spot
+    assert acc_obj.put(key, content, ConfigFormat.YAML)
+
+    # List content of directory
+    contents = os.listdir(conf_dir)
+
+    # There should STILL be just 1 new file in this directory
+    assert len(contents) == 1
+    assert contents[0].endswith('.{}'.format(ConfigFormat.YAML))
+
+    # Verify that the content is retrievable
+    assert acc_obj.get(key) == (content, ConfigFormat.YAML)

apprise_api/api/tests/test_get.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from django.test import SimpleTestCase
+
+
+class GetTests(SimpleTestCase):
+
+    def test_get_invalid_key_status_code(self):
+        """
+        Test GET requests to invalid key
+        """
+        response = self.client.get('/get/**invalid-key**')
+        assert response.status_code == 404
+
+    def test_get_config(self):
+        """
+        Test retrieving configuration
+        """
+
+        # our key to use
+        key = 'test_get_config'
+
+        # GET returns 405 (not allowed)
+        response = self.client.get('/get/{}'.format(key))
+        assert response.status_code == 405
+
+        # No content saved to the location yet
+        response = self.client.post('/get/{}'.format(key))
+        assert response.status_code == 204
+
+        # Add some content
+        response = self.client.post(
+            '/add/{}'.format(key),
+            {'urls': 'mailto://user:pass@yahoo.ca'})
+        assert response.status_code == 200
+
+        # Now we should be able to see our content
+        response = self.client.post('/get/{}'.format(key))
+        assert response.status_code == 200

apprise_api/api/tests/test_manager.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from django.test import SimpleTestCase
+
+
+class ManagerPageTests(SimpleTestCase):
+    """
+    Manager Webpage testing
+    """
+
+    def test_manage_status_code(self):
+        """
+        General testing of management page
+        """
+        # No key was specified
+        response = self.client.get('/cfg/')
+        assert response.status_code == 404
+
+        # An invalid key was specified
+        response = self.client.get('/cfg/**invalid-key**')
+        assert response.status_code == 404
+
+        # An invalid key was specified
+        response = self.client.get('/cfg/valid-key')
+        assert response.status_code == 200

apprise_api/api/tests/test_notify.py

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from django.test import SimpleTestCase
+from unittest.mock import patch
+from ..forms import NotifyForm
+import json
+import apprise
+
+
+class NotifyTests(SimpleTestCase):
+    """
+    Test notifications
+    """
+
+    @patch('apprise.Apprise.notify')
+    def test_notify_by_loaded_urls(self, mock_notify):
+        """
+        Test adding a simple notification and notifying it
+        """
+
+        # Set our return value
+        mock_notify.return_value = True
+
+        # our key to use
+        key = 'test_notify_by_loaded_urls'
+
+        # Add some content
+        response = self.client.post(
+            '/add/{}'.format(key),
+            {'urls': 'mailto://user:pass@yahoo.ca'})
+        assert response.status_code == 200
+
+        # Preare our form data
+        form_data = {
+            'body': 'test notifiction',
+        }
+
+        # At a minimum, just a body is required
+        form = NotifyForm(data=form_data)
+        assert form.is_valid()
+
+        # we always set a type if one wasn't done so already
+        assert form.cleaned_data['type'] == apprise.NotifyType.INFO
+
+        # Send our notification
+        response = self.client.post(
+            '/notify/{}'.format(key), form.cleaned_data)
+        assert response.status_code == 200
+        assert mock_notify.call_count == 1
+
+    @patch('apprise.Apprise.notify')
+    def test_notify_by_loaded_urls_with_json(self, mock_notify):
+        """
+        Test adding a simple notification and notifying it using JSON
+        """
+
+        # Set our return value
+        mock_notify.return_value = True
+
+        # our key to use
+        key = 'test_notify_by_loaded_urls_with_json'
+
+        # Add some content
+        response = self.client.post(
+            '/add/{}'.format(key),
+            {'urls': 'mailto://user:pass@yahoo.ca'})
+        assert response.status_code == 200
+
+        # Preare our JSON data
+        json_data = {
+            'body': 'test notifiction',
+            'type': apprise.NotifyType.WARNING,
+        }
+
+        # Send our notification as a JSON object
+        response = self.client.post(
+            '/notify/{}'.format(key),
+            data=json.dumps(json_data),
+            content_type='application/json',
+        )
+
+        # Still supported
+        assert response.status_code == 200
+        assert mock_notify.call_count == 1
+
+        # Reset our count
+        mock_notify.reset_mock()
+
+        # Test referencing a key that doesn't exist
+        response = self.client.post(
+            '/notify/non-existant-key',
+            data=json.dumps(json_data),
+            content_type='application/json',
+        )
+
+        # Nothing notified
+        assert response.status_code == 204
+        assert mock_notify.call_count == 0
+
+        # Test sending a garbage JSON object
+        response = self.client.post(
+            '/notify/{}'.format(key),
+            data="{",
+            content_type='application/json',
+        )
+
+        assert response.status_code == 400
+        assert mock_notify.call_count == 0
+
+        # Test sending with an invalid content type
+        response = self.client.post(
+            '/notify/{}'.format(key),
+            data="{}",
+            content_type='application/xml',
+        )
+
+        assert response.status_code == 400
+        assert mock_notify.call_count == 0
+
+        # Test sending without any content at all
+        response = self.client.post(
+            '/notify/{}'.format(key),
+            data="{}",
+            content_type='application/json',
+        )
+
+        assert response.status_code == 400
+        assert mock_notify.call_count == 0
+
+        # Test sending without a body
+        json_data = {
+            'type': apprise.NotifyType.WARNING,
+        }
+
+        response = self.client.post(
+            '/notify/{}'.format(key),
+            data=json.dumps(json_data),
+            content_type='application/json',
+        )
+
+        assert response.status_code == 400
+        assert mock_notify.call_count == 0
+
+        # Test inability to prepare writing config to disk
+        json_data = {
+            'body': 'test message'
+        }
+
+        with patch('tempfile._TemporaryFileWrapper') as mock_ntf:
+            mock_ntf.side_effect = OSError()
+            # we won't be able to write our retrieved configuration
+            # to disk for processing; we'll get a 500 error
+            response = self.client.post(
+                '/notify/{}'.format(key),
+                data=json.dumps(json_data),
+                content_type='application/json',
+            )
+
+            # internal errors are correctly identified
+            assert response.status_code == 500
+            assert mock_notify.call_count == 0
+
+        # Test the handling of underlining disk/write exceptions
+        with patch('gzip.open') as mock_open:
+            mock_open.side_effect = OSError()
+            # We'll fail to write our key now
+            response = self.client.post(
+                '/notify/{}'.format(key),
+                data=json.dumps(json_data),
+                content_type='application/json',
+            )
+
+            # internal errors are correctly identified
+            assert response.status_code == 500
+            assert mock_notify.call_count == 0

apprise_api/api/tests/test_welcome.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+from django.test import SimpleTestCase
+
+
+class WelcomePageTests(SimpleTestCase):
+
+    def test_welcome_page_status_code(self):
+        response = self.client.get('/')
+        assert response.status_code == 200