minor fixes to gluster: - removed functions from main scope - renamed rebalance function to disambiguate from variable - updated docs with defaults - added exception handling to command execution

lib/ansible/modules/extras/system/gluster_volume.py

@@ -38,27 +38,33 @@ options:
         use started/stopped to control it's availability.
   cluster:
     required: false
+    default: null
     description:
       - List of hosts to use for probing and brick setup
   host:
     required: false
+    default: null
     description:
       - Override local hostname (for peer probing purposes)
   replicas:
     required: false
+    default: null
     description:
       - Replica count for volume
   stripes:
     required: false
+    default: null
     description:
       - Stripe count for volume
   transport:
     required: false
     choices: [ 'tcp', 'rdma', 'tcp,rdma' ]
+    default: 'tcp'
     description:
       - Transport type for volume
   brick:
     required: false
+    default: null
     description:
       - Brick path on servers
   start_on_create:
@@ -69,22 +75,27 @@ options:
   rebalance:
     choices: [ 'yes', 'no']
     required: false
+    default: 'no'
     description:
       - Controls whether the cluster is rebalanced after changes
   directory:
     required: false
+    default: null
     description:
       - Directory for limit-usage
   options:
     required: false
+    default: null
     description:
       - A dictionary/hash with options/settings for the volume
   quota:
     required: false
+    default: null
     description:
       - Quota value for limit-usage (be sure to use 10.0MB instead of 10MB, see quota list)
   force:
     required: false
+    default: null
     description:
       - If brick is being created in the root partition, module will fail.
         Set force to true to override this behaviour
@@ -119,18 +130,19 @@ import shutil
 import time
 import socket
 
-def main():
-
 
-    def run_gluster(gargs, **kwargs):
+def run_gluster(gargs, **kwargs):
     args = [glusterbin]
     args.extend(gargs)
+    try:
         rc, out, err = module.run_command(args, **kwargs)
         if rc != 0:
             module.fail_json(msg='error running gluster (%s) command (rc=%d): %s' % (' '.join(args), rc, out if out != '' else err))
+    except Exception, e:
+        module.fail_json(msg='error running gluster (%s) command: %s' % (' '.join(args), str(e))
     return out
 
-    def run_gluster_nofail(gargs, **kwargs):
+def run_gluster_nofail(gargs, **kwargs):
     args = [glusterbin]
     args.extend(gargs)
     rc, out, err = module.run_command(args, **kwargs)
@@ -138,7 +150,7 @@ def main():
         return None
     return out
 
-    def run_gluster_yes(gargs):
+def run_gluster_yes(gargs):
     args = [glusterbin]
     args.extend(gargs)
     rc, out, err = module.run_command(args, data='y\n')
@@ -146,7 +158,7 @@ def main():
         module.fail_json(msg='error running gluster (%s) command (rc=%d): %s' % (' '.join(args), rc, out if out != '' else err))
     return out
 
-    def get_peers():
+def get_peers():
     out = run_gluster([ 'peer', 'status'])
     i = 0
     peers = {}
@@ -165,7 +177,7 @@ def main():
                 peers[hostname] = [ uuid, state ]
     return peers
 
-    def get_volumes():
+def get_volumes():
     out = run_gluster([ 'volume', 'info' ])
 
     volumes = {}
@@ -201,7 +213,7 @@ def main():
                 volume = {}
     return volumes
 
-    def get_quotas(name, nofail):
+def get_quotas(name, nofail):
     quotas = {}
     if nofail:
         out = run_gluster_nofail([ 'volume', 'quota', name, 'list' ])
@@ -215,7 +227,7 @@ def main():
             quotas[q[0]] = q[1]
     return quotas
 
-    def wait_for_peer(host):
+def wait_for_peer(host):
     for x in range(0, 4):
         peers = get_peers()
         if host in peers and peers[host][1].lower().find('peer in cluster') != -1:
@@ -223,20 +235,20 @@ def main():
         time.sleep(1)
     return False
 
-    def probe(host):
+def probe(host):
     run_gluster([ 'peer', 'probe', host ])
     if not wait_for_peer(host):
         module.fail_json(msg='failed to probe peer %s' % host)
     changed = True
 
-    def probe_all_peers(hosts, peers, myhostname):
+def probe_all_peers(hosts, peers, myhostname):
     for host in hosts:
         if host not in peers:
             # dont probe ourselves
             if myhostname != host:
                 probe(host)
 
-    def create_volume(name, stripe, replica, transport, hosts, brick, force):
+def create_volume(name, stripe, replica, transport, hosts, brick, force):
     args = [ 'volume', 'create' ]
     args.append(name)
     if stripe:
@@ -253,31 +265,32 @@ def main():
         args.append('force')
     run_gluster(args)
 
-    def start_volume(name):
+def start_volume(name):
     run_gluster([ 'volume', 'start', name ])
 
-    def stop_volume(name):
+def stop_volume(name):
     run_gluster_yes([ 'volume', 'stop', name ])
 
-    def set_volume_option(name, option, parameter):
+def set_volume_option(name, option, parameter):
     run_gluster([ 'volume', 'set', name, option, parameter ])
 
-    def add_brick(name, brick, force):
+def add_brick(name, brick, force):
     args = [ 'volume', 'add-brick', name, brick ]
     if force:
         args.append('force')
     run_gluster(args)
 
-    def rebalance(name):
+def do_rebalance(name):
     run_gluster(['volume', 'rebalance', name, 'start'])
 
-    def enable_quota(name):
+def enable_quota(name):
     run_gluster([ 'volume', 'quota', name, 'enable' ])
 
-    def set_quota(name, directory, value):
+def set_quota(name, directory, value):
         run_gluster([ 'volume', 'quota', name, 'limit-usage', directory, value ])
 
 
+def main():
     ### MAIN ###
 
     module = AnsibleModule(
@@ -403,7 +416,7 @@ def main():
     if changed:
         volumes = get_volumes()
         if rebalance:
-            rebalance(volume_name)
+            do_rebalance(volume_name)
 
     facts = {}
     facts['glusterfs'] = { 'peers': peers, 'volumes': volumes, 'quotas': quotas }