Additional linting for unit tests

This commit is contained in:
Andrew Morgan 2021-01-10 21:54:22 -05:00
parent 1ed54e8d0f
commit f3f946b784

View file

@ -1,5 +1,6 @@
from typing import Dict
import unittest import unittest
from typing import Dict
from my_project_name.config import Config from my_project_name.config import Config
from my_project_name.errors import ConfigError from my_project_name.errors import ConfigError
@ -14,12 +15,7 @@ class ConfigTestCase(unittest.TestCase):
"""Test that Config._get_cfg works correctly""" """Test that Config._get_cfg works correctly"""
# Here's our test dictionary. Pretend that this was parsed from a YAML config file. # Here's our test dictionary. Pretend that this was parsed from a YAML config file.
test_config_dict = { test_config_dict = {"a_key": 5, "some_key": {"some_other_key": "some_value"}}
"a_key": 5,
"some_key": {
"some_other_key": "some_value"
}
}
# We create a fake config class. This class is needed as _get_cfg pulls config options # We create a fake config class. This class is needed as _get_cfg pulls config options
# from 'self.config_dict'. So, we make a class that has a self.config_dict, and fill it # from 'self.config_dict'. So, we make a class that has a self.config_dict, and fill it
@ -43,7 +39,11 @@ class ConfigTestCase(unittest.TestCase):
# Test that the value provided by the default option is used when a key does not exist # Test that the value provided by the default option is used when a key does not exist
self.assertEqual( self.assertEqual(
Config._get_cfg(fake_cfg, ["a_made_up_key", "this_does_not_exist"], default="The default"), Config._get_cfg(
fake_cfg,
["a_made_up_key", "this_does_not_exist"],
default="The default",
),
"The default", "The default",
) )
@ -55,22 +55,31 @@ class ConfigTestCase(unittest.TestCase):
# Test that keys that do not exist raise a ConfigError when the required argument is True # Test that keys that do not exist raise a ConfigError when the required argument is True
with self.assertRaises(ConfigError): with self.assertRaises(ConfigError):
Config._get_cfg(fake_cfg, ["a_made_up_key", "this_does_not_exist"], required=True) Config._get_cfg(
fake_cfg, ["a_made_up_key", "this_does_not_exist"], required=True
)
# Test that a ConfigError is not returned when a non-existent key is provided and required is False # Test that a ConfigError is not returned when a non-existent key is provided and required is False
self.assertIsNone( self.assertIsNone(
Config._get_cfg(fake_cfg, ["a_made_up_key", "this_does_not_exist"], required=False) Config._get_cfg(
fake_cfg, ["a_made_up_key", "this_does_not_exist"], required=False
)
) )
# Test that default is used for non-existent keys, even if required is True # Test that default is used for non-existent keys, even if required is True
# (Typically one shouldn't use a default with required=True anyways...) # (Typically one shouldn't use a default with required=True anyways...)
self.assertEqual( self.assertEqual(
Config._get_cfg(fake_cfg, ["a_made_up_key", "this_does_not_exist"], default="something", required=True), Config._get_cfg(
fake_cfg,
["a_made_up_key", "this_does_not_exist"],
default="something",
required=True,
),
"something", "something",
) )
# TODO: Test creating a test yaml file, passing the path to Config and _parse_config_values is called correctly # TODO: Test creating a test yaml file, passing the path to Config and _parse_config_values is called correctly
if __name__ == '__main__': if __name__ == "__main__":
unittest.main() unittest.main()