cloudstack: add new module cs_project

lib/ansible/modules/extras/cloud/cloudstack/cs_project.py

@@ -0,0 +1,342 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2015, René Moser <mail@renemoser.net>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: cs_project
+short_description: Manages projects on Apache CloudStack based clouds.
+description:
+    - Create, update, suspend, activate and remove projects.
+version_added: '2.0'
+author: '"René Moser (@resmo)" <mail@renemoser.net>'
+  name:
+    description:
+      - Name of the project.
+    required: true
+  displaytext:
+    description:
+      - Displaytext of the project.
+      - If not specified, C(name) will be used as displaytext.
+    required: false
+    default: null
+  state:
+    description:
+      - State of the project.
+    required: false
+    default: 'present'
+    choices: [ 'present', 'absent', 'active', 'suspended' ]
+  domain:
+    description:
+      - Domain the project is related to.
+    required: false
+    default: null
+  account:
+    description:
+      - Account the project is related to.
+    required: false
+    default: null
+  poll_async:
+    description:
+      - Poll async jobs until job has finished.
+    required: false
+    default: true
+extends_documentation_fragment: cloudstack
+'''
+
+EXAMPLES = '''
+# Create a project
+- local_action:
+    module: cs_project
+    name: web
+
+# Rename a project
+- local_action:
+    module: cs_project
+    name: web
+    displaytext: my web project
+
+# Suspend an existing project
+- local_action:
+    module: cs_project
+    name: web
+    state: suspended
+
+# Activate an existing project
+- local_action:
+    module: cs_project
+    name: web
+    state: active
+
+# Remove a project
+- local_action:
+    module: cs_project
+    name: web
+    state: absent
+'''
+
+RETURN = '''
+---
+id:
+  description: ID of the project.
+  returned: success
+  type: string
+  sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6
+name:
+  description: Name of the project.
+  returned: success
+  type: string
+  sample: web project
+displaytext:
+  description: Display text of the project.
+  returned: success
+  type: string
+  sample: web project
+state:
+  description: State of the project.
+  returned: success
+  type: string
+  sample: Active
+domain:
+  description: Domain the project is related to.
+  returned: success
+  type: string
+  sample: example domain
+account:
+  description: Account the project is related to.
+  returned: success
+  type: string
+  sample: example account
+tags:
+  description: List of resource tags associated with the project.
+  returned: success
+  type: dict
+  sample: '[ { "key": "foo", "value": "bar" } ]'
+'''
+
+try:
+    from cs import CloudStack, CloudStackException, read_config
+    has_lib_cs = True
+except ImportError:
+    has_lib_cs = False
+
+# import cloudstack common
+from ansible.module_utils.cloudstack import *
+
+
+class AnsibleCloudStackProject(AnsibleCloudStack):
+
+    def __init__(self, module):
+        AnsibleCloudStack.__init__(self, module)
+        self.project = None
+
+
+    def get_displaytext(self):
+        displaytext = self.module.params.get('displaytext')
+        if not displaytext:
+            displaytext = self.module.params.get('name')
+        return displaytext
+
+
+    def get_project(self):
+        if not self.project:
+            project = self.module.params.get('name')
+
+            args                = {}
+            args['listall']     = True
+            args['account']     = self.get_account(key='name')
+            args['domainid']    = self.get_domain(key='id')
+
+            projects = self.cs.listProjects(**args)
+            if projects:
+                for p in projects['project']:
+                    if project in [ p['name'], p['id']]:
+                        self.project = p
+                        break
+        return self.project
+
+
+    def present_project(self):
+        project = self.get_project()
+        if not project:
+            project = self.create_project(project)
+        else:
+            project = self.update_project(project)
+        return project
+
+
+    def update_project(self, project):
+        args                = {}
+        args['id']          = project['id']
+        args['displaytext'] = self.get_displaytext()
+
+        if self._has_changed(args, project):
+            self.result['changed'] = True
+            if not self.module.check_mode:
+                project = self.cs.updateProject(**args)
+
+                if 'errortext' in project:
+                    self.module.fail_json(msg="Failed: '%s'" % project['errortext'])
+
+                poll_async = self.module.params.get('poll_async')
+                if project and poll_async:
+                    project = self._poll_job(project, 'project')
+        return project
+
+
+    def create_project(self, project):
+        self.result['changed'] = True
+
+        args                = {}
+        args['name']        = self.module.params.get('name')
+        args['displaytext'] = self.get_displaytext()
+        args['account']     = self.get_account('name')
+        args['domainid']    = self.get_domain('id')
+
+        if not self.module.check_mode:
+            project = self.cs.createProject(**args)
+
+            if 'errortext' in project:
+                self.module.fail_json(msg="Failed: '%s'" % project['errortext'])
+
+            poll_async = self.module.params.get('poll_async')
+            if project and poll_async:
+                project = self._poll_job(project, 'project')
+        return project
+
+
+    def state_project(self, state=None):
+        project = self.get_project()
+
+        if not project:
+            self.module.fail_json(msg="No project named '%s' found." % self.module.params('name'))
+
+        if project['state'].lower() != state:
+            self.result['changed'] = True
+
+            args        = {}
+            args['id']  = project['id']
+
+            if not self.module.check_mode:
+                if state == 'suspended':
+                    project = self.cs.suspendProject(**args)
+                else:
+                    project = self.cs.activateProject(**args)
+
+                if 'errortext' in project:
+                    self.module.fail_json(msg="Failed: '%s'" % project['errortext'])
+
+                poll_async = self.module.params.get('poll_async')
+                if project and poll_async:
+                    project = self._poll_job(project, 'project')
+        return project
+
+
+    def absent_project(self):
+        project = self.get_project()
+        if project:
+            self.result['changed'] = True
+
+            args        = {}
+            args['id']  = project['id']
+
+            if not self.module.check_mode:
+                res = self.cs.deleteProject(**args)
+
+                if 'errortext' in res:
+                    self.module.fail_json(msg="Failed: '%s'" % res['errortext'])
+
+                poll_async = self.module.params.get('poll_async')
+                if res and poll_async:
+                    res = self._poll_job(res, 'project')
+            return project
+
+
+    def get_result(self, project):
+        if project:
+            if 'name' in project:
+                self.result['name'] = project['name']
+            if 'displaytext' in project:
+                self.result['displaytext'] = project['displaytext']
+            if 'account' in project:
+                self.result['account'] = project['account']
+            if 'domain' in project:
+                self.result['domain'] = project['domain']
+            if 'state' in project:
+                self.result['state'] = project['state']
+            if 'tags' in project:
+                self.result['tags'] = []
+                for tag in project['tags']:
+                    result_tag          = {}
+                    result_tag['key']   = tag['key']
+                    result_tag['value'] = tag['value']
+                    self.result['tags'].append(result_tag)
+        return self.result
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            name = dict(required=True),
+            displaytext = dict(default=None),
+            state = dict(choices=['present', 'absent', 'active', 'suspended' ], default='present'),
+            domain = dict(default=None),
+            account = dict(default=None),
+            poll_async = dict(type='bool', choices=BOOLEANS, default=True),
+            api_key = dict(default=None),
+            api_secret = dict(default=None, no_log=True),
+            api_url = dict(default=None),
+            api_http_method = dict(choices=['get', 'post'], default='get'),
+            api_timeout = dict(type='int', default=10),
+        ),
+        required_together = (
+            ['api_key', 'api_secret', 'api_url'],
+        ),
+        supports_check_mode=True
+    )
+
+    if not has_lib_cs:
+        module.fail_json(msg="python library cs required: pip install cs")
+
+    try:
+        acs_project = AnsibleCloudStackProject(module)
+
+        state = module.params.get('state')
+        if state in ['absent']:
+            project = acs_project.absent_project()
+
+        elif state in ['active', 'suspended']:
+            project = acs_project.state_project(state=state)
+
+        else:
+            project = acs_project.present_project()
+
+        result = acs_project.get_result(project)
+
+    except CloudStackException, e:
+        module.fail_json(msg='CloudStackException: %s' % str(e))
+
+    except Exception, e:
+        module.fail_json(msg='Exception: %s' % str(e))
+
+    module.exit_json(**result)
+
+# import module snippets
+from ansible.module_utils.basic import *
+main()