Nicolas Duchon 38ccc42af6 tests: IPv6 issue 5 months ago
..
certs 760c891a0c build: bump library/nginx from 1.27.2 to 1.27.3 6 months ago
requirements fb0fc331c0 tests: minor typos and code style 5 months ago
test_acme-http-challenge-location 69bf2665ec tests: faster tests 5 months ago
test_build eb09876f97 tests: standardize file structure & naming 5 months ago
test_custom 69bf2665ec tests: faster tests 5 months ago
test_custom-error-page 69bf2665ec tests: faster tests 5 months ago
test_debug-endpoint 69bf2665ec tests: faster tests 5 months ago
test_default-host 011e0c19cb tests: refactor for use on Darwin 5 months ago
test_docker-unix-socket 69bf2665ec tests: faster tests 5 months ago
test_dockergen 69bf2665ec tests: faster tests 5 months ago
test_enable-http-on-missing-cert 69bf2665ec tests: faster tests 5 months ago
test_events 69bf2665ec tests: faster tests 5 months ago
test_fallback 69bf2665ec tests: faster tests 5 months ago
test_headers 69bf2665ec tests: faster tests 5 months ago
test_host-network-mode 69bf2665ec tests: faster tests 5 months ago
test_htpasswd 69bf2665ec tests: faster tests 5 months ago
test_http-port 69bf2665ec tests: faster tests 5 months ago
test_http2 011e0c19cb tests: refactor for use on Darwin 5 months ago
test_http3 69bf2665ec tests: faster tests 5 months ago
test_internal 69bf2665ec tests: faster tests 5 months ago
test_ipv6 69bf2665ec tests: faster tests 5 months ago
test_keepalive 69bf2665ec tests: faster tests 5 months ago
test_loadbalancing 69bf2665ec tests: faster tests 5 months ago
test_location-override 69bf2665ec tests: faster tests 5 months ago
test_logs 69bf2665ec tests: faster tests 5 months ago
test_multiple-hosts 69bf2665ec tests: faster tests 5 months ago
test_multiple-networks 69bf2665ec tests: faster tests 5 months ago
test_multiports 69bf2665ec tests: faster tests 5 months ago
test_nominal 69bf2665ec tests: faster tests 5 months ago
test_ports 69bf2665ec tests: faster tests 5 months ago
test_raw-ip-vhost 011e0c19cb tests: refactor for use on Darwin 5 months ago
test_server-down 69bf2665ec tests: faster tests 5 months ago
test_ssl 69bf2665ec tests: faster tests 5 months ago
test_trust-downstream-proxy 011e0c19cb tests: refactor for use on Darwin 5 months ago
test_unreachable-network 69bf2665ec tests: faster tests 5 months ago
test_upstream-name 69bf2665ec tests: faster tests 5 months ago
test_vhost-empty-string 69bf2665ec tests: faster tests 5 months ago
test_vhost-in-multiple-networks 69bf2665ec tests: faster tests 5 months ago
test_virtual-path 69bf2665ec tests: faster tests 5 months ago
test_wildcard-host 69bf2665ec tests: faster tests 5 months ago
README.md 329b69fe76 Update test readme 1 year ago
compose.base.yml 011e0c19cb tests: refactor for use on Darwin 5 months ago
conftest.py 38ccc42af6 tests: IPv6 issue 5 months ago
pytest.ini c338a7cf22 Color terminal output 1 year ago
pytest.sh fb0fc331c0 tests: minor typos and code style 5 months ago

README.md

Nginx proxy test suite

Install requirements

You need Docker Compose v2, python 3.9 and pip installed. Then run the commands:

pip install -r requirements/python-requirements.txt

Prepare the nginx-proxy test image

make build-nginx-proxy-test-debian

or if you want to test the alpine flavor:

make build-nginx-proxy-test-alpine

Run the test suite

pytest

need more verbosity ?

pytest -s

Note: By default this test suite relies on Docker Compose v2 with the command docker compose. It still supports Docker Compose v1 via the DOCKER_COMPOSE environment variable:

DOCKER_COMPOSE=docker-compose pytest

Run one single test module

pytest test_nominal.py

Run the test suite from a Docker container

If you cannot (or don't want to) install pytest and its requirements on your computer. You can use the nginx-proxy-tester docker image to run the test suite from a Docker container.

make test-debian

or if you want to test the alpine flavor:

make test-alpine

Write a test module

This test suite uses pytest. The conftest.py file will be automatically loaded by pytest and will provide you with two useful pytest fixtures:

  • docker_compose
  • nginxproxy

docker_compose fixture

When using the docker_compose fixture in a test, pytest will try to find a yml file named after your test module filename. For instance, if your test module is test_example.py, then the docker_compose fixture will try to load a test_example.yml docker compose file.

Once the docker compose file found, the fixture will remove all containers, run docker compose up, and finally your test will be executed.

The fixture will run the docker compose command with the -f option to load the given compose file. So you can test your docker compose file syntax by running it yourself with:

docker compose -f test_example.yml up -d

In the case you are running pytest from within a docker container, the docker_compose fixture will make sure the container running pytest is attached to all docker networks. That way, your test will be able to reach any of them.

In your tests, you can use the docker_compose variable to query and command the docker daemon as it provides you with a client from the docker python module.

Also this fixture alters the way the python interpreter resolves domain names to IP addresses in the following ways:

Any domain name containing the substring nginx-proxy will resolve to the IP address of the container that was created from the nginxproxy/nginx-proxy:test image. So all the following domain names will resolve to the nginx-proxy container in tests:

  • nginx-proxy
  • nginx-proxy.com
  • www.nginx-proxy.com
  • www.nginx-proxy.test
  • www.nginx-proxy
  • whatever.nginx-proxyooooooo
  • ...

Any domain name ending with XXX.container.docker will resolve to the IP address of the XXX container.

  • web1.container.docker will resolve to the IP address of the web1 container
  • f00.web1.container.docker will resolve to the IP address of the web1 container
  • anything.whatever.web2.container.docker will resolve to the IP address of the web2 container

Otherwise, domain names are resoved as usual using your system DNS resolver.

nginxproxy fixture

The nginxproxy fixture will provide you with a replacement for the python requests module. This replacement will just repeat up to 30 times a requests if it receives the HTTP error 404 or 502. This error occurs when you try to send queries to nginx-proxy too early after the container creation.

Also this requests replacement is preconfigured to use the Certificate Authority root certificate certs/ca-root.crt to validate https connections.

Furthermore, the nginxproxy methods accept an additional keyword parameter: ipv6 which forces requests made against containers to use the containers IPv6 address when set to True. If IPv6 is not supported by the system or docker, that particular test will be skipped.

def test_forwards_to_web1_ipv6(docker_compose, nginxproxy):
    r = nginxproxy.get("http://web1.nginx-proxy.tld/port", ipv6=True)
    assert r.status_code == 200   
    assert r.text == "answer from port 81\n"

The web docker image

When you run the make build-webserver command, you built a web docker image which is convenient for running a small web server in a container. This image can produce containers that listens on multiple ports at the same time.

Testing TLS

If you need to create server certificates, use the certs/create_server_certificate.sh script. Pytest will be able to validate any certificate issued from this script.