Swim bug fixed #437

syed-khadeerahmed · 2024-10-17T12:09:41Z

Description

Swim module incorrectly upgrades many devices even if one IP is provided

Type of Change

Bug fix
New feature
Breaking change
Documentation update

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
All the sanity checks have been completed and the sanity test cases have been executed

Ansible Best Practices

Tasks are idempotent (can be run multiple times without changing state)
Variables and secrets are handled securely (e.g., using ansible-vault or environment variables)
Playbooks are modular and reusable
Handlers are used for actions that need to run on change

Documentation

All options and parameters are documented clearly.
Examples are provided and tested.
Notes and limitations are clearly stated.

Screenshots (if applicable)

Notes to Reviewers

madhansansel · 2024-10-17T12:34:33Z

plugins/modules/swim_workflow_manager.py

-            params=params,
-        )
-        self.log("Received API response from 'get_device_list': {0}".format(str(response)), "DEBUG")
+        self.log(params)


self.log("Fetching device ID with parameters: {0}".format(params), "INFO")

updated the log

madhansansel · 2024-10-17T12:36:51Z

plugins/modules/swim_workflow_manager.py

-        else:
-            self.msg = "Device with params: '{0}' not found in Cisco Catalyst Center so can't fetch the device id".format(str(params))
-            self.log(self.msg, "WARNING")
+            if (len(device_list) == 1):


if device_list is None: self.log("Device list is empty; no devices found for given parameters.", "WARNING") raise ValueError("No devices found") if len(device_list) == 1: device_id = device_list[0].get("id") self.log("Successfully retrieved device ID: {0}".format(device_id), "INFO") return device_id self.log("Multiple devices found for parameters: {0}".format(params), "ERROR") raise ValueError("Multiple devices found") except ValueError as ve: self.msg = "Error: {0}. Unable to fetch unique device ID with parameters: {1}".format(str(ve), params) self.status = "failed" self.log(self.msg, "ERROR") self.result['response'] = self.msg return None except Exception as e: self.msg = "An unexpected error occurred while retrieving device ID: {0}".format(str(e)) self.status = "failed" self.log(self.msg, "ERROR") self.result['response'] = self.msg return None

updated the code

plugins/modules/swim_workflow_manager.py

madhansansel · 2024-10-17T12:50:11Z

plugins/modules/swim_workflow_manager.py

@@ -1703,13 +1715,14 @@ def get_diff_distribution(self):
                        self.result['changed'] = True
                        self.status = "success"
                        self.single_device_distribution = True
-                        self.result['msg'] = "Image with Id {0} Distributed Successfully".format(image_id)
-                        self.result['response'] = self.msg
+                        self.result['msg'] = "Image with Id {0} Distributed Successfully for the device: {1} ".format(image_id, device_ip)


self.result['msg'] = "Image '{0}' with ID {1} has been successfully distributed to device: {2}".format(image_name, image_id, device_ip)
OR
self.result['msg'] = "Successfully distributed image '{0}' (ID: {1}) to device: {2}".format(image_name, image_id, device_ip)

updated the code

madhansansel · 2024-10-17T12:50:21Z

plugins/modules/swim_workflow_manager.py

                        break

                    if task_details.get("isError"):
                        self.status = "failed"
-                        self.msg = "Image with Id {0} Distribution Failed".format(image_id)
+                        self.msg = "Image with Id {0} Distribution Failed for the device : {1}".format(image_id, device_ip)


Same as above

madhansansel · 2024-10-17T12:50:35Z

plugins/modules/swim_workflow_manager.py

@@ -1730,6 +1743,7 @@ def get_diff_distribution(self):
        distribution_task_dict = {}

        for device_uuid in device_uuid_list:
+            self.log("Stating image distribution for multiple devices")


what image?

madhansansel · 2024-10-17T12:54:14Z

plugins/modules/swim_workflow_manager.py

@@ -1673,8 +1683,10 @@ def get_diff_distribution(self):
        self.complete_successful_distribution = False
        self.partial_successful_distribution = False
        self.single_device_distribution = False
+        device_ip = self.want.get("distribution_details").get("device_ip_address")

        if self.have.get("distribution_device_id"):


Print image version or image name ...

distribution_device_id = self.have.get("distribution_device_id") if distribution_device_id: self.log("Starting image distribution for device IP {0} with ID {1}, targeting software version {2}.".format( device_ip, distribution_device_id, image_name ), "INFO")

updated the code

madhansansel · 2024-10-17T12:59:12Z

plugins/modules/swim_workflow_manager.py

@@ -1799,8 +1813,10 @@ def get_diff_activation(self):
        self.complete_successful_activation = False
        self.partial_successful_activation = False
        self.single_device_activation = False
+        device_ip = self.want.get("activation_details").get("device_ip_address")

        if self.have.get("activation_device_id"):


