BIND 10 trac2410, updated. 56bcca870b41742f47160cae5b30b81ef62c1095 [2410] Fix race condition in DHCP4 test

[BIND 10 source code commits]

The branch, trac2410 has been updated
       via  56bcca870b41742f47160cae5b30b81ef62c1095 (commit)
      from  9f454868d6240a3113bed21cd719293ddb10991f (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 56bcca870b41742f47160cae5b30b81ef62c1095
Author: Stephen Morris <stephen at isc.org>
Date:   Wed Nov 21 18:18:28 2012 +0000

    [2410] Fix race condition in DHCP4 test
    
    Same change as in commit 9f454868d6240a3113bed21cd719293ddb10991f
    but applied to the DHCP4 test.

-----------------------------------------------------------------------

Summary of changes:
 src/bin/dhcp4/tests/dhcp4_test.py |   80 +++++++++++++++++++++++--------------
 1 file changed, 50 insertions(+), 30 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/bin/dhcp4/tests/dhcp4_test.py b/src/bin/dhcp4/tests/dhcp4_test.py
index 444dfcf..19e4282 100644
--- a/src/bin/dhcp4/tests/dhcp4_test.py
+++ b/src/bin/dhcp4/tests/dhcp4_test.py
@@ -47,9 +47,9 @@ class TestDhcpv4Daemon(unittest.TestCase):
 
     def runCommand(self, params, wait=1):
         """
-        This method runs dhcp4 and returns a tuple: (returncode, stdout, stderr)
+        This method runs a command and returns a tuple: (returncode, stdout, stderr)
         """
-        ## @todo: Convert this into generic method and reuse it in dhcp6
+        ## @todo: Convert this into generic method and reuse it in dhcp4 and dhcp6
 
         print("Running command: %s" % (" ".join(params)))
 
@@ -89,46 +89,66 @@ class TestDhcpv4Daemon(unittest.TestCase):
         fl = fcntl.fcntl(fd, fcntl.F_GETFL)
         fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
 
-        # There's potential problem if b10-dhcp4 prints out more
-        # than 16kB of text
-        try:
-            output = os.read(self.stdout_pipes[0], 16384)
-        except OSError:
-            print("No data available from stdout")
-            output = ""
-
-        # read can return None. Make sure we have a string
-        if (output is None):
-            output = ""
-
-        try:
-            error = os.read(self.stderr_pipes[0], 16384)
-        except OSError:
-            print("No data available on stderr")
-            error = ""
-
-        # read can return None. Make sure we have a string
-        if (error is None):
-            error = ""
-
-
-        try:
-            if (not pi.process.poll()):
-                # let's be nice at first...
+        # As we don't know how long the subprocess will take to start and
+        # produce output, we'll loop and sleep for 250ms between each
+        # iteration.  To avoid an infinite loop, we'll loop for a maximum
+        # of five seconds: that should be enough.
+        count = 20
+        output = ""
+        error = ""
+        while count > 0:
+            try:
+                new_output = os.read(self.stdout_pipes[0], 16384)
+            except OSError:
+                new_output = ""
+
+            # read can return None. Make sure we have a string
+            if (new_output is not None):
+                output = output + str(new_output)
+
+            try:
+                new_error = os.read(self.stderr_pipes[0], 16384)
+            except OSError:
+                new_error = ""
+
+            # read can return None. Make sure we have a string
+            if (new_error is not None):
+                error = error + str(new_error)
+
+            # If the process has already exited, or if it has output something,
+            # quit the loop now.
+            if pi.process.poll() is not None or len(error) > 0 or len(output) > 0:
+                break
+
+            # Process still running, try again in 250 ms.
+            count = count - 1
+            time.sleep(0.25)
+
+        # Exited loop, kill the process if it is still running
+        if pi.process.poll() is None:
+            try:
                 pi.process.terminate()
-        except OSError:
-            print("Ignoring failed kill attempt. Process is dead already.")
+            except OSError:
+                print("Ignoring failed kill attempt. Process is dead already.")
 
         # call this to get returncode, process should be dead by now
         rc = pi.process.wait()
 
         # Clean up our stdout/stderr munging.
         os.dup2(self.stdout_old, sys.stdout.fileno())
+        os.close(self.stdout_old)
         os.close(self.stdout_pipes[0])
 
         os.dup2(self.stderr_old, sys.stderr.fileno())
+        os.close(self.stderr_old)
         os.close(self.stderr_pipes[0])
 
+        # Free up resources (file descriptors) from the ProcessInfo object
+        # TODO: For some reason, this gives an error if the process has ended,
+        #       although it does cause all descriptors still allocated to the
+        #       object to be freed.
+        pi = None
+
         print ("Process finished, return code=%d, stdout=%d bytes, stderr=%d bytes"
                % (rc, len(output), len(error)) )