From ea95fd208b9ab4d715624811b84c6e267e580cdd Mon Sep 17 00:00:00 2001 From: Douglas Gibbons Date: Mon, 3 Feb 2020 20:30:41 -0800 Subject: [PATCH 1/2] * Python 3 compatibility * New port for every test --- test/wait-for-it.py | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) mode change 100644 => 100755 test/wait-for-it.py diff --git a/test/wait-for-it.py b/test/wait-for-it.py old mode 100644 new mode 100755 index e06fb8c..f63990d --- a/test/wait-for-it.py +++ b/test/wait-for-it.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python + import unittest import shlex from subprocess import Popen, PIPE @@ -24,13 +26,13 @@ def execute(self, cmd): proc = Popen(args, stdout=PIPE, stderr=PIPE) out, err = proc.communicate() exitcode = proc.returncode - return exitcode, out, err + return exitcode, out.decode('utf-8'), err.decode('utf-8') - def open_local_port(self, host="localhost", port=8929, timeout=5): + def open_local_port(self, timeout=5): s = socket.socket() - s.bind((host, port)) + s.bind(('', 0)) s.listen(timeout) - return s + return s, s.getsockname()[1] def check_args(self, args, stdout_regex, stderr_regex, exitcode): command = self.wait_script + " " + args @@ -102,11 +104,11 @@ def test_no_host(self): def test_host_port(self): """ Check that --host and --port args work correctly """ - soc = self.open_local_port(port=8929) + soc, port = self.open_local_port() self.check_args( - "--host=localhost --port=8929 --timeout=1", + "--host=localhost --port={0} --timeout=1".format(port), "", - "wait-for-it.sh: waiting 1 seconds for localhost:8929", + "wait-for-it.sh: waiting 1 seconds for localhost:{0}".format(port), 0 ) soc.close() @@ -116,15 +118,16 @@ def test_combined_host_port(self): Tests that wait-for-it.sh returns correctly after establishing a connectionm using combined host and ports """ - soc = self.open_local_port(port=8929) + soc, port = self.open_local_port() self.check_args( - "localhost:8929 --timeout=1", + "localhost:{0} --timeout=1".format(port), "", - "wait-for-it.sh: waiting 1 seconds for localhost:8929", + "wait-for-it.sh: waiting 1 seconds for localhost:{0}".format(port), 0 ) soc.close() + def test_port_failure_with_timeout(self): """ Note exit status of 124 is exected, passed from the timeout command @@ -140,11 +143,11 @@ def test_command_execution(self): """ Checks that a command executes correctly after a port test passes """ - soc = self.open_local_port(port=8929) + soc, port = self.open_local_port() self.check_args( - "localhost:8929 -- echo \"CMD OUTPUT\"", + "localhost:{0} -- echo \"CMD OUTPUT\"".format(port), "CMD OUTPUT", - ".*wait-for-it.sh: localhost:8929 is available after 0 seconds", + ".*wait-for-it.sh: localhost:{0} is available after 0 seconds".format(port), 0 ) soc.close() @@ -154,9 +157,9 @@ def test_failed_command_execution(self): Check command failure. The command in question outputs STDERR and an exit code of 2 """ - soc = self.open_local_port(port=8929) + soc, port = self.open_local_port() self.check_args( - "localhost:8929 -- ls not_real_file", + "localhost:{0} -- ls not_real_file".format(port), "", ".*No such file or directory\n", 2 From 035b80087a1467bb90702d5b511b09386575c00f Mon Sep 17 00:00:00 2001 From: Douglas Gibbons Date: Mon, 3 Feb 2020 20:38:49 -0800 Subject: [PATCH 2/2] Added container-runners.py to test against different environments --- test/README.md | 18 ++++++++++++++++++ test/container-runners.py | 36 ++++++++++++++++++++++++++++++++++++ test/requirements.txt | 2 ++ test/wait-for-it.py | 26 +++++++++++++------------- 4 files changed, 69 insertions(+), 13 deletions(-) create mode 100644 test/README.md create mode 100755 test/container-runners.py create mode 100644 test/requirements.txt diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000..59cd8db --- /dev/null +++ b/test/README.md @@ -0,0 +1,18 @@ +# Tests for wait-for-it + +* wait-for-it.py - pytests for wait-for-it.sh +* container-runners.py - Runs wait-for-it.py tests in multiple containers +* requirements.txt - pip requirements for container-runners.py + +To run the basic tests: + +``` +python wait-for-it.py +``` + +Many of the issues encountered have been related to differences between operating system versions. The container-runners.py script provides an easy way to run the python wait-for-it.py tests against multiple system configurations: + +``` +pip install -r requirements.txt +python container-runners.py +``` diff --git a/test/container-runners.py b/test/container-runners.py new file mode 100755 index 0000000..bf76b9d --- /dev/null +++ b/test/container-runners.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python + +# Unit tests to run wait-for-it.py unit tests in several different docker images + +import unittest +from ddt import ddt, data +import os +import docker + +client = docker.from_env() +app_path = os.path.abspath(os.path.join(os.path.dirname( __file__ ), '..')) +volumes = {app_path: {'bind': '/app', 'mode': 'ro'}} + +@ddt +class TestContainers(unittest.TestCase): + """ + Test multiple container types with the test cases in wait-for-it.py + """ + + @data( + "python:3.5-buster", + "python:3.5-stretch", + "dougg/alpine-busybox:alpine-3.11.3_busybox-1.30.1", + "dougg/alpine-busybox:alpine-3.11.3_busybox-1.31.1", + ) + def test_image(self, image): + print(image) + command="/app/test/wait-for-it.py" + container = client.containers.run(image, command=command, volumes=volumes, detach=True) + result = container.wait() + logs = container.logs() + container.remove() + self.assertEqual(result, 0, logs) + +if __name__ == '__main__': + unittest.main() diff --git a/test/requirements.txt b/test/requirements.txt new file mode 100644 index 0000000..58bb0c5 --- /dev/null +++ b/test/requirements.txt @@ -0,0 +1,2 @@ +docker>=2.0.0 +dtt>=1.2.0 diff --git a/test/wait-for-it.py b/test/wait-for-it.py index f63990d..de7530e 100755 --- a/test/wait-for-it.py +++ b/test/wait-for-it.py @@ -34,9 +34,9 @@ def open_local_port(self, timeout=5): s.listen(timeout) return s, s.getsockname()[1] - def check_args(self, args, stdout_regex, stderr_regex, exitcode): + def check_args(self, args, stdout_regex, stderr_regex, should_succeed): command = self.wait_script + " " + args - actual_exitcode, out, err = self.execute(command) + exitcode, out, err = self.execute(command) # Check stderr msg = ("Failed check that STDERR:\n" + @@ -53,7 +53,7 @@ def check_args(self, args, stdout_regex, stderr_regex, exitcode): self.assertIsNotNone(re.match(stdout_regex, out, re.DOTALL), msg) # Check exit code - self.assertEqual(actual_exitcode, exitcode) + self.assertEqual(should_succeed, exitcode == 0) def setUp(self): script_path = os.path.dirname(sys.argv[0]) @@ -69,7 +69,7 @@ def test_no_args(self): "", "^$", MISSING_ARGS_TEXT, - 1 + False ) # Return code should be 1 when called with no args exitcode, out, err = self.execute(self.wait_script) @@ -81,7 +81,7 @@ def test_help(self): "--help", "", HELP_TEXT, - 1 + False ) def test_no_port(self): @@ -90,7 +90,7 @@ def test_no_port(self): "--host=localhost", "", MISSING_ARGS_TEXT, - 1 + False ) def test_no_host(self): @@ -99,7 +99,7 @@ def test_no_host(self): "--port=80", "", MISSING_ARGS_TEXT, - 1 + False ) def test_host_port(self): @@ -109,7 +109,7 @@ def test_host_port(self): "--host=localhost --port={0} --timeout=1".format(port), "", "wait-for-it.sh: waiting 1 seconds for localhost:{0}".format(port), - 0 + True ) soc.close() @@ -123,7 +123,7 @@ def test_combined_host_port(self): "localhost:{0} --timeout=1".format(port), "", "wait-for-it.sh: waiting 1 seconds for localhost:{0}".format(port), - 0 + True ) soc.close() @@ -136,7 +136,7 @@ def test_port_failure_with_timeout(self): "localhost:8929 --timeout=1", "", ".*timeout occurred after waiting 1 seconds for localhost:8929", - 124 + False ) def test_command_execution(self): @@ -148,7 +148,7 @@ def test_command_execution(self): "localhost:{0} -- echo \"CMD OUTPUT\"".format(port), "CMD OUTPUT", ".*wait-for-it.sh: localhost:{0} is available after 0 seconds".format(port), - 0 + True ) soc.close() @@ -162,7 +162,7 @@ def test_failed_command_execution(self): "localhost:{0} -- ls not_real_file".format(port), "", ".*No such file or directory\n", - 2 + False ) soc.close() @@ -175,7 +175,7 @@ def test_command_after_connection_failure(self): "localhost:8929 --timeout=1 -- echo \"CMD OUTPUT\"", "CMD OUTPUT", ".*timeout occurred after waiting 1 seconds for localhost:8929", - 0 + True ) if __name__ == '__main__':