Merge pull request #22 from chkp-ameera/master

add the ability to send gaia_api version within the request and add idempotincy check

Author: chkp-majds

CHANGELOG.rst

@@ -4,6 +4,23 @@ Check_Point.gaia Release Notes
 
 .. contents:: Topics
 
+v4.1.0
+======
+
+Release Summary
+---------------
+
+this release 4.1.0 of ``check_point.gaia``, released on 2022-09-21.
+
+Minor Changes
+---------------
+
+add the ability to send gaia_api version within the request.
+
+Bugfixes
+---------------
+
+add idempotincy check before each present request. do not send the request if it the same configuration in the machine.
 
 v4.0.0
 ======

galaxy.yml

@@ -48,7 +48,7 @@ dependencies: {}
 repository: https://github.com/CheckPointSW/CheckPointAnsibleGAIACollection
 
 # The URL to any online docs
-documentation: https://docs.ansible.com/ansible/latest/collections/check_point/gaia/index.html
+documentation: https://github.com/CheckPointSW/CheckPointAnsibleGAIACollection/tree/master/docs/build/html/index.html
 
 # The URL to the homepage of the collection/project
 homepage: https://github.com/CheckPointSW/CheckPointAnsibleGAIACollection

plugins/module_utils/checkpoint.py

@@ -39,12 +39,39 @@
     wait_for_task=dict(type='bool', default=True)
 )
 
+checkpoint_argument_spec_for_all = dict(
+    version=dict(type='str')
+)
+
 
 # parse failure message with code and response
 def parse_fail_message(code, response):
     return 'Checkpoint device returned error {0} with message {1}'.format(code, response)
 
 
+def idempotency_check(old_val, new_val):
+    if isinstance(new_val, dict):
+        for key in new_val:
+            if key in old_val:
+                if idempotency_check(old_val[key], new_val[key]) is False:
+                    return False
+    elif isinstance(new_val, list):
+        if len(new_val) != len(old_val):
+            return False
+        for item in new_val:
+            if item not in old_val:
+                return False
+    else:
+        if new_val != old_val:
+            return False
+    return True
+
+
+# if user insert a specific version, we add it to the url
+def get_version(module):
+    return ('v' + module.params['version'] + '/') if module.params.get('version') else ''
+
+
 # send the request to checkpoint
 def send_request(connection, version, url, payload=None):
     code, response = connection.send_request('/gaia_api/' + version + url, payload)
@@ -54,7 +81,8 @@ def send_request(connection, version, url, payload=None):
 # get the payload from the user parameters
 def is_checkpoint_param(parameter):
     if parameter == 'state' or \
-            parameter == 'wait_for_task':
+            parameter == 'wait_for_task' or \
+            parameter == 'version':
         return False
     return True
 
@@ -138,7 +166,8 @@ def api_call(module, target_version, api_call_object):
     return code, response
 
 
-def chkp_facts_api_call(module, target_version, api_call_object, is_multible):
+def chkp_facts_api_call(module, api_call_object, is_multible):
+    target_version = get_version(module)
     if is_multible is True:
         show_single = False
         module_key_params = dict((k, v) for k, v in module.params.items() if v is not None)
@@ -164,7 +193,8 @@ def chkp_facts_api_call(module, target_version, api_call_object, is_multible):
     }
 
 
-def chkp_api_call(module, target_version, api_call_object, has_add_api, ignore=None, show_params=None, add_params=None):
+def chkp_api_call(module, api_call_object, has_add_api, ignore=None, show_params=None, add_params=None):
+    target_version = get_version(module)
     changed = False
     if show_params is None:
         show_params = []
@@ -190,6 +220,16 @@ def chkp_api_call(module, target_version, api_call_object, has_add_api, ignore=N
                 "changed": False
             }
     else:  # handle set/add
+        params_dict = module.params.copy()
+        for key, value in module.params.items():
+            if not is_checkpoint_param(key):
+                del params_dict[key]
+
+        if idempotency_check(res, params_dict) is True:
+            return {
+                api_call_object.replace('-', '_'): res,
+                "changed": False
+            }
         code, res = api_call(module, target_version, api_call_object="set-{0}".format(api_call_object))
         if code != 200 and has_add_api is True:
             if add_params:
@@ -212,7 +252,8 @@ def chkp_api_call(module, target_version, api_call_object, has_add_api, ignore=N
 
 
 # for operation and async tasks
-def chkp_api_operation(module, target_version, api_call_object):
+def chkp_api_operation(module, api_call_object):
+    target_version = get_version(module)
     code, response = api_call(module, target_version, api_call_object)
     result = {'changed': True}
     if code == 200:

plugins/modules/cp_gaia_allowed_clients.py

@@ -31,6 +31,10 @@
 version_added: '3.0.0'
 requirements: ['supported starting from gaia_api >= 1.6']
 options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
   allowed_networks:
     description: Configure allowed clients as network.
     required: False
@@ -76,7 +80,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
@@ -91,12 +95,11 @@ def main():
         allowed_hosts=dict(type='list', elements='str'),
         allowed_any_host=dict(type='bool')
     )
