Changeset 459:2f5ad7fd7e74

Timestamp:

08/04/08 12:13:52 (5 months ago)

Author:

"Brian Warner <warner@lothar.com>"

branch:

default

Message:

logging: add tests for 'flogtool dump', handle stdout/stderr better

Files:

• ChangeLog (modified) (1 diff)
• foolscap/logging/cli.py (modified) (3 diffs)
• foolscap/logging/dumper.py (modified) (6 diffs)
• foolscap/logging/gatherer.py (modified) (4 diffs)
• foolscap/test/test_logging.py (modified) (2 diffs)

ChangeLog

@@ +1 @@
+2008-08-04  Brian Warner  <warner@lothar.com>
+
+        * foolscap/test/test_logging.py (Dumper): test 'flogtool dump'
+
+        * foolscap/logging/cli.py (dispatch): pass stdout/stderr through
+        attributes on the subcommand's Options instance, rather than as
+        separate function arguments.. makes testing easier.
+        * foolscap/logging/gatherer.py (create_log_gatherer): same
+        (create_incident_gatherer): same
+        (CreateGatherOptions): same
+        (CreateIncidentGatherOptions): same
+        * foolscap/logging/dumper.py (DumpOptions): same
+
-2008-08-01  Brian Warner  <warner@lothar.com>
-

foolscap/logging/cli.py

@@ -44 +44 @@
-
-
-, stdout, stderr
+
-    if command == "tail":
-        from foolscap.logging.tail import LogTail
@@ -52 +52 @@
-    elif command == "create-gatherer":
-        from foolscap.logging.gatherer import create_log_gatherer
-, stdout
+
-
-    elif command == "create-incident-gatherer":
-        from foolscap.logging.gatherer import create_incident_gatherer
-, stdout
+
-
-    elif command == "dump":
@@ -96 +96 @@
-    command = config.subCommand
-    so = config.subOptions
-    stdout, stderr = sys.stdout, sys.stderr
-    if not run_by_human:
-
-
-, stdout, stderr
+o.s
+o.s
+
-    if not run_by_human:
-tdout.getvalue(), 
+o.stdout.getvalue(), so.

foolscap/logging/dumper.py

