Filled out process management in python brokertest framework.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@834124 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 192 insertions, 86 deletions

diff --git a/cpp/src/tests/brokertest.py b/cpp/src/tests/brokertest.py
index 511a86edda..c176024789 100644
--- a/cpp/src/tests/brokertest.py
+++ b/cpp/src/tests/brokertest.py
@@ -20,22 +20,18 @@
 # Support library for tests that start multiple brokers, e.g. cluster
 # or federation
 
-#
-# FIXME aconway 2009-10-30: Missing features:
-# - support for calling qpid-tool/qpid-config directly from a test.
-#   (Not by starting a separate process)
-# - helper functions to run  executable clients e.g. sender/receiver.
-# 
-
-import os, signal, string, tempfile, popen2, socket
-from qpid import connection, messaging
-from shutil import rmtree
+import os, signal, string, tempfile, popen2, socket, threading, time
+import qpid
+from qpid import connection, messaging, util
+from qpid.harness import Skipped
 from unittest import TestCase
+from copy import copy
+from threading import Thread, Lock, Condition
 
 # Values for expected outcome of process at end of test
-EXPECT_NONE=0              # No expectation
-EXPECT_EXIT_OK=1           # Expect to exit with 0 before end of test
-EXPECT_RUNNING=2           # Expect to still be running at end of test
+EXPECT_EXIT_OK=1           # Expect to exit with 0 status before end of test.
+EXPECT_EXIT_FAIL=2         # Expect to exit with non-0 status before end of test.
+EXPECT_RUNNING=3           # Expect to still be running at end of test
     
 def is_running(pid):
     try:
@@ -44,50 +40,76 @@ def is_running(pid):
     except:
         return False
 
