Rename BeforeLoadScriptFailed to BeforeLoadScriptError, refactor.

Author: tony

doc/api.rst

@@ -125,7 +125,7 @@ Exceptions
 
 .. autoexception:: tmuxp.exc.ConfigError
 
-.. autoexception:: tmuxp.exc.BeforeLoadScriptFailed
+.. autoexception:: tmuxp.exc.BeforeLoadScriptError
 
 .. autoexception:: tmuxp.exc.BeforeLoadScriptNotExists
 
@@ -136,10 +136,6 @@ Test tools
 
 .. automethod:: tmuxp.testsuite.helpers.get_test_window_name
 
-.. automethod:: tmuxp.testsuite.helpers.get_test_pane_name
-
 .. automethod:: tmuxp.testsuite.helpers.temp_session
 
 .. automethod:: tmuxp.testsuite.helpers.temp_window
-
-.. automethod:: tmuxp.testsuite.helpers.temp_pane

tmuxp/exc.py

@@ -54,17 +54,22 @@ def __init__(self, *args, **kwargs):
 
 
 @implements_to_string
-class BeforeLoadScriptFailed(subprocess.CalledProcessError):
+class BeforeLoadScriptError(Exception):
 
-    """Exception extending :py:class:`subprocess.CalledProcessError` for
+    """Exception replacing :py:class:`subprocess.CalledProcessError` for
     :meth:`util.run_before_script`.
     """
 
-    def __init__(self, *args, **kwargs):
-        super(BeforeLoadScriptFailed, self).__init__(*args, **kwargs)
+    def __init__(self, returncode, cmd, output=None):
+        self.returncode = returncode
+        self.cmd = cmd
+        self.output = output
+        self.message = (
+            'before_script failed with returncode {returncode}.\n'
+            'command: {cmd}\n'
+            'Error output:\n'
+            '{output}'
+        ).format(returncode=self.returncode, cmd=self.cmd, output=self.output)
 
     def __str__(self):
-        return "before_script failed (%s): %s." \
-            "\nError Output: \n%s" % (
-                self.returncode, self.cmd, self.output
-            )
+        return self.message

tmuxp/testsuite/util.py

@@ -17,7 +17,7 @@
 
 from .. import exc
 from ..util import has_required_tmux_version, run_before_script
-from ..exc import BeforeLoadScriptNotExists, BeforeLoadScriptFailed
+from ..exc import BeforeLoadScriptNotExists, BeforeLoadScriptError
 
 
 from .helpers import TmuxTestCase, TestCase
@@ -72,10 +72,10 @@ def test_raise_BeforeLoadScriptNotExists_if_not_exists(self):
         with self.assertRaises(OSError):
             run_before_script(script_file)
 
-    def test_raise_BeforeLoadScriptFailed_if_retcode(self):
+    def test_raise_BeforeLoadScriptError_if_retcode(self):
         script_file = os.path.join(fixtures_dir, 'script_failed.sh')
 
-        with self.assertRaises(BeforeLoadScriptFailed):
+        with self.assertRaises(BeforeLoadScriptError):
             run_before_script(script_file)
 
     def test_return_stdout_if_ok(self):
@@ -84,24 +84,24 @@ def test_return_stdout_if_ok(self):
         run_before_script(script_file)
 
 
-class BeforeLoadScriptFailedTestCase(TestCase):
+class BeforeLoadScriptErrorTestCase(TestCase):
 
     def test_returncode(self):
         script_file = os.path.join(fixtures_dir, 'script_failed.sh')
 
-        with self.assertRaisesRegexp(subprocess.CalledProcessError, "113"):
+        with self.assertRaisesRegexp(exc.BeforeLoadScriptError, "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"):
+        with self.assertRaisesRegexp(exc.BeforeLoadScriptError, "failed with returncode"):
             run_before_script(script_file)
 
 
 def suite():
     suite = unittest.TestSuite()
-    suite.addTest(unittest.makeSuite(BeforeLoadScriptFailedTestCase))
+    suite.addTest(unittest.makeSuite(BeforeLoadScriptErrorTestCase))
     suite.addTest(unittest.makeSuite(RunBeforeScript))
     suite.addTest(unittest.makeSuite(TmuxVersionTest))
     return suite

tmuxp/testsuite/workspacebuilder.py

@@ -13,7 +13,6 @@
 import sys
 import logging
 import unittest
-import subprocess
 import time
 
 import kaptan
@@ -602,7 +601,7 @@ def test_throw_error_if_retcode_error(self):
         with self.temp_session() as sess:
             session_name = sess.get('session_name')
 
-            with self.assertRaises((exc.BeforeLoadScriptFailed, subprocess.CalledProcessError)):
+            with self.assertRaises(exc.BeforeLoadScriptError):
                 builder.build(session=sess)
 
             result = self.server.has_session(session_name)

tmuxp/util.py

@@ -43,11 +43,8 @@ def run_before_script(script_file):
             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 exc.BeforeLoadScriptError(proc.returncode, script_file, stderr)
 
-            raise(error)
         return proc.returncode
     except OSError as e:
         if e.errno == 2: