New swim workflow feature

[syed-khadeerahmed]

Description

Please include a summary of the changes and the related issue. Also, include relevant motivation and context.

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]

Can we opimize the logic?

        messages = []

        if skipped_images_str:
            messages.append("Image(s) {0} were skipped as they already exist in Cisco Catalyst Center.".format(skipped_images_str))

        if imported_images_str:
            messages.append("Image(s) {0} have been imported successfully into Cisco Catalyst Center.".format(imported_images_str))
        elif not skipped_images_str:
            messages.append("No images were imported.")

[madhansansel]

Remove commented lines...

[madhansansel]

getting isError, progress, failure_reason from task_details used in multiple places.
Can't we get the vaules, store and use it?

<<< Sample Code, modify the code based on your logic.... >>>>>>>>>>

device_family = tagging_details.get("device_image_family_name")
device_role = tagging_details.get("device_role", "ALL")
site_name = tagging_details.get("site_name", "Global")

while True:
    task_details = self.get_task_details(task_id)
    is_error = task_details.get("isError")
    progress = task_details.get("progress", "")
    failure_reason = task_details.get("failureReason", "")

    if is_error:
        if not tag_image_golden and "An inheritted tag cannot be un-tagged" in failure_reason:
            self.msg = failure_reason
        else:
            action = "Tagging" if tag_image_golden else "Un-Tagging"
            self.msg = (
                "{0} image {1} golden for site {2} for family {3} for device role {4} failed."
                .format(action, image_name, site_name, device_family, device_role)
            )
        self.status = "failed"
        self.result['changed'] = False
        self.result['msg'] = self.msg
        self.log(self.msg, "ERROR")
        break

    if "successful" in progress:
        action = "Tagging" if tag_image_golden else "Un-Tagging"
        self.msg = (
            "{0} image {1} golden for site {2} for family {3} for device role {4} successful."
            .format(action, image_name, site_name, device_family, device_role)
        )
        self.status = "success"
        self.result['changed'] = True
        self.result['msg'] = self.msg
        self.log(self.msg, "INFO")
        break

return self

What happens if not is_error, and not successful in progress? Do we sleep for some time? Is it needed to be in while loop to do tag and untag an image? If we still need to check "while" loop, then add sleep and do checks for default times and break from the loop..