"Provide an easy way to perform integration testing with docker and python"
Project description
Testcompose
Testcompose - A clean and better way to test your Python containerized applications.
Testcompose provides an easy way of using docker containers for functional and integration testing. It allows for combination of more than one containers and allows for interactions with these containers from your test code without having to write extra scripts for such interactions. I.e providing a docke compose kind of functionality with the extra benefit of being abale to fully control the containers from test codes.
This is inspired by the testcontainers-python project and goes further to add a few additional functionality to imporve software integration testing while allowing the engineer control every aspect of the test.
Install testcompose using pip:
$ pip install testcompose
testcompose requires Python 3.7+.
Using a config file. See the Quickstart for other options
network:
name: some_network_name
auto_create: False
use_random_network: True
services:
- name: db1
image: "postgres:13"
auto_remove: True
command: ""
environment:
POSTGRES_USER: postgres
POSTGRES_DB: postgres
POSTGRES_PASSWORD: a
exposed_ports:
- 5432
volumes:
- host: "data_volume"
container: "/data"
mode: "rw"
source: "docker" # possible values are `docker` or `local`
log_wait_parameters:
log_line_regex: "database system is ready to accept connections"
wait_timeout: 30
poll_interval: 2
Verify it as follows:
from testcompose.parse_config import TestConfigParser
from testcompose.configs.service_config import Config
from testcompose.run_containers import RunContainers
my_test_service = TestConfigParser.parse_config(
file_name='some-file-name'
)
my_config = Config(test_services=my_test_service)
print(my_config.ranked_itest_config_services)
with RunContainers(
services=running_config.ranked_itest_config_services
) as runner:
# Interract with the running containers
assert runner.containers
# Use some special parameters of the running containers
app_container = runner.extra_envs["app_container_config_name"]
# Get the host port a certain exposed container port is mapped to
mapped_port = app_container.get("DOCKER_PYTHON_MAPPED_PORTS", {}).get("port")
# where `port` is the exposed port of the container
Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for testcompose-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4a5738498060221ef35f29e038e2e54586c9581392205c1a3e0f2595f5cd3dc |
|
MD5 | 6d135e6cddcf1fb3e4a5c7fab23cad2c |
|
BLAKE2b-256 | 0efac6e7fb966c7d9f4df01805ec12440c291a72f91ede1af18ff904cfdaf1ec |