jbosscli.py

#!/usr/bin/python
#
# (c) 2017, Antonio Insusti <antonio@insuasti.ec>
#
# This file is part of Ansible
#
# JBoss Cli module 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.
#
# JBoss Cli module 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
# If not, see <http://www.gnu.org/licenses/>.

ANSIBLE_METADATA = {'metadata_version': '1.0',
                    'status': ['preview'],
                    'supported_by': 'community'}

DOCUMENTATION = """
author: "Antonio Insuasti (@wolfantEc)"
module: jbosscli
version_added: 2.4
short_description: deploy applications to JBoss
description:
  - Deploy applications to JBoss standalone using the filesystem
options:
  command:
    required: false
    description:
      - JBoss Cli command
  src:
    required: false
    description:
      - File with list of commands
  cli_path:
    required: false
    default: /usr/share/wildfly/bin
    description:
      - The location in the filesystem where jboss-cli.sh is located
  user:
    required: false
    description:
      - JBoss management user
  password:
    required: false
    description:
      - JBoss management user password
  server:
    required: false
    default: localhost:9990
    description:
      - JBoss server or domain controller, with management port
  verbose:
    required: false
    default: false
    description:
      - Show the JBoss Cli output, commonly in DMR
notes:
  - "jboss-cli.sh need to be running on client host, and $JAVA_HOME/bin is needed in client $PATH"
  - ""
"""

EXAMPLES = """
# Change scan-interval value, on user wildfly installation
- jbosscli:
    command: /subsystem=deployment-scanner/scanner=default:write-attribute(name=scan-interval,value=6000)
    cli_path: /home/user/wildfly-10.1.0.Final/bin

#  Change ExampleDS datasource user-name, on 192.168.20.55:9990 default installation
- jbosscli:
    command: /subsystem=datasources/data-source=ExampleDS:write-attribute(name=user-name,value=other)
    server: 192.168.20.55:9990

# Undeploy the hello world application on wildfly server
- jbosscli:
    command: undeploy hello.war
    server: "{{ ansible_hostname}}:9990"
"""

RETURN = '''
---
changed:
    description: if JBoss Cli command change something
    returned: true
    type: string
    sample: 'changed: true'
command:
    description: JBoss Cli command
    returned: JBoss Cli command
    type: string
    sample: 'command: "/subsystem=deployment-scanner/scanner=default:write-attribute(name=scan-interval,value=1000)"'
stdout:
    description: JBoss Cli command output
    returned: If verbose JBoss Cli command output, else success or failed
    type: string
    sample: '{"outcome" => "success"}'
Error:
    description: JBoss Cli command error
    returned: return error if falied
    type: string
    sample: '{"outcome" => "success"}'

'''

import os
import re
import platform
from ansible.module_utils.basic import AnsibleModule


def main():
    module = AnsibleModule(
        argument_spec=dict(
            src=dict(),
            user=dict(),
            password=dict(),
            command=dict(),
            cli_path=dict(default='/usr/share/wildfly/bin'),
            server=dict(default='localhost:9990'),
            verbose=dict(default="False"),
        ),
        mutually_exclusive=[['command', 'src']],
    )

    src = module.params['src']
    user = module.params['user']
    password = module.params['password']
    command = module.params['command']
    cli_path = module.params['cli_path']
    server = module.params['server']
    verbose = module.params['verbose']

    if user and not password:
        module.fail_json(msg="Argument 'user' needs 'password' ")

    if not os.access(cli_path + "/jboss-cli.sh", os.X_OK):
        module.fail_json(msg="jboss-cli.sh in not found on cli_path ")

    cmd = [cli_path + "/jboss-cli.sh"]
    cmd.append('-c')
    cmd.append("--controller=" + str(server))

    if user:
        cmd.append('--user=' + str(user))
        cmd.append('--password=' + str(password))

    if src:
        cmd.append('--file=' + str(src))
    else:
        cmd.append('%s' % str(command))

    rc = None
    out = ''
    err = ''
    result = {}
    result['command'] = command

    (rc, out, err) = module.run_command(cmd, encoding='utf-8')

    if rc is None:
        result['changed'] = False
    else:
        result['changed'] = True

    if rc != 0 and not out:
        cause = re.findall("Caused.+", err)
        if cause is not None:
            module.fail_json(name='jboss-cli', msg=str(cause))
        else:
            module.fail_json(name='jboss-cli', msg=err)

    if out and not src:
        if not out.find("outcome") < 0:
            if out.find('success'):
                result['changed'] = True
                if verbose == "True":
                    result['stdout'] = out
                else:
                    result['stdout'] = 'success'
            else:
                result['changed'] = False
                result['Error'] = re.findall("failure-description.+", out)
                if verbose == "True":
                    result['stdout'] = out
                else:
                    result['stdout'] = re.findall("outcome.+", out)
        else:
            result['changed'] = False
            result['stdout'] = out

    if src:
        result['changed'] = True
        result['stdout'] = out
    if rc != 0:
        failure = re.findall("failure-description.+", out)
        if failure:
            module.fail_json(name='jbosscli', msg=failure)
        else:
            module.fail_json(name='jbosscli', msg=out)
    if err:
        result['Error'] = err

    module.exit_json(**result)

if __name__ == '__main__':
    main()