internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 14:22:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reformat everything.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

125
plugins/modules/jenkins_job.py
View File

@@ -165,6 +165,7 @@ import xml.etree.ElementTree as ET
JENKINS_IMP_ERR = None
try:
import jenkins
python_jenkins_installed = True
except ImportError:
JENKINS_IMP_ERR = traceback.format_exc()
@@ -175,35 +176,31 @@ from ansible.module_utils.common.text.converters import to_native
class JenkinsJob:
def __init__(self, module):
self.module = module
self.config = module.params.get('config')
self.name = module.params.get('name')
self.password = module.params.get('password')
self.state = module.params.get('state')
self.enabled = module.params.get('enabled')
self.token = module.params.get('token')
self.user = module.params.get('user')
self.jenkins_url = module.params.get('url')
self.config = module.params.get("config")
self.name = module.params.get("name")
self.password = module.params.get("password")
self.state = module.params.get("state")
self.enabled = module.params.get("enabled")
self.token = module.params.get("token")
self.user = module.params.get("user")
self.jenkins_url = module.params.get("url")
self.server = self.get_jenkins_connection()
self.result = {
'changed': False,
'url': self.jenkins_url,
'name': self.name,
'user': self.user,
'state': self.state,
'diff': {
'before': "",
'after': ""
}
"changed": False,
"url": self.jenkins_url,
"name": self.name,
"user": self.user,
"state": self.state,
"diff": {"before": "", "after": ""},
}
self.EXCL_STATE = "excluded state"
if not module.params['validate_certs']:
os.environ['PYTHONHTTPSVERIFY'] = '0'
if not module.params["validate_certs"]:
os.environ["PYTHONHTTPSVERIFY"] = "0"
def get_jenkins_connection(self):
try:
@@ -216,7 +213,7 @@ class JenkinsJob:
else:
return jenkins.Jenkins(self.jenkins_url)
except Exception as e:
self.module.fail_json(msg=f'Unable to connect to Jenkins server, {e}', exception=traceback.format_exc())
self.module.fail_json(msg=f"Unable to connect to Jenkins server, {e}", exception=traceback.format_exc())
def get_job_status(self):
try:
@@ -224,23 +221,24 @@ class JenkinsJob:
if "color" not in response:
return self.EXCL_STATE
else:
return to_native(response['color'])
return to_native(response["color"])
except Exception as e:
self.module.fail_json(msg=f'Unable to fetch job information, {e}', exception=traceback.format_exc())
self.module.fail_json(msg=f"Unable to fetch job information, {e}", exception=traceback.format_exc())
def job_exists(self):
try:
return bool(self.server.job_exists(self.name))
except Exception as e:
self.module.fail_json(msg=f'Unable to validate if job exists, {e} for {self.jenkins_url}',
exception=traceback.format_exc())
self.module.fail_json(
msg=f"Unable to validate if job exists, {e} for {self.jenkins_url}", exception=traceback.format_exc()
)
def get_config(self):
return job_config_to_string(self.config)
def get_current_config(self):
return job_config_to_string(self.server.get_job_config(self.name).encode('utf-8'))
return job_config_to_string(self.server.get_job_config(self.name).encode("utf-8"))
def has_config_changed(self):
# config is optional, if not provided we keep the current config as is
@@ -250,8 +248,8 @@ class JenkinsJob:
config_file = self.get_config()
machine_file = self.get_current_config()
self.result['diff']['after'] = config_file
self.result['diff']['before'] = machine_file
self.result["diff"]["after"] = config_file
self.result["diff"]["before"] = machine_file
if machine_file != config_file:
return True
@@ -259,7 +257,7 @@ class JenkinsJob:
def present_job(self):
if self.config is None and self.enabled is None:
self.module.fail_json(msg='one of the following params is required on state=present: config,enabled')
self.module.fail_json(msg="one of the following params is required on state=present: config,enabled")
if not self.job_exists():
self.create_job()
@@ -285,82 +283,87 @@ class JenkinsJob:
# Handle job config
if self.has_config_changed():
self.result['changed'] = True
self.result["changed"] = True
if not self.module.check_mode:
self.server.reconfig_job(self.name, self.get_config())
# Handle job disable/enable
elif status != self.EXCL_STATE and self.has_state_changed(status):
self.result['changed'] = True
self.result["changed"] = True
if not self.module.check_mode:
self.switch_state()
except Exception as e:
self.module.fail_json(msg=f'Unable to reconfigure job, {e} for {self.jenkins_url}',
exception=traceback.format_exc())
self.module.fail_json(
msg=f"Unable to reconfigure job, {e} for {self.jenkins_url}", exception=traceback.format_exc()
)
def create_job(self):
if self.config is None:
self.module.fail_json(msg='missing required param: config')
self.module.fail_json(msg="missing required param: config")
self.result['changed'] = True
self.result["changed"] = True
try:
config_file = self.get_config()
self.result['diff']['after'] = config_file
self.result["diff"]["after"] = config_file
if not self.module.check_mode:
self.server.create_job(self.name, config_file)
except Exception as e:
self.module.fail_json(msg=f'Unable to create job, {e} for {self.jenkins_url}',
exception=traceback.format_exc())
self.module.fail_json(
msg=f"Unable to create job, {e} for {self.jenkins_url}", exception=traceback.format_exc()
)
def absent_job(self):
if self.job_exists():
self.result['changed'] = True
self.result['diff']['before'] = self.get_current_config()
self.result["changed"] = True
self.result["diff"]["before"] = self.get_current_config()
if not self.module.check_mode:
try:
self.server.delete_job(self.name)
except Exception as e:
self.module.fail_json(msg=f'Unable to delete job, {e} for {self.jenkins_url}',
exception=traceback.format_exc())
self.module.fail_json(
msg=f"Unable to delete job, {e} for {self.jenkins_url}", exception=traceback.format_exc()
)
def get_result(self):
result = self.result
if self.job_exists():
result['enabled'] = self.get_job_status() != "disabled"
result["enabled"] = self.get_job_status() != "disabled"
else:
result['enabled'] = None
result["enabled"] = None
return result
def test_dependencies(module):
if not python_jenkins_installed:
module.fail_json(
msg=missing_required_lib("python-jenkins",
url="https://python-jenkins.readthedocs.io/en/latest/install.html"),
exception=JENKINS_IMP_ERR)
msg=missing_required_lib(
"python-jenkins", url="https://python-jenkins.readthedocs.io/en/latest/install.html"
),
exception=JENKINS_IMP_ERR,
)
def job_config_to_string(xml_str):
return ET.tostring(ET.fromstring(xml_str)).decode('ascii')
return ET.tostring(ET.fromstring(xml_str)).decode("ascii")
def main():
module = AnsibleModule(
argument_spec=dict(
config=dict(type='str'),
name=dict(type='str', required=True),
password=dict(type='str', no_log=True),
state=dict(type='str', choices=['present', 'absent'], default="present"),
enabled=dict(type='bool'),
token=dict(type='str', no_log=True),
url=dict(type='str', default="http://localhost:8080"),
user=dict(type='str'),
validate_certs=dict(type='bool', default=True),
config=dict(type="str"),
name=dict(type="str", required=True),
password=dict(type="str", no_log=True),
state=dict(type="str", choices=["present", "absent"], default="present"),
enabled=dict(type="bool"),
token=dict(type="str", no_log=True),
url=dict(type="str", default="http://localhost:8080"),
user=dict(type="str"),
validate_certs=dict(type="bool", default=True),
),
mutually_exclusive=[
['password', 'token'],
['config', 'enabled'],
["password", "token"],
["config", "enabled"],
],
supports_check_mode=True,
)
@@ -368,7 +371,7 @@ def main():
test_dependencies(module)
jenkins_job = JenkinsJob(module)
if module.params.get('state') == "present":
if module.params.get("state") == "present":
jenkins_job.present_job()
else:
jenkins_job.absent_job()
@@ -377,5 +380,5 @@ def main():
module.exit_json(**result)
if __name__ == '__main__':
if __name__ == "__main__":
main()