Merge lp:~pwlars/lava-test/betteroutput into lp:lava-test/0.0

[Paul Larson]

This adds a -q/--quiet option for running tests, and changes default
behavior to be verbose. Some long running tests would leave the user
without feedback during the run. To do this, two util functions were
added as well. One to run commands and poll for output, and another to
mimic tee functionality so that output can optionally be sent to stdout,
and to a logfile.

[Zygmunt Krynicki (zyga)]

124 + proc = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE)
125 + while proc.poll() is None:
126 + output, err = proc.communicate()
127 + if output is not None:
128 + fd.write(output)
129 + return proc.returncode

I'm not sure what poll() does exactly but I remember writing similar code without it. Just call proc.communicate() - it blocks until the subprocess finishes. Am I missing anything?

=== modified file 'abrek/builtins.py'
--- abrek/builtins.py	2010-08-26 20:05:06 +0000
+++ abrek/builtins.py	2010-09-21 22:42:49 +0000
@@ -79,6 +79,8 @@
     Run tests
     """
     arglist = ['*testname']
+    options = [make_option('-q', '--quiet', action='store_true',
+        default=False, dest='quiet')]
 
     def run(self):
         if len(self.args) != 1:
@@ -86,7 +88,7 @@
             sys.exit(1)
         test = abrek.testdef.testloader(self.args[0])
         try:
-            test.run()
+            test.run(quiet=self.opts.quiet)
         except Exception as strerror:
             print "Test execution error: %s" % strerror
             sys.exit(1)

=== modified file 'abrek/testdef.py'
--- abrek/testdef.py	2010-09-21 02:07:11 +0000
+++ abrek/testdef.py	2010-09-21 22:42:49 +0000
@@ -25,7 +25,7 @@
 from uuid import uuid1
 
 from abrek.config import get_config
-from abrek.utils import geturl, write_file
+from abrek.utils import Tee, geturl, run_and_log, write_file
 from abrek import hwprofile
 from abrek import swprofile
 
@@ -105,7 +105,7 @@
         testdata['sw_context'] = sw
         write_file(json.dumps(testdata), filename)
 
-    def run(self):
+    def run(self, quiet=False):
         if not self.runner:
             raise RuntimeError("no test runner defined for '%s'" %
                                 self.testname)
@@ -114,7 +114,7 @@
         self.resultsdir = os.path.join(self.config.resultsdir, resultname)
         os.makedirs(self.resultsdir)
         os.chdir(self.installdir)
-        self.runner.run(self.resultsdir)
+        self.runner.run(self.resultsdir, quiet=quiet)
         self._savetestdata()
 
     def parse(self, resultname):
@@ -200,16 +200,15 @@
         self.steps = steps
         self.testoutput = []
 
-    def _runsteps(self, resultsdir):
+    def _runsteps(self, resultsdir, quiet=False):
         outputlog = os.path.join(resultsdir, 'testoutput.log')
-        with open(outputlog, 'a') as fd:
+        with Tee(outputlog, 'a', quiet=quiet) as fd:
             for cmd in self.steps:
-                rc, output = getstatusoutput(cmd)
-                fd.write(output)
+                run_and_log(cmd, fd)
 
-    def run(self, resultsdir):
+    def run(self, resultsdir, quiet=False):
         self.starttime = datetime.utcnow()
-        self._runsteps(resultsdir)
+        self._runsteps(resultsdir, quiet=quiet)
         self.endtime = datetime.utcnow()
 
 

=== modified file 'abrek/utils.py'
--- abrek/utils.py	2010-09-18 04:21:56 +0000
+++ abrek/utils.py	2010-09-21 22:42:49 +0000
@@ -13,14 +13,34 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import os
 import shutil
-import os
+import sys
 import urllib2
 import urlparse
+from subprocess import Popen, PIPE
 
 _fake_files = None
 _fake_paths = None
 
+class Tee(file):
+    """ A file-like object that optionally mimics tee functionality.
+
+    By default, output will go to both stdout and the file specified.
+    Optionally, quiet=True can be used to mute the output to stdout.
+    """
+    def __init__(self, *args, **kwargs):
+        try:
+            self.quiet = kwargs.pop('quiet')
+        except KeyError:
+            self.quiet = False
+        super(Tee, self).__init__(*args, **kwargs)
+
+    def write(self, data):
+        super(Tee, self).write(data)
+        if self.quiet is False:
+            sys.stdout.write(data)
+
 def geturl(url, path=""):
     urlpath = urlparse.urlsplit(url).path
     filename = os.path.basename(urlpath)
@@ -77,3 +97,14 @@
     global _fake_paths
     _fake_files = {}
     _fake_paths = {}
+
+def run_and_log(cmd, fd):
+    """
+    Run a command and log the output to fd
+    """
+    proc = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE)
+    while proc.poll() is None:
+        output, err = proc.communicate()
+        if output is not None:
+            fd.write(output)
+    return proc.returncode

=== modified file 'tests/test_abrektestrunner.py'
--- tests/test_abrektestrunner.py	2010-09-10 17:09:14 +0000
+++ tests/test_abrektestrunner.py	2010-09-21 22:42:49 +0000
@@ -20,9 +20,13 @@
 from datetime import datetime
 
 from abrek.testdef import AbrekTestRunner
-
-
-class testAbrekTestInstaller(unittest.TestCase):
+from imposters import OutputImposter
+from fixtures import TestCaseWithFixtures
+
+def makerunner(**kwargs):
+    return AbrekTestRunner(**kwargs)
+
+class testAbrekTestRunner(unittest.TestCase):
     def setUp(self):
         self.origdir = os.path.abspath(os.curdir)
         self.tmpdir = tempfile.mkdtemp()
@@ -33,33 +37,68 @@
         os.chdir(self.origdir)
         shutil.rmtree(self.tmpdir)
 
-    def makerunner(self,**kwargs):
-        return AbrekTestRunner(**kwargs)
-
     def test_starttime(self):
-        runner = self.makerunner()
+        runner = makerunner()
         runner.run(self.tmpdir)
         self.assertTrue(isinstance(runner.starttime, datetime))
 
     def test_endtime(self):
-        runner = self.makerunner()
+        runner = makerunner()
         runner.run(self.tmpdir)
         self.assertTrue(isinstance(runner.endtime, datetime))
 
     def test_timediff(self):
         steps = ['sleep 2']
-        runner = self.makerunner(steps=steps)
+        runner = makerunner(steps=steps)
         runner.run(self.tmpdir)
         self.assertNotEqual(runner.starttime, runner.endtime)
 
     def test_runsteps(self):
         steps = ["echo test > foo"]
-        runner = self.makerunner(steps=steps)
+        runner = makerunner(steps=steps)
         runner._runsteps(self.tmpdir)
         self.assertTrue(os.path.exists("./foo"))
 
     def test_logoutput(self):
         steps = ["echo test > foo"]
-        runner = self.makerunner(steps=steps)
+        runner = makerunner(steps=steps)
         runner._runsteps(self.tmpdir)
         self.assertTrue(os.path.exists("./testoutput.log"))
+
+class testAbrekTestRunnerVerbosity(TestCaseWithFixtures):
+    def setUp(self):
+        super(testAbrekTestRunnerVerbosity, self).setUp()
+        self.origdir = os.path.abspath(os.curdir)
+        self.tmpdir = tempfile.mkdtemp()
+        self.filename = os.path.abspath(__file__)
+        os.chdir(self.tmpdir)
+        self.out = self.add_fixture(OutputImposter())
+
+    def tearDown(self):
+        super(testAbrekTestRunnerVerbosity, self).tearDown()
+        os.chdir(self.origdir)
+        shutil.rmtree(self.tmpdir)
+
+    def test_runsteps_quiet_true(self):
+        steps = ["echo test"]
+        runner = makerunner(steps=steps)
+        runner._runsteps(self.tmpdir, quiet=True)
+        self.assertEqual("", self.out.getvalue().strip())
+
+    def test_runsteps_quiet_false(self):
+        steps = ["echo test"]
+        runner = makerunner(steps=steps)
+        runner._runsteps(self.tmpdir, quiet=False)
+        self.assertEqual("test", self.out.getvalue().strip())
+
+    def test_run_quiet_true(self):
+        steps = ["echo test"]
+        runner = makerunner(steps=steps)
+        runner.run(self.tmpdir, quiet=True)
+        self.assertEqual("", self.out.getvalue().strip())
+
+    def test_run_quiet_false(self):
+        steps = ["echo test"]
+        runner = makerunner(steps=steps)
+        runner.run(self.tmpdir, quiet=False)
+        self.assertEqual("test", self.out.getvalue().strip())