我如何对 Configparser 进行单元测试

Question

您好，我有一个简单的配置文件，我们称之为 config.cfg，以及一个使用 configparser 读取文件的函数，传递两个参数，一个用于配置文件路径，另一个用于配置文件的名称部分。

配置文件

[SECTION1]
key1 = value1
key2 = value2
key3 = value3
 

function_to_test

def read_config_file(CFG_PATH, CFG_SECTION):
  try:
     cf = configparser.ConfigParser()
     cf.read(CFG_PATH)
     return cf.[CFG_SECTION].get('key1')
  except KeyError:
     return " "

我想对代码进行单元测试，但我不知道该怎么做，我会在节名和键名正常时为返回的值测试一个 assertequal，并在节名不存在时测试上升 KeyError配置文件。

我可以模拟 CFG_PATH 和 CFG_SECTION 进行隔离，并且不需要读取配置文件。 但我很困惑如何实现返回值和 Keyerror 测试。 这是测试 function 的正确方法还是我错了？ 有人可以帮助我或分享一些代码吗？

顺便说一句，我正在使用 python 3.6

Answer 1

我通常使用集成测试来验证read_config_file类的函数。 集成测试将存储具有已知配置的夹具文件，例如：

   # tests/fixtures/config.has_key.cfg
   [SECTION1]
   key1 = value1
   key2 = value2
   key3 = value3

然后你需要 2 个测试用例来充分练习你的方法：

def test_read_config_file_contains_section(self):
   self.assertEqual(
     'value1',
     read_config_file('tests/fixtures/config.has_key.cfg', 'SECTION1')
   )

def test_read_config_file_missing_section(self):
   with self.assertRaises(KeyError): 
     read_config_file('tests/fixtures/config.has_key.cfg', 'MISSING_SECTION')

---

另一种选择可能是将您的 function 分解为 2 个不同的组件：

• 解析
• 读取配置值

下面的 function 采用已解析的配置文件并尝试检索部分值：

def read_config(cfg, CFG_SECTION):
  try:
     return cfg.[CFG_SECTION].get('key1')
  except KeyError:
     return " "

这种方法对于单元测试来说是微不足道的。