Same as like getting distribution_device_id...

updated the code

madhansansel · 2024-10-17T12:59:31Z

plugins/modules/swim_workflow_manager.py

@@ -1861,6 +1877,7 @@ def get_diff_activation(self):
        activation_task_dict = {}

        for device_uuid in device_uuid_list:
+            self.log("Stating image activation for multiple devices")


what image ?? Check the above log messages and make more meaningful

updated the code

madhansansel · 2024-10-18T10:21:20Z

plugins/modules/swim_workflow_manager.py

            device_id = self.get_device_id(device_params)

-            if device_id is not None:
-                have["distribution_device_id"] = device_id
+            if (distribution_details.get("device_ip_address") or


I don't understand why do we need to get device_ip/mac... again? We already got those values in 1156?
Can we replace the whole logic from 1156?
Also why do we use camel case in 1156? Can we replace?

device_params = { "hostname": distribution_details.get("device_hostname"), "serial_number": distribution_details.get("device_serial_number"), "management_ip_address": distribution_details.get("device_ip_address"), "mac_address": distribution_details.get("device_mac_address") } if any(device_params.values()): device_id = self.get_device_id(device_params) if device_id is None: # Device not found, format error message params_list = [] for key, value in device_params.items(): if value: formatted_param = "{0}: {1}".format(key, value) params_list.append(formatted_param) # Join the parameters for the final error message params_message = ", ".join(params_list) self.status = "failed" self.msg = "The device with the following parameter(s): {0} could not be found in the Cisco Catalyst Center.".format(params_message) self.log(self.msg, "ERROR") self.result['response'] = self.msg self.check_return_status() else: # Device found, log success and store the device ID self.log("Device with ID {0} found and added to distribution details.".format(device_id), "DEBUG") have["distribution_device_id"] = device_id else: self.log("No valid device identifier found in the distribution details.", "WARNING") What we do here ....????

updated the code

madhansansel · 2024-10-18T13:44:47Z

plugins/modules/swim_workflow_manager.py

@@ -207,8 +207,8 @@
            type: bool
      image_distribution_details:
        description: Details for SWIM image distribution. Device on which the image needs to distributed


image_distribution_details: description: | Parameters for specifying the target device(s) for SWIM image distribution. The device can be identified using one of the following options: - device_serial_number - device_ip_address - device_hostname - device_mac_address - site_name (if specified, the image will be distributed to all devices within the site) At least one of these parameters must be provided. If 'site_name' is provided, additional filters—such as 'device_role', 'device_family_name', and 'device_series_name'—can be used to further narrow down the devices within the site.

madhansansel · 2024-10-18T14:00:43Z

plugins/modules/swim_workflow_manager.py

@@ -256,8 +256,8 @@
            type: str
      image_activation_details:
        description: Details for SWIM image activation. Device on which the image needs to activated


Same as like distribution

syed-khadeerahmed added 3 commits October 17, 2024 17:04

bug fixed

c6dc3b8

minoe fix in inventory

1391c9b

bug fixed

36c5198

syed-khadeerahmed requested a review from madhansansel as a code owner October 17, 2024 12:09

madhansansel reviewed Oct 17, 2024

View reviewed changes

syed-khadeerahmed added 3 commits October 18, 2024 15:14

addressed the review comments

95f89fe

addressed the review comments

851d999

addressed the review comments

7cbb946

madhansansel reviewed Oct 18, 2024

View reviewed changes

review comments compleated

8dbdde7

madhansansel reviewed Oct 18, 2024

View reviewed changes

syed-khadeerahmed added 3 commits October 18, 2024 19:46

review comments compleated

8b9b892

review comments compleated

47f3cf4

review comments compleated

42d3018

madhansansel approved these changes Oct 18, 2024

View reviewed changes

madhansansel merged commit 87a54c1 into madhansansel:main Oct 18, 2024
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swim bug fixed #437

Swim bug fixed #437

syed-khadeerahmed commented Oct 17, 2024 •

edited

Loading

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 17, 2024

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 18, 2024

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 18, 2024

madhansansel Oct 17, 2024

madhansansel Oct 17, 2024

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 17, 2024

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 18, 2024

madhansansel Oct 17, 2024

syed-khadeerahmed Oct 18, 2024

madhansansel Oct 18, 2024

syed-khadeerahmed Oct 18, 2024

madhansansel Oct 18, 2024

madhansansel Oct 18, 2024

Swim bug fixed #437

Swim bug fixed #437

Conversation

syed-khadeerahmed commented Oct 17, 2024 • edited Loading

Description

Type of Change

Checklist

Ansible Best Practices

Documentation

Screenshots (if applicable)

Notes to Reviewers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

syed-khadeerahmed commented Oct 17, 2024 •

edited

Loading