Changes to run_script_before, exceptions and testsuites.

Author: tony

CHANGES

@@ -4,6 +4,17 @@ Changelog
 
 Here you can find the recent changes to tmuxp.
 
+CURRENT
+-------
+
+- [internal]: Improvements to :func:`util.run_script_before`,
+  :class:`exc.BeforeLoadScriptFailed` behavior to print ``stdout`` and
+  return ``stderr`` is a non-zero exit is returned.
+- [internal]: ``run_script_before`` has moved to ``util``.
+- [internal]: ``BeforeLoadScriptFailed`` and ``BeforeLoadScriptNotExists``
+  has moved to the ``exc`` module.
+- [internal]: Tests for ``run_script_before`` refactored.
+
 0.1.10
 ------
 

doc/api.rst

@@ -125,6 +125,10 @@ Exceptions
 
 .. autoexception:: tmuxp.exc.ConfigError
 
+.. autoexception:: tmuxp.exc.BeforeLoadScriptFailed
+
+.. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
+
 Test tools
 ----------
 

tmuxp/_compat.py

@@ -33,11 +33,16 @@
     from string import lower as ascii_lowercase
     import urlparse
 
+    exec('def reraise(tp, value, tb=None):\n raise tp, value, tb')
+
+    def implements_to_string(cls):
+        cls.__unicode__ = cls.__str__
+        cls.__str__ = lambda x: x.__unicode__().encode('utf-8')
+        return cls
+
     def console_to_str(s):
         return s.decode('utf_8')
 
-    exec('def reraise(tp, value, tb=None):\n raise tp, value, tb')
-
 else:
     unichr = chr
     text_type = str
@@ -68,6 +73,8 @@ def console_to_str(s):
 
     console_encoding = sys.__stdout__.encoding
 
+    implements_to_string = _identity
+
     def console_to_str(s):
         """ From pypa/pip project, pip.backwardwardcompat. License MIT. """
         try:

tmuxp/exc.py

@@ -9,6 +9,10 @@
 from __future__ import absolute_import, division, print_function, \
     with_statement, unicode_literals
 
+import subprocess
+
+from ._compat import implements_to_string
+
 
 class TmuxpException(Exception):
 
@@ -39,3 +43,28 @@ class EmptyConfigException(ConfigError):
     """Configuration is empty."""
 
     pass
+
+
+class BeforeLoadScriptNotExists(OSError):
+
+    def __init__(self, *args, **kwargs):
+        super(BeforeLoadScriptNotExists, self).__init__(*args, **kwargs)
+
+        self.strerror = "before_script file '%s' doesn't exist." % self.strerror
+
+
+@implements_to_string
+class BeforeLoadScriptFailed(subprocess.CalledProcessError):
+
+    """Exception extending :py:class:`subprocess.CalledProcessError` for
+    :meth:`util.run_before_script`.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(BeforeLoadScriptFailed, self).__init__(*args, **kwargs)
+
+    def __str__(self):
+        return "before_script failed (%s): %s." \
+            "\nError Output: \n%s" % (
+                self.returncode, self.cmd, self.output
+            )

tmuxp/testsuite/fixtures/script_failed.sh

@@ -1,4 +1,8 @@
 #!/bin/bash
 
+
+echoerr() { echo "$@" 1>&2; }
+echoerr An error has occured
+
 exit 113   # Will return 113 to shell.
            # To verify this, type "echo $?" after script terminates.

tmuxp/testsuite/util.py

@@ -12,14 +12,21 @@
 import random
 import logging
 import unittest
+import subprocess
+import os
 
 from .. import exc
-from ..util import has_required_tmux_version
+from ..util import has_required_tmux_version, run_before_script
+from ..exc import BeforeLoadScriptNotExists, BeforeLoadScriptFailed
 
-from .helpers import TmuxTestCase
+
+from .helpers import TmuxTestCase, TestCase
 
 logger = logging.getLogger(__name__)
 
+current_dir = os.path.abspath(os.path.dirname(__file__))
+fixtures_dir = os.path.abspath(os.path.join(current_dir, 'fixtures'))
+
 
 class TmuxVersionTest(TmuxTestCase):
 
@@ -54,7 +61,47 @@ def test_error_version_less_1_7(self):
         has_required_tmux_version('1.9a')
 
 
+class RunBeforeScript(TestCase):
+
+    def test_raise_BeforeLoadScriptNotExists_if_not_exists(self):
+        script_file = os.path.join(fixtures_dir, 'script_noexists.sh')
+
+        with self.assertRaises(BeforeLoadScriptNotExists):
+            run_before_script(script_file)
+
+        with self.assertRaises(OSError):
+            run_before_script(script_file)
+
+    def test_raise_BeforeLoadScriptFailed_if_retcode(self):
+        script_file = os.path.join(fixtures_dir, 'script_failed.sh')
+
+        with self.assertRaises(BeforeLoadScriptFailed):
+            run_before_script(script_file)
+
+    def test_return_stdout_if_ok(self):
+        script_file = os.path.join(fixtures_dir, 'script_complete.sh')
+
+        run_before_script(script_file)
+
+
+class BeforeLoadScriptFailedTestCase(TestCase):
+
+    def test_returncode(self):
+        script_file = os.path.join(fixtures_dir, 'script_failed.sh')
+
+        with self.assertRaisesRegexp(subprocess.CalledProcessError, "113"):
+            run_before_script(script_file)
+
+    def test_returns_stderr_messages(self):
+        script_file = os.path.join(fixtures_dir, 'script_failed.sh')
+
+        with self.assertRaisesRegexp(subprocess.CalledProcessError, "An error has occured"):
+            run_before_script(script_file)
+
+
 def suite():
     suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(BeforeLoadScriptFailedTestCase))
+    suite.addTest(unittest.makeSuite(RunBeforeScript))
     suite.addTest(unittest.makeSuite(TmuxVersionTest))
     return suite

tmuxp/testsuite/workspacebuilder.py

@@ -587,7 +587,7 @@ class BeforeLoadScript(TmuxTestCase):
       - pane
     """
 
