Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(panos_security_rule): state merged with existing values #570

Merged
merged 6 commits into from
Aug 29, 2024
Merged

fix(panos_security_rule): state merged with existing values #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
68341f4
fix: state merged for panos_security_rule
alperenkose Jul 15, 2024
c3fc902
fix: state merged for panos_security_rule
alperenkose Aug 7, 2024
6070430
chore: apply black code formatting
alperenkose Aug 7, 2024
e51e6cf
fix: invocation param as str while config is a member type
alperenkose Aug 8, 2024
ab49672
docs(panos_security_rule): move defaults to description
alperenkose Aug 8, 2024
03eb9e8
Merge branch 'develop' into 564-state-merged-merges-default-values-wi…
alperenkose Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 83 additions & 16 deletions plugins/module_utils/panos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,8 @@ def __init__(
self.parents = ()
self.sdk_params = {}
self.extra_params = {}
self.default_values = {}
self.preset_values = {}
self.reference_operations = ()
self.ansible_to_sdk_param_mapping = {}
self.with_uuid = False
Expand Down Expand Up @@ -489,6 +491,11 @@ def process(self, module):
ansible_param, ansible_param
)
spec[sdk_param] = module.params.get(ansible_param)
if ansible_param in self.preset_values.keys():
self.preset_values[sdk_param] = self.preset_values.pop(ansible_param)
if ansible_param in self.default_values.keys():
self.default_values[sdk_param] = self.default_values.pop(ansible_param)

if self.with_uuid:
spec["uuid"] = module.params["uuid"]
if self.with_target:
Expand Down Expand Up @@ -690,27 +697,40 @@ def apply_state(
if not item.equal(obj, compare_children=True):
result["changed"] = True
obj.extend(other_children)
result["after"] = self.describe(obj)
result["diff"]["after"] = eltostr(obj)
if not module.check_mode:
if self.with_update_in_apply_state:
for param in obj.about().keys():
if getattr(item, param) != getattr(obj, param):
for key, obj_value in obj.about().items():
# NOTE checking defaults for with_update_in_apply_state doesnot have
# a use for now as template, stack and device group dont have
# defaults in the SDK
# it also breaks panos_template as SDK has `mode` attribute set
# to "normal" by default, but there is no xpath for this.
# if obj_value is None:
# setattr(obj, key, self._get_default_value(obj, key))
if getattr(item, key) != getattr(obj, key):
try:
obj.update(param)
obj.update(key)
except PanDeviceError as e:
module.fail_json(
msg="Failed update {0}: {1}".format(
param, e
)
msg="Failed update {0}: {1}".format(key, e)
)
result["after"] = self.describe(obj)
result["diff"]["after"] = eltostr(obj)
else:
for key, obj_value in obj.about().items():
if obj_value is None:
setattr(obj, key, self._get_default_value(obj, key))
result["after"] = self.describe(obj)
result["diff"]["after"] = eltostr(obj)
try:
obj.apply()
except PanDeviceError as e:
module.fail_json(msg="Failed apply: {0}".format(e))
break
else:
for key, obj_value in obj.about().items():
if obj_value is None:
setattr(obj, key, self._get_default_value(obj, key))
result["changed"] = True
result["before"] = None
result["after"] = self.describe(obj)
Expand Down Expand Up @@ -829,15 +849,29 @@ def apply_state(
updated_params = set([])
for key, obj_value in obj.about().items():
item_value = getattr(item, key, None)
if obj_value is not None:
if obj_value:
if isinstance(obj_value, list) or isinstance(item_value, list):
if not item_value:
item_value = []
for elm in obj_value:
if elm not in item_value:
updated_params.add(key)
item_value.append(elm)
setattr(item, key, item_value)
if isinstance(obj_value, str):
obj_value = [obj_value]
# if current config or obj to create is one of the preset values
# (dropdown options in UI) then replace it with the obj value
# since values like "any" can not be in place with other values.
if (
preset_values := self.preset_values.get(key, None)
) and (
set(item_value).issubset(preset_values)
or set(obj_value).issubset(preset_values)
):
updated_params.add(key)
setattr(item, key, obj_value)
else:
for elm in obj_value:
if elm not in item_value:
updated_params.add(key)
item_value.append(elm)
setattr(item, key, item_value)
elif item_value != obj_value:
updated_params.add(key)
setattr(item, key, obj_value)
Expand All @@ -854,7 +888,10 @@ def apply_state(
msg="Failed update {0}: {1}".format(param, e)
)
break
else:
else: # create new record with merge
for key, obj_value in obj.about().items():
if obj_value is None:
setattr(obj, key, self._get_default_value(obj, key))
result["before"] = None
result["after"] = self.describe(obj)
result["diff"] = {
Expand Down Expand Up @@ -1139,6 +1176,30 @@ def _describe(self, elm):

return ans

def _get_default_value(self, obj, key):
"""Returns default value for an sdk param in Ansible module.

Args:
obj: The pandevice object to fetch defaults from SDK.
key: sdk param name to get default value for.

Returns:
Default value of sdk param if defined in Ansible module default_values or
fetch from SDK defaults as a fallback.

"""
# TODO get default values from pan-os-python SDK
# obj._params is not public attribute on SDK which provide default values
# either make it public accessible or provide a method
# NOTE create a temp object with defaults and use values from this temp object
# to fetch defaults for None values and set it for the object to create
obj_default = obj.__class__()
if (default_value := self.default_values.get(key, None)) is None:
# set default value from SDK if not found in module default_values
default_value = getattr(obj_default, key, None)

return default_value

def matches_gathered_filter(self, item, logic):
"""Returns True if the item and its contents matches the logic given.

Expand Down Expand Up @@ -1368,6 +1429,8 @@ def get_connection(
parents=None,
sdk_params=None,
extra_params=None,
default_values=None,
preset_values=None,
reference_operations=None,
ansible_to_sdk_param_mapping=None,
with_uuid=False,
Expand Down Expand Up @@ -1745,6 +1808,10 @@ class in the package (e.g. - "VirtualRouter"). If the class is a singleton
renames[k] = sdk_name
spec[k] = sdk_params[k]
helper.sdk_params = sdk_params
if preset_values is not None:
helper.preset_values = preset_values
if default_values is not None:
helper.default_values = default_values

if with_gathered_filter:
if "gathered_filter" in spec:
Expand Down Expand Up @@ -1821,7 +1888,7 @@ def __init__(
with_state=False,
with_enabled_state=False,
*args,
**kwargs
**kwargs,
):
spec = {}

Expand Down
Loading
Loading