mirror of
https://github.com/rembo10/headphones.git
synced 2026-05-19 18:15:31 +01:00
Merge remote-tracking branch 'maxkoryukov/feature/test-config' into develop
This commit is contained in:
rembo10
439
headphones/config_test.py
Normal file
439
headphones/config_test.py
Normal file
@@ -0,0 +1,439 @@
|
||||
import mock
|
||||
from mock import MagicMock
|
||||
import headphones.config
|
||||
import re
|
||||
import unittestcompat
|
||||
from unittestcompat import TestCase, TestArgs
|
||||
|
||||
class ConfigApiTest(TestCase):
|
||||
""" Common tests for headphones.Config
|
||||
|
||||
Common tests for headphones.Config This test suite guarantees, that external
|
||||
API of the Config class conforms all expectations of other modules.
|
||||
"""
|
||||
|
||||
def _setUpConfigMock(self, mock, sections):
|
||||
# every constructor `xx = ConfigObj()` in headphones.config will return
|
||||
# this mock:
|
||||
self.config_mock = self.config_module_mock.return_value = mock
|
||||
|
||||
if sections:
|
||||
mock.__contains__.side_effect = sections.__contains__
|
||||
mock.__getitem__.side_effect = sections.__getitem__
|
||||
mock.__setitem__.side_effect = sections.__setitem__
|
||||
mock.items.side_effect = sections.items
|
||||
|
||||
return mock
|
||||
|
||||
def setUp(self):
|
||||
# patch for low-level ConfigObj for entire test class
|
||||
# result - each test_* method will get one additional
|
||||
# argument during testing
|
||||
self.config_module_mock_patcher = mock.patch('headphones.config.ConfigObj', name='ConfigObjModuleMock')
|
||||
self.config_module_mock = self.config_module_mock_patcher.start()
|
||||
|
||||
existing_sections = {'General': {}, 'Email': {}}
|
||||
# every constructor `xx = ConfigObj()` in headphones.config will return
|
||||
# this mock:
|
||||
self._setUpConfigMock(MagicMock(), existing_sections)
|
||||
|
||||
def tearDown(self):
|
||||
self.config_module_mock_patcher.stop()
|
||||
|
||||
def test_constructor(self):
|
||||
""" Config : creating """
|
||||
|
||||
cf = headphones.config.Config('/tmp/notexist')
|
||||
self.assertIsInstance(cf, headphones.config.Config)
|
||||
|
||||
@TestArgs(
|
||||
# this sections are explicitly added in the test body:
|
||||
('General', False),
|
||||
('Email', False),
|
||||
|
||||
# this sections will not be created nor in the test, either in the
|
||||
# Config module
|
||||
('some_new_section_never_defined', True),
|
||||
('another_new_section_never_defined', True),
|
||||
)
|
||||
def test_check_section(self, section_name, expected_return):
|
||||
""" Config : check_section """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.check_section(section_name)
|
||||
res2 = c.check_section(section_name)
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(res, expected_return)
|
||||
self.assertFalse(res2)
|
||||
|
||||
@TestArgs(
|
||||
('api_enabled', 0, int),
|
||||
('Api_Key', '', str),
|
||||
)
|
||||
def test_check_setting(self, setting_name, expected_return, expected_instance):
|
||||
""" Config: check_setting , basic cases """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.check_setting(setting_name)
|
||||
res2 = c.check_setting(setting_name)
|
||||
|
||||
# assertions:
|
||||
self.assertIsInstance(res, expected_instance)
|
||||
self.assertEqual(res, expected_return)
|
||||
self.assertEqual(res, res2)
|
||||
|
||||
@TestArgs(
|
||||
(''),
|
||||
('This_IsNew_Name'),
|
||||
)
|
||||
def test_check_setting_raise_on_unknown_settings(self, setting_name):
|
||||
""" Config: check_setting should raise on unknown """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
exc_regex = re.compile(setting_name, re.IGNORECASE)
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
# assertions:
|
||||
with self.assertRaisesRegexp(KeyError, exc_regex):
|
||||
c.check_setting(setting_name)
|
||||
pass
|
||||
|
||||
@TestArgs(
|
||||
(None)
|
||||
)
|
||||
def test_check_setting_raise_on_none(self, setting_name):
|
||||
""" Config: check_setting shoud raise on None name """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
# assertions:
|
||||
with self.assertRaises(AttributeError):
|
||||
c.check_setting(setting_name)
|
||||
pass
|
||||
|
||||
def test_write(self):
|
||||
""" Config : write """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# overload mocks, defined in setUp:
|
||||
old_conf_mock = self._setUpConfigMock(MagicMock(), {'a': {}})
|
||||
|
||||
option_name_not_from_definitions = 'some_invalid_option_with_super_uniq1_name'
|
||||
option_name_not_from_definitions_value = 1
|
||||
old_conf_mock['asdf'] = {option_name_not_from_definitions: option_name_not_from_definitions_value}
|
||||
|
||||
# call methods
|
||||
cf = headphones.config.Config(path)
|
||||
|
||||
# overload mock-patching for NEW CONFIG
|
||||
new_patcher = mock.patch('headphones.config.ConfigObj', name='NEW_ConfigObjModuleMock_FOR_WRITE')
|
||||
|
||||
new_conf_module_mock = new_patcher.start()
|
||||
new_conf_mock = \
|
||||
new_conf_module_mock.return_value = \
|
||||
MagicMock()
|
||||
cf.write()
|
||||
new_patcher.stop()
|
||||
|
||||
# assertions:
|
||||
self.assertFalse(old_conf_mock.write.called, 'write not called for old config')
|
||||
self.assertTrue(new_conf_mock.write.called, 'write called for new config')
|
||||
self.assertEqual(new_conf_mock.filename, path)
|
||||
|
||||
new_conf_mock['General'].__setitem__.assert_any_call('download_dir', '')
|
||||
# from 3.5... new_conf_mock['asdf'].__setitem__.assert_not_called('download_dir', '')
|
||||
new_conf_mock['asdf'].__setitem__.assert_any_call(option_name_not_from_definitions, option_name_not_from_definitions_value)
|
||||
|
||||
@unittestcompat.skip("process_kwargs should be removed")
|
||||
def test_process_kwargs(self):
|
||||
self.assertTrue(True)
|
||||
|
||||
# ===========================================================
|
||||
# GET ATTR
|
||||
# ===========================================================
|
||||
|
||||
@TestArgs(
|
||||
('ADD_ALBUM_ART', True),
|
||||
('ALBUM_ART_FORMAT', 'shmolder'),
|
||||
('API_ENABLED', 1),
|
||||
('API_KEY', 'Hello'),
|
||||
)
|
||||
def test__getattr__ConfValues(self, name, value):
|
||||
""" Config: __getattr__ with setting value explicit """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
self.config_mock["General"] = {name.lower(): value}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
act = c.__getattr__(name)
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(act, value)
|
||||
|
||||
@TestArgs(
|
||||
('ADD_ALBUM_ART', 0),
|
||||
('ALBUM_ART_FORMAT', 'folder'),
|
||||
('API_ENABLED', 0),
|
||||
('API_KEY', ''),
|
||||
)
|
||||
def test__getattr__ConfValuesDefault(self, name, value):
|
||||
""" Config: __getattr__ from config(by braces), default values """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.__getattr__(name)
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(res, value)
|
||||
|
||||
def test__getattr__ConfValuesDefaultUsingDotNotation(self):
|
||||
""" Config: __getattr__ from config (by dot), default values """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(c.ALBUM_ART_FORMAT, 'folder')
|
||||
self.assertEqual(c.API_ENABLED, 0)
|
||||
self.assertEqual(c.API_KEY, '')
|
||||
|
||||
def test__getattr__OwnAttributes(self):
|
||||
""" Config: __getattr__ access own attrs """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
|
||||
# assertions:
|
||||
self.assertIsNotNone(c)
|
||||
self.assertIn('<headphones.config.Config', c.__str__())
|
||||
|
||||
# ===========================================================
|
||||
# SET ATTR
|
||||
# ===========================================================
|
||||
|
||||
@TestArgs(
|
||||
('ADD_ALBUM_ART', True),
|
||||
('ALBUM_ART_FORMAT', 'shmolder'),
|
||||
('API_ENABLED', 1),
|
||||
('API_KEY', 'Hello'),
|
||||
)
|
||||
def test__setattr__ConfValuesDefault(self, name, value):
|
||||
""" Config: __setattr__ with setting value explicit """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
act = c.__setattr__(name, value)
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(self.config_mock["General"][name.lower()], value)
|
||||
self.assertEqual(act, value)
|
||||
|
||||
def test__setattr__ExplicitSetUsingDotNotation(self):
|
||||
""" Config: __setattr__ with setting values using dot notation """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
act1 = c.ALBUM_ART_FORMAT = 'Apple'
|
||||
act2 = c.API_ENABLED = True
|
||||
act3 = c.API_KEY = 123
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(self.config_mock["General"]['album_art_format'], 'Apple')
|
||||
self.assertEqual(self.config_mock["General"]['api_enabled'], 1)
|
||||
self.assertEqual(self.config_mock["General"]['api_key'], '123')
|
||||
|
||||
self.assertEqual(act1, 'Apple')
|
||||
self.assertEqual(act2, 1)
|
||||
|
||||
# TODO : check this trange behaviour. I have expected to see here '123', not 123.
|
||||
self.assertEqual(act3, 123)
|
||||
|
||||
# ===========================================================
|
||||
# NEWZNABS
|
||||
#
|
||||
|
||||
@TestArgs(
|
||||
('', []),
|
||||
('ABCDEF', [('A', 'B', 'C'), ('D', 'E', 'F')]),
|
||||
(['ABC', 'DEF'], []),
|
||||
([1], []),
|
||||
([1, 2], []),
|
||||
([1, 2, 3], [(1, 2, 3)]),
|
||||
|
||||
([1, 2, 3, 'Aaa'], [(1, 2, 3)]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba'], [(1, 2, 3)]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba', 'Ccccc'], [(1, 2, 3), ('Aaa', 'Bbba', 'Ccccc')]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba', 'Ccccc', 'Ddddda'], [(1, 2, 3), ('Aaa', 'Bbba', 'Ccccc')]),
|
||||
)
|
||||
def test_get_extra_newznabs(self, conf_value, expected):
|
||||
""" Config: get_extra_newznabs """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
#itertools.izip(*[itertools.islice('', i, None, 3) for i in range(3)])
|
||||
# set up mocks:
|
||||
# 'EXTRA_NEWZNABS': (list, 'Newznab', ''),
|
||||
# 'EXTRA_TORZNABS': (list, 'Torznab', ''),
|
||||
self.config_mock["Newznab"] = {"extra_newznabs": conf_value}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.get_extra_newznabs()
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(res, expected)
|
||||
|
||||
def test_clear_extra_newznabs(self):
|
||||
""" Config: clear_extra_newznabs """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
random_value = 1827746
|
||||
self.config_mock["Newznab"] = {"extra_newznabs": [1, 2, 3]}
|
||||
self.config_mock["Newznab"] = {"do_not_touch": random_value}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.clear_extra_newznabs()
|
||||
|
||||
# assertions:
|
||||
self.assertIsNone(res)
|
||||
self.assertEqual(self.config_mock["Newznab"]["extra_newznabs"], [])
|
||||
self.assertEqual(self.config_mock["Newznab"]["do_not_touch"], random_value)
|
||||
|
||||
@TestArgs(
|
||||
([], [''], ['']),
|
||||
([], 'ABCDEF', ['A', 'B', 'C', 'D', 'E', 'F']),
|
||||
|
||||
([1, 2, [False, True]], ['3', [0, 0]], [1, 2, [False, True], '3', [0, 0]]),
|
||||
)
|
||||
def test_add_extra_newznab(self, initial, added, expected):
|
||||
""" Config: add_extra_newznab """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
self.config_mock["Newznab"] = {"extra_newznabs": initial}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
c.add_extra_newznab(added)
|
||||
act = self.config_mock["Newznab"]["extra_newznabs"]
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(act, expected)
|
||||
|
||||
@TestArgs(
|
||||
(None),
|
||||
([]),
|
||||
([1, 2, 3]),
|
||||
([True]),
|
||||
)
|
||||
def test_add_extra_newznab_raise_on_none(self, initial):
|
||||
""" Config: add_extra_newznab should raise on None adding"""
|
||||
path = '/tmp/notexist'
|
||||
|
||||
self.config_mock["Newznab"] = {"extra_newznabs": initial}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
with self.assertRaises(TypeError):
|
||||
c.add_extra_newznab(None)
|
||||
pass
|
||||
|
||||
# ===========================================================
|
||||
# TORZNABS
|
||||
# TODO : here is copypaste from of NEZNABS tests. Make tests better, plz refactor them
|
||||
#
|
||||
@TestArgs(
|
||||
('', []),
|
||||
('ABCDEF', [('A', 'B', 'C'), ('D', 'E', 'F')]),
|
||||
(['ABC', 'DEF'], []),
|
||||
([1], []),
|
||||
([1, 2], []),
|
||||
([1, 2, 3], [(1, 2, 3)]),
|
||||
|
||||
([1, 2, 3, 'Aaa'], [(1, 2, 3)]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba'], [(1, 2, 3)]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba', 'Ccccc'], [(1, 2, 3), ('Aaa', 'Bbba', 'Ccccc')]),
|
||||
([1, 2, 3, 'Aaa', 'Bbba', 'Ccccc', 'Ddddda'], [(1, 2, 3), ('Aaa', 'Bbba', 'Ccccc')]),
|
||||
)
|
||||
def test_get_extra_torznabs(self, conf_value, expected):
|
||||
""" Config: get_extra_torznabs """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
#itertools.izip(*[itertools.islice('', i, None, 3) for i in range(3)])
|
||||
# set up mocks:
|
||||
# 'EXTRA_TORZNABS': (list, '', ''),
|
||||
self.config_mock["Torznab"] = {"extra_torznabs": conf_value}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.get_extra_torznabs()
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(res, expected)
|
||||
|
||||
def test_clear_extra_torznabs(self):
|
||||
""" Config: clear_extra_torznabs """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
random_value = -1292721
|
||||
self.config_mock["Torznab"] = {"extra_torznabs": [1, 2, 3]}
|
||||
self.config_mock["Torznab"] = {"do_not_touch": random_value}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
res = c.clear_extra_torznabs()
|
||||
|
||||
# assertions:
|
||||
self.assertIsNone(res)
|
||||
self.assertEqual(self.config_mock["Torznab"]["extra_torznabs"], [])
|
||||
self.assertEqual(self.config_mock["Torznab"]["do_not_touch"], random_value)
|
||||
|
||||
@TestArgs(
|
||||
([], [''], ['']),
|
||||
([], 'ABCDEF', ['A', 'B', 'C', 'D', 'E', 'F']),
|
||||
|
||||
([1, 2, [False, True]], ['3', [0, 0]], [1, 2, [False, True], '3', [0, 0]]),
|
||||
)
|
||||
def test_add_extra_torznab(self, initial, added, expected):
|
||||
""" Config: add_extra_torznab """
|
||||
path = '/tmp/notexist'
|
||||
|
||||
self.config_mock["Torznab"] = {"extra_torznabs": initial}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
c.add_extra_torznab(added)
|
||||
act = self.config_mock["Torznab"]["extra_torznabs"]
|
||||
|
||||
# assertions:
|
||||
self.assertEqual(act, expected)
|
||||
|
||||
@TestArgs(
|
||||
(None),
|
||||
([]),
|
||||
([1, 2, 3]),
|
||||
([True]),
|
||||
)
|
||||
def test_add_extra_torznab_raise_on_none(self, initial):
|
||||
""" Config: add_extra_torznab should raise on None adding"""
|
||||
path = '/tmp/notexist'
|
||||
|
||||
self.config_mock["Torznab"] = {"extra_torznabs": initial}
|
||||
|
||||
# call methods
|
||||
c = headphones.config.Config(path)
|
||||
with self.assertRaises(TypeError):
|
||||
c.add_extra_torznab(None)
|
||||
pass
|
||||
113
lib/unittestcompat.py
Normal file
113
lib/unittestcompat.py
Normal file
@@ -0,0 +1,113 @@
|
||||
import sys
|
||||
if sys.version_info < (2, 7):
|
||||
import unittest2 as unittest
|
||||
from unittest2 import TestCase as TC
|
||||
else:
|
||||
import unittest
|
||||
from unittest import TestCase as TC
|
||||
|
||||
skip = unittest.skip
|
||||
|
||||
_dummy = False
|
||||
|
||||
# less than 2.6 ...
|
||||
if sys.version_info[0] == 2 and sys.version_info[1] <= 6:
|
||||
_dummy = True
|
||||
|
||||
def _d(f):
|
||||
def decorate(self, *args, **kw):
|
||||
if not _dummy:
|
||||
return f(self, *args, **kw)
|
||||
return self.assertTrue(True)
|
||||
return decorate
|
||||
|
||||
|
||||
class TestCase(TC):
|
||||
"""
|
||||
Wrapper for python 2.6 stubs
|
||||
"""
|
||||
|
||||
def assertIsInstance(self, obj, cls, msg=None):
|
||||
if not _dummy:
|
||||
return super(TestCase, self).assertIsInstance(obj, cls, msg)
|
||||
tst = isinstance(obj, cls)
|
||||
return self.assertTrue(tst, msg)
|
||||
|
||||
@_d
|
||||
def assertNotIsInstance(self, *args, **kw):
|
||||
return super(TestCase, self).assertNotIsInstance(*args, **kw)
|
||||
|
||||
@_d
|
||||
def assertIn(self, *args, **kw):
|
||||
return super(TestCase, self).assertIn(*args, **kw)
|
||||
|
||||
@_d
|
||||
def assertRegexpMatches(self, *args, **kw):
|
||||
return super(TestCase, self).assertRegexpMatches(*args, **kw)
|
||||
|
||||
# -----------------------------------------------------------
|
||||
# NOT DUMMY ASSERTIONS
|
||||
# -----------------------------------------------------------
|
||||
def assertIsNone(self, val, msg=None):
|
||||
if not _dummy:
|
||||
return super(TestCase, self).assertIsNone(val, msg)
|
||||
tst = val is None
|
||||
return super(TestCase, self).assertTrue(tst, msg)
|
||||
|
||||
def assertIsNotNone(self, val, msg=None):
|
||||
if not _dummy:
|
||||
return super(TestCase, self).assertIsNotNone(val, msg)
|
||||
tst = val is not None
|
||||
return super(TestCase, self).assertTrue(tst, msg)
|
||||
|
||||
def assertRaises(self, exc, msg=None):
|
||||
if not _dummy:
|
||||
return super(TestCase, self).assertRaises(exc, msg)
|
||||
return TestCase._TestCaseRaiseStub(self, exc, msg=msg)
|
||||
|
||||
def assertRaisesRegexp(self, exc, regex, msg=None):
|
||||
if not _dummy:
|
||||
return super(TestCase, self).assertRaises(exc, msg)
|
||||
return TestCase._TestCaseRaiseStub(self, exc, regex=regex, msg=msg)
|
||||
|
||||
class _TestCaseRaiseStub:
|
||||
""" Internal stuff for stubbing `assertRaises*` """
|
||||
|
||||
def __init__(self, test_case, exc, regex=None, msg=None):
|
||||
self.exc = exc
|
||||
self.test_case = test_case
|
||||
self.regex = regex
|
||||
self.msg = msg
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, tp, value, traceback):
|
||||
tst = tp is self.exc
|
||||
self.test_case.assertTrue(tst, msg=self.msg)
|
||||
self.exception = value
|
||||
|
||||
# TODO: implement self.regex checking
|
||||
|
||||
# True indicates, that exception is handled
|
||||
return True
|
||||
|
||||
def TestArgs(*parameters):
|
||||
def tuplify(x):
|
||||
if not isinstance(x, tuple):
|
||||
return (x,)
|
||||
return x
|
||||
|
||||
def decorator(method, parameters=parameters):
|
||||
for parameter in (tuplify(x) for x in parameters):
|
||||
|
||||
def method_for_parameter(self, method=method, parameter=parameter):
|
||||
method(self, *parameter)
|
||||
args_for_parameter = ",".join(repr(v) for v in parameter)
|
||||
name_for_parameter = method.__name__ + "(" + args_for_parameter + ")"
|
||||
frame = sys._getframe(1) # pylint: disable-msg=W0212
|
||||
frame.f_locals[name_for_parameter] = method_for_parameter
|
||||
frame.f_locals[name_for_parameter].__doc__ = method.__doc__ + '(' + args_for_parameter + ')'
|
||||
method_for_parameter.__name__ = name_for_parameter + '(' + args_for_parameter + ')'
|
||||
return None
|
||||
return decorator
|
||||
Reference in New Issue
Block a user