pytest-docker-compose 3.2.1

等待服务上线

名为 'scope'_scoped_container_getter 的固定装置将在将控制权交给测试之前等待每个容器启动。

然而，仅仅因为容器已启动，并不意味着其上运行的服务已经准备好接受传入的请求！

如果您的测试需要等待特定条件（例如，等待HTTP健康检查端点返回200响应），请确保您的固定装置考虑到了这一点。

以下是一个名为 wait_for_api 的固定装置示例，它等待HTTP服务上线，然后才能运行名为 test_read_and_write 的测试。

import pytest
import requests
from urllib.parse import urljoin
from urllib3.util.retry import Retry
from requests.adapters import HTTPAdapter

pytest_plugins = ["docker_compose"]

# Invoking this fixture: 'function_scoped_container_getter' starts all services
@pytest.fixture(scope="function")
def wait_for_api(function_scoped_container_getter):
    """Wait for the api from my_api_service to become responsive"""
    request_session = requests.Session()
    retries = Retry(total=5,
                    backoff_factor=0.1,
                    status_forcelist=[500, 502, 503, 504])
    request_session.mount('http://', HTTPAdapter(max_retries=retries))

    service = function_scoped_container_getter.get("my_api_service").network_info[0]
    api_url = "http://%s:%s/" % (service.hostname, service.host_port)
    assert request_session.get(api_url)
    return request_session, api_url


def test_read_and_write(wait_for_api):
    """The Api is now verified good to go and tests can interact with it"""
    request_session, api_url = wait_for_api
    data_string = 'some_data'
    request_session.put('%sitems/2?data_string=%s' % (api_url, data_string))
    item = request_session.get(urljoin(api_url, 'items/2')).json()
    assert item['data'] == data_string
    request_session.delete(urljoin(api_url, 'items/2'))

使用更广泛的固定装置

function_scoped_container_getter 固定装置使用“函数”范围，这意味着在每次单独测试之后，所有容器都会被拆除。

这样做是为了确保每个测试都在“干净”的环境中运行。然而，这可能会使测试套件完成时间非常长。

有两种方法可以使容器在单个测试之后持续存在。最好的方法是用不同范围显式范围化的固定装置。为此有三个额外的固定装置：class_scoped_container_getter、module_scoped_container_getter 和 session_scoped_container_getter。请注意，使用这些时需要小心！有两个主要注意事项需要记住

1. 正确管理您的范围，使用单个文件中的“模块”范围和“函数”范围将引发错误！这是因为模块范围固定装置将启动容器，然后函数范围固定装置将尝试再次启动容器。Docker compose 不允许您启动容器两次。

2. 在每次测试后清理您的环境。因为容器不会被重新启动，所以它们的环境可能会携带来自以前测试的信息。因此，您在设计测试时需要非常小心，以确保测试将容器留在与启动时相同的状态，否则您可能会遇到难以理解的行为。

使容器在单个测试之后持续存在的第二种方法是向pytest提供 –use-running-containers 标志，如下所示

pytest --use-running-containers

使用此标志，pytest-docker-compose会在项目创建过程中检查所有容器是否正在运行。如果它们没有运行，将会显示警告，但仍然会启动它们。然后它们将被用于所有测试，并在之后不会销毁。

此模式最好与“–docker-compose-no-build”标志结合使用，因为新构建的容器本来也不会使用。如下所示：

pytest --docker-compose-no-build --use-running-containers

当然，可以将这些选项添加到pytest.ini文件中。

请注意，对于此模式，固定项的作用域变得不那么重要，因为容器在整个测试过程中都是完全持久的。我只建议在您的网络启动或关闭时间过长时使用此功能。这应该是一个最后的手段，并且您可能需要考虑加快网络速度而不是使用此功能。