From 17f006511d723420aff4892e3d3cf35cd72ddceb Mon Sep 17 00:00:00 2001 From: Franz Chih-Ping Hsieh Date: Tue, 24 Oct 2017 15:23:16 -0400 Subject: [PATCH] add unittests for koji commands - assign-task - wrapper-rpm --- tests/test_cli/test_assign_task.py | 110 ++++++++++++++++ tests/test_cli/test_wrapper_rpm.py | 198 +++++++++++++++++++++++++++++ 2 files changed, 308 insertions(+) create mode 100644 tests/test_cli/test_assign_task.py create mode 100644 tests/test_cli/test_wrapper_rpm.py diff --git a/tests/test_cli/test_assign_task.py b/tests/test_cli/test_assign_task.py new file mode 100644 index 00000000..45c0966d --- /dev/null +++ b/tests/test_cli/test_assign_task.py @@ -0,0 +1,110 @@ +from __future__ import absolute_import +import mock +import os +import six +import sys +import unittest +import koji + +from koji_cli.commands import handle_assign_task + + +class TestAssignTask(unittest.TestCase): + + # Show long diffs in error output... + maxDiff = None + + @mock.patch('sys.stdout', new_callable=six.StringIO) + @mock.patch('koji_cli.commands.activate_session') + def test_handle_assign_task( + self, activate_session_mock, stdout): + hostname = "host" + task_id = "1" + arguments = [task_id, hostname] + options = mock.MagicMock() + progname = os.path.basename(sys.argv[0]) or 'koji' + + # Mock out the xmlrpc server + session = mock.MagicMock() + + session.getTaskInfo.return_value = None + with six.assertRaisesRegex(self, koji.GenericError, + "No such task: %s" % task_id): + handle_assign_task(options, session, arguments) + + session.getTaskInfo.return_value = "task_info" + session.getHost.return_value = None + with six.assertRaisesRegex(self, koji.GenericError, + "No such host: %s" % hostname): + handle_assign_task(options, session, arguments) + + arguments.append("--force") + session.getHost.return_value = hostname + session.hasPerm.return_value = False + handle_assign_task(options, session, arguments) + actual = stdout.getvalue() + expected = "This action requires admin privileges\n" + self.assertMultiLineEqual(actual, expected) + + # Clean stdout buffer + stdout.truncate(0) + stdout.seek(0) + + session.hasPerm.return_value = True + session.assignTask.return_value = True + handle_assign_task(options, session, arguments) + actual = stdout.getvalue() + expected = 'assigned task %s to host %s\n' % \ + (task_id, hostname) + self.assertMultiLineEqual(actual, expected) + + # Clean stdout buffer + stdout.truncate(0) + stdout.seek(0) + + session.assignTask.return_value = False + handle_assign_task(options, session, arguments) + actual = stdout.getvalue() + expected = 'failed to assign task %s to host %s\n' % \ + (task_id, hostname) + self.assertMultiLineEqual(actual, expected) + + # Finally, assert that things were called as we expected. + activate_session_mock.assert_called_with(session, options) + session.assignTask.assert_called_with(int(task_id), hostname, True) + + @mock.patch('sys.stdout', new_callable=six.StringIO) + @mock.patch('sys.stderr', new_callable=six.StringIO) + @mock.patch('koji_cli.commands.activate_session') + def test_handle_assign_task_help( + self, activate_session_mock, stderr, stdout): + arguments = [] + options = mock.MagicMock() + progname = os.path.basename(sys.argv[0]) or 'koji' + + # Mock out the xmlrpc server + session = mock.MagicMock() + + # Run it and check immediate output + with self.assertRaises(SystemExit) as cm: + handle_assign_task(options, session, arguments) + actual_stdout = stdout.getvalue() + actual_stderr = stderr.getvalue() + expected_stdout = '' + expected_stderr = """Usage: %s assign-task task_id hostname +(Specify the --help global option for a list of other help options) + +%s: error: please specify a task id and a hostname +""" % (progname, progname) + self.assertMultiLineEqual(actual_stdout, expected_stdout) + self.assertMultiLineEqual(actual_stderr, expected_stderr) + + # Finally, assert that things were called as we expected. + activate_session_mock.assert_not_called() + session.hasHost.assert_not_called() + session.addHost.assert_not_called() + self.assertEqual(cm.exception.code, 2) + + +if __name__ == '__main__': + unittest.main() diff --git a/tests/test_cli/test_wrapper_rpm.py b/tests/test_cli/test_wrapper_rpm.py new file mode 100644 index 00000000..5aca281e --- /dev/null +++ b/tests/test_cli/test_wrapper_rpm.py @@ -0,0 +1,198 @@ +from __future__ import absolute_import +import mock +import os +import six +import sys +import unittest +import koji + +from koji_cli.commands import handle_wrapper_rpm + + +class TestWrapperRpm(unittest.TestCase): + + # Show long diffs in error output... + maxDiff = None + + def setUp(self): + self.progname = os.path.basename(sys.argv[0]) or 'koji' + self.target = 'target' + self.build = '1' + self.scm_url = 'git+https://github.com/project/test#12345' + self.task_id = 1 + + def assert_console_output(self, device, expected, wipe=True, regex=False): + if not isinstance(device, six.StringIO): + raise TypeError('Not a StringIO object') + + output = device.getvalue() + if not regex: + self.assertMultiLineEqual(output, expected) + else: + six.assertRegex(self, output, expected) + if wipe: + device.truncate(0) + device.seek(0) + + @mock.patch('sys.stdout', new_callable=six.StringIO) + @mock.patch('sys.stderr', new_callable=six.StringIO) + @mock.patch('koji_cli.commands.watch_tasks') + @mock.patch('koji_cli.commands.activate_session') + def test_handle_wrapper_rpm(self, activate_session_mock, + watch_tasks_mock, stderr, stdout): + """Test handle_wrapper_rpm function without --ini option""" + arguments = [self.target, self.build, self.scm_url] + options = mock.MagicMock(weburl='weburl') + + # Mock out the xmlrpc server + session = mock.MagicMock() + session.logout.return_value = None + session.wrapperRPM.return_value = self.task_id + + # Argument tests + arguments.extend(['--create-build', '--skip-tag', '--scratch']) + with mock.patch('koji_cli.commands._running_in_bg', + return_value=False): + handle_wrapper_rpm(options, session, + arguments + ['--nowait', '--background']) + expected = "Created task: %d\n" % self.task_id + expected += "Task info: %s/taskinfo?taskID=%s\n" % \ + (options.weburl, self.task_id) + self.assert_console_output(stdout, expected) + + watch_tasks_mock.return_value = True + self.assertTrue(handle_wrapper_rpm(options, session, arguments)) + expected = "Created task: %d\n" % self.task_id + expected += "Task info: %s/taskinfo?taskID=%s\n" % \ + (options.weburl, self.task_id) + self.assert_console_output(stdout, expected) + + # Finally, assert that things were called as we expected. + activate_session_mock.assert_called_with(session, options) + watch_tasks_mock.assert_called_with( + session, [self.task_id], quiet=options.quiet, + poll_interval=options.poll_interval) + + @mock.patch('sys.stdout', new_callable=six.StringIO) + @mock.patch('sys.stderr', new_callable=six.StringIO) + @mock.patch('koji.util.parse_maven_param') + @mock.patch('koji_cli.commands.watch_tasks') + @mock.patch('koji_cli.commands.activate_session') + def test_handle_wrapper_rpm_with_ini_config( + self, activate_session_mock, watch_tasks_mock, + parse_maven_mock, stderr, stdout): + """Test handle_wrapper_rpm function with --ini option""" + arguments = [] + options = mock.MagicMock(weburl='weburl') + + target_info = { + 'dest_tag_name': 'dest_tag_name', + 'dest_tag': 'dest_tag' + } + + maven_param = { + 'pkg1': { + 'type': 'wrapper', + 'scmurl': 'scmurl', + 'buildrequires': ['r1'], + 'create_build': True} + } + + # Mock out the xmlrpc server + session = mock.MagicMock() + session.logout.return_value = None + session.getBuildTarget.return_value = target_info + session.getLatestBuilds.return_value = None + session.wrapperRPM.return_value = self.task_id + + # With --ini option, only build target is required + arguments = [ + self.target, + self.build, + self.scm_url, + '--ini=/etc/koji.ini' + ] + with self.assertRaises(SystemExit) as cm: + handle_wrapper_rpm(options, session, arguments) + expected_stderr = """Usage: %s wrapper-rpm [options] target build-id|n-v-r URL +(Specify the --help global option for a list of other help options) + +%s: error: Exactly one argument (a build target) is required +""" % (self.progname, self.progname) + self.assert_console_output(stdout, '') + self.assert_console_output(stderr, expected_stderr) + + # If koji.util.parse_maven_param has troubles + # ValueError exception + arguments = [self.target, '--ini=/etc/koji.ini'] + with self.assertRaises(SystemExit) as cm: + parse_maven_mock.side_effect = ValueError('fake-value-error') + handle_wrapper_rpm(options, session, arguments) + self.assert_console_output( + stderr, '.*error: fake-value-error', regex=True) + self.assertEqual(cm.exception.code, 2) + + parse_maven_mock.side_effect = None + + # type != wrapper case + with self.assertRaises(SystemExit) as cm: + bad_param = {'pkg1': maven_param['pkg1'].copy()} + bad_param['pkg1']['type'] = 'undefined' + parse_maven_mock.return_value = bad_param + handle_wrapper_rpm(options, session, arguments) + self.assert_console_output( + stderr, + 'Section .* does not contain a wrapper-rpm config', + regex=True) + + # Lastest build does not exist case + parse_maven_mock.return_value = maven_param + with self.assertRaises(SystemExit) as cm: + handle_wrapper_rpm(options, session, arguments) + self.assert_console_output( + stderr, + '.*error: No build of .* in %s' % target_info['dest_tag_name'], + regex=True) + + # Check everything should work fine + session.getLatestBuilds.return_value = [{'nvr': 'r1'}] + handle_wrapper_rpm(options, session, arguments) + expected = "Created task: %d\n" % self.task_id + expected += "Task info: %s/taskinfo?taskID=%s\n" % \ + (options.weburl, self.task_id) + self.assert_console_output(stdout, expected) + + activate_session_mock.assert_called_with(session, options) + watch_tasks_mock.assert_called_with( + session, [self.task_id], quiet=options.quiet, + poll_interval=options.poll_interval) + + @mock.patch('sys.stdout', new_callable=six.StringIO) + @mock.patch('sys.stderr', new_callable=six.StringIO) + @mock.patch('koji_cli.commands.activate_session') + def test_handle_wrapper_rpm_help(self, activate_session_mock, + stderr, stdout): + """Test handle_wrapper_rpm help message output""" + arguments = [] + options = mock.MagicMock() + + # Mock out the xmlrpc server + session = mock.MagicMock() + + # Run it and check immediate output + with self.assertRaises(SystemExit) as cm: + handle_wrapper_rpm(options, session, arguments) + expected_stderr = """Usage: %s wrapper-rpm [options] target build-id|n-v-r URL +(Specify the --help global option for a list of other help options) + +%s: error: You must provide a build target, a build ID or NVR, and a SCM URL to a specfile fragment +""" % (self.progname, self.progname) + self.assert_console_output(stdout, '') + self.assert_console_output(stderr, expected_stderr) + + # Finally, assert that things were called as we expected. + activate_session_mock.assert_not_called() + self.assertEqual(cm.exception.code, 2) + +if __name__ == '__main__': + unittest.main()