lbry-sdk/tests/unit/test_conf.py

170 lines
7.1 KiB
Python
Raw Normal View History

2016-11-30 22:12:14 +01:00
import os
2018-06-13 20:04:14 +02:00
import sys
2019-01-20 10:06:55 +01:00
import types
import tempfile
2019-01-20 10:06:55 +01:00
import unittest
import argparse
2019-01-21 21:55:50 +01:00
from lbrynet.conf import Config, BaseConfig, String, Integer, Toggle, Servers, NOT_SET
2019-01-22 21:56:45 +01:00
from lbrynet.error import InvalidCurrencyError
2016-11-30 22:12:14 +01:00
2018-06-13 20:04:14 +02:00
2019-01-21 21:55:50 +01:00
class TestConfig(BaseConfig):
test_str = String('str help', 'the default', previous_names=['old_str'])
test_int = Integer('int help', 9)
test_toggle = Toggle('toggle help', False)
servers = Servers('servers help', [('localhost', 80)])
2019-01-20 10:06:55 +01:00
class ConfigurationTests(unittest.TestCase):
@unittest.skipIf('linux' not in sys.platform, 'skipping linux only test')
def test_linux_defaults(self):
2019-01-21 21:55:50 +01:00
c = Config()
2019-01-20 10:06:55 +01:00
self.assertEqual(c.data_dir, os.path.expanduser('~/.local/share/lbry/lbrynet'))
self.assertEqual(c.wallet_dir, os.path.expanduser('~/.local/share/lbry/lbryum'))
self.assertEqual(c.download_dir, os.path.expanduser('~/Downloads'))
self.assertEqual(c.config, os.path.expanduser('~/.local/share/lbry/lbrynet/daemon_settings.yml'))
2019-01-21 21:55:50 +01:00
self.assertEqual(c.api_connection_url, 'http://localhost:5279/lbryapi')
self.assertEqual(c.log_file_path, os.path.expanduser('~/.local/share/lbry/lbrynet/lbrynet.log'))
2019-01-20 10:06:55 +01:00
def test_search_order(self):
c = TestConfig()
2019-01-21 21:55:50 +01:00
c.runtime = {'test_str': 'runtime'}
c.arguments = {'test_str': 'arguments'}
c.environment = {'test_str': 'environment'}
c.persisted = {'test_str': 'persisted'}
self.assertEqual(c.test_str, 'runtime')
2019-01-20 10:06:55 +01:00
c.runtime = {}
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'arguments')
2019-01-20 10:06:55 +01:00
c.arguments = {}
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'environment')
2019-01-20 10:06:55 +01:00
c.environment = {}
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'persisted')
2019-01-20 10:06:55 +01:00
c.persisted = {}
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'the default')
2019-01-20 10:06:55 +01:00
def test_arguments(self):
parser = argparse.ArgumentParser()
2019-01-21 21:55:50 +01:00
parser.add_argument("--test-str")
args = parser.parse_args(['--test-str', 'blah'])
2019-01-20 10:06:55 +01:00
c = TestConfig.create_from_arguments(args)
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'blah')
2019-01-20 10:06:55 +01:00
c.arguments = {}
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'the default')
2019-01-20 10:06:55 +01:00
def test_environment(self):
c = TestConfig()
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'the default')
c.set_environment({'LBRY_TEST_STR': 'from environ'})
self.assertEqual(c.test_str, 'from environ')
2019-01-20 10:06:55 +01:00
def test_persisted(self):
with tempfile.TemporaryDirectory() as temp_dir:
c = TestConfig.create_from_arguments(
types.SimpleNamespace(config=os.path.join(temp_dir, 'settings.yml'))
)
# settings.yml doesn't exist on file system
self.assertFalse(c.persisted.exists)
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'the default')
2019-01-20 10:06:55 +01:00
self.assertEqual(c.modify_order, [c.runtime])
with c.update_config():
self.assertEqual(c.modify_order, [c.runtime, c.persisted])
2019-01-21 21:55:50 +01:00
c.test_str = 'original'
2019-01-20 10:06:55 +01:00
self.assertEqual(c.modify_order, [c.runtime])
# share_usage_data has been saved to settings file
self.assertTrue(c.persisted.exists)
with open(c.config, 'r') as fd:
2019-01-21 21:55:50 +01:00
self.assertEqual(fd.read(), 'test_str: original\n')
2019-01-20 10:06:55 +01:00
# load the settings file and check share_usage_data is false
c = TestConfig.create_from_arguments(
types.SimpleNamespace(config=os.path.join(temp_dir, 'settings.yml'))
)
self.assertTrue(c.persisted.exists)
2019-01-21 21:55:50 +01:00
self.assertEqual(c.test_str, 'original')
2019-01-20 10:06:55 +01:00
# setting in runtime overrides config
2019-01-21 21:55:50 +01:00
self.assertNotIn('test_str', c.runtime)
c.test_str = 'from runtime'
self.assertIn('test_str', c.runtime)
self.assertEqual(c.test_str, 'from runtime')
# without context manager NOT_SET only clears it in runtime location
c.test_str = NOT_SET
self.assertNotIn('test_str', c.runtime)
self.assertEqual(c.test_str, 'original')
# clear it in persisted as well by using context manager
self.assertIn('test_str', c.persisted)
2019-01-20 10:06:55 +01:00
with c.update_config():
2019-01-21 21:55:50 +01:00
c.test_str = NOT_SET
self.assertNotIn('test_str', c.persisted)
self.assertEqual(c.test_str, 'the default')
2019-01-20 10:06:55 +01:00
with open(c.config, 'r') as fd:
self.assertEqual(fd.read(), '{}\n')
2019-01-21 21:55:50 +01:00
def test_persisted_upgrade(self):
with tempfile.TemporaryDirectory() as temp_dir:
config = os.path.join(temp_dir, 'settings.yml')
with open(config, 'w') as fd:
fd.write('old_str: old stuff\n')
c = TestConfig.create_from_arguments(
types.SimpleNamespace(config=config)
)
self.assertEqual(c.test_str, 'old stuff')
self.assertNotIn('old_str', c.persisted)
with open(config, 'w') as fd:
fd.write('test_str: old stuff\n')
2019-01-20 10:06:55 +01:00
def test_validation(self):
c = TestConfig()
with self.assertRaisesRegex(AssertionError, 'must be a string'):
2019-01-21 21:55:50 +01:00
c.test_str = 9
2019-01-20 10:06:55 +01:00
with self.assertRaisesRegex(AssertionError, 'must be an integer'):
c.test_int = 'hi'
with self.assertRaisesRegex(AssertionError, 'must be a true/false'):
c.test_toggle = 'hi'
def test_file_extension_validation(self):
with self.assertRaisesRegex(AssertionError, "'.json' is not supported"):
TestConfig.create_from_arguments(
types.SimpleNamespace(config=os.path.join('settings.json'))
)
def test_serialize_deserialize(self):
with tempfile.TemporaryDirectory() as temp_dir:
c = TestConfig.create_from_arguments(
types.SimpleNamespace(config=os.path.join(temp_dir, 'settings.yml'))
)
self.assertEqual(c.servers, [('localhost', 80)])
with c.update_config():
c.servers = [('localhost', 8080)]
with open(c.config, 'r+') as fd:
self.assertEqual(fd.read(), 'servers:\n- localhost:8080\n')
fd.write('servers:\n - localhost:5566\n')
c = TestConfig.create_from_arguments(
types.SimpleNamespace(config=os.path.join(temp_dir, 'settings.yml'))
)
self.assertEqual(c.servers, [('localhost', 5566)])
def test_max_key_fee(self):
with tempfile.TemporaryDirectory() as temp_dir:
config = os.path.join(temp_dir, 'settings.yml')
with open(config, 'w') as fd:
2019-01-25 00:45:52 +01:00
fd.write('max_key_fee: {currency: USD, amount: 1}\n')
2019-01-21 21:55:50 +01:00
c = Config.create_from_arguments(
2019-01-20 10:06:55 +01:00
types.SimpleNamespace(config=config)
)
self.assertEqual(c.max_key_fee['currency'], 'USD')
self.assertEqual(c.max_key_fee['amount'], 1)
with self.assertRaises(InvalidCurrencyError):
c.max_key_fee = {'currency': 'BCH', 'amount': 1}
with c.update_config():
c.max_key_fee = {'currency': 'BTC', 'amount': 1}
with open(config, 'r') as fd:
2019-01-25 00:45:52 +01:00
self.assertEqual(fd.read(), 'max_key_fee:\n amount: 1\n currency: BTC\n')