-class Popen:
-    """Similar to subprocess.Popen but using popen2 classes for portability.
-    Can set expectation that process exits with 0 or is still running at end of test.
+class Unexpected(Exception):
+    pass
+
+class Popen(popen2.Popen3):
+    """
+    Similar to subprocess.Popen but using popen2 classes for portability.
+    Can set and verify expectation of process status at end of test.
     """
 
     def __init__(self, cmd, expect=EXPECT_EXIT_OK):
-        self._cmd  = cmd
+        self.cmd  = [ str(x) for x in cmd ]
+        popen2.Popen3.__init__(self, self.cmd, True)
         self.expect = expect
-        self._popen = popen2.Popen3(cmd, True)
-        self.stdin = self._popen.tochild
-        self.stdout = self._popen.fromchild
-        self.stderr = self._popen.childerr
-        self.pid = self._popen.pid
-
-    def _addoutput(self, msg, name, output):
-        if output: msg += [name, output]
-
-    def _check(self, retcode):
-        self.returncode = retcode
-        if self.expect == EXPECT_EXIT_OK and self.returncode != 0:
-            msg = [ "Unexpected error %d: %s" %(retcode, string.join(self._cmd)) ]
-            self._addoutput(msg, "stdout:", self.stdout.read())
-            self._addoutput(msg, "stderr:", self.stderr.read())
-            raise Exception(string.join(msg, "\n"))
+        self.stdin = self.tochild
+        self.stdout = self.fromchild
+        self.stderr = self.childerr
+
+    def unexpected(self,msg):
+        raise Unexpected("%s: %s\n--stdout:\n%s\n--stderr:\n%s" %
+                         (msg, self.cmd_str(), self.stdout.read(), self.stderr.read()))
     
+    def testend(self):                  # Clean up at end of test.
+        if self.expect == EXPECT_RUNNING:
+            try:
+                self.kill()
+            except:
+                self.unexpected("Expected running but exited %d" % self.wait())
+        else:
+            # Give the process some time to exit.
+            delay = 0.1
+            while (self.poll() is None and delay < 1):
+                time.sleep(delay)
+                delay *= 2
+            if self.returncode is None: # Still haven't stopped
+                self.kill()
+                self.unexpected("Expected to exit but still running")
+            elif self.expect == EXPECT_EXIT_OK and self.returncode != 0:
+                self.unexpected("Expected exit ok but exited %d" % self.returncode)
+            elif self.expect == EXPECT_EXIT_FAIL and self.returncode == 0:
+                self.unexpected("Expected to fail but exited ok")
+               
+    def communicate(self, input=None):
+        if input:
+            self.stdin.write(input)
+            self.stdin.close()
+        outerr = (self.stdout.read(), self.stderr.read())
+        self.wait()
+        return outerr
+
+    def is_running(self): return is_running(self.pid)
+
     def poll(self):
-        retcode = self._popen.poll()
-        if retcode != -1: self._check(retcode)
-        return retcode
+        self.returncode = popen2.Popen3.poll(self)
+        if (self.returncode == -1): self.returncode = None
+        return self.returncode
 
     def wait(self):
-        self._check(self._popen.wait())
+        self.returncode = popen2.Popen3.wait(self)
         return self.returncode
 
-    def communicate(self, input=None):
-        if input: self.stdin.write(input)
-        outerr = (self.stdout.read(), self.stderr.read())
-        wait()
-        return outerr
+    def send_signal(self, sig):
+        os.kill(self.pid,sig)
+        self.wait()
 
-    def is_running(self): return is_running(pid)
-    def send_signal(self, sig): os.kill(self.pid,sig)
     def terminate(self): self.send_signal(signal.SIGTERM)
     def kill(self): self.send_signal(signal.SIGKILL)
+        
+        
+
+    def cmd_str(self): return " ".join([str(s) for s in self.cmd])
 
 def checkenv(name):
     value = os.getenv(name)
@@ -103,21 +125,24 @@ class Broker(Popen):
     def __init__(self, test, args=[], name=None, expect=EXPECT_RUNNING):
         """Start a broker daemon. name determines the data-dir and log
         file names."""
-        
+
+        self.test = test
         cmd = [self._qpidd, "--port=0", "--no-module-dir", "--auth=no"] + args
         if name: self.name = name
         else:
             self.name = "broker%d" % Broker._broker_count
             Broker._broker_count += 1
         self.log = os.path.join(test.dir, self.name+".log")
-        cmd += ["--log-to-file", self.log, "--log-prefix", self.name]
+        cmd += ["--log-to-file", self.log, "--log-prefix", self.name,"--log-to-stderr=no"]
         self.datadir = os.path.join(test.dir, self.name)
         cmd += ["--data-dir", self.datadir]
         if self._store_lib: cmd += ["--load-module", self._store_lib]
 
         Popen.__init__(self, cmd, expect)
-        self.port = int(self.stdout.readline())
-        test.willkill(self)             
+        try: self.port = int(self.stdout.readline())
+        except Exception:
+            raise Exception("Failed to start broker: "+self.cmd_str())
+        test.cleanup_popen(self)
         self.host = "localhost"         # Placeholder for remote brokers.
 
     def connect(self):
@@ -126,11 +151,16 @@ class Broker(Popen):
 
     def connect_old(self):
         """Old API connection to the broker."""
-        socket = connect(self.host,self.port)
-        connection = connection.Connection (sock=socket)
+        socket = qpid.util.connect(self.host,self.port)
+        connection = qpid.connection.Connection (sock=socket)
         connection.start()
         return connection;
 
+    def declare_queue(self, queue):
+        c = self.connect_old()
+        s = c.session(str(qpid.datatypes.uuid4()))
+        s.queue_declare(queue=queue)
+        c.close()
 
 class Cluster:
     """A cluster of brokers in a test."""
@@ -138,17 +168,16 @@ class Cluster:
     _cluster_lib = checkenv("CLUSTER_LIB")
     _cluster_count = 0
 
-    # FIXME aconway 2009-10-30: missing args
-    def __init__(self, test, count=0):
+    def __init__(self, test, count=0, args=[], expect=EXPECT_RUNNING):
         self.test = test
         self._brokers=[]
         self.name = "cluster%d" % Cluster._cluster_count
         Cluster._cluster_count += 1
         # Use unique cluster name
-        self.args = []
+        self.args = copy(args)
         self.args += [ "--cluster-name", "%s-%s:%d" % (self.name, socket.gethostname(), os.getpid()) ]
         self.args += [ "--load-module", self._cluster_lib ]
-        self.start_n(count)
+        self.start_n(count, expect=expect)
 
     def start(self, name=None, expect=EXPECT_RUNNING):
         """Add a broker to the cluster. Returns the index of the new broker."""
@@ -156,60 +185,137 @@ class Cluster:
         self._brokers.append(self.test.broker(self.args, name, expect))
         return self._brokers[-1]
 
-    def start_n(self, count):
-        for i in range(count): self.start()
+    def start_n(self, count, expect=EXPECT_RUNNING):
+        for i in range(count): self.start(expect=expect)
 
     def wait(self):
         """Wait for all cluster members to be ready"""
-        for b in brokers:
+        for b in self._brokers:
             b.connect().close()
-        
+
     # Behave like a list of brokers.
     def __len__(self): return len(self._brokers)
     def __getitem__(self,index): return self._brokers[index]
     def __iter__(self): return self._brokers.__iter__()
 
 class BrokerTest(TestCase):
-    """Provides working dir that is cleaned up only if test passes.
+    """
     Tracks processes started by test and kills at end of test.
-    Note that subclasses need to call selfpassed() at the end of
-    a successful test."""
-    
+    Provides a well-known working directory for each test.
+    """
+
+    # FIXME aconway 2009-11-05: too many env vars, need a simpler
+    # scheme for locating exes and libs
+
+    cluster_lib = os.getenv("CLUSTER_LIB")
+    xml_lib = os.getenv("XML_LIB")
+    qpidConfig_exec = os.getenv("QPID_CONFIG_EXEC")
+    qpidRoute_exec = os.getenv("QPID_ROUTE_EXEC")
+    receiver_exec = os.getenv("RECEIVER_EXEC")
+    sender_exec = os.getenv("SENDER_EXEC")
+
     def setUp(self):
-        self.dir = tempfile.mkdtemp()
+        self.dir = os.path.join("brokertest.tmp", self.id())
+        os.makedirs(self.dir)
         self.popens = []
 
-    def willkill(self, popen):
+    def tearDown(self):
+        err = []
+        for p in self.popens:
+            try: p.testend()
+            except Unexpected, e: err.append(str(e))
+        if err: raise Exception("\n".join(err))
+
+    # FIXME aconway 2009-11-06: check for core files of exited processes.
+    
+    def cleanup_popen(self, popen):
         """Add process to be killed at end of test"""
         self.popens.append(popen)
 
     def popen(self, cmd, expect=EXPECT_EXIT_OK):
         """Start a process that will be killed at end of test"""
         p = Popen(cmd, expect)
-        willkill(p)
+        self.cleanup_popen(p)
         return p
 
     def broker(self, args=[], name=None, expect=EXPECT_RUNNING):
-        return Broker(self, args, name, expect)
-
-    def cluster(self, count=0): return Cluster(self)
-
-    def passed(self):
-        """On pass, kill processes and clean up work directory"""
-        rmtree(self.dir)
-        self.passed = True
-
-    def tearDown(self):
-        """On failure print working dir, kill processes"""
-        if not self.passed: print "TEST DIRECTORY: ", self.dir
-        err=[]
-        for p in self.popens:
-            if p.is_running:
-                p.kill()
-            else:
-                if p.expect == EXPECT_RUNNING:
-                    err.append("NOT running: %s" % (cmd))
-        if len(err) != 0:
-            raise Exception(string.join(err, "\n"))
+        """Create and return a broker ready for use"""
+        b = Broker(self, args, name, expect)
+        b.connect().close()
+        return b
+
+    def cluster(self, count=0, args=[], expect=EXPECT_RUNNING):
+        """Create and return a cluster ready for use"""
+        cluster = Cluster(self, count, args, expect=expect)
+        cluster.wait()
+        return cluster
+
+class StoppableThread(Thread):
+    """
+    Base class for threads that do something in a loop and periodically check
+    to see if they have been stopped.
+    """
+    def __init__(self):
+        self.stopped = False
+        self.error = None
+        Thread.__init__(self)
+
+    def stop(self):
+        self.stopped = True
+        self.join()
+        if self.error: raise self.error
+    
+class Sender(StoppableThread):
+    """
+    Thread to run a sender client and send numbered messages until stopped.
+    """
 
+    def __init__(self, broker):
+        StoppableThread.__init__(self)
+        self.sender = broker.test.popen(
+            [broker.test.sender_exec, "--port", broker.port], expect=EXPECT_RUNNING)
+
+    def run(self):
+        try:
+            self.sent = 0
+            while not self.stopped:
+                self.sender.stdin.write(str(self.sent)+"\n")
+                self.sender.stdin.flush()
+                self.sent += 1
+        except Exception, e: self.error = e
+
+class Receiver(Thread):
+    """
+    Thread to run a receiver client and verify it receives
+    sequentially numbered messages.
+    """
+    def __init__(self, broker):
+        Thread.__init__(self)
+        self.test = broker.test
+        self.receiver = self.test.popen(
+            [self.test.receiver_exec, "--port", broker.port], expect=EXPECT_RUNNING)
+        self.stopat = None
+        self.lock = Lock()
+        self.error = None
+
+    def run(self):
+        try:
+            self.received = 0
+            while self.stopat is None or self.received < self.stopat:
+                self.lock.acquire()
+                try:
+                    self.test.assertEqual(self.receiver.stdout.readline(), str(self.received)+"\n")
+                    self.received += 1
+                finally:
+                    self.lock.release()
+        except Exception, e:
+            self.error = e
+
+    def stop(self, count):
+        """Returns when received >= count"""
+        self.lock.acquire()
+        self.stopat = count
+        self.lock.release()
+        self.join()
+        if self.error: raise self.error