conftest.py 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545
  1. import contextlib
  2. import logging
  3. import os
  4. import re
  5. import shlex
  6. import socket
  7. import subprocess
  8. import time
  9. from typing import List
  10. import backoff
  11. import docker
  12. import pytest
  13. import requests
  14. from _pytest._code.code import ReprExceptionInfo
  15. from distutils.version import LooseVersion
  16. from docker.models.containers import Container
  17. from requests.packages.urllib3.util.connection import HAS_IPV6
  18. logging.basicConfig(level=logging.INFO)
  19. logging.getLogger('backoff').setLevel(logging.INFO)
  20. logging.getLogger('DNS').setLevel(logging.DEBUG)
  21. logging.getLogger('requests.packages.urllib3.connectionpool').setLevel(logging.WARN)
  22. CA_ROOT_CERTIFICATE = os.path.join(os.path.dirname(__file__), 'certs/ca-root.crt')
  23. PYTEST_RUNNING_IN_CONTAINER = os.environ.get('PYTEST_RUNNING_IN_CONTAINER') == "1"
  24. FORCE_CONTAINER_IPV6 = False # ugly global state to consider containers' IPv6 address instead of IPv4
  25. docker_client = docker.from_env()
  26. # Name of pytest container to reference if it's being used for running tests
  27. test_container = 'nginx-proxy-pytest'
  28. ###############################################################################
  29. #
  30. # utilities
  31. #
  32. ###############################################################################
  33. @contextlib.contextmanager
  34. def ipv6(force_ipv6=True):
  35. """
  36. Meant to be used as a context manager to force IPv6 sockets:
  37. with ipv6():
  38. nginxproxy.get("http://something.nginx-proxy.local") # force use of IPv6
  39. with ipv6(False):
  40. nginxproxy.get("http://something.nginx-proxy.local") # legacy behavior
  41. """
  42. global FORCE_CONTAINER_IPV6
  43. FORCE_CONTAINER_IPV6 = force_ipv6
  44. yield
  45. FORCE_CONTAINER_IPV6 = False
  46. class requests_for_docker(object):
  47. """
  48. Proxy for calling methods of the requests module.
  49. When a HTTP response failed due to HTTP Error 404 or 502, retry a few times.
  50. Provides method `get_conf` to extract the nginx-proxy configuration content.
  51. """
  52. def __init__(self):
  53. self.session = requests.Session()
  54. if os.path.isfile(CA_ROOT_CERTIFICATE):
  55. self.session.verify = CA_ROOT_CERTIFICATE
  56. @staticmethod
  57. def get_nginx_proxy_containers() -> List[Container]:
  58. """
  59. Return list of containers
  60. """
  61. nginx_proxy_containers = docker_client.containers.list(filters={"ancestor": "nginxproxy/nginx-proxy:test"})
  62. if len(nginx_proxy_containers) > 1:
  63. pytest.fail("Too many running nginxproxy/nginx-proxy:test containers", pytrace=False)
  64. elif len(nginx_proxy_containers) == 0:
  65. pytest.fail("No running nginxproxy/nginx-proxy:test container", pytrace=False)
  66. return nginx_proxy_containers
  67. def get_conf(self):
  68. """
  69. Return the nginx config file
  70. """
  71. nginx_proxy_containers = self.get_nginx_proxy_containers()
  72. return get_nginx_conf_from_container(nginx_proxy_containers[0])
  73. def get_ip(self) -> str:
  74. """
  75. Return the nginx container ip address
  76. """
  77. nginx_proxy_containers = self.get_nginx_proxy_containers()
  78. return container_ip(nginx_proxy_containers[0])
  79. def get(self, *args, **kwargs):
  80. with ipv6(kwargs.pop('ipv6', False)):
  81. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  82. def _get(*args, **kwargs):
  83. return self.session.get(*args, **kwargs)
  84. return _get(*args, **kwargs)
  85. def post(self, *args, **kwargs):
  86. with ipv6(kwargs.pop('ipv6', False)):
  87. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  88. def _post(*args, **kwargs):
  89. return self.session.post(*args, **kwargs)
  90. return _post(*args, **kwargs)
  91. def put(self, *args, **kwargs):
  92. with ipv6(kwargs.pop('ipv6', False)):
  93. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  94. def _put(*args, **kwargs):
  95. return self.session.put(*args, **kwargs)
  96. return _put(*args, **kwargs)
  97. def head(self, *args, **kwargs):
  98. with ipv6(kwargs.pop('ipv6', False)):
  99. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  100. def _head(*args, **kwargs):
  101. return self.session.head(*args, **kwargs)
  102. return _head(*args, **kwargs)
  103. def delete(self, *args, **kwargs):
  104. with ipv6(kwargs.pop('ipv6', False)):
  105. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  106. def _delete(*args, **kwargs):
  107. return self.session.delete(*args, **kwargs)
  108. return _delete(*args, **kwargs)
  109. def options(self, *args, **kwargs):
  110. with ipv6(kwargs.pop('ipv6', False)):
  111. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  112. def _options(*args, **kwargs):
  113. return self.session.options(*args, **kwargs)
  114. return _options(*args, **kwargs)
  115. def __getattr__(self, name):
  116. return getattr(requests, name)
  117. def container_ip(container: Container):
  118. """
  119. return the IP address of a container.
  120. If the global FORCE_CONTAINER_IPV6 flag is set, return the IPv6 address
  121. """
  122. global FORCE_CONTAINER_IPV6
  123. if FORCE_CONTAINER_IPV6:
  124. if not HAS_IPV6:
  125. pytest.skip("This system does not support IPv6")
  126. ip = container_ipv6(container)
  127. if ip == '':
  128. pytest.skip(f"Container {container.name} has no IPv6 address")
  129. else:
  130. return ip
  131. else:
  132. net_info = container.attrs["NetworkSettings"]["Networks"]
  133. if "bridge" in net_info:
  134. return net_info["bridge"]["IPAddress"]
  135. # not default bridge network, fallback on first network defined
  136. network_name = list(net_info.keys())[0]
  137. return net_info[network_name]["IPAddress"]
  138. def container_ipv6(container):
  139. """
  140. return the IPv6 address of a container.
  141. """
  142. net_info = container.attrs["NetworkSettings"]["Networks"]
  143. if "bridge" in net_info:
  144. return net_info["bridge"]["GlobalIPv6Address"]
  145. # not default bridge network, fallback on first network defined
  146. network_name = list(net_info.keys())[0]
  147. return net_info[network_name]["GlobalIPv6Address"]
  148. def nginx_proxy_dns_resolver(domain_name):
  149. """
  150. if "nginx-proxy" if found in host, return the ip address of the docker container
  151. issued from the docker image nginxproxy/nginx-proxy:test.
  152. :return: IP or None
  153. """
  154. log = logging.getLogger('DNS')
  155. log.debug(f"nginx_proxy_dns_resolver({domain_name!r})")
  156. if 'nginx-proxy' in domain_name:
  157. nginxproxy_containers = docker_client.containers.list(filters={"status": "running", "ancestor": "nginxproxy/nginx-proxy:test"})
  158. if len(nginxproxy_containers) == 0:
  159. log.warn(f"no container found from image nginxproxy/nginx-proxy:test while resolving {domain_name!r}")
  160. exited_nginxproxy_containers = docker_client.containers.list(filters={"status": "exited", "ancestor": "nginxproxy/nginx-proxy:test"})
  161. if len(exited_nginxproxy_containers) > 0:
  162. exited_nginxproxy_container_logs = exited_nginxproxy_containers[0].logs()
  163. log.warn(f"nginxproxy/nginx-proxy:test container might have exited unexpectedly. Container logs: " + "\n" + exited_nginxproxy_container_logs.decode())
  164. return
  165. nginxproxy_container = nginxproxy_containers[0]
  166. ip = container_ip(nginxproxy_container)
  167. log.info(f"resolving domain name {domain_name!r} as IP address {ip} of nginx-proxy container {nginxproxy_container.name}")
  168. return ip
  169. def docker_container_dns_resolver(domain_name):
  170. """
  171. if domain name is of the form "XXX.container.docker" or "anything.XXX.container.docker", return the ip address of the docker container
  172. named XXX.
  173. :return: IP or None
  174. """
  175. log = logging.getLogger('DNS')
  176. log.debug(f"docker_container_dns_resolver({domain_name!r})")
  177. match = re.search(r'(^|.+\.)(?P<container>[^.]+)\.container\.docker$', domain_name)
  178. if not match:
  179. log.debug(f"{domain_name!r} does not match")
  180. return
  181. container_name = match.group('container')
  182. log.debug(f"looking for container {container_name!r}")
  183. try:
  184. container = docker_client.containers.get(container_name)
  185. except docker.errors.NotFound:
  186. log.warn(f"container named {container_name!r} not found while resolving {domain_name!r}")
  187. return
  188. log.debug(f"container {container.name!r} found ({container.short_id})")
  189. ip = container_ip(container)
  190. log.info(f"resolving domain name {domain_name!r} as IP address {ip} of container {container.name}")
  191. return ip
  192. def monkey_patch_urllib_dns_resolver():
  193. """
  194. Alter the behavior of the urllib DNS resolver so that any domain name
  195. containing substring 'nginx-proxy' will resolve to the IP address
  196. of the container created from image 'nginxproxy/nginx-proxy:test'.
  197. """
  198. prv_getaddrinfo = socket.getaddrinfo
  199. dns_cache = {}
  200. def new_getaddrinfo(*args):
  201. logging.getLogger('DNS').debug(f"resolving domain name {repr(args)}")
  202. _args = list(args)
  203. # Fail early when querying IP directly and it is forced ipv6 when not supported,
  204. # Otherwise a pytest container not using the host network fails to pass `test_raw-ip-vhost`.
  205. if FORCE_CONTAINER_IPV6 and not HAS_IPV6:
  206. pytest.skip("This system does not support IPv6")
  207. # custom DNS resolvers
  208. ip = nginx_proxy_dns_resolver(args[0])
  209. if ip is None:
  210. ip = docker_container_dns_resolver(args[0])
  211. if ip is not None:
  212. _args[0] = ip
  213. # call on original DNS resolver, with eventually the original host changed to the wanted IP address
  214. try:
  215. return dns_cache[tuple(_args)]
  216. except KeyError:
  217. res = prv_getaddrinfo(*_args)
  218. dns_cache[tuple(_args)] = res
  219. return res
  220. socket.getaddrinfo = new_getaddrinfo
  221. return prv_getaddrinfo
  222. def restore_urllib_dns_resolver(getaddrinfo_func):
  223. socket.getaddrinfo = getaddrinfo_func
  224. def remove_all_containers():
  225. for container in docker_client.containers.list(all=True):
  226. if PYTEST_RUNNING_IN_CONTAINER and container.name == test_container:
  227. continue # pytest is running within a Docker container, so we do not want to remove that particular container
  228. logging.info(f"removing container {container.name}")
  229. container.remove(v=True, force=True)
  230. def get_nginx_conf_from_container(container):
  231. """
  232. return the nginx /etc/nginx/conf.d/default.conf file content from a container
  233. """
  234. import tarfile
  235. from io import BytesIO
  236. strm_generator, stat = container.get_archive('/etc/nginx/conf.d/default.conf')
  237. strm_fileobj = BytesIO(b"".join(strm_generator))
  238. with tarfile.open(fileobj=strm_fileobj) as tf:
  239. conffile = tf.extractfile('default.conf')
  240. return conffile.read()
  241. def docker_compose_up(compose_file='docker-compose.yml'):
  242. logging.info(f'docker-compose -f {compose_file} up -d')
  243. try:
  244. subprocess.check_output(shlex.split(f'docker-compose -f {compose_file} up -d'), stderr=subprocess.STDOUT)
  245. except subprocess.CalledProcessError as e:
  246. pytest.fail(f"Error while runninng 'docker-compose -f {compose_file} up -d':\n{e.output}", pytrace=False)
  247. def docker_compose_down(compose_file='docker-compose.yml'):
  248. logging.info(f'docker-compose -f {compose_file} down -v')
  249. try:
  250. subprocess.check_output(shlex.split(f'docker-compose -f {compose_file} down -v'), stderr=subprocess.STDOUT)
  251. except subprocess.CalledProcessError as e:
  252. pytest.fail(f"Error while runninng 'docker-compose -f {compose_file} down -v':\n{e.output}", pytrace=False)
  253. def wait_for_nginxproxy_to_be_ready():
  254. """
  255. If one (and only one) container started from image nginxproxy/nginx-proxy:test is found,
  256. wait for its log to contain substring "Watching docker events"
  257. """
  258. containers = docker_client.containers.list(filters={"ancestor": "nginxproxy/nginx-proxy:test"})
  259. if len(containers) != 1:
  260. return
  261. container = containers[0]
  262. for line in container.logs(stream=True):
  263. if b"Watching docker events" in line:
  264. logging.debug("nginx-proxy ready")
  265. break
  266. @pytest.fixture
  267. def docker_compose_file(request):
  268. """Fixture naming the docker-compose file to consider.
  269. If a YAML file exists with the same name as the test module (with the `.py` extension replaced
  270. with `.yml` or `.yaml`), use that. Otherwise, use `docker-compose.yml` in the same directory
  271. as the test module.
  272. Tests can override this fixture to specify a custom location.
  273. """
  274. test_module_dir = os.path.dirname(request.module.__file__)
  275. yml_file = os.path.join(test_module_dir, request.module.__name__ + '.yml')
  276. yaml_file = os.path.join(test_module_dir, request.module.__name__ + '.yaml')
  277. default_file = os.path.join(test_module_dir, 'docker-compose.yml')
  278. if os.path.isfile(yml_file):
  279. docker_compose_file = yml_file
  280. elif os.path.isfile(yaml_file):
  281. docker_compose_file = yaml_file
  282. else:
  283. docker_compose_file = default_file
  284. if not os.path.isfile(docker_compose_file):
  285. logging.error("Could not find any docker-compose file named either '{0}.yml', '{0}.yaml' or 'docker-compose.yml'".format(request.module.__name__))
  286. logging.debug(f"using docker compose file {docker_compose_file}")
  287. return docker_compose_file
  288. def connect_to_network(network):
  289. """
  290. If we are running from a container, connect our container to the given network
  291. :return: the name of the network we were connected to, or None
  292. """
  293. if PYTEST_RUNNING_IN_CONTAINER:
  294. try:
  295. my_container = docker_client.containers.get(test_container)
  296. except docker.errors.NotFound:
  297. logging.warn(f"container {test_container} not found")
  298. return
  299. # figure out our container networks
  300. my_networks = list(my_container.attrs["NetworkSettings"]["Networks"].keys())
  301. # If the pytest container is using host networking, it cannot connect to container networks (not required with host network)
  302. if 'host' in my_networks:
  303. return None
  304. # Make sure our container is connected to the nginx-proxy's network,
  305. # but avoid connecting to `none` network (not valid) with `test_server-down` tests
  306. if network.name not in my_networks and network.name != 'none':
  307. logging.info(f"Connecting to docker network: {network.name}")
  308. network.connect(my_container)
  309. return network
  310. def disconnect_from_network(network=None):
  311. """
  312. If we are running from a container, disconnect our container from the given network.
  313. :param network: name of a docker network to disconnect from
  314. """
  315. if PYTEST_RUNNING_IN_CONTAINER and network is not None:
  316. try:
  317. my_container = docker_client.containers.get(test_container)
  318. except docker.errors.NotFound:
  319. logging.warn(f"container {test_container} not found")
  320. return
  321. # figure out our container networks
  322. my_networks_names = list(my_container.attrs["NetworkSettings"]["Networks"].keys())
  323. # disconnect our container from the given network
  324. if network.name in my_networks_names:
  325. logging.info(f"Disconnecting from network {network.name}")
  326. network.disconnect(my_container)
  327. def connect_to_all_networks():
  328. """
  329. If we are running from a container, connect our container to all current docker networks.
  330. :return: a list of networks we connected to
  331. """
  332. if not PYTEST_RUNNING_IN_CONTAINER:
  333. return []
  334. else:
  335. # find the list of docker networks
  336. networks = [network for network in docker_client.networks.list(greedy=True) if len(network.containers) > 0 and network.name != 'bridge']
  337. return [connect_to_network(network) for network in networks]
  338. class DockerComposer(contextlib.AbstractContextManager):
  339. def __init__(self):
  340. self._docker_compose_file = None
  341. def __exit__(self, *exc_info):
  342. self._down()
  343. def _down(self):
  344. if self._docker_compose_file is None:
  345. return
  346. for network in self._networks:
  347. disconnect_from_network(network)
  348. docker_compose_down(self._docker_compose_file)
  349. self._docker_compose_file = None
  350. def compose(self, docker_compose_file):
  351. if docker_compose_file == self._docker_compose_file:
  352. return
  353. self._down()
  354. if docker_compose_file is None:
  355. return
  356. remove_all_containers()
  357. docker_compose_up(docker_compose_file)
  358. self._networks = connect_to_all_networks()
  359. wait_for_nginxproxy_to_be_ready()
  360. time.sleep(3) # give time to containers to be ready
  361. self._docker_compose_file = docker_compose_file
  362. ###############################################################################
  363. #
  364. # Py.test fixtures
  365. #
  366. ###############################################################################
  367. @pytest.fixture(scope="module")
  368. def docker_composer():
  369. with DockerComposer() as d:
  370. yield d
  371. @pytest.fixture
  372. def ca_root_certificate():
  373. return CA_ROOT_CERTIFICATE
  374. @pytest.fixture
  375. def monkey_patched_dns():
  376. original_dns_resolver = monkey_patch_urllib_dns_resolver()
  377. yield
  378. restore_urllib_dns_resolver(original_dns_resolver)
  379. @pytest.fixture
  380. def docker_compose(monkey_patched_dns, docker_composer, docker_compose_file):
  381. """Ensures containers described in a docker compose file are started.
  382. A custom docker compose file name can be specified by overriding the `docker_compose_file`
  383. fixture.
  384. Also, in the case where pytest is running from a docker container, this fixture makes sure
  385. our container will be attached to all the docker networks.
  386. """
  387. docker_composer.compose(docker_compose_file)
  388. yield docker_client
  389. @pytest.fixture()
  390. def nginxproxy():
  391. """
  392. Provides the `nginxproxy` object that can be used in the same way the requests module is:
  393. r = nginxproxy.get("http://foo.com")
  394. The difference is that in case an HTTP requests has status code 404 or 502 (which mostly
  395. indicates that nginx has just reloaded), we retry up to 30 times the query.
  396. Also, the nginxproxy methods accept an additional keyword parameter: `ipv6` which forces requests
  397. made against containers to use the containers IPv6 address when set to `True`. If IPv6 is not
  398. supported by the system or docker, that particular test will be skipped.
  399. """
  400. yield requests_for_docker()
  401. ###############################################################################
  402. #
  403. # Py.test hooks
  404. #
  405. ###############################################################################
  406. # pytest hook to display additionnal stuff in test report
  407. def pytest_runtest_logreport(report):
  408. if report.failed:
  409. if isinstance(report.longrepr, ReprExceptionInfo):
  410. test_containers = docker_client.containers.list(all=True, filters={"ancestor": "nginxproxy/nginx-proxy:test"})
  411. for container in test_containers:
  412. report.longrepr.addsection('nginx-proxy logs', container.logs())
  413. report.longrepr.addsection('nginx-proxy conf', get_nginx_conf_from_container(container))
  414. # Py.test `incremental` marker, see http://stackoverflow.com/a/12579625/107049
  415. def pytest_runtest_makereport(item, call):
  416. if "incremental" in item.keywords:
  417. if call.excinfo is not None:
  418. parent = item.parent
  419. parent._previousfailed = item
  420. def pytest_runtest_setup(item):
  421. previousfailed = getattr(item.parent, "_previousfailed", None)
  422. if previousfailed is not None:
  423. pytest.xfail(f"previous test failed ({previousfailed.name})")
  424. ###############################################################################
  425. #
  426. # Check requirements
  427. #
  428. ###############################################################################
  429. try:
  430. docker_client.images.get('nginxproxy/nginx-proxy:test')
  431. except docker.errors.ImageNotFound:
  432. pytest.exit("The docker image 'nginxproxy/nginx-proxy:test' is missing")
  433. if LooseVersion(docker.__version__) < LooseVersion("5.0.0"):
  434. pytest.exit("This test suite is meant to work with the python docker module v5.0.0 or later")