在测试用例成功后删除 py.test tmpdir 目录

Question

我正在运行在执行过程中创建大量大文件的测试。为此，如果测试通过，我想删除 tmpdir 目录。但是，如果测试失败，则 tmpdir 的内容应保持不变。

我知道如何确定测试结果：

from _pytest.runner import runtestprotocol
def pytest_runtest_protocol(item, nextitem):
    reports = runtestprotocol(item, nextitem=nextitem)
    for report in reports:
        if report.when == 'call':
            # value will be set to passed or filed
            test_outcome = report.outcome
            # But what next?
return True

但我不知道如何找出创建的 tmpdir 目录的路径。

Answer 1

你应该创建一个 tmpdir 灯具来创建 tempdir，将其传递到你的代码中，然后删除它。

此外，必须将灯具设置为始终删除临时设置，即使在失败时也是如此。否则，您可能会留下不干净状态，这可能会导致其他测试失败（用户没有注意到）。

相反，我推荐

1. 使用--pdb在出错时放入 Python 调试器。灯具尚未清理，您可以检查文件。
2. 创建一个自定义选项，允许您禁用 tmpdir 的清理。
3. 创建一个自定义 tmpdir 灯具，将所有 tmpfile 复制到用户可配置的位置（同样，使用自定义选项），然后清理 tmpdir。

在任何情况下，不干净的 tmpdir 状态都是用户有意识的决定，并将防止意外的副作用。

Answer 2

您可以轻松地从实际物品的funcargs中检索tmpdir。

在您的情况下：

from _pytest.runner import runtestprotocol
def pytest_runtest_protocol(item, nextitem):
    reports = runtestprotocol(item, nextitem=nextitem)
    for report in reports:
        if report.when == 'call':
            # value will be set to passed or filed
            test_outcome = report.outcome
            # depending on test_outcome value, remove tmpdir
            if test_outcome is "OK for you":
               if 'tmpdir' in item.funcargs:
                  tmpdir = item.funcargs['tmpdir'] #retrieve tmpdir
                  if tmpdir.check(): tmpdir.remove()
return True

对于这个故事，item.funcargs 是一个字典，其中包含传递给我们当前正在检查的测试项的 {arguments：value}。所以第一步是检查tmpdir确实是实际测试的参数，然后检索它。并在删除它之前最终检查它的存在。

希望这会有所帮助。

编辑：您的 pytest_runtest_protocol（..） 似乎尚未完全初始化该项目。为了确保它是..

只需覆盖 pytest_runtest_teardown（item），一旦运行完成（成功或失败），它就会作用于每个测试项目。尝试添加这样的方法：

def pytest_runtest_teardown(item):
   if item.rep_call.passed:
      if 'tmpdir' in item.funcargs:
         tmpdir = item.funcargs['tmpdir'] #retrieve tmpdir
         if tmpdir.check(): tmpdir.remove()

当然，不要忘记以下内容（在文档中给出），以便轻松访问您的报告。

@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call,):
    # execute all other hooks to obtain the report object
    outcome = yield
    rep = outcome.get_result()
    # set an report attribute for each phase of a call, which can
    # be "setup", "call", "teardown"
    setattr(item, "rep_" + rep.when, rep)