-    def test_throw_error_if_retcode_false(self):
+    def test_throw_error_if_retcode_error(self):
 
         sconfig = kaptan.Kaptan(handler='yaml')
         yaml = self.config_script_fails.format(
@@ -602,7 +602,7 @@ def test_throw_error_if_retcode_false(self):
         with self.temp_session() as sess:
             session_name = sess.get('session_name')
 
-            with self.assertRaises(subprocess.CalledProcessError):
+            with self.assertRaises((exc.BeforeLoadScriptFailed, subprocess.CalledProcessError)):
                 builder.build(session=sess)
 
             result = self.server.has_session(session_name)
@@ -628,7 +628,7 @@ def test_throw_error_if_file_not_exists(self):
             temp_session_exists = self.server.has_session(sess.get('session_name'))
             self.assertTrue(temp_session_exists)
             with self.assertRaisesRegexp(
-                (BeforeLoadScriptNotExists, OSError),
+                (exc.BeforeLoadScriptNotExists, OSError),
                 'No such file or directory'
             ):
                 builder.build(session=sess)
@@ -654,40 +654,9 @@ def test_true_if_test_passes(self):
             builder.build(session=self.session)
 
 
-from ..workspacebuilder import run_before_script, BeforeLoadScriptNotExists, \
-    BeforeLoadScriptFailed
-
-
-class RunBeforeScript(TestCase):
-
-    def test_raise_BeforeLoadScriptNotExists_if_not_exists(self):
-        script_file = os.path.join(fixtures_dir, 'script_noexists.sh')
-
-        with self.assertRaises(BeforeLoadScriptNotExists):
-            run_before_script(script_file)
-
-        with self.assertRaises(OSError):
-            run_before_script(script_file)
-
-    def test_raise_BeforeLoadScriptFailed_if_retcode(self):
-        script_file = os.path.join(fixtures_dir, 'script_failed.sh')
-
-        with self.assertRaises(BeforeLoadScriptFailed):
-            run_before_script(script_file)
-
-        with self.assertRaises(subprocess.CalledProcessError):
-            run_before_script(script_file)
-
-    def test_return_stdout_if_exits_zero(self):
-        script_file = os.path.join(fixtures_dir, 'script_complete.sh')
-
-        run_before_script(script_file)
-
-
 def suite():
     suite = unittest.TestSuite()
     suite.addTest(unittest.makeSuite(BeforeLoadScript))
-    suite.addTest(unittest.makeSuite(RunBeforeScript))
     suite.addTest(unittest.makeSuite(BlankPaneTest))
     suite.addTest(unittest.makeSuite(FocusAndPaneIndexTest))
     suite.addTest(unittest.makeSuite(PaneOrderingTest))

tmuxp/util.py

@@ -27,6 +27,35 @@
 PY2 = sys.version_info[0] == 2
 
 
+def run_before_script(script_file):
+    """Function to wrap try/except for subprocess.check_call()."""
+    try:
+        proc = subprocess.Popen(
+            script_file,
+            # stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE
+        )
+        proc.wait()
+
+        if proc.returncode:
+            stderr = proc.stderr.read()
+            proc.stderr.close()
+            stderr = console_to_str(stderr).split('\n')
+            stderr = '\n'.join(list(filter(None, stderr)))  # filter empty values
+
+            # python 2.6 doesn't have a third "output" argument.
+            error = exc.BeforeLoadScriptFailed(proc.returncode, script_file)
+            error.output = stderr
+
+            raise(error)
+        return proc.returncode
+    except OSError as e:
+        if e.errno == 2:
+            raise exc.BeforeLoadScriptNotExists(e, script_file)
+        else:
+            raise(e)
+
+
 class tmux(object):
 
     """:py:mod:`subprocess` for :term:`tmux(1)`.

tmuxp/workspacebuilder.py

@@ -14,47 +14,12 @@
 import subprocess
 
 from . import exc, config, Window, Pane, Session, Server
-from ._compat import PY2
+from ._compat import PY2, console_to_str
+from .util import run_before_script
 
 logger = logging.getLogger(__name__)
 
 
-class BeforeLoadScriptNotExists(OSError):
-
-    def __init__(self, *args, **kwargs):
-        super(BeforeLoadScriptNotExists, self).__init__(*args, **kwargs)
-
-        self.strerror = "before_script file '%s' doesn't exist." % self.strerror
-
-
-class BeforeLoadScriptFailed(subprocess.CalledProcessError):
-
-    def __init__(self, *args, **kwargs):
-        super(BeforeLoadScriptFailed, self).__init__(*args, **kwargs)
-
-    def __unicode__(self):
-        return "before_script failed (%s): %s. Output: \n%s" % (
-            self.returncode, self.cmd, self.output
-        )
-
-    if PY2:
-        def __str__(self):
-            return self.__unicode__().encode('utf-8')
-
-
-def run_before_script(script_file):
-    """Function to wrap try/except for subprocess.check_call()."""
-    try:
-        return subprocess.check_call(script_file, stdout=subprocess.PIPE)
-    except subprocess.CalledProcessError as e:
-        raise BeforeLoadScriptFailed(e.returncode, e.cmd)
-    except OSError as e:
-        if e.errno == 2:
-            raise BeforeLoadScriptNotExists(e, script_file)
-        else:
-            raise(e)
-
-
 class WorkspaceBuilder(object):
 
     """Load workspace from session :py:obj:`dict`.