@@ -5 +5 @@
-
-class DumpOptions(usage.Options):
+    stdout = sys.stdout
+    stderr = sys.stderr
-    synopsis = "Usage: flogtool dump DUMPFILE.pickle"
-    optFlags = [
@@ -20 +22 @@
-
-    def run(self, options):
+        self.options = options
-        try:
-options
+
-        except IOError:
-            sys.exit(1)
-
-, options
-options
+
+
-            if "header" in e:
-                if e["header"]["type"] == "incident":
@@ -32 +35 @@
-                    self.trigger = (t["incarnation"], t["num"])
-            if "d" in e:
-, options
+
-
-    def format_time(self, when):
@@ -39 +42 @@
-        return time_s
-
-, options
+
-        short = e['from'][:8]
-        d = e['d']
-        when = self.format_time(d['time'])
-
-
+self.
+>>self.options.stdout, 
-            return
-
@@ -54 +57 @@
-
-        t = "%s#%d " % (short, d['num'])
-
+self.
-            rx_when = self.format_time(e['rx_time'])
-            t += "rx(%s) " % rx_when
@@ -61 +64 @@
-            t += "%s" % when
-        t += ": %s" % text
-
+self.
-            t += ": %r" % d
-        if is_trigger:
-            t += " [INCIDENT-TRIGGER]"
-
+>>self.options.stdout, 
-        if 'failure' in d:
-
+>>self.options.stdout,
-            lines = str(d['failure']).split("\n")
-            for line in lines:
-
+>>self.options.stdout, 
-
-, options
-
+
+self.
-        if fn.endswith(".bz2"):
-            import bz2

foolscap/logging/gatherer.py

@@ -76 +76 @@
-class CreateGatherOptions(usage.Options):
-    """flogtool create-gatherer GATHERER_DIRECTORY"""
+    stdout = sys.stdout
+    stderr = sys.stderr
-
-    optFlags = [
@@ -254 +256 @@
-"""
-
-, stdout=sys.stdout
+
-    basedir = config["basedir"]
+    stdout = config.stdout
-    if not os.path.exists(basedir):
-        os.makedirs(basedir)
@@ -282 +285 @@
-class CreateIncidentGatherOptions(usage.Options):
-    """flogtool create-incident-gatherer BASEDIR"""
+    stdout = sys.stdout
+    stderr = sys.stderr
-
-    optFlags = [
@@ -511 +516 @@
-"""
-
-, stdout=sys.stdout
+
-    basedir = config["basedir"]
+    stdout = config.stdout
-    if not os.path.exists(basedir):
-        os.makedirs(basedir)

foolscap/test/test_logging.py

@@ -9 +9 @@
-from twisted.python import failure, runtime, usage
-import foolscap
-
+
+
-from foolscap.logging.interfaces import RILogObserver
-from foolscap.eventual import fireEventually, flushEventualQueue
@@ -1527 +1528 @@
-        self.failUnless("to launch the daemon" in out, out)
-
+class Dumper(unittest.TestCase, LogfileReaderMixin):
+    # create a logfile, then dump it, and examine the output to make sure it
+    # worked right.
+
+    def create_logfile(self):
+        if not os.path.exists(self.basedir):
+            os.makedirs(self.basedir)
+        fn = os.path.join(self.basedir, "dump.flog")
+        l = log.FoolscapLogger()
+        lfo = log.LogFileObserver(fn)
+        l.addObserver(lfo.msg)
+        l.msg("one")
+        l.msg("two")
+        try:
+            raise SampleError("whoops1")
+        except:
+            l.err()
+        l.msg("three")
+        d = fireEventually()
+        def _done(res):
+            lfo._stop()
+            #events = self._read_logfile(fn)
+            #self.failUnlessEqual(len(events), 1+3)
+            return fn
+        d.addCallback(_done)
+        return d
+
+    def test_dump(self):
+        self.basedir = "logging/Dumper/dump"
+        d = self.create_logfile()
+        def _check(fn):
+            events = self._read_logfile(fn)
+            d = dumper.LogDumper()
+
+            argv = ["flogtool", "dump", fn]
+            (out,err) = cli.run_flogtool(argv[1:], run_by_human=False)
+            self.failUnlessEqual(err, "")
+            lines = list(StringIO(out).readlines())
+            line0 = "local#%d %s: one" % (events[1]["d"]["num"],
+                                          d.format_time(events[1]["d"]["time"]))
+            self.failUnlessEqual(lines[0].strip(), line0)
+            self.failUnless("FAILURE:" in lines[3])
+            self.failUnless("test_logging.SampleError: whoops1" in lines[-3])
+            self.failUnless(lines[-1].startswith("local#3 "))
+
+            argv = ["flogtool", "dump", "--just-numbers", fn]
+            (out,err) = cli.run_flogtool(argv[1:], run_by_human=False)
+            self.failUnlessEqual(err, "")
+            lines = list(StringIO(out).readlines())
+            line0 = "%s %d" % (d.format_time(events[1]["d"]["time"]),
+                               events[1]["d"]["num"])
+            self.failUnlessEqual(lines[0].strip(), line0)
+            self.failUnless(lines[1].strip().endswith(" 1"))
+            self.failUnless(lines[-1].strip().endswith(" 3"))
+            # failures are not dumped in --just-numbers
+            self.failUnlessEqual(len(lines), 1+3)
+
+            argv = ["flogtool", "dump", "--rx-time", fn]
+            (out,err) = cli.run_flogtool(argv[1:], run_by_human=False)
+            self.failUnlessEqual(err, "")
+            lines = list(StringIO(out).readlines())
+            line0 = "local#%d rx(%s) emit(%s): one" % \
+                    (events[1]["d"]["num"],
+                     d.format_time(events[1]["rx_time"]),
+                     d.format_time(events[1]["d"]["time"]))
+            self.failUnlessEqual(lines[0].strip(), line0)
+            self.failUnless(lines[-1].strip().endswith(" three"))
+
+            argv = ["flogtool", "dump", "--verbose", fn]
+            (out,err) = cli.run_flogtool(argv[1:], run_by_human=False)
+            self.failUnlessEqual(err, "")
+            lines = list(StringIO(out).readlines())
+            self.failUnless("'message': 'one'" in lines[0])
+            self.failUnless("'level': 20" in lines[0])
+            self.failUnless(": three: {" in lines[-1])
+
+        d.addCallback(_check)
+        return d
+
+    def create_incident(self):
+        if not os.path.exists(self.basedir):
+            os.makedirs(self.basedir)
+        l = log.FoolscapLogger()
+        l.setLogDir(self.basedir)
+        l.setIncidentReporterFactory(NoFollowUpReporter)
+
+        d = defer.Deferred()
+        def _done(name, trigger):
+            d.callback( (name,trigger) )
+        l.addImmediateIncidentObserver(_done)
+
+        l.msg("one")
+        l.msg("two")
+        l.msg("boom", level=log.WEIRD)
+        l.msg("four")
+
+        d.addCallback(lambda (name,trigger):
+                      os.path.join(self.basedir, name+".flog.bz2"))
+
+        return d
+
+    def test_incident(self):
+        self.basedir = "logging/Dumper/incident"
+        d = self.create_incident()
+        def _check(fn):
+            events = self._read_logfile(fn)
+            # for sanity, make sure we created the incident correctly
+            assert events[0]["header"]["type"] == "incident"
+            assert events[0]["header"]["trigger"]["num"] == 2
+
+            argv = ["flogtool", "dump", fn]
+            (out,err) = cli.run_flogtool(argv[1:], run_by_human=False)
+            self.failUnlessEqual(err, "")
+            lines = list(StringIO(out).readlines())
+            self.failUnlessEqual(len(lines), 3)
+            self.failIf("[INCIDENT-TRIGGER]" in lines[0])
+            self.failIf("[INCIDENT-TRIGGER]" in lines[1])
+            self.failUnless(lines[2].strip().endswith(": boom [INCIDENT-TRIGGER]"))
+            
+        d.addCallback(_check)
+        return d
-
-class Web(unittest.TestCase):