1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-03 18:56:55 +00:00

Reformat everything.

This commit is contained in:
Felix Fontein 2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions

View file

@ -205,13 +205,16 @@ 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,
)
from datetime import datetime
class GitlabMilestones:
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
@ -233,17 +236,17 @@ class GitlabMilestones:
return True, True
var = {
"title": var_obj.get('title'),
"title": var_obj.get("title"),
}
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('start_date') is not None:
var["start_date"] = self.check_date(var_obj.get('start_date'))
if var_obj.get("start_date") is not None:
var["start_date"] = self.check_date(var_obj.get("start_date"))
if var_obj.get('due_date') is not None:
var["due_date"] = self.check_date(var_obj.get('due_date'))
if var_obj.get("due_date") is not None:
var["due_date"] = self.check_date(var_obj.get("due_date"))
_obj = self.gitlab_object.milestones.create(var)
return True, _obj.asdict()
@ -251,16 +254,16 @@ class GitlabMilestones:
def update_milestone(self, var_obj):
if self._module.check_mode:
return True, True
_milestone = self.gitlab_object.milestones.get(self.get_milestone_id(var_obj.get('title')))
_milestone = self.gitlab_object.milestones.get(self.get_milestone_id(var_obj.get("title")))
if var_obj.get('description') is not None:
_milestone.description = var_obj.get('description')
if var_obj.get("description") is not None:
_milestone.description = var_obj.get("description")
if var_obj.get('start_date') is not None:
_milestone.start_date = var_obj.get('start_date')
if var_obj.get("start_date") is not None:
_milestone.start_date = var_obj.get("start_date")
if var_obj.get('due_date') is not None:
_milestone.due_date = var_obj.get('due_date')
if var_obj.get("due_date") is not None:
_milestone.due_date = var_obj.get("due_date")
# save returns None
_milestone.save()
@ -276,7 +279,7 @@ class GitlabMilestones:
def check_date(self, _date):
try:
datetime.strptime(_date, '%Y-%m-%d')
datetime.strptime(_date, "%Y-%m-%d")
except ValueError:
self._module.fail_json(msg=f"milestone's date '{_date}' not in correct format.")
return _date
@ -284,7 +287,7 @@ class GitlabMilestones:
def delete_milestone(self, var_obj):
if self._module.check_mode:
return True, True
_milestone = self.gitlab_object.milestones.get(self.get_milestone_id(var_obj.get('title')))
_milestone = self.gitlab_object.milestones.get(self.get_milestone_id(var_obj.get("title")))
# delete returns None
_milestone.delete()
return True, _milestone.asdict()
@ -302,16 +305,16 @@ def compare(requested_milestones, existing_milestones, state):
updated = list()
added = list()
if state == 'present':
if state == "present":
_existing_milestones = list()
for item in existing_milestones:
_existing_milestones.append({'title': item.get('title')})
_existing_milestones.append({"title": item.get("title")})
for var in requested_milestones:
if var in existing_milestones:
untouched.append(var)
else:
compare_item = {'title': var.get('title')}
compare_item = {"title": var.get("title")}
if compare_item in _existing_milestones:
updated.append(var)
else:
@ -330,42 +333,42 @@ def native_python_main(this_gitlab, purge, requested_milestones, state, module):
# filter out and enrich before compare
for item in requested_milestones:
# add defaults when not present
if item.get('description') is None:
item['description'] = ""
if item.get('due_date') is None:
item['due_date'] = None
if item.get('start_date') is None:
item['start_date'] = None
if item.get("description") is None:
item["description"] = ""
if item.get("due_date") is None:
item["due_date"] = None
if item.get("start_date") is None:
item["start_date"] = None
for item in milestones_before:
# remove field only from server
item.pop('id')
item.pop('iid')
item.pop('created_at')
item.pop('expired')
item.pop('state')
item.pop('updated_at')
item.pop('web_url')
item.pop("id")
item.pop("iid")
item.pop("created_at")
item.pop("expired")
item.pop("state")
item.pop("updated_at")
item.pop("web_url")
# group milestone has group_id, while project has project_id
if 'group_id' in item:
item.pop('group_id')
if 'project_id' in item:
item.pop('project_id')
if "group_id" in item:
item.pop("group_id")
if "project_id" in item:
item.pop("project_id")
if state == 'present':
if state == "present":
add_or_update = [x for x in requested_milestones if x not in milestones_before]
for item in add_or_update:
try:
_rv, _obj = this_gitlab.create_milestone(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 milestone already exists
_rv, _obj = this_gitlab.update_milestone(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
@ -374,30 +377,30 @@ def native_python_main(this_gitlab, purge, requested_milestones, state, module):
for item in milestones_before:
_rv, _obj = this_gitlab.delete_milestone(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:
_milestone_titles_requested = [x['title'] for x in requested_milestones]
remove_requested = [x for x in milestones_before if x['title'] in _milestone_titles_requested]
_milestone_titles_requested = [x["title"] for x in requested_milestones]
remove_requested = [x for x in milestones_before if x["title"] in _milestone_titles_requested]
for item in remove_requested:
_rv, _obj = this_gitlab.delete_milestone(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 milestones_before:
_rv, _obj = this_gitlab.delete_milestone(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_milestones, milestones_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
milestones_after = [x.asdict() for x in this_gitlab.list_all_milestones()]
@ -409,47 +412,48 @@ 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),
milestones=dict(type='list', elements='dict', default=[],
options=dict(
title=dict(type='str', required=True),
description=dict(type='str'),
due_date=dict(type='str'),
start_date=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),
milestones=dict(
type="list",
elements="dict",
default=[],
options=dict(
title=dict(type="str", required=True),
description=dict(type="str"),
due_date=dict(type="str"),
start_date=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']
milestone_list = module.params['milestones']
state = module.params['state']
gitlab_project = module.params["project"]
gitlab_group = module.params["group"]
purge = module.params["purge"]
milestone_list = module.params["milestones"]
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,23 +468,25 @@ def main():
if gitlab_group and not gitlab_group_id:
module.fail_json(msg=f"group '{gitlab_group}' not found.")
this_gitlab = GitlabMilestones(module=module, gitlab_instance=gitlab_instance, group_id=gitlab_group_id,
project_id=gitlab_project_id)
this_gitlab = GitlabMilestones(
module=module, gitlab_instance=gitlab_instance, group_id=gitlab_group_id, project_id=gitlab_project_id
)
change, raw_return_value, before, after, _obj = native_python_main(this_gitlab, purge, milestone_list, state,
module)
change, raw_return_value, before, after, _obj = native_python_main(
this_gitlab, purge, milestone_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('title') for x in raw_return_value['added']]
updated = [x.get('title') for x in raw_return_value['updated']]
removed = [x.get('title') for x in raw_return_value['removed']]
untouched = [x.get('title') for x in raw_return_value['untouched']]
added = [x.get("title") for x in raw_return_value["added"]]
updated = [x.get("title") for x in raw_return_value["updated"]]
removed = [x.get("title") for x in raw_return_value["removed"]]
untouched = [x.get("title") for x in raw_return_value["untouched"]]
return_value = dict(added=added, updated=updated, removed=removed, untouched=untouched)
module.exit_json(changed=change, milestones=return_value, milestones_obj=_obj)
if __name__ == '__main__':
if __name__ == "__main__":
main()