rename image_mgmt directory to image_upgrade

Background: Initially, image_mgmt was going to hold the module_utils for image_policy, image_upgrade, and image_upload. I never coordinated with Mallik on this, and later decided it was a bit of organizational overkill. This commit comprises the following: 1. Renaming directory module_utils/image_mgmt to module_utils/image_upgrade. 2. Modifying all python imports that point to module_utils/image_mgmt, to point to module_utils/image_upgrade. 3. Modifying all unit test names to replace image_mgmt with image_upgrade 4. Changing key names for all the unit tests to replace image_mgmt with image_upgrade.
CiscoDevNet · Feb 18, 2024 · 3bd708a · 3bd708a
1 parent 53a5fe0
commit 3bd708a
Show file tree

Hide file tree

Showing 41 changed files with 638 additions and 638 deletions.
diff --git a/plugins/module_utils/common/controller_version.py b/plugins/module_utils/common/controller_version.py
@@ -24,9 +24,9 @@
 
 import logging
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/plugins/module_utils/image_mgmt/__init__.py → ...ns/module_utils/image_upgrade/__init__.py b/plugins/module_utils/image_mgmt/__init__.py → ...ns/module_utils/image_upgrade/__init__.py
diff --git a/.../module_utils/image_mgmt/api_endpoints.py → ...dule_utils/image_upgrade/api_endpoints.py b/.../module_utils/image_mgmt/api_endpoints.py → ...dule_utils/image_upgrade/api_endpoints.py
diff --git a/...module_utils/image_mgmt/image_policies.py → ...ule_utils/image_upgrade/image_policies.py b/...module_utils/image_mgmt/image_policies.py → ...ule_utils/image_upgrade/image_policies.py
@@ -23,9 +23,9 @@
 import logging
 from typing import Any, AnyStr, Dict
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/...e_utils/image_mgmt/image_policy_action.py → ...tils/image_upgrade/image_policy_action.py b/...e_utils/image_mgmt/image_policy_action.py → ...tils/image_upgrade/image_policy_action.py
@@ -24,13 +24,13 @@
 import logging
 from typing import Any, Dict
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_policies import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_policies import \
     ImagePolicies
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_issu_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_issu_details import \
     SwitchIssuDetailsBySerialNumber
 
 

diff --git a/...ns/module_utils/image_mgmt/image_stage.py → ...module_utils/image_upgrade/image_stage.py b/...ns/module_utils/image_mgmt/image_stage.py → ...module_utils/image_upgrade/image_stage.py
@@ -26,13 +26,13 @@
 
 from ansible_collections.cisco.dcnm.plugins.module_utils.common.controller_version import \
     ControllerVersion
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.rest_send import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.rest_send import \
     RestSend
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_issu_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_issu_details import \
     SwitchIssuDetailsBySerialNumber
 
 

diff --git a/.../module_utils/image_mgmt/image_upgrade.py → ...dule_utils/image_upgrade/image_upgrade.py b/.../module_utils/image_mgmt/image_upgrade.py → ...dule_utils/image_upgrade/image_upgrade.py
@@ -25,15 +25,15 @@
 from time import sleep
 from typing import Any, Dict, List, Set
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.install_options import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.install_options import \
     ImageInstallOptions
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.rest_send import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.rest_send import \
     RestSend
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_issu_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_issu_details import \
     SwitchIssuDetailsByIpAddress
 
 

diff --git a/..._utils/image_mgmt/image_upgrade_common.py → ...ils/image_upgrade/image_upgrade_common.py b/..._utils/image_mgmt/image_upgrade_common.py → ...ils/image_upgrade/image_upgrade_common.py
@@ -25,7 +25,7 @@
 from time import sleep
 
 # Using only for its failed_result property
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_task_result import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_task_result import \
     ImageUpgradeTaskResult
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/...s/image_mgmt/image_upgrade_task_result.py → ...mage_upgrade/image_upgrade_task_result.py b/...s/image_mgmt/image_upgrade_task_result.py → ...mage_upgrade/image_upgrade_task_result.py
diff --git a/...module_utils/image_mgmt/image_validate.py → ...ule_utils/image_upgrade/image_validate.py b/...module_utils/image_mgmt/image_validate.py → ...ule_utils/image_upgrade/image_validate.py
@@ -25,13 +25,13 @@
 from time import sleep
 from typing import List, Set
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.rest_send import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.rest_send import \
     RestSend
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_issu_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_issu_details import \
     SwitchIssuDetailsBySerialNumber
 
 

