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_variable.py
2025-11-01 13:46:53 +01:00

378 lines
15 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
import unittest
from unittest.mock import patch
from ansible_collections.community.general.plugins.module_utils.source_control.bitbucket import BitbucketHelper
from ansible_collections.community.general.plugins.modules import bitbucket_pipeline_variable
from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import (
AnsibleFailJson,
AnsibleExitJson,
ModuleTestCase,
set_module_args,
)
class TestBucketPipelineVariableModule(ModuleTestCase):
def setUp(self):
super().setUp()
self.module = bitbucket_pipeline_variable
def test_without_required_parameters(self):
with self.assertRaises(AnsibleFailJson) as exec_info:
with set_module_args(
{
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
}
):
self.module.main()
self.assertEqual(exec_info.exception.args[0]["failed"], True)
def test_missing_value_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",
"name": "PIPELINE_VAR_NAME",
"state": "present",
}
):
self.module.main()
self.assertEqual(exec_info.exception.args[0]["msg"], self.module.error_messages["required_value"])
@patch.dict(
"os.environ",
{
"BITBUCKET_CLIENT_ID": "ABC",
"BITBUCKET_CLIENT_SECRET": "XXX",
},
)
@patch.object(BitbucketHelper, "fetch_access_token", return_value="token")
@patch.object(bitbucket_pipeline_variable, "get_existing_pipeline_variable", return_value=None)
def test_oauth_env_vars_params(self, *args):
with self.assertRaises(AnsibleExitJson):
with set_module_args(
{
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
}
):
self.module.main()
@patch.dict(
"os.environ",
{
"BITBUCKET_USERNAME": "ABC",
"BITBUCKET_PASSWORD": "XXX",
},
)
@patch.object(bitbucket_pipeline_variable, "get_existing_pipeline_variable", return_value=None)
def test_basic_auth_env_vars_params(self, *args):
with self.assertRaises(AnsibleExitJson):
with set_module_args(
{
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
}
):
self.module.main()
@patch.object(bitbucket_pipeline_variable, "get_existing_pipeline_variable", return_value=None)
def test_create_variable(self, *args):
with patch.object(self.module, "create_pipeline_variable") as create_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"user": "ABC",
"password": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"state": "present",
}
):
self.module.main()
self.assertEqual(create_pipeline_variable_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_variable, "get_existing_pipeline_variable", return_value=None)
def test_create_variable_check_mode(self, *args):
with patch.object(self.module, "create_pipeline_variable") as create_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"state": "present",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(create_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "Im alive",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_update_variable(self, *args):
with patch.object(self.module, "update_pipeline_variable") as update_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"state": "present",
}
):
self.module.main()
self.assertEqual(update_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"type": "pipeline_variable",
"secured": True,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_update_secured_variable(self, *args):
with patch.object(self.module, "update_pipeline_variable") as update_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"secured": True,
"state": "present",
}
):
self.module.main()
self.assertEqual(update_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "42",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_update_secured_state(self, *args):
with patch.object(self.module, "update_pipeline_variable") as update_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"secured": True,
"state": "present",
}
):
self.module.main()
self.assertEqual(update_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "42",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_dont_update_same_value(self, *args):
with patch.object(self.module, "update_pipeline_variable") as update_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"state": "present",
}
):
self.module.main()
self.assertEqual(update_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "Im alive",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_update_variable_check_mode(self, *args):
with patch.object(self.module, "update_pipeline_variable") as update_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"value": "42",
"state": "present",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(update_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "Im alive",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_delete_variable(self, *args):
with patch.object(self.module, "delete_pipeline_variable") as delete_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
}
):
self.module.main()
self.assertEqual(delete_pipeline_variable_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_variable, "get_existing_pipeline_variable", return_value=None)
def test_delete_absent_variable(self, *args):
with patch.object(self.module, "delete_pipeline_variable") as delete_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
}
):
self.module.main()
self.assertEqual(delete_pipeline_variable_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_variable,
"get_existing_pipeline_variable",
return_value={
"name": "PIPELINE_VAR_NAME",
"value": "Im alive",
"type": "pipeline_variable",
"secured": False,
"uuid": "{9ddb0507-439a-495a- 99f3 - 564f15138127}",
},
)
def test_delete_variable_check_mode(self, *args):
with patch.object(self.module, "delete_pipeline_variable") as delete_pipeline_variable_mock:
with self.assertRaises(AnsibleExitJson) as exec_info:
with set_module_args(
{
"client_id": "ABC",
"client_secret": "XXX",
"workspace": "name",
"repository": "repo",
"name": "PIPELINE_VAR_NAME",
"state": "absent",
"_ansible_check_mode": True,
}
):
self.module.main()
self.assertEqual(delete_pipeline_variable_mock.call_count, 0)
self.assertEqual(exec_info.exception.args[0]["changed"], True)
if __name__ == "__main__":
unittest.main()