conftest.py 11 KB

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