mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-01 09:56:18 +00:00
Reformat everything.
This commit is contained in:
Felix Fontein
parent
3f2213791a
commit
340ff8586d
1008 changed files with 61301 additions and 58309 deletions
|
|
@ -221,12 +221,15 @@ from ansible.module_utils.basic import AnsibleModule
|
|||
from ansible.module_utils.api import basic_auth_argument_spec
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.gitlab import (
|
||||
auth_argument_spec, gitlab_authentication, ensure_gitlab_package, find_group, find_project
|
||||
auth_argument_spec,
|
||||
gitlab_authentication,
|
||||
ensure_gitlab_package,
|
||||
find_group,
|
||||
find_project,
|
||||
)
|
||||
|
||||
|
||||
class GitlabLabels:
|
||||
|
||||
def __init__(self, module, gitlab_instance, group_id, project_id):
|
||||
self._gitlab = gitlab_instance
|
||||
self.gitlab_object = group_id if group_id else project_id
|
||||
|
|
@ -248,15 +251,15 @@ class GitlabLabels:
|
|||
return True, True
|
||||
|
||||
var = {
|
||||
"name": var_obj.get('name'),
|
||||
"color": var_obj.get('color'),
|
||||
"name": var_obj.get("name"),
|
||||
"color": var_obj.get("color"),
|
||||
}
|
||||
|
||||
if var_obj.get('description') is not None:
|
||||
var["description"] = var_obj.get('description')
|
||||
if var_obj.get("description") is not None:
|
||||
var["description"] = var_obj.get("description")
|
||||
|
||||
if var_obj.get('priority') is not None:
|
||||
var["priority"] = var_obj.get('priority')
|
||||
if var_obj.get("priority") is not None:
|
||||
var["priority"] = var_obj.get("priority")
|
||||
|
||||
_obj = self.gitlab_object.labels.create(var)
|
||||
return True, _obj.asdict()
|
||||
|
|
@ -264,17 +267,17 @@ class GitlabLabels:
|
|||
def update_label(self, var_obj):
|
||||
if self._module.check_mode:
|
||||
return True, True
|
||||
_label = self.gitlab_object.labels.get(var_obj.get('name'))
|
||||
_label = self.gitlab_object.labels.get(var_obj.get("name"))
|
||||
|
||||
if var_obj.get('new_name') is not None:
|
||||
_label.new_name = var_obj.get('new_name')
|
||||
if var_obj.get("new_name") is not None:
|
||||
_label.new_name = var_obj.get("new_name")
|
||||
|
||||
if var_obj.get('description') is not None:
|
||||
_label.description = var_obj.get('description')
|
||||
if var_obj.get('priority') is not None:
|
||||
_label.priority = var_obj.get('priority')
|
||||
if var_obj.get('color') is not None:
|
||||
_label.color = var_obj.get('color')
|
||||
if var_obj.get("description") is not None:
|
||||
_label.description = var_obj.get("description")
|
||||
if var_obj.get("priority") is not None:
|
||||
_label.priority = var_obj.get("priority")
|
||||
if var_obj.get("color") is not None:
|
||||
_label.color = var_obj.get("color")
|
||||
|
||||
# save returns None
|
||||
_label.save()
|
||||
|
|
@ -283,7 +286,7 @@ class GitlabLabels:
|
|||
def delete_label(self, var_obj):
|
||||
if self._module.check_mode:
|
||||
return True, True
|
||||
_label = self.gitlab_object.labels.get(var_obj.get('name'))
|
||||
_label = self.gitlab_object.labels.get(var_obj.get("name"))
|
||||
# delete returns None
|
||||
_label.delete()
|
||||
return True, _label.asdict()
|
||||
|
|
@ -301,16 +304,16 @@ def compare(requested_labels, existing_labels, state):
|
|||
updated = list()
|
||||
added = list()
|
||||
|
||||
if state == 'present':
|
||||
if state == "present":
|
||||
_existing_labels = list()
|
||||
for item in existing_labels:
|
||||
_existing_labels.append({'name': item.get('name')})
|
||||
_existing_labels.append({"name": item.get("name")})
|
||||
|
||||
for var in requested_labels:
|
||||
if var in existing_labels:
|
||||
untouched.append(var)
|
||||
else:
|
||||
compare_item = {'name': var.get('name')}
|
||||
compare_item = {"name": var.get("name")}
|
||||
if compare_item in _existing_labels:
|
||||
updated.append(var)
|
||||
else:
|
||||
|
|
@ -329,42 +332,42 @@ def native_python_main(this_gitlab, purge, requested_labels, state, module):
|
|||
# filter out and enrich before compare
|
||||
for item in requested_labels:
|
||||
# add defaults when not present
|
||||
if item.get('description') is None:
|
||||
item['description'] = ""
|
||||
if item.get('new_name') is None:
|
||||
item['new_name'] = None
|
||||
if item.get('priority') is None:
|
||||
item['priority'] = None
|
||||
if item.get("description") is None:
|
||||
item["description"] = ""
|
||||
if item.get("new_name") is None:
|
||||
item["new_name"] = None
|
||||
if item.get("priority") is None:
|
||||
item["priority"] = None
|
||||
|
||||
# group label does not have priority, removing for comparison
|
||||
if this_gitlab.is_group_label:
|
||||
item.pop('priority')
|
||||
item.pop("priority")
|
||||
|
||||
for item in labels_before:
|
||||
# remove field only from server
|
||||
item.pop('id')
|
||||
item.pop('description_html')
|
||||
item.pop('text_color')
|
||||
item.pop('subscribed')
|
||||
item.pop("id")
|
||||
item.pop("description_html")
|
||||
item.pop("text_color")
|
||||
item.pop("subscribed")
|
||||
# field present only when it is a project's label
|
||||
if 'is_project_label' in item:
|
||||
item.pop('is_project_label')
|
||||
item['new_name'] = None
|
||||
if "is_project_label" in item:
|
||||
item.pop("is_project_label")
|
||||
item["new_name"] = None
|
||||
|
||||
if state == 'present':
|
||||
if state == "present":
|
||||
add_or_update = [x for x in requested_labels if x not in labels_before]
|
||||
for item in add_or_update:
|
||||
try:
|
||||
_rv, _obj = this_gitlab.create_label(item)
|
||||
if _rv:
|
||||
return_value['added'].append(item)
|
||||
return_obj['added'].append(_obj)
|
||||
return_value["added"].append(item)
|
||||
return_obj["added"].append(_obj)
|
||||
except Exception:
|
||||
# create raises exception with following error message when label already exists
|
||||
_rv, _obj = this_gitlab.update_label(item)
|
||||
if _rv:
|
||||
return_value['updated'].append(item)
|
||||
return_obj['updated'].append(_obj)
|
||||
return_value["updated"].append(item)
|
||||
return_obj["updated"].append(_obj)
|
||||
|
||||
if purge:
|
||||
# re-fetch
|
||||
|
|
@ -373,30 +376,30 @@ def native_python_main(this_gitlab, purge, requested_labels, state, module):
|
|||
for item in labels_before:
|
||||
_rv, _obj = this_gitlab.delete_label(item)
|
||||
if _rv:
|
||||
return_value['removed'].append(item)
|
||||
return_obj['removed'].append(_obj)
|
||||
return_value["removed"].append(item)
|
||||
return_obj["removed"].append(_obj)
|
||||
|
||||
elif state == 'absent':
|
||||
elif state == "absent":
|
||||
if not purge:
|
||||
_label_names_requested = [x['name'] for x in requested_labels]
|
||||
remove_requested = [x for x in labels_before if x['name'] in _label_names_requested]
|
||||
_label_names_requested = [x["name"] for x in requested_labels]
|
||||
remove_requested = [x for x in labels_before if x["name"] in _label_names_requested]
|
||||
for item in remove_requested:
|
||||
_rv, _obj = this_gitlab.delete_label(item)
|
||||
if _rv:
|
||||
return_value['removed'].append(item)
|
||||
return_obj['removed'].append(_obj)
|
||||
return_value["removed"].append(item)
|
||||
return_obj["removed"].append(_obj)
|
||||
else:
|
||||
for item in labels_before:
|
||||
_rv, _obj = this_gitlab.delete_label(item)
|
||||
if _rv:
|
||||
return_value['removed'].append(item)
|
||||
return_obj['removed'].append(_obj)
|
||||
return_value["removed"].append(item)
|
||||
return_obj["removed"].append(_obj)
|
||||
|
||||
if module.check_mode:
|
||||
_untouched, _updated, _added = compare(requested_labels, labels_before, state)
|
||||
return_value = dict(added=_added, updated=_updated, removed=return_value['removed'], untouched=_untouched)
|
||||
return_value = dict(added=_added, updated=_updated, removed=return_value["removed"], untouched=_untouched)
|
||||
|
||||
if any(return_value[x] for x in ['added', 'removed', 'updated']):
|
||||
if any(return_value[x] for x in ["added", "removed", "updated"]):
|
||||
change = True
|
||||
|
||||
labels_after = [x.asdict() for x in this_gitlab.list_all_labels()]
|
||||
|
|
@ -408,48 +411,49 @@ def main():
|
|||
argument_spec = basic_auth_argument_spec()
|
||||
argument_spec.update(auth_argument_spec())
|
||||
argument_spec.update(
|
||||
project=dict(type='str'),
|
||||
group=dict(type='str'),
|
||||
purge=dict(type='bool', default=False),
|
||||
labels=dict(type='list', elements='dict', default=list(),
|
||||
options=dict(
|
||||
name=dict(type='str', required=True),
|
||||
color=dict(type='str'),
|
||||
description=dict(type='str'),
|
||||
priority=dict(type='int'),
|
||||
new_name=dict(type='str'))
|
||||
),
|
||||
state=dict(type='str', default="present", choices=["absent", "present"]),
|
||||
project=dict(type="str"),
|
||||
group=dict(type="str"),
|
||||
purge=dict(type="bool", default=False),
|
||||
labels=dict(
|
||||
type="list",
|
||||
elements="dict",
|
||||
default=list(),
|
||||
options=dict(
|
||||
name=dict(type="str", required=True),
|
||||
color=dict(type="str"),
|
||||
description=dict(type="str"),
|
||||
priority=dict(type="int"),
|
||||
new_name=dict(type="str"),
|
||||
),
|
||||
),
|
||||
state=dict(type="str", default="present", choices=["absent", "present"]),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
mutually_exclusive=[
|
||||
['api_username', 'api_token'],
|
||||
['api_username', 'api_oauth_token'],
|
||||
['api_username', 'api_job_token'],
|
||||
['api_token', 'api_oauth_token'],
|
||||
['api_token', 'api_job_token'],
|
||||
['project', 'group'],
|
||||
["api_username", "api_token"],
|
||||
["api_username", "api_oauth_token"],
|
||||
["api_username", "api_job_token"],
|
||||
["api_token", "api_oauth_token"],
|
||||
["api_token", "api_job_token"],
|
||||
["project", "group"],
|
||||
],
|
||||
required_together=[
|
||||
['api_username', 'api_password'],
|
||||
["api_username", "api_password"],
|
||||
],
|
||||
required_one_of=[
|
||||
['api_username', 'api_token', 'api_oauth_token', 'api_job_token'],
|
||||
['project', 'group']
|
||||
],
|
||||
supports_check_mode=True
|
||||
required_one_of=[["api_username", "api_token", "api_oauth_token", "api_job_token"], ["project", "group"]],
|
||||
supports_check_mode=True,
|
||||
)
|
||||
ensure_gitlab_package(module)
|
||||
|
||||
gitlab_project = module.params['project']
|
||||
gitlab_group = module.params['group']
|
||||
purge = module.params['purge']
|
||||
label_list = module.params['labels']
|
||||
state = module.params['state']
|
||||
gitlab_project = module.params["project"]
|
||||
gitlab_group = module.params["group"]
|
||||
purge = module.params["purge"]
|
||||
label_list = module.params["labels"]
|
||||
state = module.params["state"]
|
||||
|
||||
gitlab_instance = gitlab_authentication(module, min_version='3.2.0')
|
||||
gitlab_instance = gitlab_authentication(module, min_version="3.2.0")
|
||||
|
||||
# find_project can return None, but the other must exist
|
||||
gitlab_project_id = find_project(gitlab_instance, gitlab_project)
|
||||
|
|
@ -464,29 +468,30 @@ def main():
|
|||
if gitlab_group and not gitlab_group_id:
|
||||
module.fail_json(msg=f"group '{gitlab_group}' not found.")
|
||||
|
||||
this_gitlab = GitlabLabels(module=module, gitlab_instance=gitlab_instance, group_id=gitlab_group_id,
|
||||
project_id=gitlab_project_id)
|
||||
this_gitlab = GitlabLabels(
|
||||
module=module, gitlab_instance=gitlab_instance, group_id=gitlab_group_id, project_id=gitlab_project_id
|
||||
)
|
||||
|
||||
if state == 'present':
|
||||
_existing_labels = [x.asdict()['name'] for x in this_gitlab.list_all_labels()]
|
||||
if state == "present":
|
||||
_existing_labels = [x.asdict()["name"] for x in this_gitlab.list_all_labels()]
|
||||
|
||||
# color is mandatory when creating label, but it is optional when changing name or updating other fields
|
||||
if any(x['color'] is None and x['new_name'] is None and x['name'] not in _existing_labels for x in label_list):
|
||||
module.fail_json(msg='color parameter is required for new labels')
|
||||
if any(x["color"] is None and x["new_name"] is None and x["name"] not in _existing_labels for x in label_list):
|
||||
module.fail_json(msg="color parameter is required for new labels")
|
||||
|
||||
change, raw_return_value, before, after, _obj = native_python_main(this_gitlab, purge, label_list, state, module)
|
||||
|
||||
if not module.check_mode:
|
||||
raw_return_value['untouched'] = [x for x in before if x in after]
|
||||
raw_return_value["untouched"] = [x for x in before if x in after]
|
||||
|
||||
added = [x.get('name') for x in raw_return_value['added']]
|
||||
updated = [x.get('name') for x in raw_return_value['updated']]
|
||||
removed = [x.get('name') for x in raw_return_value['removed']]
|
||||
untouched = [x.get('name') for x in raw_return_value['untouched']]
|
||||
added = [x.get("name") for x in raw_return_value["added"]]
|
||||
updated = [x.get("name") for x in raw_return_value["updated"]]
|
||||
removed = [x.get("name") for x in raw_return_value["removed"]]
|
||||
untouched = [x.get("name") for x in raw_return_value["untouched"]]
|
||||
return_value = dict(added=added, updated=updated, removed=removed, untouched=untouched)
|
||||
|
||||
module.exit_json(changed=change, labels=return_value, labels_obj=_obj)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue