Merge pull request #307 from CiscoDevNet/dcnm_image_policy_v2

dcnm_image_policy v2: Ready for review

Author: mikewiebe

playbooks/roles/dcnm_image_policy/dcnm_hosts.yaml

@@ -0,0 +1,20 @@
+all:
+  vars:
+    ansible_user: "admin"
+    ansible_password: "password-secret"
+    ansible_python_interpreter: python
+    ansible_httpapi_validate_certs: False
+    ansible_httpapi_use_ssl: True
+  children:
+    dcnm:
+      vars:
+        ansible_connection: ansible.netcommon.httpapi
+        ansible_network_os: cisco.dcnm.dcnm
+      hosts:
+        dcnm-instance.example.com:
+    nxos:
+      hosts:
+        n9k-hosta.example.com:
+           ansible_connection: ansible.netcommon.network_cli
+           ansible_network_os: cisco.nxos.nxos
+           ansible_ssh_port: 22

playbooks/roles/dcnm_image_policy/dcnm_tests.yaml

@@ -0,0 +1,38 @@
+---
+# This playbook can be used to execute integration tests for
+# the role located in:
+#
+# tests/integration/targets/dcnm_image_policy
+#
+# Modify the hosts and vars sections with details for your testing
+# setup and uncomment the testcase you want to run.
+#
+- hosts: dcnm
+  gather_facts: no
+  connection: ansible.netcommon.httpapi
+
+  vars:
+    # testcase: dcnm_image_policy_deleted
+    # testcase: dcnm_image_policy_merged
+    # testcase: dcnm_image_policy_overridden
+    # testcase: dcnm_image_policy_query
+    # testcase: dcnm_image_policy_replaced
+    switch_username: admin
+    switch_password: "foobar"
+    spine1: 192.168.1.2
+    spine2: 192.168.1.3
+    leaf1: 192.168.1.4
+    leaf2: 192.168.1.5
+    leaf3: 192.168.1.6
+    leaf4: 192.168.1.7
+    image_policy_1: "KR5M"
+    image_policy_2: "NR3F"
+    epld_image_1: n9000-epld.10.2.5.M.img
+    epld_image_2: n9000-epld.10.3.1.F.img
+    nxos_image_1: n9000-dk9.10.2.5.M.bin
+    nxos_image_2: n9000-dk9.10.3.1.F.bin
+    nxos_release_1: 10.2.5_nxos64-cs_64bit
+    nxos_release_2: 10.3.1_nxos64-cs_64bit
+
+  roles:
+    - dcnm_image_policy

plugins/module_utils/common/api/v1/imagemanagement/rest/policymgnt/policymgnt.py

@@ -223,6 +223,50 @@ def verb(self):
         return "POST"
 
 
+class EpPolicyDelete(PolicyMgnt):
+    """
+    ## V1 API - PolicyMgnt().EpPolicyDelete()
+
+    ### Description
+    Delete image policies.
+
+    ### Raises
+    -   None
+
+    ### Path
+    -   ``/rest/policymgnt/policy``
+
+    ### Verb
+    -   DELETE
+
+    ### Notes
+    Expects a JSON payload as shown below, where ``policyNames`` is a
+    comma-separated list of policy names.
+
+    ```json
+        {
+            "policyNames": "policyA,policyB,etc"
+        }
+    ```
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.class_name = self.__class__.__name__
+        self.log = logging.getLogger(f"dcnm.{self.class_name}")
+        msg = "ENTERED api.v1.imagemanagement.rest."
+        msg += f"policymgnt.{self.class_name}"
+        self.log.debug(msg)
+
+    @property
+    def path(self):
+        return f"{self.policymgnt}/policy"
+
+    @property
+    def verb(self):
+        return "DELETE"
+
+
 class EpPolicyDetach(PolicyMgnt):
     """
     ## V1 API - PolicyMgnt().EpPolicyDetach()
