Add and upfate CLI unit tests

Fixes: https://pagure.io/koji/issue/729
This commit is contained in:
Jana Cupova 2021-11-04 10:00:29 +01:00 committed by Tomas Kopecek
parent ae15fa34ba
commit c3e89500f2
26 changed files with 1573 additions and 1537 deletions

View file

@ -1,67 +1,96 @@
from __future__ import absolute_import
import os
import sys
import mock
import six
from mock import call
from koji_cli.commands import handle_block_pkg
import koji
from . import utils
class TestBlockPkg(utils.CliTestCase):
# Show long diffs in error output...
maxDiff = None
def setUp(self):
# Show long diffs in error output...
self.maxDiff = None
self.options = mock.MagicMock()
self.options.debug = False
self.session = mock.MagicMock()
self.session.getAPIVersion.return_value = koji.API_VERSION
self.activate_session_mock = mock.patch('koji_cli.commands.activate_session').start()
self.error_format = """Usage: %s block-pkg [options] <tag> <package> [<package> ...]
(Specify the --help global option for a list of other help options)
%s: error: {message}
""" % (self.progname, self.progname)
@mock.patch('sys.stdout', new_callable=six.StringIO)
@mock.patch('koji_cli.commands.activate_session')
def test_handle_block_pkg(self, activate_session_mock, stdout):
def test_handle_block_pkg(self, stdout):
tag = 'tag'
dsttag = {'name': tag, 'id': 1}
package = 'package'
args = [tag, package, '--force']
options = mock.MagicMock()
# Mock out the xmlrpc server
session = mock.MagicMock()
session.getTag.return_value = dsttag
session.listPackages.return_value = [
self.session.getTag.return_value = dsttag
self.session.listPackages.return_value = [
{'package_name': package, 'package_id': 1}]
# Run it and check immediate output
# args: tag, package
# expected: success
rv = handle_block_pkg(options, session, args)
rv = handle_block_pkg(self.options, self.session, args)
actual = stdout.getvalue()
expected = ''
self.assertMultiLineEqual(actual, expected)
# Finally, assert that things were called as we expected.
activate_session_mock.assert_called_once_with(session, options)
session.getTag.assert_called_once_with(tag)
session.listPackages.assert_called_once_with(
self.activate_session_mock.assert_called_once_with(self.session, self.options)
self.session.getTag.assert_called_once_with(tag)
self.session.listPackages.assert_called_once_with(
tagID=dsttag['id'], inherited=True, with_owners=False)
session.packageListBlock.assert_called_once_with(
self.session.packageListBlock.assert_called_once_with(
tag, package, force=True)
session.multiCall.assert_called_once_with(strict=True)
self.session.multiCall.assert_called_once_with(strict=True)
self.assertFalse(rv)
@mock.patch('sys.stdout', new_callable=six.StringIO)
@mock.patch('koji_cli.commands.activate_session')
def test_handle_block_pkg_multi_pkg(self, activate_session_mock, stdout):
def test_handle_block_pkg_parameter_error(self, stdout):
tag = 'tag'
dsttag = {'name': tag, 'id': 1}
package = 'package'
args = [tag, package, '--force']
self.session.getTag.return_value = dsttag
self.session.listPackages.side_effect = [koji.ParameterError,
[{'package_name': package, 'package_id': 1}]]
# Run it and check immediate output
# args: tag, package
# expected: success
rv = handle_block_pkg(self.options, self.session, args)
actual = stdout.getvalue()
expected = ''
self.assertMultiLineEqual(actual, expected)
# Finally, assert that things were called as we expected.
self.activate_session_mock.assert_called_once_with(self.session, self.options)
self.session.getTag.assert_called_once_with(tag)
self.session.listPackages.assert_has_calls([
call(tagID=dsttag['id'], inherited=True, with_owners=False),
call(tagID=dsttag['id'], inherited=True)
])
self.session.packageListBlock.assert_called_once_with(
tag, package, force=True)
self.session.multiCall.assert_called_once_with(strict=True)
self.assertFalse(rv)
@mock.patch('sys.stdout', new_callable=six.StringIO)
def test_handle_block_pkg_multi_pkg(self, stdout):
tag = 'tag'
dsttag = {'name': tag, 'id': 1}
packages = ['package1', 'package2', 'package3']
args = [tag] + packages
options = mock.MagicMock()
# Mock out the xmlrpc server
session = mock.MagicMock()
session.getTag.return_value = dsttag
session.listPackages.return_value = [
self.session.getTag.return_value = dsttag
self.session.listPackages.return_value = [
{'package_name': 'package1', 'package_id': 1},
{'package_name': 'package2', 'package_id': 2},
{'package_name': 'package3', 'package_id': 3},
@ -70,14 +99,14 @@ class TestBlockPkg(utils.CliTestCase):
# Run it and check immediate output
# args: tag, package1, package2, package3
# expected: success
rv = handle_block_pkg(options, session, args)
rv = handle_block_pkg(self.options, self.session, args)
actual = stdout.getvalue()
expected = ''
self.assertMultiLineEqual(actual, expected)
# Finally, assert that things were called as we expected.
activate_session_mock.assert_called_once_with(session, options)
self.activate_session_mock.assert_called_once_with(self.session, self.options)
self.assertEqual(
session.mock_calls, [
self.session.mock_calls, [
call.getTag(tag),
call.listPackages(tagID=dsttag['id'], inherited=True, with_owners=False),
call.packageListBlock(tag, packages[0]),
@ -86,99 +115,71 @@ class TestBlockPkg(utils.CliTestCase):
call.multiCall(strict=True)])
self.assertNotEqual(rv, 1)
@mock.patch('sys.stderr', new_callable=six.StringIO)
@mock.patch('koji_cli.commands.activate_session')
def test_handle_block_pkg_no_package(self, activate_session_mock, stderr):
def test_handle_block_pkg_no_package(self):
tag = 'tag'
dsttag = {'name': tag, 'id': 1}
packages = ['package1', 'package2', 'package3']
args = [tag] + packages
options = mock.MagicMock()
arguments = [tag] + packages
# Mock out the xmlrpc server
session = mock.MagicMock()
session.getTag.return_value = dsttag
session.listPackages.return_value = [
self.session.getTag.return_value = dsttag
self.session.listPackages.return_value = [
{'package_name': 'package1', 'package_id': 1},
{'package_name': 'package3', 'package_id': 3},
{'package_name': 'other_package', 'package_id': 4}]
# Run it and check immediate output
# args: tag, package1, package2, package3
# expected: failed: can not find package2 under tag
with self.assertRaises(SystemExit) as ex:
handle_block_pkg(options, session, args)
self.assertExitCode(ex, 1)
actual = stderr.getvalue()
expected = 'Package package2 doesn\'t exist in tag tag\n'
self.assertMultiLineEqual(actual, expected)
self.assert_system_exit(
handle_block_pkg,
self.options, self.session, arguments,
stderr='Package package2 doesn\'t exist in tag tag\n',
stdout='',
activate_session=None,
exit_code=1)
# Finally, assert that things were called as we expected.
activate_session_mock.assert_called_once_with(session, options)
session.getTag.assert_called_once_with(tag)
session.listPackages.assert_called_once_with(
self.activate_session_mock.assert_called_once_with(self.session, self.options)
self.session.getTag.assert_called_once_with(tag)
self.session.listPackages.assert_called_once_with(
tagID=dsttag['id'], inherited=True, with_owners=False)
session.packageListBlock.assert_not_called()
session.multiCall.assert_not_called()
self.session.packageListBlock.assert_not_called()
self.session.multiCall.assert_not_called()
@mock.patch('sys.stderr', new_callable=six.StringIO)
@mock.patch('koji_cli.commands.activate_session')
def test_handle_block_pkg_tag_no_exists(
self, activate_session_mock, stderr):
def test_handle_block_pkg_tag_no_exists(self):
tag = 'tag'
dsttag = None
packages = ['package1', 'package2', 'package3']
args = [tag] + packages
options = mock.MagicMock()
arguments = [tag] + packages
# Mock out the xmlrpc server
session = mock.MagicMock()
session.getTag.return_value = dsttag
self.session.getTag.return_value = dsttag
# Run it and check immediate output
# args: tag, package1, package2, package3
# expected: failed: tag does not exist
with self.assertRaises(SystemExit) as ex:
handle_block_pkg(options, session, args)
self.assertExitCode(ex, 1)
actual = stderr.getvalue()
expected = 'No such tag: %s\n' % tag
self.assertMultiLineEqual(actual, expected)
self.assert_system_exit(
handle_block_pkg,
self.options, self.session, arguments,
stderr='No such tag: %s\n' % tag,
stdout='',
activate_session=None,
exit_code=1)
# Finally, assert that things were called as we expected.
activate_session_mock.assert_called_once_with(session, options)
session.getTag.assert_called_once_with(tag)
session.listPackages.assert_not_called()
session.packageListBlock.assert_not_called()
@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_block_pkg_help(
self, activate_session_mock, stderr, stdout):
args = []
options = mock.MagicMock()
progname = os.path.basename(sys.argv[0]) or 'koji'
# Mock out the xmlrpc server
session = mock.MagicMock()
self.activate_session_mock.assert_called_once_with(self.session, self.options)
self.session.getTag.assert_called_once_with(tag)
self.session.listPackages.assert_not_called()
self.session.packageListBlock.assert_not_called()
def test_handle_block_pkg_without_args(self):
arguments = []
# Run it and check immediate output
with self.assertRaises(SystemExit) as ex:
handle_block_pkg(options, session, args)
self.assertExitCode(ex, 2)
actual_stdout = stdout.getvalue()
actual_stderr = stderr.getvalue()
expected_stdout = ''
expected_stderr = """Usage: %s block-pkg [options] <tag> <package> [<package> ...]
(Specify the --help global option for a list of other help options)
%s: error: Please specify a tag and at least one package
""" % (progname, progname)
self.assertMultiLineEqual(actual_stdout, expected_stdout)
self.assertMultiLineEqual(actual_stderr, expected_stderr)
self.assert_system_exit(
handle_block_pkg,
self.options, self.session, arguments,
stderr=self.format_error_message('Please specify a tag and at least one package'),
stdout='',
activate_session=None,
exit_code=2)
# Finally, assert that things were called as we expected.
activate_session_mock.assert_not_called()
session.getTag.assert_not_called()
session.listPackages.assert_not_called()
session.packageListBlock.assert_not_called()
self.activate_session_mock.assert_not_called()
self.session.getTag.assert_not_called()
self.session.listPackages.assert_not_called()
self.session.packageListBlock.assert_not_called()