1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
community.general/tests/unit/plugins/modules/test_bitbucket_pipeline_key_pair.py
Felix Fontein 236b9c0e04
Sort imports with ruff check --fix (#11400)
Sort imports with ruff check --fix.
2026-01-09 07:40:58 +01:00

237 lines
9.4 KiB
Python

# Copyright (c) Ansible project
# 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.internal_test_tools.tests.unit.plugins.modules.utils import (
AnsibleExitJson,
AnsibleFailJson,
ModuleTestCase,
set_module_args,
)
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.modules import bitbucket_pipeline_key_pair
class TestBucketPipelineKeyPairModule(ModuleTestCase):
def setUp(self):
super().setUp()
self.module = bitbucket_pipeline_key_pair
def test_missing_keys_with_present_state(self):
with self.assertRaises(AnsibleFailJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"state": "present",
}
):
self.module.main()
self.assertEqual(exec_info.exception.args[0]["msg"], self.module.error_messages["required_keys"])
@patch.object(bitbucket_pipeline_key_pair, "get_existing_ssh_key_pair", return_value=None)
def test_create_keys(self, *args):
with patch.object(self.module, "update_ssh_key_pair") as update_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"user": "ABC",
"password": "XXX",
"workspace": "name",
"repository": "repo",
"public_key": "public",
"private_key": "PRIVATE",
"state": "present",
}
):
self.module.main()
self.assertEqual(update_ssh_key_pair_mock.call_count, 1)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(bitbucket_pipeline_key_pair, "get_existing_ssh_key_pair", return_value=None)
def test_create_keys_check_mode(self, *args):
with patch.object(self.module, "update_ssh_key_pair") as update_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"public_key": "public",
"private_key": "PRIVATE",
"state": "present",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(update_ssh_key_pair_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(
bitbucket_pipeline_key_pair,
"get_existing_ssh_key_pair",
return_value={
"public_key": "unknown",
"type": "pipeline_ssh_key_pair",
},
)
def test_update_keys(self, *args):
with patch.object(self.module, "update_ssh_key_pair") as update_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"public_key": "public",
"private_key": "PRIVATE",
"state": "present",
}
):
self.module.main()
self.assertEqual(update_ssh_key_pair_mock.call_count, 1)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(
bitbucket_pipeline_key_pair,
"get_existing_ssh_key_pair",
return_value={
"public_key": "public",
"type": "pipeline_ssh_key_pair",
},
)
def test_dont_update_same_key(self, *args):
with patch.object(self.module, "update_ssh_key_pair") as update_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"public_key": "public",
"private_key": "PRIVATE",
"state": "present",
}
):
self.module.main()
self.assertEqual(update_ssh_key_pair_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], False)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(
bitbucket_pipeline_key_pair,
"get_existing_ssh_key_pair",
return_value={
"public_key": "unknown",
"type": "pipeline_ssh_key_pair",
},
)
def test_update_keys_check_mode(self, *args):
with patch.object(self.module, "update_ssh_key_pair") as update_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"public_key": "public",
"private_key": "PRIVATE",
"state": "present",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(update_ssh_key_pair_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(
bitbucket_pipeline_key_pair,
"get_existing_ssh_key_pair",
return_value={
"public_key": "public",
"type": "pipeline_ssh_key_pair",
},
)
def test_delete_keys(self, *args):
with patch.object(self.module, "delete_ssh_key_pair") as delete_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"state": "absent",
}
):
self.module.main()
self.assertEqual(delete_ssh_key_pair_mock.call_count, 1)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(bitbucket_pipeline_key_pair, "get_existing_ssh_key_pair", return_value=None)
def test_delete_absent_keys(self, *args):
with patch.object(self.module, "delete_ssh_key_pair") as delete_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"state": "absent",
}
):
self.module.main()
self.assertEqual(delete_ssh_key_pair_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], False)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(
bitbucket_pipeline_key_pair,
"get_existing_ssh_key_pair",
return_value={
"public_key": "public",
"type": "pipeline_ssh_key_pair",
},
)
def test_delete_keys_check_mode(self, *args):
with patch.object(self.module, "delete_ssh_key_pair") as delete_ssh_key_pair_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"state": "absent",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(delete_ssh_key_pair_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], True)