lovely-pytest-docker 0.1.0

与pytest一起使用

docker compose文件应该包含所有需要的容器和端口 应该暴露出来。在下面的示例中，我们希望启动应用程序进行测试 以及一个sql数据库（crate）。假设应用程序有一个Dockerfile。 在与Docker相同的文件夹中编写文件：

version: "3"
services:
  app:
    build: .
    ports:
      - "8080"
    depends_on:
      - "crate"

  crate:
    image: crate:latest
    ports:
      - "4200"

在conftest.py文件中，我们可以为每个服务声明docker fixture 我们希望能够在测试中开始：

import pytest

@pytest.fixture(scope='session')
def docker_app(docker_services):
    docker_services.start('app')
    public_port = docker_services.wait_for_service("app", 8080)
    url = "http://{docker_services.docker_ip}:{public_port}".format(**locals())
    return url

@pytest.fixture(scope='session')
def docker_crate(docker_services):
    docker_services.start('crate')
    public_port = docker_services.wait_for_service("crate", 4200)
    dsn = "{docker_services.docker_ip}:{public_port}".format(**locals())
    return dsn

默认情况下，fixture将在 tests位于pytest.ini所在路径的子文件夹（或项目的 如果没有给定ini文件，则为根目录（如测试示例中所示）。在许多 您将要覆盖Docker撰写文件的位置的案例。只是 覆盖conftest.py文件中的docker_compose_files设备：

@pytest.fixture(scope='session')
def docker_compose_files(pytestconfig):
    """Get the docker-compose.yml absolute path.
    Override this fixture in your tests if you need a custom location.
    """
    return [
        project_path('docker', 'docker-compose.yml'),
    ]

在测试文件中声明要使用的设备：

def test_something(docker_app, docker_crate):
    # e.g. initialize database
    ...
    # test something (e.g. request to docker_app)
    ...

工作配置和测试示例可以在tests文件夹中找到 这个包裹的。

在Docker容器中执行

可以在其中一个Docker容器中执行命令。使用 docker_servicesfixture的exec方法：

def test_exec(docker_services):
    # the first argument is the service name of the compose file,
    # the following arguments build the command to run
    res = docker_services.exec('crate', 'ls', '-a')

等待服务

服务模块的wait_for_service方法检查 Docker服务真的启动了。默认情况下，它向 服务器的/终结点。服务将重试检查，直到超时 30秒过去了。

def custom_service_checker(ip_address, port):
    # if service is ready
    return True
    # otherwise return False

@pytest.fixture(scope='session')
def docker_custom_service(docker_services):
    docker_services.start('custom_service')
    public_port = docker_services.wait_for_service(
        "app",
        8080,
        check_service=custom_service_checker
    )
    url = "http://{docker_services.docker_ip}:{public_port}".format(**locals())
    return url

运行测试

测试保存在tests目录中。运行测试通过 pytest包，带有：

./gradlew pytest