-
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = 'allowed-clients'
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_api_call(module, api_call_object, False)
     module.exit_json(**res)
 
 

plugins/modules/cp_gaia_allowed_clients_facts.py

@@ -27,6 +27,11 @@
 description:
 - Show the configuration of allowed clients.
 module: cp_gaia_allowed_clients_facts
+options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
 short_description: Show the configuration of allowed clients.
 version_added: '3.0.0'
 notes:
@@ -76,18 +81,18 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
     # arguments for the module:
     fields = dict()
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
 
     api_call_object = 'allowed-clients'
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_facts_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_facts_api_call(module, api_call_object, False)
     module.exit_json(ansible_facts=res["ansible_facts"])
 
 

plugins/modules/cp_gaia_api_versions_facts.py

@@ -26,6 +26,11 @@
 author: Ameer Asli (@chkp-ameera)
 description:
 - Show api versions.
+options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
 short_description: Show api versions.
 version_added: '3.0.0'
 notes:
@@ -59,17 +64,17 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
     # arguments for the module:
     fields = dict()
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = 'api-versions'
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_facts_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_facts_api_call(module, api_call_object, False)
     module.exit_json(ansible_facts=res["ansible_facts"])
 
 

plugins/modules/cp_gaia_asset_facts.py

@@ -26,6 +26,11 @@
 author: Ameer Asli (@chkp-ameera)
 description:
 - Show Asset.
+options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
 short_description: Show Asset.
 version_added: '3.0.0'
 notes:
@@ -152,17 +157,17 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
     # arguments for the module:
     fields = dict()
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = 'asset'
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_facts_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_facts_api_call(module, api_call_object, False)
     module.exit_json(ansible_facts=res["ansible_facts"])
 
 

plugins/modules/cp_gaia_banner.py

@@ -28,6 +28,10 @@
 - Setting the banner message.
 module: cp_gaia_banner
 options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
   msg:
     description: Banner message for the web, ssh and serial login. Empty string returns to default.
     required: false
@@ -59,7 +63,7 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
@@ -68,11 +72,11 @@ def main():
         msg=dict(type='str', required=False, default="This system is for authorized use only."),
         enabled=dict(type='bool', required=False)
     )
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = 'banner'
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_api_call(module, api_call_object, False)
     module.exit_json(**res)
 
 

plugins/modules/cp_gaia_banner_facts.py

@@ -26,6 +26,11 @@
 description:
 - Show banner message.
 module: cp_gaia_banner_facts
+options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
 short_description: Show banner message settings.
 version_added: '3.0.0'
 notes:
@@ -59,17 +64,17 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_facts_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
     # arguments for the module:
     fields = dict()
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = "banner"
-    gaia_api_version = 'v1.6/'
 
-    res = chkp_facts_api_call(module, gaia_api_version, api_call_object, False)
+    res = chkp_facts_api_call(module, api_call_object, False)
     module.exit_json(ansible_facts=res["ansible_facts"])
 
 

plugins/modules/cp_gaia_bond_interface.py

@@ -31,6 +31,10 @@
 notes:
 - Supports C(check_mode).
 options:
+  version:
+    description: Gaia API version for example 1.6.
+    required: False
+    type: str
   state:
     description: Ansible state which can be C(present) or C(absent).
     required: False
@@ -166,7 +170,7 @@
 """
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call
+from ansible_collections.check_point.gaia.plugins.module_utils.checkpoint import chkp_api_call, checkpoint_argument_spec_for_all
 
 
 def main():
@@ -202,16 +206,16 @@ def main():
         mii_interval=dict(type='int')
     )
 
+    fields.update(checkpoint_argument_spec_for_all)
     module = AnsibleModule(argument_spec=fields, supports_check_mode=True)
     api_call_object = 'bond-interface'
-    gaia_api_version = 'v1.6/'
     ignore = ['status']
     show_params = ['name']
     add_params = {}
     if module.params['name'].startswith('bond') and len(module.params['name']) > 4:
         add_params = {'id': int(module.params['name'][4:])}
 
-    res = chkp_api_call(module, gaia_api_version, api_call_object, True, ignore=ignore, show_params=show_params, add_params=add_params)
+    res = chkp_api_call(module, api_call_object, True, ignore=ignore, show_params=show_params, add_params=add_params)
     module.exit_json(**res)