实现CI测试以检查函数参数是否有效的方法？

问题描述

假设我有一个python函数和字典，如下所示：

d = {"a": 1,"b": 2,"c": 3}
def foo(input):
    return d[input]

当我将代码推送到GitHub（大概是通过某种持续集成）时，有没有办法检查所有foo的调用仅使用d的键之一作为{{ 1}}参数，如果有一个带有无效参数的调用，要标记它还是发出警报？

例如：

input

我知道如何在运行时引发异常或foo("a") # no flag foo("d") # flag/alert ，但是我正在寻找CI解决方案以包含在我们的GitHub工作流程中。现在，我们将Travis-CI用于我们的自定义测试和LGTM提供的标准CodeQL测试。我考虑通过LGTM使用自定义CodeQL，但我不太清楚。我可以通过连续集成或第三个集成来实现它。

解决方法

我们在您的wrkDir中，其中pythonFunction.py在其中，您的foo（input），d dict位于其中。在那个wrkDir中创建文件tests.py：

import unittest

class TestPythonFunction(unittest.TestCase):
    # define here all required cases
    ALL_DICT_REQUIREMENTS_ =(
        ('a',1),('b',2),('c',3)
    )

    
    def test_dictFoo(self):
        # pythonFunction reflects to your pythonFunction.py
        from pythonFunction import foo
        # test all required patterns
        for pattern in TestPythonFunction.ALL_DICT_REQUIREMENTS_:
            key = pattern[0]
            value = pattern[1]
            self.assertIs(foo(key),value)
        # test function is raising error if key doesn't exists
        with self.assertRaises((KeyError)):
            foo('nonsenseKey')
    

if __name__ == '__main__':
    unittest.main()
    

在wrkDir中运行

python tests.py

扩展输出：

.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

tests.py的退出代码为0（所有测试均成功），如果某些测试失败，则退出代码为0，因此您可以相应地控制CI任务，

python tests.py && git push || echo "Bad,check tests for error"