guillotinaweb/pytest-docker-fixtures

Introduction

Provide various service pytest fixtures.

Install

pip install pytest-docker-fixtures

Usages

In your conftest.py, add the following:

pytest_plugins = ['pytest_docker_fixtures']

And to use the fixtures:

def test_foobar(redis):
    pass

Available fixtures

PRs welcome!

• cockroach (require to be installed with pip install pytest-docker-fixtures[pg])
• es (elasticsearch)
• etcd
• kafka (require to be installed with pip install pytest-docker-fixtures[kafka])
• memcached (require to be installed with pip install pytest-docker-fixtures[memcached])
• minio
• mysql (require to be installed with pip install pytest-docker-fixtures[mysql])
• pg (require to be installed with pip install pytest-docker-fixtures[pg])
• rabbitmq (require to be installed with pip install pytest-docker-fixtures[rabbitmq])
• redis
• stripe (stripemock)
• emqx
• influxdb

Configuring custom images

You can also configure custom images to use:

from pytest_docker_fixtures import images
images.configure(
    'elasticsearch',
    'docker.elastic.co/elasticsearch/elasticsearch-platinum', '6.2.4',
    env={},
    options={}
)

pytest-docker-fixtures's Issues

Doesn't seem to support kafka-python library version >= 2.0.0

Kafka fixture seems to be supporting kafka-python library version up to 1.4.7 only, not up to the latest version 2.0.2.
There seem to be few changes between kafka-python <=1.4.7 and >= 2.0.0

I can raise a PR to support it.

Running containers privileged by default imposes unnecessary security risk

I've noticed the base image contains the default option to run the containers in privileged mode. That seems totally unnecessary for most use cases and only imposes a security risk, I think.

pytest-docker-fixtures/pytest_docker_fixtures/containers/_base.py

Line 19 in c3a8b39

privileged=True,

Several resources online warn about the risks and suggests to avoid doing this. example

Configuring custom images easily

Dear @vangheem and @masipcat,

for adding Mosquitto (#15), we tried to use the fastpath option to configure custom images [1] first. However, we found these problems when doing it like outlined within [2]:

1. images.configure() will not create a new slot within images.settings, so we added images.settings['mosquitto'] = {} before.
2. After we did that, we found images.configure() will also not honor the options kwarg.
3. An any case, just adding a service definition to images.settings will not be sufficient. We also had to add a minimal image class derived from BaseImage [3] as well as the fixture function itself [4].

While we have been able to work around these issues, we might think about improving this procedure to get closer to DWIM.

With kind regards,
Andreas.

[1] https://github.com/guillotinaweb/pytest-docker-fixtures#configuring-custom-images
[2] https://github.com/hiveeyes/terkin-datalogger/blob/ccaa56d6/test/util/mosquitto.py#L8-L19
[3] https://github.com/hiveeyes/terkin-datalogger/blob/ccaa56d6/test/util/mosquitto.py#L32-L40
[4] https://github.com/hiveeyes/terkin-datalogger/blob/ccaa56d6/test/util/mosquitto.py#L43-L49

Passing configuration properties to kafka image

Dear @vangheem,

I was just looking to set some custom configuration options for Kafka image to run with.
Was trying to understand how and what all config options can I pass to the kafka image while configuring the fixture.

If you could help with any pointers for the same, that will be really helpful. Thanks in advance!

Add Mosquitto service

Dear @vangheem and @masipcat,

first things first: Thanks for conceiving and maintaining this valuable pytest fixture module.

We needed the Mosquitto service for running integration tests against and added a [WIP] at [1]. It should be improved by also integrating the MQTT client library paho-mqtt.

Unless we will be able to submit a pull request, it might serve as a starter for others.

With kind regards,
Andreas.

[1] https://github.com/hiveeyes/terkin-datalogger/blob/ccaa56d6/test/util/mosquitto.py