pytest运行测试用例报fixture 'a' not found错误如何解决

问题复现 #

编写的pytest测试用例代码如下：

import pytest


@pytest.fixture()
def my_fixture():
    print('begin')
    print('#####################################')


class TestA():

    # @pytest.mark.usefixtures('my_fixture')
    def test_a(self, my_fixture, a):
        print("{}".format(a))


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

运行时抛出的错误信息：

E       fixture 'a' not found
>       available fixtures: cache, capfd, capfdbinary, caplog, capsys, capsysbinary, doctest_namespace, extra, include_metadata_in_junit_xml, login_and_exit, metadata, monkeypatch, my_fixture, pytestconfig, record_property, record_testsuite_property, record_xml_attribute, recwarn, tmp_path, tmp_path_factory, tmpdir, tmpdir_factory
>       use 'pytest --fixtures [testpath]' for help on them.

错误产生原因 #

pytest核心运行规则：测试方法参数列表中所有未显式赋值的参数，都会被pytest识别为需要自动注入的fixture。
当前test_a方法参数中声明了a，但pytest在内置fixture、当前文件自定义fixture、全局生效fixture列表中都找不到名为a的fixture定义，因此抛出该错误。从报错打印的可用fixture列表也能验证：自定义的my_fixture已被正常识别，但列表中不存在a。

通用排查方法 #

遇到fixture xxx not found类错误，按以下步骤排查即可：

• 先看报错里列出的available fixtures列表，确认你要使用的fixture名称是否在列表中
• 检查测试方法的参数列表，有没有手误打错fixture名称、有没有把普通变量误写到参数列表里
• 如果是自定义fixture，检查fixture有没有加@pytest.fixture()装饰器、fixture的作用域是否覆盖当前测试用例、fixture名称和参数里写的是否完全一致
• 如果是跨文件调用的fixture，检查fixture所在文件是否符合pytest的文件命名规则、有没有在conftest.py里正确定义，没有被作用域限制

对应解决方案 #

根据实际使用场景选择对应方案即可：

• 如果a是测试方法内部使用的普通变量：直接把a从test_a的参数列表里删掉，在方法内部定义赋值

  def test_a(self, my_fixture):
      a = "目标测试值"
      print("{}".format(a))
  

• 如果a是需要pytest注入的自定义fixture：补充定义名为a的fixture即可

  @pytest.fixture()
  def a():
      return "fixture a的返回值"
  
  def test_a(self, my_fixture, a):
      print("{}".format(a))
  

• 如果a是测试用例的入参：用@pytest.mark.parametrize装饰器定义参数a的取值，pytest会自动识别参数化配置，不会把它当成未定义的fixture

  @pytest.mark.parametrize('a', ['测试参数值'])
  def test_a(self, my_fixture, a):
      print("{}".format(a))
  

内容的提问来源于stack exchange，提问作者gaoHang