avast/pytest-docker được TopGit xếp vào nhóm dự án mã nguồn mở, với 489 sao trên GitHub, viết chủ yếu bằng Python. Docker-based integration tests
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Simple pytest fixtures that help you write integration
tests with Docker and Docker Compose.
Specify all necessary containers in a docker-compose.yml file and
pytest-docker will spin them up for the duration of your tests.
pytest-docker was originally created by André Caron.
Installation
Install pytest-docker with pip or add it to your test requirements.
By default, it uses the docker compose command, so it relies on the Compose plugin for Docker (also called Docker Compose V2).
Docker Compose V1 compatibility
If you want to use the old docker-compose command (deprecated since July 2023, not receiving updates since 2021)
then you can do it using the docker-compose-command fixture:
import pytest
import requests
from requests.exceptions import ConnectionError
def is_responsive(url):
try:
response = requests.get(url)
if response.status_code == 200:
return True
except ConnectionError:
return False
@pytest.fixture(scope="session")
def http_service(docker_ip, docker_services):
"""Ensure that HTTP service is up and responsive."""
# `port_for` takes a container port and returns the corresponding host port
port = docker_services.port_for("httpbin", 80)
url = "http://{}:{}".format(docker_ip, port)
docker_services.wait_until_responsive(
timeout=30.0, pause=0.1, check=lambda: is_responsive(url)
)
return url
def test_status_code(http_service):
status = 418
response = requests.get(http_service + "/status/{}".format(status))
assert response.status_code == status
The default docker_setup command includes --wait, which respects either the
image HEALTHCHECK or the compose healthcheck. Generally, if those
are configured properly, wait_until_responsive should not be required.
By default, this plugin will try to open docker-compose.yml in your
tests directory. If you need to use a custom location, override the
docker_compose_file fixture inside your conftest.py file:
If you want to debug the test suite in your IDE (Pycharm, VsCode, etc.) and need to stop the test, the stack will be left running.
To avoid creating multiple stacks, you can pin the project name and always teardown before starting a new stack:
import pytest
# Pin the project name to avoid creating multiple stacks
@pytest.fixture(scope="session")
def docker_compose_project_name() -> str:
return "my-compose-project"
# Stop the stack before starting a new one
@pytest.fixture(scope="session")
def docker_setup():
return ["down -v", "up --build --wait"]
Available fixtures
By default, the scope of the fixtures are session but can be changed with
pytest command line option --container-scope <scope>:
pytest --container-scope <scope> <test_directory>
For available scopes and descriptions
see https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes
docker_ip
Determine the IP address for TCP connections to Docker containers.
docker_compose_file
Get an absolute path to the docker-compose.yml file. Override this fixture in
your tests if you need a custom location.
docker_compose_project_name
Generate a project name using the current process PID. Override this fixture in
your tests if you need a particular project name.
docker_services
Start all services from the docker compose file (docker-compose up).
After test are finished, shutdown all services (docker-compose down).
docker_compose_command
Docker Compose command to use to execute Dockers. Default is to use
Docker Compose V2 (command is docker compose). If you want to use
Docker Compose V1, change this fixture to return docker-compose.
docker_setup
Get the list of docker_compose commands to be executed for test spawn actions.
Override this fixture in your tests if you need to change spawn actions.
Returning anything that would evaluate to False will skip this command.
docker_cleanup
Get the list of docker_compose commands to be executed for test clean-up actions.
Override this fixture in your tests if you need to change clean-up actions.
Returning anything that would evaluate to False will skip this command.
Development
Use of a virtual environment is recommended. See the
venv package for more
information.
First, install pytest-docker and its test dependencies:
pip install -e ".[tests]"
Run tests with
pytest -c setup.cfg
to make sure that the correct configuration is used. This is also how tests are
run in CI.
Use black with default settings for
formatting. You can also use pylint with setup.cfg as the configuration
file as well as mypy for type checking.
Contributing
This pytest plug-in and its source code are made available to you under a MIT
license. It is safe to use in commercial and closed-source applications. Read
the license for details!
Found a bug? Think a new feature would make this plug-in more practical? We
welcome issues and pull requests!
When creating a pull request, be sure to follow this projects conventions (see
above).
avast/pytest-docker có 489 sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/avast/pytest-docker. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
avast/pytest-docker có tag gì không?
Bản đồng bộ chưa ghi nhận topic GitHub nào cho avast/pytest-docker. GitHub topics hiển thị ở thanh bên phải trang repo — đó là nơi đáng kiểm tra nhất.
avast/pytest-docker còn đang phát triển không?
Commit gần nhất trên avast/pytest-docker là 1 tháng trước (theo timestamp GitHub). Repo có 78 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
avast/pytest-docker là gì?
avast/pytest-docker (avast/pytest-docker) là dự án Python trên GitHub. Theo mô tả gốc: Docker-based integration tests
avast/pytest-docker viết bằng ngôn ngữ gì?
avast/pytest-docker chủ yếu viết bằng Python. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về pytest-docker?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về pytest-docker.