From dec0c7b77f954127850483dca2b8477bb012683e Mon Sep 17 00:00:00 2001 From: Mike McLean Date: Oct 28 2017 00:46:05 +0000 Subject: PR#633: unify runroot CLI interface Merges #633 https://pagure.io/koji/pull-request/633 Fixes: #564 https://pagure.io/koji/issue/564 Add --nowait option for koji runroot --- diff --git a/plugins/cli/runroot.py b/plugins/cli/runroot.py index 04c02fb..f8d4b50 100644 --- a/plugins/cli/runroot.py +++ b/plugins/cli/runroot.py @@ -3,7 +3,8 @@ import time import koji from koji.plugin import export_cli -from koji_cli.lib import _, activate_session, OptionParser, list_task_output_all_volumes +from koji_cli.lib import _, activate_session, OptionParser, watch_tasks, \ + list_task_output_all_volumes @export_cli def handle_runroot(options, session, args): @@ -25,11 +26,18 @@ def handle_runroot(options, session, args): parser.add_option("--new-chroot", action="store_true", default=False, help=_("Run command with the --new-chroot (systemd-nspawn) option to mock")) parser.add_option("--repo-id", type="int", help=_("ID of the repo to use")) + parser.add_option("--nowait", action="store_false", dest="wait", + default=True, help=_("Do not wait on task")) + parser.add_option("--watch", action="store_true", help=_("Watch task instead of printing runroot.log")) + parser.add_option("--quiet", action="store_true", default=options.quiet, + help=_("Do not print the task information")) (opts, args) = parser.parse_args(args) if len(args) < 3: parser.error(_("Incorrect number of arguments")) + assert False # pragma: no cover + activate_session(session, options) tag = args[0] arch = args[1] @@ -59,6 +67,14 @@ def handle_runroot(options, session, args): if opts.task_id: print(task_id) + if not opts.wait: + return + + if opts.watch: + session.logout() + return watch_tasks(session, [task_id], quiet=opts.quiet, + poll_interval=options.poll_interval) + try: while True: # wait for the task to finish @@ -81,4 +97,3 @@ def handle_runroot(options, session, args): state = koji.TASK_STATES[info['state']] if state in ('FAILED', 'CANCELED'): sys.exit(1) - return diff --git a/tests/test_plugins/test_runroot_cli.py b/tests/test_plugins/test_runroot_cli.py index 905e5dc..7005e63 100644 --- a/tests/test_plugins/test_runroot_cli.py +++ b/tests/test_plugins/test_runroot_cli.py @@ -8,29 +8,39 @@ from . import load_plugin runroot = load_plugin.load_plugin('cli', 'runroot') + +class ParserError(Exception): + pass + + class TestListCommands(unittest.TestCase): def setUp(self): self.options = mock.MagicMock() + self.options.debug = False self.session = mock.MagicMock() self.session.getAPIVersion.return_value = koji.API_VERSION - self.args = mock.MagicMock() - runroot.OptionParser = mock.MagicMock() - self.parser = runroot.OptionParser.return_value + self.args = ['TAG', 'ARCH', 'COMMAND'] + self.old_OptionParser = runroot.OptionParser + runroot.OptionParser = mock.MagicMock(side_effect=self.get_parser) + self.old_watch_tasks = runroot.watch_tasks + runroot.watch_tasks = mock.MagicMock(name='watch_tasks') + + def tearDown(self): + runroot.OptionParser = self.old_OptionParser + runroot.watch_tasks = self.old_watch_tasks + + def get_parser(self, *a, **kw): + # we don't want parser.error to exit + parser = self.old_OptionParser(*a, **kw) + parser.error = mock.MagicMock(side_effect=ParserError) + return parser # Show long diffs in error output... maxDiff = None @mock.patch('sys.stdout', new_callable=six.StringIO) def test_handle_runroot(self, stdout): - tag = 'tag' - arch = 'arch' - command = 'command' - arguments = [tag, arch, command] - options = mock.MagicMock() - options.new_chroot = False - self.parser.parse_args.return_value = [options, arguments] - # Mock out the xmlrpc server self.session.getTaskInfo.return_value = {'state': 1} self.session.downloadTaskOutput.return_value = 'task output' @@ -41,7 +51,7 @@ class TestListCommands(unittest.TestCase): runroot.handle_runroot(self.options, self.session, self.args) actual = stdout.getvalue() actual = actual.replace('nosetests', 'koji') - expected = 'successfully connected to hub\n1\ntask output' + expected = 'task output' self.assertMultiLineEqual(actual, expected) # Finally, assert that things were called as we expected. @@ -50,7 +60,52 @@ class TestListCommands(unittest.TestCase): self.session.downloadTaskOutput.assert_called_once_with( 1, 'runroot.log', volume='DEFAULT') self.session.runroot.assert_called_once_with( - tag, arch, command, repo_id=mock.ANY, weight=mock.ANY, + 'TAG', 'ARCH', ['COMMAND'], repo_id=mock.ANY, weight=mock.ANY, mounts=mock.ANY, packages=mock.ANY, skip_setarch=mock.ANY, channel=mock.ANY, ) + + def test_handle_runroot_watch(self): + args = ['--watch', 'TAG', 'ARCH', 'COMMAND'] + + # Mock out the xmlrpc server + self.session.runroot.return_value = 1 + + # Run it and check immediate output + runroot.handle_runroot(self.options, self.session, args) + + # Finally, assert that things were called as we expected. + runroot.watch_tasks.assert_called_once() + self.session.getTaskInfo.assert_not_called() + self.session.listTaskOutput.assert_not_called() + self.session.downloadTaskOutput.assert_not_called() + self.session.runroot.assert_called_once() + + def test_invalid_arguments(self): + args = ['TAG', 'COMMAND'] # no arch + + # Run it and check immediate output + with self.assertRaises(ParserError): + runroot.handle_runroot(self.options, self.session, args) + + # Finally, assert that things were called as we expected. + self.session.getTaskInfo.assert_not_called() + self.session.listTaskOutput.assert_not_called() + self.session.downloadTaskOutput.assert_not_called() + self.session.runroot.assert_not_called() + + def test_nowait(self): + args = ['--nowait', 'TAG', 'ARCH', 'COMMAND'] + + # Mock out the xmlrpc server + self.session.runroot.return_value = 1 + + # Run it and check immediate output + runroot.handle_runroot(self.options, self.session, args) + + # Finally, assert that things were called as we expected. + runroot.watch_tasks.assert_not_called() + self.session.getTaskInfo.assert_not_called() + self.session.listTaskOutput.assert_not_called() + self.session.downloadTaskOutput.assert_not_called() + self.session.runroot.assert_called_once()