mirror of
https://github.com/mtan93/cachet-url-monitor.git
synced 2026-03-07 21:21:58 +00:00
5be0217c00
* #10 - Creating auxiliary client class to generate configuration class based on cachet's component list. * Updating the python version in codacy to reduce false positives * Moving some of the cachet operations to the client class to clean up the configuration class and making better constants * Refactoring status to have proper classes and adding more tests. Refactoring the requests tests to use requests-mock. * Removing unused imports from test_scheduler * Adding more tests and the ability to run the client from command line * Updating README and client arg parsing * Fixing broken unit tests
150 lines
6.7 KiB
Python
150 lines
6.7 KiB
Python
#!/usr/bin/env python
|
|
import sys
|
|
import unittest
|
|
|
|
import mock
|
|
import pytest
|
|
import requests
|
|
import requests_mock
|
|
from yaml import load, SafeLoader
|
|
|
|
import cachet_url_monitor.status
|
|
|
|
sys.modules['logging'] = mock.Mock()
|
|
from cachet_url_monitor.configuration import Configuration
|
|
import os
|
|
|
|
|
|
class ConfigurationTest(unittest.TestCase):
|
|
@mock.patch.dict(os.environ, {'CACHET_TOKEN': 'token2'})
|
|
def setUp(self):
|
|
def getLogger(name):
|
|
self.mock_logger = mock.Mock()
|
|
return self.mock_logger
|
|
|
|
sys.modules['logging'].getLogger = getLogger
|
|
|
|
# def get(url, headers):
|
|
# get_return = mock.Mock()
|
|
# get_return.ok = True
|
|
# get_return.json = mock.Mock()
|
|
# get_return.json.return_value = {'data': {'status': 1, 'default_value': 0.5}}
|
|
# return get_return
|
|
#
|
|
# sys.modules['requests'].get = get
|
|
|
|
self.configuration = Configuration(
|
|
load(open(os.path.join(os.path.dirname(__file__), 'configs/config.yml'), 'rt'), SafeLoader), 0)
|
|
# sys.modules['requests'].Timeout = Timeout
|
|
# sys.modules['requests'].ConnectionError = ConnectionError
|
|
# sys.modules['requests'].HTTPError = HTTPError
|
|
|
|
def test_init(self):
|
|
self.assertEqual(len(self.configuration.data), 2, 'Number of root elements in config.yml is incorrect')
|
|
self.assertEqual(len(self.configuration.expectations), 3, 'Number of expectations read from file is incorrect')
|
|
self.assertDictEqual(self.configuration.headers, {'X-Cachet-Token': 'token2'}, 'Header was not set correctly')
|
|
self.assertEqual(self.configuration.api_url, 'https://demo.cachethq.io/api/v1',
|
|
'Cachet API URL was set incorrectly')
|
|
self.assertDictEqual(self.configuration.endpoint_header, {'SOME-HEADER': 'SOME-VALUE'}, 'Header is incorrect')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate(self, m):
|
|
m.get('http://localhost:8080/swagger', text='<body>')
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.OPERATIONAL,
|
|
'Component status set incorrectly')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate_without_header(self, m):
|
|
m.get('http://localhost:8080/swagger', text='<body>')
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.OPERATIONAL,
|
|
'Component status set incorrectly')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate_with_failure(self, m):
|
|
m.get('http://localhost:8080/swagger', text='<body>', status_code=400)
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.MAJOR_OUTAGE,
|
|
'Component status set incorrectly or custom incident status is incorrectly parsed')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate_with_timeout(self, m):
|
|
m.get('http://localhost:8080/swagger', exc=requests.Timeout)
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.PERFORMANCE_ISSUES,
|
|
'Component status set incorrectly')
|
|
self.mock_logger.warning.assert_called_with('Request timed out')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate_with_connection_error(self, m):
|
|
m.get('http://localhost:8080/swagger', exc=requests.ConnectionError)
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.PARTIAL_OUTAGE,
|
|
'Component status set incorrectly')
|
|
self.mock_logger.warning.assert_called_with('The URL is unreachable: GET http://localhost:8080/swagger')
|
|
|
|
@requests_mock.mock()
|
|
def test_evaluate_with_http_error(self, m):
|
|
m.get('http://localhost:8080/swagger', exc=requests.HTTPError)
|
|
self.configuration.evaluate()
|
|
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.PARTIAL_OUTAGE,
|
|
'Component status set incorrectly')
|
|
self.mock_logger.exception.assert_called_with('Unexpected HTTP response')
|
|
|
|
@requests_mock.mock()
|
|
def test_push_status(self, m):
|
|
m.put('https://demo.cachethq.io/api/v1/components/1?id=1&status=1', headers={'X-Cachet-Token': 'token2'})
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.OPERATIONAL,
|
|
'Incorrect component update parameters')
|
|
self.configuration.push_status()
|
|
|
|
@requests_mock.mock()
|
|
def test_push_status_with_failure(self, m):
|
|
m.put('https://demo.cachethq.io/api/v1/components/1?id=1&status=1', headers={'X-Cachet-Token': 'token2'},
|
|
status_code=400)
|
|
self.assertEqual(self.configuration.status, cachet_url_monitor.status.ComponentStatus.OPERATIONAL,
|
|
'Incorrect component update parameters')
|
|
self.configuration.push_status()
|
|
|
|
|
|
class ConfigurationMultipleUrlTest(unittest.TestCase):
|
|
@mock.patch.dict(os.environ, {'CACHET_TOKEN': 'token2'})
|
|
def setUp(self):
|
|
config_yaml = load(open(os.path.join(os.path.dirname(__file__), 'configs/config_multiple_urls.yml'), 'rt'),
|
|
SafeLoader)
|
|
self.configuration = []
|
|
|
|
for index in range(len(config_yaml['endpoints'])):
|
|
self.configuration.append(Configuration(config_yaml, index))
|
|
|
|
def test_init(self):
|
|
expected_method = ['GET', 'POST']
|
|
expected_url = ['http://localhost:8080/swagger', 'http://localhost:8080/bar']
|
|
|
|
for index in range(len(self.configuration)):
|
|
config = self.configuration[index]
|
|
self.assertEqual(len(config.data), 2, 'Number of root elements in config.yml is incorrect')
|
|
self.assertEqual(len(config.expectations), 1, 'Number of expectations read from file is incorrect')
|
|
self.assertDictEqual(config.headers, {'X-Cachet-Token': 'token2'}, 'Header was not set correctly')
|
|
self.assertEqual(config.api_url, 'https://demo.cachethq.io/api/v1',
|
|
'Cachet API URL was set incorrectly')
|
|
|
|
self.assertEqual(expected_method[index], config.endpoint_method)
|
|
self.assertEqual(expected_url[index], config.endpoint_url)
|
|
|
|
|
|
class ConfigurationNegativeTest(unittest.TestCase):
|
|
@mock.patch.dict(os.environ, {'CACHET_TOKEN': 'token2'})
|
|
def test_init(self):
|
|
with pytest.raises(cachet_url_monitor.configuration.ConfigurationValidationError):
|
|
self.configuration = Configuration(
|
|
load(open(os.path.join(os.path.dirname(__file__), 'configs/config_invalid_type.yml'), 'rt'),
|
|
SafeLoader), 0)
|