From 1af790f01a0ca254277d99dd14917bd8bf284f2d Mon Sep 17 00:00:00 2001 From: Daniel Tomlinson Date: Sat, 23 Oct 2021 21:08:16 +0100 Subject: [PATCH] updating tests --- panaetius/config.py | 1 - tests/data/without_header/config.yml | 9 +++++++++ tests/test_config.py | 30 +++++++++++++++++++++++++--- tests/test_logging.py | 3 +++ 4 files changed, 39 insertions(+), 4 deletions(-) create mode 100644 tests/data/without_header/config.yml diff --git a/panaetius/config.py b/panaetius/config.py index 34fa52a..3677acf 100644 --- a/panaetius/config.py +++ b/panaetius/config.py @@ -40,7 +40,6 @@ class Config: Examples: `config_path` defaults to None on initialisation but will be set to `~/.config`. - Example: A header of `data_analysis` with a config_path of `~/myapps` will define a config file in `~/myapps/data_analysis/config.yml`. """ diff --git a/tests/data/without_header/config.yml b/tests/data/without_header/config.yml new file mode 100644 index 0000000..377f992 --- /dev/null +++ b/tests/data/without_header/config.yml @@ -0,0 +1,9 @@ +panaetius_testing: + some_top_string: some_top_value + second: + some_second_string: some_second_value + some_second_int: 1 + some_second_float: 1.0 + some_second_list: ["some", "second", "value"] + some_second_table: { "first": ["some", "first", "value"] } + some_second_table_bools: { "bool": [true, false] } diff --git a/tests/test_config.py b/tests/test_config.py index 3137e22..21b282c 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -29,6 +29,17 @@ def test_user_config_path_set(header, shared_datadir): assert str(config.config_path) == config_path +def test_user_config_path_without_header_dir_set(header, shared_datadir): + # arrange + config_path = str(shared_datadir / "without_header") + + # act + config = panaetius.Config(header, config_path, skip_header_init=True) + + # assert + assert str(config.config_path) == config_path + + # test config files @@ -44,6 +55,18 @@ def test_config_file_exists(header, shared_datadir): assert config._missing_config is False +def test_config_file_without_header_dir_exists(header, shared_datadir): + # arrange + config_path = str(shared_datadir / "without_header") + + # act + config = panaetius.Config(header, config_path, skip_header_init=True) + _ = config.config + + # assert + assert config._missing_config is False + + def test_config_file_contents_read_success( header, shared_datadir, testing_config_contents ): @@ -106,7 +129,7 @@ def test_get_value_from_key( def test_get_value_environment_var_override(header, shared_datadir): # arrange - os.environ[f"{header.upper()}_SOME_TOP_STRING"] = '"some_overridden_value"' + os.environ[f"{header.upper()}_SOME_TOP_STRING"] = "some_overridden_value" config_path = str(shared_datadir / "without_logging") config = panaetius.Config(header, config_path) panaetius.set_config(config, "some_top_string") @@ -158,7 +181,7 @@ def test_get_value_missing_key_from_default(header, shared_datadir): def test_get_value_missing_key_from_env(header, shared_datadir): # arrange - os.environ[f"{header.upper()}_MISSING_KEY"] = '"some missing key"' + os.environ[f"{header.upper()}_MISSING_KEY"] = "some missing key" config_path = str(shared_datadir / "without_logging") config = panaetius.Config(header, config_path) @@ -205,7 +228,7 @@ def test_missing_config_read_from_default(header, shared_datadir): @pytest.mark.parametrize( "env_value,expected_value", [ - ('"a missing string"', "a missing string"), + ("a missing string", "a missing string"), ("1", 1), ("1.0", 1.0), ("True", True), @@ -237,6 +260,7 @@ def test_missing_config_read_from_env_var( del os.environ[f"{header.upper()}_MISSING_KEY_READ_FROM_ENV_VAR"] +@pytest.mark.skip(reason="No longer needed as strings are loaded without quotes") def test_missing_config_read_from_env_var_invalid_python(header): # arrange os.environ[f"{header.upper()}_INVALID_PYTHON"] = "a string without quotes" diff --git a/tests/test_logging.py b/tests/test_logging.py index b1344ff..46ccc78 100644 --- a/tests/test_logging.py +++ b/tests/test_logging.py @@ -21,6 +21,7 @@ def test_logging_directory_does_not_exist(header, shared_datadir): assert str(logging_exception.value) == "" +# TODO: change this test so it asserts the dir exists def test_logging_directory_does_exist(header, shared_datadir): # arrange config = Config(header) @@ -32,3 +33,5 @@ def test_logging_directory_does_exist(header, shared_datadir): # assert assert isinstance(logger, logging.Logger) + +# TODO: add tests to check that SimpleLogger, AdvancedLogger, CustomLogger work as intended