diff --git a/...odule_utils/image_mgmt/install_options.py → ...le_utils/image_upgrade/install_options.py b/...odule_utils/image_mgmt/install_options.py → ...le_utils/image_upgrade/install_options.py
@@ -25,9 +25,9 @@
 import time
 from typing import Any, Dict
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/plugins/module_utils/image_mgmt/rest_send.py → ...s/module_utils/image_upgrade/rest_send.py b/plugins/module_utils/image_mgmt/rest_send.py → ...s/module_utils/image_upgrade/rest_send.py
@@ -25,7 +25,7 @@
 from time import sleep
 
 # Using only for its failed_result property
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_task_result import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_task_result import \
     ImageUpgradeTaskResult
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/...module_utils/image_mgmt/switch_details.py → ...ule_utils/image_upgrade/switch_details.py b/...module_utils/image_mgmt/switch_details.py → ...ule_utils/image_upgrade/switch_details.py
@@ -22,11 +22,11 @@
 import json
 import logging
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.rest_send import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.rest_send import \
     RestSend
 
 

diff --git a/...e_utils/image_mgmt/switch_issu_details.py → ...tils/image_upgrade/switch_issu_details.py b/...e_utils/image_mgmt/switch_issu_details.py → ...tils/image_upgrade/switch_issu_details.py
@@ -22,9 +22,9 @@
 import json
 import logging
 
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import \
     dcnm_send

diff --git a/plugins/modules/dcnm_image_upgrade.py b/plugins/modules/dcnm_image_upgrade.py
@@ -299,19 +299,19 @@
 
 EXAMPLES = """
 # This module supports the following states:
-#
+
 # merged:
 #   Attach image policy to one or more devices.
 #   Stage image on one or more devices.
 #   Validate image on one or more devices.
 #   Upgrade image on one or more devices.
-#
+
 # query:
 #   Return ISSU details for one or more devices.
-#
+
 # deleted:
 #   Delete image policy from one or more devices
-#
+
 
 # Attach image policy NR3F to two devices
 # Stage and validate the image on two devices but do not upgrade
@@ -414,27 +414,27 @@
     ParamsMergeDefaults
 from ansible_collections.cisco.dcnm.plugins.module_utils.common.params_validate import \
     ParamsValidate
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.api_endpoints import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.api_endpoints import \
     ApiEndpoints
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_policies import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_policies import \
     ImagePolicies
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_policy_action import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_policy_action import \
     ImagePolicyAction
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_stage import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_stage import \
     ImageStage
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade import \
     ImageUpgrade
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_common import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_common import \
     ImageUpgradeCommon
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_upgrade_task_result import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_upgrade_task_result import \
     ImageUpgradeTaskResult
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.image_validate import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.image_validate import \
     ImageValidate
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.install_options import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.install_options import \
     ImageInstallOptions
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_details import \
     SwitchDetails
-from ansible_collections.cisco.dcnm.plugins.module_utils.image_mgmt.switch_issu_details import \
+from ansible_collections.cisco.dcnm.plugins.module_utils.image_upgrade.switch_issu_details import \
     SwitchIssuDetailsByIpAddress
 
 
@@ -1326,9 +1326,9 @@ def main():
     # For an example configuration, see:
     # $ANSIBLE_COLLECTIONS_PATH/cisco/dcnm/plugins/module_utils/common/logging_config.json
     log = Log(ansible_module)
-    # collection_path = "/Users/arobel/repos/collections/ansible_collections/cisco/dcnm"
-    # config_file = f"{collection_path}/plugins/module_utils/common/logging_config.json"
-    # log.config = config_file
+    collection_path = "/Users/arobel/repos/collections/ansible_collections/cisco/dcnm"
+    config_file = f"{collection_path}/plugins/module_utils/common/logging_config.json"
+    log.config = config_file
     log.commit()
 
     task_module = ImageUpgradeTask(ansible_module)

diff --git a/tests/unit/modules/dcnm/dcnm_image_upgrade/fixtures/image_upgrade_payloads_ImageUpgrade.json b/tests/unit/modules/dcnm/dcnm_image_upgrade/fixtures/image_upgrade_payloads_ImageUpgrade.json
@@ -1,5 +1,5 @@
 {
-    "test_image_mgmt_upgrade_00019a": {
+    "test_image_upgrade_upgrade_00019a": {
         "devices": [
             {
                 "policyName": "KR5M",
@@ -28,7 +28,7 @@
             "writeErase": false
         }
     },
-    "test_image_mgmt_upgrade_00020a": {
+    "test_image_upgrade_upgrade_00020a": {
         "devices": [
             {
                 "policyName": "NR3F",
@@ -57,7 +57,7 @@
             "writeErase": false
         }
     },
-    "test_image_mgmt_upgrade_00021a": {
+    "test_image_upgrade_upgrade_00021a": {
         "devices": [
             {
                 "policyName": "NR3F",