Tidy up sanity checks (2021/Batch 3 - who's counting) (#1885)

* fixed validation-modules for plugins/modules/packaging/language/pip_package_info.py

* fixed validation-modules for plugins/modules/packaging/language/maven_artifact.py

* fixed validation-modules for plugins/modules/packaging/language/bundler.py

* fixed validation-modules for plugins/modules/notification/pushbullet.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_handler.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_check.py

* fixed validation-modules for plugins/modules/monitoring/sensu/sensu_client.py

* fixed validation-modules for plugins/modules/monitoring/icinga2_host.py

* fixed validation-modules for plugins/modules/monitoring/datadog/datadog_monitor.py

* fixed validation-modules for plugins/modules/monitoring/datadog/datadog_event.py

* fixed validation-modules for plugins/modules/clustering/znode.py

* fixed validation-modules for plugins/modules/clustering/etcd3.py

* fixed validation-modules for plugins/modules/clustering/consul/consul_session.py

* fixed validation-modules for plugins/modules/clustering/consul/consul_kv.py

* fixed validation-modules for plugins/modules/clustering/consul/consul.py

* fixed validation-modules for plugins/modules/cloud/profitbricks/profitbricks.py

* fixed validation-modules for plugins/modules/cloud/profitbricks/profitbricks_volume.py

* fixed validation-modules for plugins/modules/cloud/packet/packet_sshkey.py

* fixed validation-modules for plugins/modules/cloud/oneandone/oneandone_server.py

* fixed validation-modules for plugins/modules/cloud/oneandone/oneandone_private_network.py

* fixed validation-modules for plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py

* fixed validation-modules for plugins/modules/cloud/oneandone/oneandone_load_balancer.py

* fixed validation-modules for plugins/modules/cloud/oneandone/oneandone_firewall_policy.py

* fixed validation-modules for plugins/modules/cloud/webfaction/webfaction_app.py

* fixed validation-modules for plugins/modules/cloud/webfaction/webfaction_db.py

* fixed validation-modules for plugins/modules/cloud/webfaction/webfaction_domain.py

* fixed validation-modules for plugins/modules/cloud/webfaction/webfaction_mailbox.py

* fixed validation-modules for plugins/modules/cloud/webfaction/webfaction_site.py

* fixed validation-modules for plugins/modules/remote_management/lxca/lxca_cmms.py

* fixed validation-modules for plugins/modules/remote_management/lxca/lxca_nodes.py

* missed one "elements" in sensu_handler

* Tidy up batch of sanity checks ignore lines

* missed lines in ignore-2.9.txt

* fixed validation-modules for plugins/modules/clustering/consul/consul_acl.py

* Update ignore-2.9.txt

Removed consul_acl.py from ignore-2.9.txt

* Apply suggestions from code review

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

* Update plugins/modules/notification/pushbullet.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* added changelog fragment

* Update plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py

* Update changelogs/fragments/1885-sanity-check-fixes-batch3.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>

plugins/modules/clustering/consul/consul.py

@@ -33,6 +33,7 @@ requirements:
 author: "Steve Gargan (@sgargan)"
 options:
     state:
+        type: str
         description:
           - register or deregister the consul service, defaults to present
         default: present
@@ -86,6 +87,7 @@ options:
             documentation for further details.
     tags:
         type: list
+        elements: str
         description:
           - tags that will be attached to the service registration.
     script:
@@ -345,7 +347,7 @@ def remove_service(module, service_id):
     module.exit_json(changed=False, id=service_id)
 
 
-def get_consul_api(module, token=None):
+def get_consul_api(module):
     consulClient = consul.Consul(host=module.params.get('host'),
                                  port=module.params.get('port'),
                                  scheme=module.params.get('scheme'),
@@ -398,7 +400,7 @@ def parse_service(module):
         module.fail_json(msg="service_name is required to configure a service.")
 
 
-class ConsulService():
+class ConsulService(object):
 
     def __init__(self, service_id=None, name=None, address=None, port=-1,
                  tags=None, loaded=None):
@@ -564,26 +566,26 @@ def main():
         argument_spec=dict(
             host=dict(default='localhost'),
             port=dict(default=8500, type='int'),
-            scheme=dict(required=False, default='http'),
-            validate_certs=dict(required=False, default=True, type='bool'),
-            check_id=dict(required=False),
-            check_name=dict(required=False),
-            check_node=dict(required=False),
-            check_host=dict(required=False),
-            notes=dict(required=False),
-            script=dict(required=False),
-            service_id=dict(required=False),
-            service_name=dict(required=False),
-            service_address=dict(required=False, type='str', default=None),
-            service_port=dict(required=False, type='int', default=None),
+            scheme=dict(default='http'),
+            validate_certs=dict(default=True, type='bool'),
+            check_id=dict(),
+            check_name=dict(),
+            check_node=dict(),
+            check_host=dict(),
+            notes=dict(),
+            script=dict(),
+            service_id=dict(),
+            service_name=dict(),
+            service_address=dict(type='str'),
+            service_port=dict(type='int'),
             state=dict(default='present', choices=['present', 'absent']),
-            interval=dict(required=False, type='str'),
-            ttl=dict(required=False, type='str'),
-            tcp=dict(required=False, type='str'),
-            http=dict(required=False, type='str'),
-            timeout=dict(required=False, type='str'),
-            tags=dict(required=False, type='list'),
-            token=dict(required=False, no_log=True)
+            interval=dict(type='str'),
+            ttl=dict(type='str'),
+            tcp=dict(type='str'),
+            http=dict(type='str'),
+            timeout=dict(type='str'),
+            tags=dict(type='list', elements='str'),
+            token=dict(no_log=True)
         ),
         supports_check_mode=False,
     )

plugins/modules/clustering/consul/consul_acl.py

@@ -22,29 +22,35 @@ options:
     description:
       - a management token is required to manipulate the acl lists
     required: true
+    type: str
   state:
     description:
       - whether the ACL pair should be present or absent
     required: false
     choices: ['present', 'absent']
     default: present
+    type: str
   token_type:
     description:
       - the type of token that should be created
     choices: ['client', 'management']
     default: client
+    type: str
   name:
     description:
       - the name that should be associated with the acl key, this is opaque
         to Consul
     required: false
+    type: str
   token:
     description:
       - the token key identifying an ACL rule set. If generated by consul
         this will be a UUID
     required: false
+    type: str
   rules:
     type: list
+    elements: dict
     description:
       - rules that should be associated with a given token
     required: false
@@ -53,6 +59,7 @@ options:
       - host of the consul agent defaults to localhost
     required: false
     default: localhost
+    type: str
   port:
     type: int
     description:
@@ -64,6 +71,7 @@ options:
       - the protocol scheme on which the consul agent is running
     required: false
     default: http
+    type: str
   validate_certs:
     type: bool
     description:
@@ -215,14 +223,14 @@ _POLICY_HCL_PROPERTY = "policy"
 _ARGUMENT_SPEC = {
     MANAGEMENT_PARAMETER_NAME: dict(required=True, no_log=True),
     HOST_PARAMETER_NAME: dict(default='localhost'),
-    SCHEME_PARAMETER_NAME: dict(required=False, default='http'),
-    VALIDATE_CERTS_PARAMETER_NAME: dict(required=False, type='bool', default=True),
-    NAME_PARAMETER_NAME: dict(required=False),
+    SCHEME_PARAMETER_NAME: dict(default='http'),
+    VALIDATE_CERTS_PARAMETER_NAME: dict(type='bool', default=True),
+    NAME_PARAMETER_NAME: dict(),
     PORT_PARAMETER_NAME: dict(default=8500, type='int'),
-    RULES_PARAMETER_NAME: dict(default=None, required=False, type='list'),
+    RULES_PARAMETER_NAME: dict(type='list', elements='dict'),
     STATE_PARAMETER_NAME: dict(default=PRESENT_STATE_VALUE, choices=[PRESENT_STATE_VALUE, ABSENT_STATE_VALUE]),
-    TOKEN_PARAMETER_NAME: dict(required=False),
-    TOKEN_TYPE_PARAMETER_NAME: dict(required=False, choices=[CLIENT_TOKEN_TYPE_VALUE, MANAGEMENT_TOKEN_TYPE_VALUE],
+    TOKEN_PARAMETER_NAME: dict(),
+    TOKEN_TYPE_PARAMETER_NAME: dict(choices=[CLIENT_TOKEN_TYPE_VALUE, MANAGEMENT_TOKEN_TYPE_VALUE],
                                     default=CLIENT_TOKEN_TYPE_VALUE)
 }
 

plugins/modules/clustering/consul/consul_kv.py

@@ -37,6 +37,7 @@ options:
             'release' respectively. a valid session must be supplied to make the
             attempt changed will be true if the attempt is successful, false
             otherwise.
+        type: str
         choices: [ absent, acquire, present, release ]
         default: present
     key:

plugins/modules/clustering/consul/consul_session.py

@@ -67,6 +67,7 @@ options:
             associated with the session will be release and can be acquired once
             the associated lock delay has expired.
         type: list
+        elements: str
     host:
         description:
           - The host of the consul agent defaults to localhost.
@@ -237,7 +238,7 @@ def test_dependencies(module):
 
 def main():
     argument_spec = dict(
-        checks=dict(type='list'),
+        checks=dict(type='list', elements='str'),
         delay=dict(type='int', default='15'),
         behavior=dict(type='str', default='release', choices=['release', 'delete']),
         host=dict(type='str', default='localhost'),

plugins/modules/clustering/etcd3.py

@@ -18,47 +18,58 @@ description:
    - Needs python etcd3 lib to work
 options:
     key:
+        type: str
         description:
             - the key where the information is stored in the cluster
         required: true
     value:
+        type: str
         description:
             - the information stored
         required: true
     host:
+        type: str
         description:
             - the IP address of the cluster
         default: 'localhost'
     port:
+        type: int
         description:
             - the port number used to connect to the cluster
         default: 2379
     state:
+        type: str
         description:
             - the state of the value for the key.
             - can be present or absent
         required: true
         choices: [ present, absent ]
     user:
+        type: str
         description:
             - The etcd user to authenticate with.
     password:
+        type: str
         description:
             - The password to use for authentication.
             - Required if I(user) is defined.
     ca_cert:
+        type: path
         description:
             - The Certificate Authority to use to verify the etcd host.
             - Required if I(client_cert) and I(client_key) are defined.
     client_cert:
+        type: path
         description:
             - PEM formatted certificate chain file to be used for SSL client authentication.
             - Required if I(client_key) is defined.
     client_key:
+        type: path
         description:
             - PEM formatted file that contains your private key to be used for SSL client authentication.
             - Required if I(client_cert) is defined.
     timeout:
+        type: int
         description:
             - The socket level timeout in seconds.
 author:

plugins/modules/clustering/znode.py

@@ -17,25 +17,31 @@ options:
         description:
             - A list of ZooKeeper servers (format '[server]:[port]').
         required: true
+        type: str
     name:
         description:
             - The path of the znode.
         required: true
+        type: str
     value:
         description:
             - The value assigned to the znode.
+        type: str
     op:
         description:
             - An operation to perform. Mutually exclusive with state.
         choices: [ get, wait, list ]
+        type: str
     state:
         description:
             - The state to enforce. Mutually exclusive with op.
         choices: [ present, absent ]
+        type: str
     timeout:
         description:
             - The amount of time to wait for a node to appear.
         default: 300
+        type: int
     recursive:
         description:
             - Recursively delete node and all its children.
@@ -110,11 +116,11 @@ def main():
         argument_spec=dict(
             hosts=dict(required=True, type='str'),
             name=dict(required=True, type='str'),
-            value=dict(required=False, default=None, type='str'),
-            op=dict(required=False, default=None, choices=['get', 'wait', 'list']),
+            value=dict(type='str'),
+            op=dict(choices=['get', 'wait', 'list']),
             state=dict(choices=['present', 'absent']),
-            timeout=dict(required=False, default=300, type='int'),
-            recursive=dict(required=False, default=False, type='bool')
+            timeout=dict(default=300, type='int'),
+            recursive=dict(default=False, type='bool')
         ),
         supports_check_mode=False
     )