mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-02-04 07:51:50 +00:00
3478863ef0
* Resolve E713 and E714 (not in/is tests). * Address UP018 (unnecessary str call). * UP045 requires Python 3.10+. * Address UP007 (X | Y for type annotations). * Address UP035 (import Callable from collections.abc). * Address UP006 (t.Dict -> dict). * Address UP009 (UTF-8 encoding comment). * Address UP034 (extraneous parantheses). * Address SIM910 (dict.get() with None default). * Address F401 (unused import). * Address UP020 (use builtin open). * Address B009 and B010 (getattr/setattr with constant name). * Address SIM300 (Yoda conditions). * UP029 isn't in use anyway. * Address FLY002 (static join). * Address B034 (re.sub positional args). * Address B020 (loop variable overrides input). * Address B017 (assert raise Exception). * Address SIM211 (if expression with false/true). * Address SIM113 (enumerate for loop). * Address UP036 (sys.version_info checks). * Remove unnecessary UP039. * Address SIM201 (not ==). * Address SIM212 (if expr with twisted arms). * Add changelog fragment. * Reformat.
137 lines
5.8 KiB
Python
137 lines
5.8 KiB
Python
# Copyright (c) 2021, Florian Dambrine <android.florian@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
from unittest.mock import patch
|
|
|
|
from ansible_collections.community.general.plugins.modules import (
|
|
pritunl_user_info,
|
|
)
|
|
from ansible_collections.community.general.tests.unit.plugins.module_utils.net_tools.pritunl.test_api import (
|
|
PritunlListOrganizationMock,
|
|
PritunlListUserMock,
|
|
)
|
|
from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import (
|
|
AnsibleExitJson,
|
|
AnsibleFailJson,
|
|
ModuleTestCase,
|
|
set_module_args,
|
|
)
|
|
|
|
|
|
class TestPritunlUserInfo(ModuleTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.module = pritunl_user_info
|
|
|
|
def tearDown(self):
|
|
super().tearDown()
|
|
|
|
def patch_get_pritunl_users(self, **kwds):
|
|
return patch(
|
|
"ansible_collections.community.general.plugins.module_utils.net_tools.pritunl.api._get_pritunl_users",
|
|
autospec=True,
|
|
**kwds,
|
|
)
|
|
|
|
def patch_get_pritunl_organizations(self, **kwds):
|
|
return patch(
|
|
"ansible_collections.community.general.plugins.module_utils.net_tools.pritunl.api._get_pritunl_organizations",
|
|
autospec=True,
|
|
**kwds,
|
|
)
|
|
|
|
def test_without_parameters(self):
|
|
"""Test without parameters"""
|
|
with self.patch_get_pritunl_organizations(side_effect=PritunlListOrganizationMock) as org_mock:
|
|
with self.patch_get_pritunl_users(side_effect=PritunlListUserMock) as user_mock:
|
|
with set_module_args({}):
|
|
with self.assertRaises(AnsibleFailJson):
|
|
self.module.main()
|
|
|
|
self.assertEqual(org_mock.call_count, 0)
|
|
self.assertEqual(user_mock.call_count, 0)
|
|
|
|
def test_missing_organization(self):
|
|
"""Failure must occur when the requested organization is not found."""
|
|
with self.patch_get_pritunl_organizations(side_effect=PritunlListOrganizationMock) as org_mock:
|
|
with self.patch_get_pritunl_users(side_effect=PritunlListUserMock) as user_mock:
|
|
with self.assertRaises(AnsibleFailJson) as result:
|
|
with set_module_args(
|
|
{
|
|
"pritunl_api_token": "token",
|
|
"pritunl_api_secret": "secret",
|
|
"pritunl_url": "https://pritunl.domain.com",
|
|
"organization": "Unknown",
|
|
}
|
|
):
|
|
self.module.main()
|
|
|
|
self.assertEqual(org_mock.call_count, 1)
|
|
self.assertEqual(user_mock.call_count, 0)
|
|
|
|
exc = result.exception.args[0]
|
|
self.assertRegex(exc["msg"], "Can not list users from the organization")
|
|
|
|
def test_get_all_client_users_from_organization(self):
|
|
"""
|
|
The list of all Pritunl client users from the organization must be returned when no user specified.
|
|
"""
|
|
expected_user_type = "client"
|
|
with self.patch_get_pritunl_organizations(side_effect=PritunlListOrganizationMock) as org_mock:
|
|
with self.patch_get_pritunl_users(side_effect=PritunlListUserMock) as user_mock:
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
with set_module_args(
|
|
{
|
|
"pritunl_api_token": "token",
|
|
"pritunl_api_secret": "secret",
|
|
"pritunl_url": "https://pritunl.domain.com",
|
|
"organization": "GumGum",
|
|
}
|
|
):
|
|
self.module.main()
|
|
|
|
self.assertEqual(org_mock.call_count, 1)
|
|
self.assertEqual(user_mock.call_count, 1)
|
|
|
|
exc = result.exception.args[0]
|
|
# module should not report changes
|
|
self.assertFalse(exc["changed"])
|
|
# user_type when not provided is set client and should only return client user type
|
|
self.assertEqual(len(exc["users"]), 1)
|
|
for user in exc["users"]:
|
|
self.assertEqual(user["type"], expected_user_type)
|
|
|
|
def test_get_specific_server_user_from_organization(self):
|
|
"""
|
|
Retrieving a specific user from the organization must return a single record.
|
|
"""
|
|
expected_user_type = "server"
|
|
expected_user_name = "ops"
|
|
with self.patch_get_pritunl_organizations(side_effect=PritunlListOrganizationMock) as org_mock:
|
|
with self.patch_get_pritunl_users(side_effect=PritunlListUserMock) as user_mock:
|
|
with self.assertRaises(AnsibleExitJson) as result:
|
|
with set_module_args(
|
|
{
|
|
"pritunl_api_token": "token",
|
|
"pritunl_api_secret": "secret",
|
|
"pritunl_url": "https://pritunl.domain.com",
|
|
"organization": "GumGum",
|
|
"user_name": expected_user_name,
|
|
"user_type": expected_user_type,
|
|
}
|
|
):
|
|
self.module.main()
|
|
|
|
self.assertEqual(org_mock.call_count, 1)
|
|
self.assertEqual(user_mock.call_count, 1)
|
|
|
|
exc = result.exception.args[0]
|
|
# module should not report changes
|
|
self.assertFalse(exc["changed"])
|
|
self.assertEqual(len(exc["users"]), 1)
|
|
for user in exc["users"]:
|
|
self.assertEqual(user["type"], expected_user_type)
|
|
self.assertEqual(user["name"], expected_user_name)
|