From 472f174693a05764c90586fa031691798e586c70 Mon Sep 17 00:00:00 2001 From: Rene Moser Date: Sat, 10 Sep 2016 09:07:09 +0200 Subject: [PATCH 1/4] jenkins_job: default state to present --- web_infrastructure/jenkins_job.py | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/web_infrastructure/jenkins_job.py b/web_infrastructure/jenkins_job.py index 71d584dd7ac..9600b6a06f9 100644 --- a/web_infrastructure/jenkins_job.py +++ b/web_infrastructure/jenkins_job.py @@ -23,7 +23,7 @@ requirements: - "python-jenkins >= 0.4.12" - "lxml >= 3.3.3" version_added: "2.2" -author: "Sergio Millan Rodriguez" +author: "Sergio Millan Rodriguez (@sermilrod)" options: config: description: @@ -44,7 +44,8 @@ options: state: description: - Attribute that specifies if the job has to be created or deleted. - required: true + required: false + default: present choices: ['present', 'absent'] token: description: @@ -67,7 +68,6 @@ EXAMPLES = ''' config: "{{ lookup('file', 'templates/test.xml') }}" name: test password: admin - state: present enable: True url: "http://localhost:8080" user: admin @@ -77,7 +77,6 @@ EXAMPLES = ''' config: "{{ lookup('template', 'templates/test.xml.j2') }}" name: test token: asdfasfasfasdfasdfadfasfasdfasdfc - state: present enable: yes url: "http://localhost:8080" user: admin @@ -102,7 +101,6 @@ EXAMPLES = ''' - jenkins_job: name: test password: admin - state: present enable: False url: "http://localhost:8080" user: admin @@ -111,7 +109,6 @@ EXAMPLES = ''' - jenkins_job: name: test token: asdfasfasfasdfasdfadfasfasdfasdfc - state: present enable: no url: "http://localhost:8080" user: admin @@ -303,7 +300,7 @@ def main(): config = dict(required=False), name = dict(required=True), password = dict(required=False, no_log=True), - state = dict(required=True, choices=['present', 'absent']), + state = dict(required=False, choices=['present', 'absent'], default="present"), enable = dict(required=False, type='bool'), token = dict(required=False, no_log=True), url = dict(required=False, default="http://localhost:8080"), From 407e19fe4f06a11348a04efb1223f38cb535688f Mon Sep 17 00:00:00 2001 From: Rene Moser Date: Sat, 10 Sep 2016 16:56:09 +0200 Subject: [PATCH 2/4] jenkins_job: rename enable to enabled and mutually exclusive with config Jenkins stores the information about the state (disabled/enabled) in the config, which result in a race condition between `config` and `enabled` and we loose idempotency. It makes sense to define them mutually exclusive. Renamed `enable` to `enabled`. Ansible uses the name `enabled` in many modules, e.g. service as it indicates a state not an action. --- web_infrastructure/jenkins_job.py | 77 +++++++++++++++++++------------ 1 file changed, 47 insertions(+), 30 deletions(-) diff --git a/web_infrastructure/jenkins_job.py b/web_infrastructure/jenkins_job.py index 9600b6a06f9..ea33b729bce 100644 --- a/web_infrastructure/jenkins_job.py +++ b/web_infrastructure/jenkins_job.py @@ -27,11 +27,16 @@ author: "Sergio Millan Rodriguez (@sermilrod)" options: config: description: - - config.xml file to use as job config within your Ansible repo. + - config in XML format. + - Required if job does not yet exist. + - Mututally exclusive with C(enabled). + - Considered if C(state=present). required: false - enable: + enabled: description: - - Action to take with the Jenkins job (enable/disable). + - Whether the job should be enabled or disabled. + - Mututally exclusive with C(config). + - Considered if C(state=present). required: false name: description: @@ -68,7 +73,6 @@ EXAMPLES = ''' config: "{{ lookup('file', 'templates/test.xml') }}" name: test password: admin - enable: True url: "http://localhost:8080" user: admin @@ -77,7 +81,6 @@ EXAMPLES = ''' config: "{{ lookup('template', 'templates/test.xml.j2') }}" name: test token: asdfasfasfasdfasdfadfasfasdfasdfc - enable: yes url: "http://localhost:8080" user: admin @@ -101,7 +104,7 @@ EXAMPLES = ''' - jenkins_job: name: test password: admin - enable: False + enabled: false url: "http://localhost:8080" user: admin @@ -109,7 +112,7 @@ EXAMPLES = ''' - jenkins_job: name: test token: asdfasfasfasdfasdfadfasfasdfasdfc - enable: no + enabled: false url: "http://localhost:8080" user: admin ''' @@ -146,12 +149,12 @@ except ImportError: python_lxml_installed = False class Jenkins: - def __init__(self, config, name, password, state, enable, token, url, user): + def __init__(self, config, name, password, state, enabled, token, url, user): self.config = config self.name = name self.password = password self.state = state - self.enable = enable + self.enabled = enabled self.token = token self.user = user self.jenkins_url = url @@ -195,29 +198,39 @@ class Jenkins: return job_config_to_string(self.config) def configuration_changed(self): + # config is optional, if not provided we keep the current config as is + if self.config is None: + return False + changed = False config_file = self.get_config() machine_file = job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) - if not machine_file == config_file: + if machine_file != config_file: changed = True - return changed def update_job(self, module): + if self.config is None and self.enabled is None: + module.fail_json(msg='one of the following params is required on state=present: config,enabled') + if not self.job_exists(module): self.create_job(module) else: self.reconfig_job(module) def state_changed(self, status): + # Keep in current state if enabled arg_spec is not given + if self.enabled is None: + return False + changed = False - if ( (self.enable == False and status != "disabled") or (self.enable == True and status == "disabled") ): + if ( (self.enabled == False and status != "disabled") or (self.enabled == True and status == "disabled") ): changed = True return changed def change_state(self): - if self.enable == False: + if self.enabled == False: self.server.disable_job(self.name) else: self.server.enable_job(self.name) @@ -226,17 +239,18 @@ class Jenkins: changed = False try: status = self.get_job_status(module) - if self.enable == True: - if ( self.configuration_changed() or self.state_changed(status) ): - changed = True - if not module.check_mode: - self.server.reconfig_job(self.name, self.get_config()) - self.change_state() - else: - if self.state_changed(status): - changed = True - if not module.check_mode: - self.change_state() + + # Handle job config + if self.configuration_changed(): + changed = True + if not module.check_mode: + self.server.reconfig_job(self.name, self.get_config()) + + # Handle job disable/enable + elif self.state_changed(status): + changed = True + if not module.check_mode: + self.change_state() except Exception: e = get_exception() @@ -245,6 +259,10 @@ class Jenkins: module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url) def create_job(self, module): + + if self.config is None: + module.fail_json(msg='missing required param: config') + changed = False try: changed = True @@ -288,7 +306,7 @@ def jenkins_builder(module): module.params.get('name'), module.params.get('password'), module.params.get('state'), - module.params.get('enable'), + module.params.get('enabled'), module.params.get('token'), module.params.get('url'), module.params.get('user') @@ -301,16 +319,15 @@ def main(): name = dict(required=True), password = dict(required=False, no_log=True), state = dict(required=False, choices=['present', 'absent'], default="present"), - enable = dict(required=False, type='bool'), + enabled = dict(required=False, type='bool'), token = dict(required=False, no_log=True), url = dict(required=False, default="http://localhost:8080"), user = dict(required=False) ), - required_if = [ - ('state', 'present', ['enable']), - ('enable', True, ['config']) + mutually_exclusive = [ + ['password', 'token'], + ['config', 'enabled'], ], - mutually_exclusive = [['password', 'token']], supports_check_mode=True, ) From 66e69b3ad3c67cc9d0e97821463e0aae0b0ee3c5 Mon Sep 17 00:00:00 2001 From: Rene Moser Date: Sat, 10 Sep 2016 17:21:42 +0200 Subject: [PATCH 3/4] jenkins_job: implement diff support --- web_infrastructure/jenkins_job.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/web_infrastructure/jenkins_job.py b/web_infrastructure/jenkins_job.py index ea33b729bce..5ef3e159c1f 100644 --- a/web_infrastructure/jenkins_job.py +++ b/web_infrastructure/jenkins_job.py @@ -159,6 +159,10 @@ class Jenkins: self.user = user self.jenkins_url = url self.server = self.get_jenkins_connection() + self.diff = { + 'before': "", + 'after': "", + } def get_jenkins_connection(self): try: @@ -204,7 +208,9 @@ class Jenkins: changed = False config_file = self.get_config() + self.diff['after'] = config_file machine_file = job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) + self.diff['before'] = machine_file if machine_file != config_file: changed = True return changed @@ -256,29 +262,31 @@ class Jenkins: e = get_exception() module.fail_json(msg='Unable to reconfigure job, %s for %s' % (str(e), self.jenkins_url)) - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url) + module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) def create_job(self, module): if self.config is None: module.fail_json(msg='missing required param: config') - changed = False + changed = True try: - changed = True + config_file = self.get_config() + self.diff['after'] = config_file if not module.check_mode: - self.server.create_job(self.name, self.get_config()) + self.server.create_job(self.name, config_file) self.change_state() except Exception: e = get_exception() module.fail_json(msg='Unable to create job, %s for %s' % (str(e), self.jenkins_url)) - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url) + module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) def delete_job(self, module): changed = False if self.job_exists(module): changed = True + self.diff['before'] = job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) if not module.check_mode: try: self.server.delete_job(self.name) @@ -286,7 +294,7 @@ class Jenkins: e = get_exception() module.fail_json(msg='Unable to delete job, %s for %s' % (str(e), self.jenkins_url)) - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url) + module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) def test_dependencies(module): if not python_jenkins_installed: From 79efc2c70f396345ff8120bef28f6fe58e990a54 Mon Sep 17 00:00:00 2001 From: Rene Moser Date: Sat, 10 Sep 2016 18:26:30 +0200 Subject: [PATCH 4/4] jenkins_job: refactoring --- web_infrastructure/jenkins_job.py | 184 ++++++++++++++++-------------- 1 file changed, 97 insertions(+), 87 deletions(-) diff --git a/web_infrastructure/jenkins_job.py b/web_infrastructure/jenkins_job.py index 5ef3e159c1f..ee8b1745cb7 100644 --- a/web_infrastructure/jenkins_job.py +++ b/web_infrastructure/jenkins_job.py @@ -18,7 +18,7 @@ DOCUMENTATION = ''' module: jenkins_job short_description: Manage jenkins jobs description: - - Manage Jenkins jobs by using Jenkins REST API + - Manage Jenkins jobs by using Jenkins REST API. requirements: - "python-jenkins >= 0.4.12" - "lxml >= 3.3.3" @@ -129,6 +129,16 @@ state: returned: success type: string sample: present +enabled: + description: Whether the jenkins job is enabled or not. + returned: success + type: bool + sample: true +user: + description: User used for authentication. + returned: success + type: string + sample: admin url: description: Url to connect to the Jenkins server. returned: success @@ -148,20 +158,30 @@ try: except ImportError: python_lxml_installed = False -class Jenkins: - def __init__(self, config, name, password, state, enabled, token, url, user): - self.config = config - self.name = name - self.password = password - self.state = state - self.enabled = enabled - self.token = token - self.user = user - self.jenkins_url = url +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.server = self.get_jenkins_connection() - self.diff = { - 'before': "", - 'after': "", + + self.result = { + 'changed': False, + 'url': self.jenkins_url, + 'name': self.name, + 'user': self.user, + 'state': self.state, + 'diff': { + 'before': "", + 'after': "" + } } def get_jenkins_connection(self): @@ -176,125 +196,119 @@ class Jenkins: return jenkins.Jenkins(self.jenkins_url) except Exception: e = get_exception() - module.fail_json(msg='Unable to connect to Jenkins server, %s' % str(e)) + self.module.fail_json(msg='Unable to connect to Jenkins server, %s' % str(e)) - def get_job_status(self, module): + def get_job_status(self): try: return self.server.get_job_info(self.name)['color'].encode('utf-8') except Exception: e = get_exception() - module.fail_json(msg='Unable to fetch job information, %s' % str(e)) + self.module.fail_json(msg='Unable to fetch job information, %s' % str(e)) - def job_exists(self, module): + def job_exists(self): try: return bool(self.server.job_exists(self.name)) except Exception: e = get_exception() - module.fail_json(msg='Unable to validate if job exists, %s for %s' % (str(e), self.jenkins_url)) - - def build(self, module): - if self.state == 'present': - self.update_job(module) - else: - self.delete_job(module) + self.module.fail_json(msg='Unable to validate if job exists, %s for %s' % (str(e), self.jenkins_url)) def get_config(self): return job_config_to_string(self.config) - def configuration_changed(self): + def get_current_config(self): + 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 if self.config is None: return False - changed = False config_file = self.get_config() - self.diff['after'] = config_file - machine_file = job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) - self.diff['before'] = machine_file + machine_file = self.get_current_config() + + self.result['diff']['after'] = config_file + self.result['diff']['before'] = machine_file + if machine_file != config_file: - changed = True - return changed + return True + return False - def update_job(self, module): + def present_job(self): if self.config is None and self.enabled is None: module.fail_json(msg='one of the following params is required on state=present: config,enabled') - if not self.job_exists(module): - self.create_job(module) + if not self.job_exists(): + self.create_job() else: - self.reconfig_job(module) + self.update_job() - def state_changed(self, status): + def has_state_changed(self, status): # Keep in current state if enabled arg_spec is not given if self.enabled is None: return False - changed = False if ( (self.enabled == False and status != "disabled") or (self.enabled == True and status == "disabled") ): - changed = True - - return changed + return True + return False - def change_state(self): + def switch_state(self): if self.enabled == False: self.server.disable_job(self.name) else: self.server.enable_job(self.name) - def reconfig_job(self, module): - changed = False + def update_job(self): try: - status = self.get_job_status(module) + status = self.get_job_status() # Handle job config - if self.configuration_changed(): - changed = True - if not module.check_mode: + if self.has_config_changed(): + self.result['changed'] = True + if not self.module.check_mode: self.server.reconfig_job(self.name, self.get_config()) # Handle job disable/enable - elif self.state_changed(status): - changed = True - if not module.check_mode: - self.change_state() + elif self.has_state_changed(status): + self.result['changed'] = True + if not self.module.check_mode: + self.switch_state() except Exception: e = get_exception() - module.fail_json(msg='Unable to reconfigure job, %s for %s' % (str(e), self.jenkins_url)) - - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) - - def create_job(self, module): + self.module.fail_json(msg='Unable to reconfigure job, %s for %s' % (str(e), self.jenkins_url)) + def create_job(self): if self.config is None: - module.fail_json(msg='missing required param: config') + self.module.fail_json(msg='missing required param: config') - changed = True + self.result['changed'] = True try: config_file = self.get_config() - self.diff['after'] = config_file - if not module.check_mode: + self.result['diff']['after'] = config_file + if not self.module.check_mode: self.server.create_job(self.name, config_file) - self.change_state() except Exception: e = get_exception() - module.fail_json(msg='Unable to create job, %s for %s' % (str(e), self.jenkins_url)) - - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) + self.module.fail_json(msg='Unable to create job, %s for %s' % (str(e), self.jenkins_url)) - def delete_job(self, module): - changed = False - if self.job_exists(module): - changed = True - self.diff['before'] = job_config_to_string(self.server.get_job_config(self.name).encode('utf-8')) - if not module.check_mode: + def absent_job(self): + if self.job_exists(): + 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: e = get_exception() - module.fail_json(msg='Unable to delete job, %s for %s' % (str(e), self.jenkins_url)) + self.module.fail_json(msg='Unable to delete job, %s for %s' % (str(e), self.jenkins_url)) - module.exit_json(changed=changed, name=self.name, state=self.state, url=self.jenkins_url, diff=self.diff) + def get_result(self): + result = self.result + if self.job_exists(): + result['enabled'] = self.get_job_status() != "disabled" + else: + result['enabled'] = None + return result def test_dependencies(module): if not python_jenkins_installed: @@ -308,18 +322,6 @@ def test_dependencies(module): def job_config_to_string(xml_str): return ET.tostring(ET.fromstring(xml_str)) -def jenkins_builder(module): - return Jenkins( - module.params.get('config'), - module.params.get('name'), - module.params.get('password'), - module.params.get('state'), - module.params.get('enabled'), - module.params.get('token'), - module.params.get('url'), - module.params.get('user') - ) - def main(): module = AnsibleModule( argument_spec = dict( @@ -340,8 +342,16 @@ def main(): ) test_dependencies(module) - jenkins = jenkins_builder(module) - jenkins.build(module) + jenkins_job = JenkinsJob(module) + + if module.params.get('state') == "present": + jenkins_job.present_job() + else: + jenkins_job.absent_job() + + result = jenkins_job.get_result() + module.exit_json(**result) + from ansible.module_utils.basic import * if __name__ == '__main__':