debian-koji/tests/test_cli/test_list_users.py
Yuming Zhu ca05418fb5 unittest: use unittest.mock instead of mock
because the absence of unittest.mock on python2.7, we still fallback to
mock
2024-10-23 16:35:30 +00:00

265 lines
10 KiB
Python

from __future__ import absolute_import
try:
from unittest import mock
except ImportError:
import mock
from six.moves import StringIO
import koji
from koji_cli.commands import anon_handle_list_users
from . import utils
class TestListUsers(utils.CliTestCase):
def setUp(self):
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.patch('koji_cli.commands.activate_session').start()
self.error_format = """Usage: %s list-users [options]
(Specify the --help global option for a list of other help options)
%s: error: {message}
""" % (self.progname, self.progname)
def tearDown(self):
mock.patch.stopall()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_default_valid(self, stdout):
arguments = []
self.session.listUsers.return_value = [{
'id': 1, 'krb_principals': [],
'name': 'kojiadmin',
'status': 0,
'usertype': 0},
{'id': 2,
'krb_principals': [],
'name': 'testuser',
'status': 0,
'usertype': 0},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """kojiadmin
testuser
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=koji.USERTYPES['NORMAL'])
self.session.getAllPerms.assert_not_called()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_prefix(self, stdout):
arguments = ['--prefix', 'koji']
self.session.listUsers.return_value = [{
'id': 1, 'krb_principals': [],
'name': 'kojiadmin',
'status': 0,
'usertype': 0},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """kojiadmin
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=koji.USERTYPES['NORMAL'],
prefix='koji')
self.session.getAllPerms.assert_not_called()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_usertype(self, stdout):
arguments = ['--usertype', 'host']
self.session.listUsers.return_value = [{
'id': 3, 'krb_principals': [],
'name': 'kojihost',
'status': 0,
'usertype': 1},
{'id': 5, 'krb_principals': [],
'name': 'testhost',
'status': 0,
'usertype': 1},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """kojihost
testhost
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=koji.USERTYPES['HOST'])
self.session.getAllPerms.assert_not_called()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_all_types(self, stdout):
arguments = ['--usertype', 'any']
self.session.listUsers.return_value = [{
'id': 3, 'krb_principals': [],
'name': 'kojihost',
'status': 0,
'usertype': 1},
{'id': 5, 'krb_principals': [],
'name': 'testhost',
'status': 0,
'usertype': 1},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """kojihost
testhost
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=None)
self.session.getAllPerms.assert_not_called()
@mock.patch('sys.stderr', new_callable=StringIO)
def test_list_users_with_all_types_old_hub(self, stderr):
arguments = ['--usertype', 'any']
self.session.listUsers.return_value = []
self.session.hub_version = (1, 34, 0)
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stderr.getvalue()
expected = "This hub does not support querying for all usertypes\n"
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=None)
self.session.getAllPerms.assert_not_called()
def test_list_users_with_usertype_non_existing(self):
arguments = ['--usertype', 'test']
self.assert_system_exit(
anon_handle_list_users,
self.options, self.session, arguments,
stdout='',
stderr="Invalid usertype: test\n",
activate_session=None,
exit_code=1)
self.session.listUsers.assert_not_called()
self.session.getAllPerms.assert_not_called()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_usertype_and_prefix(self, stdout):
arguments = ['--usertype', 'host', '--prefix', 'test']
self.session.listUsers.return_value = [{
'id': 5, 'krb_principals': [],
'name': 'testhost',
'status': 0,
'usertype': 1},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """testhost
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(userType=koji.USERTYPES['HOST'],
prefix='test')
self.session.getAllPerms.assert_not_called()
def test_list_users_with_arg(self):
arguments = ['test-arg']
self.assert_system_exit(
anon_handle_list_users,
self.options, self.session, arguments,
stderr=self.format_error_message("This command takes no arguments"),
stdout='',
activate_session=None,
exit_code=2)
self.activate_session.assert_not_called()
self.session.listUsers.assert_not_called()
self.session.getAllPerms.assert_not_called()
def test_list_users_not_exists_perm(self):
arguments = ['--perm', 'test-non-exist-perm']
self.session.getAllPerms.return_value = [{'name': 'test-perm'}, {'name': 'test-perm-2'}]
self.assert_system_exit(
anon_handle_list_users,
self.options, self.session, arguments,
stderr="Invalid permission: test-non-exist-perm\n",
stdout='',
activate_session=None,
exit_code=1)
self.activate_session.assert_called_once_with(self.session, self.options)
self.session.listUsers.assert_not_called()
self.session.getAllPerms.assert_called_once_with()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_empty_result_of_users(self, stdout):
perm = 'test-perm'
arguments = ['--perm', perm]
self.session.getAllPerms.return_value = [{'name': 'test-perm'}, {'name': 'test-perm-2'}]
self.session.listUsers.return_value = []
self.session.hub_version = (1, 34, 1)
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.activate_session.assert_called_once_with(self.session, self.options)
self.session.listUsers.assert_called_once_with(perm=perm,
userType=koji.USERTYPES['NORMAL'])
self.session.getAllPerms.assert_called_once_with()
@mock.patch('sys.stdout', new_callable=StringIO)
def test_list_users_with_perms_valid_and_inherited_perm(self, stdout):
perm = 'test-perm'
arguments = ['--perm', perm, '--inherited-perm']
self.session.getAllPerms.return_value = [{'name': 'test-perm'}, {'name': 'test-perm-2'}]
self.session.listUsers.return_value = [{
'id': 1, 'krb_principals': [],
'name': 'kojiadmin',
'permission': perm,
'status': 0,
'usertype': 0},
{'id': 4,
'krb_principals': [],
'name': 'testuser1234',
'permission': perm,
'status': 0,
'usertype': 2},
]
rv = anon_handle_list_users(self.options, self.session, arguments)
actual = stdout.getvalue()
expected = """kojiadmin
testuser1234
"""
self.assertMultiLineEqual(actual, expected)
self.assertEqual(rv, None)
self.session.listUsers.assert_called_once_with(
inherited_perm=True, perm=perm, userType=koji.USERTYPES['NORMAL'])
self.session.getAllPerms.assert_called_once_with()
self.activate_session.assert_called_once_with(self.session, self.options)
def test_list_users_inherited_perm_without_perm(self):
arguments = ['--inherited-perm']
self.assert_system_exit(
anon_handle_list_users,
self.options, self.session, arguments,
stderr=self.format_error_message(
"inherited_perm option must be used with perm option"),
stdout='',
activate_session=None,
exit_code=2)
self.activate_session.assert_not_called()
self.session.listUsers.assert_not_called()
self.session.getAllPerms.assert_not_called()
def test_anon_handle_list_users_help(self):
self.assert_help(
anon_handle_list_users,
"""Usage: %s list-users [options]
(Specify the --help global option for a list of other help options)
Options:
-h, --help show this help message and exit
--usertype=USERTYPE List users that have a given usertype (e.g. NORMAL,
HOST, GROUP). Use "any" to get all types
--prefix=PREFIX List users that have a given prefix
--perm=PERM List users that have a given permission
--inherited-perm Consider inherited permissions
""" % self.progname)