conftest.py 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. from __future__ import print_function
  2. import json
  3. import logging
  4. import os
  5. import shlex
  6. import socket
  7. import subprocess
  8. import time
  9. import backoff
  10. import docker
  11. import pytest
  12. import requests
  13. logging.basicConfig(level=logging.WARNING)
  14. logging.getLogger('backoff').setLevel(logging.INFO)
  15. logging.getLogger('patched DNS').setLevel(logging.INFO)
  16. CA_ROOT_CERTIFICATE = os.path.join(os.path.dirname(__file__), 'certs/ca-root.crt')
  17. ###############################################################################
  18. #
  19. # utilities
  20. #
  21. ###############################################################################
  22. class requests_retry_on_error_502(object):
  23. """
  24. Proxy for calling methods of the requests module.
  25. When a HTTP response failed due to HTTP Error 404 or 502, retry up to 30 times.
  26. """
  27. def __init__(self):
  28. self.session = requests.Session()
  29. if os.path.isfile(CA_ROOT_CERTIFICATE):
  30. self.session.verify = CA_ROOT_CERTIFICATE
  31. def get(self, *args, **kwargs):
  32. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  33. def _get(*args, **kwargs):
  34. return self.session.get(*args, **kwargs)
  35. return _get(*args, **kwargs)
  36. def post(self, *args, **kwargs):
  37. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  38. def _post(*args, **kwargs):
  39. return self.session.post(*args, **kwargs)
  40. return _post(*args, **kwargs)
  41. def put(self, *args, **kwargs):
  42. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  43. def _put(*args, **kwargs):
  44. return self.session.put(*args, **kwargs)
  45. return _put(*args, **kwargs)
  46. def head(self, *args, **kwargs):
  47. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  48. def _head(*args, **kwargs):
  49. return self.session.head(*args, **kwargs)
  50. return _head(*args, **kwargs)
  51. def delete(self, *args, **kwargs):
  52. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  53. def _delete(*args, **kwargs):
  54. return self.session.delete(*args, **kwargs)
  55. return _delete(*args, **kwargs)
  56. def options(self, *args, **kwargs):
  57. @backoff.on_predicate(backoff.constant, lambda r: r.status_code in (404, 502), interval=.3, max_tries=30, jitter=None)
  58. def _options(*args, **kwargs):
  59. return self.session.options(*args, **kwargs)
  60. return _options(*args, **kwargs)
  61. def __getattr__(self, name):
  62. return getattr(requests, name)
  63. def monkey_patch_urllib_dns_resolver():
  64. """
  65. Alter the behavior of the urllib DNS resolver so that any domain name
  66. containing substring 'nginx-proxy' will resolve to the IP address
  67. of the container created from image 'jwilder/nginx-proxy:test'.
  68. """
  69. log = logging.getLogger("patched DNS")
  70. prv_getaddrinfo = socket.getaddrinfo
  71. dns_cache = {}
  72. def new_getaddrinfo(*args):
  73. log.debug("resolving domain name %s" % repr(args))
  74. if 'nginx-proxy' in args[0]:
  75. docker_client = docker.from_env()
  76. ip = docker_client.containers(filters={"status": "running", "ancestor": "jwilder/nginx-proxy:test"})[0]["NetworkSettings"]["Networks"]["bridge"]["IPAddress"]
  77. log.info("resolving domain name %r as IP address is %s" % (args[0], ip))
  78. return [
  79. (socket.AF_INET, socket.SOCK_STREAM, 6, '', (ip, args[1])),
  80. (socket.AF_INET, socket.SOCK_DGRAM, 17, '', (ip, args[1])),
  81. (socket.AF_INET, socket.SOCK_RAW, 0, '', (ip, args[1]))
  82. ]
  83. try:
  84. return dns_cache[args]
  85. except KeyError:
  86. res = prv_getaddrinfo(*args)
  87. dns_cache[args] = res
  88. return res
  89. socket.getaddrinfo = new_getaddrinfo
  90. return prv_getaddrinfo
  91. def restore_urllib_dns_resolver(getaddrinfo_func):
  92. socket.getaddrinfo = getaddrinfo_func
  93. def remove_all_containers():
  94. docker_client = docker.from_env()
  95. for info in docker_client.containers(all=True):
  96. docker_client.remove_container(info["Id"], v=True, force=True)
  97. def get_nginx_conf_from_container(container_id):
  98. """
  99. return the nginx /etc/nginx/conf.d/default.conf file content from a container
  100. """
  101. import tarfile
  102. from cStringIO import StringIO
  103. docker_client = docker.from_env()
  104. strm, stat = docker_client.get_archive(container_id, '/etc/nginx/conf.d/default.conf')
  105. with tarfile.open(fileobj=StringIO(strm.read())) as tf:
  106. conffile = tf.extractfile('default.conf')
  107. return conffile.read()
  108. def docker_compose_up(compose_file='docker-compose.yml'):
  109. subprocess.check_output(shlex.split('docker-compose -f %s up -d' % compose_file))
  110. def wait_for_nginxproxy_to_be_ready():
  111. """
  112. If a one (and only one) container started from image jwilder/nginx-proxy:test is found,
  113. wait for its log to contain substring "Watching docker events"
  114. """
  115. docker_client = docker.from_env()
  116. containers = docker_client.containers(filters={"ancestor": "jwilder/nginx-proxy:test"})
  117. if len(containers) != 1:
  118. return
  119. container = containers[0]
  120. for line in docker_client.logs(container['Id'], stream=True):
  121. if "Watching docker events" in line:
  122. logging.debug("nginx-proxy ready")
  123. break
  124. def find_docker_compose_file(request):
  125. """
  126. helper for fixture functions to figure out the name of the docker-compose file to consider.
  127. - if the test module provides a `docker_compose_file` variable, take that
  128. - else, if a yaml file exists with the same name as the test module (but for the `.yml` extension), use that
  129. - otherwise use `docker-compose.yml`.
  130. """
  131. test_module_dir = os.path.dirname(request.module.__file__)
  132. yml_file = os.path.join(test_module_dir, request.module.__name__ + '.yml')
  133. yaml_file = os.path.join(test_module_dir, request.module.__name__ + '.yaml')
  134. default_file = os.path.join(test_module_dir, 'docker-compose.yml')
  135. docker_compose_file_module_variable = getattr(request.module, "docker_compose_file", None)
  136. if docker_compose_file_module_variable is not None:
  137. docker_compose_file = os.path.join( test_module_dir, docker_compose_file_module_variable)
  138. if not os.path.isfile(docker_compose_file):
  139. raise ValueError("docker compose file %r could not be found. Check your test module `docker_compose_file` variable value." % docker_compose_file)
  140. else:
  141. if os.path.isfile(yml_file):
  142. docker_compose_file = yml_file
  143. elif os.path.isfile(yaml_file):
  144. docker_compose_file = yaml_file
  145. else:
  146. docker_compose_file = default_file
  147. if not os.path.isfile(docker_compose_file):
  148. logging.error("Could not find any docker-compose file named either '{0}.yml', '{0}.yaml' or 'docker-compose.yml'".format(request.module.__name__))
  149. logging.info("using docker compose file %s" % docker_compose_file)
  150. return docker_compose_file
  151. ###############################################################################
  152. #
  153. # Py.test fixtures
  154. #
  155. ###############################################################################
  156. @pytest.yield_fixture(scope="module")
  157. def docker_compose(request):
  158. """
  159. pytest fixture providing containers described in a docker compose file. After the tests, remove the created containers
  160. A custom docker compose file name can be defined in a variable named `docker_compose_file`.
  161. """
  162. docker_compose_file = find_docker_compose_file(request)
  163. original_dns_resolver = monkey_patch_urllib_dns_resolver()
  164. remove_all_containers()
  165. docker_compose_up(docker_compose_file)
  166. wait_for_nginxproxy_to_be_ready()
  167. time.sleep(3)
  168. yield
  169. restore_urllib_dns_resolver(original_dns_resolver)
  170. @pytest.fixture(scope="session")
  171. def nginxproxy():
  172. """
  173. Provides the `nginxproxy` object that can be used in the same way the requests module is:
  174. r = nginxproxy.get("http://foo.com")
  175. The difference is that in case an HTTP requests has status code 404 or 502 (which mostly
  176. indicates that nginx has just reloaded), we retry up to 30 times the query
  177. """
  178. return requests_retry_on_error_502()
  179. ###############################################################################
  180. #
  181. # Py.test hooks
  182. #
  183. ###############################################################################
  184. # pytest hook to display additionnal stuff in test report
  185. def pytest_runtest_logreport(report):
  186. if report.failed:
  187. docker_client = docker.from_env()
  188. test_containers = docker_client.containers(all=True, filters={"ancestor": "jwilder/nginx-proxy:test"})
  189. for container in test_containers:
  190. report.longrepr.addsection('nginx-proxy logs', docker_client.logs(container['Id']))
  191. report.longrepr.addsection('nginx-proxy conf', get_nginx_conf_from_container(container['Id']))