vmware_cluster: PEP8, imports, cosmetics (#25140)

This PR includes:
- Documentation improvements (mostly related to boolean defaults)
- Make PEP8 compliant
- Ensure imports are specific
- Few cosmetic changes (sort lists, casing, punctuation)

lib/ansible/modules/cloud/vmware/vmware_cluster.py

@@ -12,59 +12,61 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
                     'status': ['preview'],
                     'supported_by': 'community'}
 
-
+DOCUMENTATION = r'''
-DOCUMENTATION = '''
 ---
 module: vmware_cluster
-short_description: Create VMware vSphere Cluster
+short_description: Manage VMware vSphere clusters
 description:
-    - Create VMware vSphere Cluster
+    - Add or remove VMware vSphere clusters.
-version_added: 2.0
+version_added: '2.0'
 author: Joseph Callen (@jcpowermac)
-notes:
 requirements:
     - Tested on ESXi 5.5
     - PyVmomi installed
 options:
+    cluster_name:
+        description:
+            - The name of the cluster that will be created.
+        required: yes
     datacenter_name:
         description:
             - The name of the datacenter the cluster will be created in.
-        required: True
+        required: yes
-    cluster_name:
-        description:
-            - The name of the cluster that will be created
-        required: True
-    enable_ha:
-        description:
-            - If set to True will enable HA when the cluster is created.
-        required: False
-        default: False
     enable_drs:
         description:
-            - If set to True will enable DRS when the cluster is created.
+            - If set to C(yes) will enable DRS when the cluster is created.
-        required: False
+        type: bool
-        default: False
+        default: 'no'
+    enable_ha:
+        description:
+            - If set to C(yes) will enable HA when the cluster is created.
+        type: bool
+        default: 'no'
     enable_vsan:
         description:
-            - If set to True will enable vSAN when the cluster is created.
+            - If set to C(yes) will enable vSAN when the cluster is created.
-        required: False
+        type: bool
-        default: False
+        default: 'no'
+    state:
+        description:
+            - Create (C(present)) or remove (C(absent)) a VMware vSphere cluster.
+        choices: [absent, present]
+        default: present
 extends_documentation_fragment: vmware.documentation
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
-# Example vmware_cluster command from Ansible Playbooks
 - name: Create Cluster
   local_action:
     module: vmware_cluster
-    hostname: "{{ ansible_ssh_host }}"
+    hostname: '{{ ansible_ssh_host }}'
     username: root
     password: vmware
-    datacenter_name: "datacenter"
+    datacenter_name: datacenter
-    cluster_name: "cluster"
+    cluster_name: cluster
-    enable_ha: True
+    enable_ha: yes
-    enable_drs: True
+    enable_drs: yes
-    enable_vsan: True
+    enable_vsan: yes
 '''
 
 try:
@@ -81,21 +83,21 @@ from ansible.module_utils.vmware import (HAS_PYVMOMI,
                                          find_datacenter_by_name,
                                          vmware_argument_spec,
                                          wait_for_task
-                                        )
+                                         )
 
 
 class VMwareCluster(object):
     def __init__(self, module):
         self.module = module
-        self.enable_ha = module.params['enable_ha']
-        self.enable_drs = module.params['enable_drs']
-        self.enable_vsan = module.params['enable_vsan']
         self.cluster_name = module.params['cluster_name']
+        self.datacenter_name = module.params['datacenter_name']
+        self.enable_drs = module.params['enable_drs']
+        self.enable_ha = module.params['enable_ha']
+        self.enable_vsan = module.params['enable_vsan']
         self.desired_state = module.params['state']
         self.datacenter = None
         self.cluster = None
         self.content = connect_to_api(module)
-        self.datacenter_name = module.params['datacenter_name']
 
     def process_state(self):
         cluster_states = {
@@ -208,8 +210,8 @@ class VMwareCluster(object):
             self.datacenter = find_datacenter_by_name(self.content, self.datacenter_name)
             if self.datacenter is None:
                 self.module.fail_json(msg="Datacenter %s does not exist, "
-                                     "please create first with Ansible Module vmware_datacenter or manually."
+                                          "please create first with Ansible Module vmware_datacenter or manually."
-                                     % self.datacenter_name)
+                                          % self.datacenter_name)
             self.cluster = find_cluster_by_name_datacenter(self.datacenter, self.cluster_name)
 
             if self.cluster is None:
@@ -236,14 +238,19 @@ class VMwareCluster(object):
 def main():
 
     argument_spec = vmware_argument_spec()
-    argument_spec.update(dict(datacenter_name=dict(required=True, type='str'),
+    argument_spec.update(dict(
-                         cluster_name=dict(required=True, type='str'),
+        cluster_name=dict(type='str', required=True),
-                         enable_ha=dict(default=False, required=False, type='bool'),
+        datacenter_name=dict(type='str', required=True),
-                         enable_drs=dict(default=False, required=False, type='bool'),
+        enable_drs=dict(type='bool', default=False),
-                         enable_vsan=dict(default=False, required=False, type='bool'),
+        enable_ha=dict(type='bool', default=False),
-                         state=dict(default='present', choices=['present', 'absent'], type='str')))
+        enable_vsan=dict(type='bool', default=False),
+        state=dict(type='str', default='present', choices=['absent', 'present']),
+    ))
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
 
     if not HAS_PYVMOMI:
         module.fail_json(msg='pyvmomi is required for this module')

test/sanity/pep8/legacy-files.txt

@@ -178,7 +178,6 @@ lib/ansible/modules/cloud/univention/udm_user.py
 lib/ansible/modules/cloud/vmware/vca_fw.py
 lib/ansible/modules/cloud/vmware/vca_nat.py
 lib/ansible/modules/cloud/vmware/vca_vapp.py
-lib/ansible/modules/cloud/vmware/vmware_cluster.py
 lib/ansible/modules/cloud/vmware/vmware_dvswitch.py
 lib/ansible/modules/cloud/vmware/vmware_local_user_manager.py
 lib/ansible/modules/cloud/vmware/vmware_migrate_vmk.py