@@ -268,6 +312,51 @@ def verb(self):
         return "DELETE"
 
 
+class EpPolicyEdit(PolicyMgnt):
+    """
+    ## V1 API - PolicyMgnt().EpPolicyEdit()
+
+    ### Description
+    Return endpoint information.
+
+    ### Raises
+    -   None
+
+    ### Path
+    -   ``/rest/policymgnt/edit-policy``
+
+    ### Verb
+    -   POST
+
+    ### Parameters
+    -   path: retrieve the path for the endpoint
+    -   verb: retrieve the verb for the endpoint
+
+    ### Usage
+    ```python
+    instance = EpPolicyEdit()
+    path = instance.path
+    verb = instance.verb
+    ```
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.class_name = self.__class__.__name__
+        self.log = logging.getLogger(f"dcnm.{self.class_name}")
+        msg = "ENTERED api.v1.imagemanagement.rest."
+        msg += f"policymgnt.{self.class_name}"
+        self.log.debug(msg)
+
+    @property
+    def path(self):
+        return f"{self.policymgnt}/edit-policy"
+
+    @property
+    def verb(self):
+        return "POST"
+
+
 class EpPolicyInfo(PolicyMgnt):
     """
     ## V1 API - PolicyMgnt().EpPolicyInfo()

plugins/module_utils/common/properties.py

@@ -37,6 +37,64 @@ class Properties:
     -   ``rest_send``: Set and return nn instance of the ``RestSend`` class.
     -   ``results``: Set and return an instance of the ``Results`` class.
     """
+    @property
+    def params(self):
+        """
+        ### Summary
+        Expects value to be a dictionary containing, at mimimum, the keys
+        ``state`` and ``check_mode``.
+
+        ### Raises
+        -   setter: ``ValueError`` if value is not a dict.
+        -   setter: ``ValueError`` if value["state"] is missing.
+        -   setter: ``ValueError`` if value["state"] is not a valid state.
+        -   setter: ``ValueError`` if value["check_mode"] is missing.
+
+        ### Valid values
+
+        #### ``state``
+        -   deleted
+        -   merged
+        -   overridden
+        -   query
+        -   replaced
+
+        #### ``check_mode``
+        -   ``False`` - The Ansible module should make requested changes.
+        -   ``True``  - The Ansible module should not make requested changed
+            and should only report what changes it would make if ``check_mode``
+            was ``False``.
+
+        ### Details
+        -   Example Valid params:
+                -   ``{"state": "deleted", "check_mode": False}``
+                -   ``{"state": "merged", "check_mode": False}``
+                -   ``{"state": "overridden", "check_mode": False}``
+                -   ``{"state": "query", "check_mode": False}``
+                -   ``{"state": "replaced", "check_mode": False}``
+        -   getter: return the params
+        -   setter: set the params
+        """
+        return self._params
+
+    @params.setter
+    def params(self, value):
+        method_name = inspect.stack()[0][3]
+        if not isinstance(value, dict):
+            msg = f"{self.class_name}.{method_name}: "
+            msg += "params must be a dictionary. "
+            msg += f"got {type(value).__name__} for "
+            msg += f"value {value}"
+            raise TypeError(msg)
+        if value.get("state", None) is None:
+            msg = f"{self.class_name}.{method_name}: "
+            msg += "params.state is required but missing."
+            raise ValueError(msg)
+        if value.get("check_mode", None) is None:
+            msg = f"{self.class_name}.{method_name}: "
+            msg += "params.check_mode is required but missing."
+            raise ValueError(msg)
+        self._params = value
 
     @property
     def rest_send(self):
@@ -106,6 +164,14 @@ def results(self, value):
             raise TypeError(msg)
         self._results = value
 
+    def add_params(self):
+        """
+        ### Summary
+        Class decorator method to set the ``params`` property.
+        """
+        self.params = Properties.params
+        return self
+
     def add_rest_send(self):
         """
         ### Summary