Allow configuring (run|rebot)_cli to not always exit.

pekkaklarck · pekkaklarck · commit 1ab0887cce6d · 2016-12-28T13:06:49.000+02:00
Both functions got optional `exit=True` argument. Fixes robotframework#2504.
diff --git a/src/robot/rebot.py b/src/robot/rebot.py
@@ -353,22 +353,22 @@ def main(self, datasources, **options):
         return rc
 
 
-def rebot_cli(arguments):
+def rebot_cli(arguments, exit=True):
     """Command line execution entry point for running rebot.
 
     :param arguments: Command line arguments as a list of strings.
+    :param exit: If `True`, call `sys.exit` with the return code denoting
+        execution status, otherwise just return the rc. New in 3.0.1.
 
-    For programmatic usage the :func:`rebot` method is typically better. It has
-    a better API for that usage and does not call :func:`sys.exit` like this
-    method.
+    For programmatic usage the :func:`rebot` method is typically better.
 
     Example::
 
         from robot import rebot_cli
 
         rebot_cli(['--report', 'r.html', '--log', 'NONE', 'o1.xml', 'o2.xml'])
     """
-    Rebot().execute_cli(arguments)
+    return Rebot().execute_cli(arguments, exit=exit)
 
 
 def rebot(*datasources, **options):
diff --git a/src/robot/run.py b/src/robot/run.py
@@ -449,22 +449,22 @@ def _filter_options_without_value(self, options):
                     if value not in (None, []))
 
 
-def run_cli(arguments):
+def run_cli(arguments, exit=True):
     """Command line execution entry point for running tests.
 
     :param arguments: Command line arguments as a list of strings.
+    :param exit: If `True`, call `sys.exit` with the return code denoting
+        execution status, otherwise just return the rc. New in 3.0.1.
 
-    For programmatic usage the :func:`run` function is typically better. It has
-    a better API for that usage and does not call :func:`sys.exit` like this
-    function.
+    For programmatic usage the :func:`run` function is typically better.
 
     Example::
 
         from robot import run_cli
 
         run_cli(['--include', 'tag', 'path/to/tests.html'])
     """
-    RobotFramework().execute_cli(arguments)
+    return RobotFramework().execute_cli(arguments, exit=exit)
 
 
 def run(*datasources, **options):
diff --git a/src/robot/utils/application.py b/src/robot/utils/application.py
@@ -39,12 +39,14 @@ def main(self, arguments, **options):
     def validate(self, options, arguments):
         return options, arguments
 
-    def execute_cli(self, cli_arguments):
+    def execute_cli(self, cli_arguments, exit=True):
         with self._logger:
             self._logger.info('%s %s' % (self._ap.name, self._ap.version))
             options, arguments = self._parse_arguments(cli_arguments)
             rc = self._execute(arguments, options)
-        self._exit(rc)
+        if exit:
+            self._exit(rc)
+        return rc
 
     def console(self, msg):
         if msg:
diff --git a/utest/api/test_run_and_rebot.py b/utest/api/test_run_and_rebot.py
@@ -9,11 +9,11 @@
 from os.path import abspath, dirname, join, exists, curdir
 from os import chdir
 
-from robot import run, rebot
+from robot import run, run_cli, rebot, rebot_cli
 from robot.model import SuiteVisitor
 from robot.running import namespace
 from robot.utils import StringIO
-from robot.utils.asserts import assert_equal, assert_true
+from robot.utils.asserts import assert_equal, assert_raises, assert_true
 
 from resources.runningtestcase import RunningTestCase
 from resources.Listener import Listener
@@ -146,6 +146,14 @@ def test_invalid_modifier(self):
                              [("[ ERROR ] Executing model modifier 'integer' "
                                "failed: AttributeError: ", 1)])
 
+    def test_run_cli_system_exits_by_default(self):
+        exit = assert_raises(SystemExit, run_cli, [self.data])
+        assert_equal(exit.code, 1)
+
+    def test_run_cli_optionally_returns_rc(self):
+        rc = run_cli([self.data], exit=False)
+        assert_equal(rc, 1)
+
 
 class TestRebot(RunningTestCase):
     data = join(ROOT, 'atest', 'testdata', 'rebot', 'created_normal.xml')
@@ -198,6 +206,14 @@ def visit_test(self, test):
                            prerebotmodifier=modifier), 3)
         assert_equal(modifier.tests, ['Test 1.1', 'Test 1.2', 'Test 2.1'])
 
+    def test_rebot_cli_system_exits_by_default(self):
+        exit = assert_raises(SystemExit, rebot_cli, [self.data])
+        assert_equal(exit.code, 1)
+
+    def test_rebot_cli_optionally_returns_rc(self):
+        rc = rebot_cli([self.data], exit=False)
+        assert_equal(rc, 1)
+
 
 class TestStateBetweenTestRuns(RunningTestCase):
     data = join(ROOT, 'atest', 'testdata', 'misc', 'normal.robot')
