Merge pull request #23 from cisco-en-programmability/develop

Develop to update to v3.2.0

.github/workflows/sanity_tests.yml

@@ -14,9 +14,11 @@ jobs:
     strategy:
       matrix:
         ansible:
+          - stable-2.9
           - stable-2.10
           - stable-2.11
           - stable-2.12
+          - devel
     runs-on: ubuntu-latest
     steps:
       - name: Check out code

changelogs/changelog.yaml

@@ -14,6 +14,7 @@ releases:
     changes:
       release_summary: Fixes a bug related to optional module parameters.
       bugfixes:
+        - Improve the documentation.
         - Fixes a bug that caused the task execution to fail if the optional parameters like port, dnac version and SSL verification were missing from the hosts.yml file.
   1.0.3:
     release_date: '2021-03-29'
@@ -79,14 +80,22 @@ releases:
     release_date: '2021-04-12'
     changes:
       release_summary: This release introduces no changes. Exists just to be in sync with the Ansible Galaxy release number.
+      minor_changes:
+        - sync with Ansible Galaxy release number
   2.0.6:
     release_date: '2021-04-13'
     changes:
       release_summary: Adds dnacentersdk to the requirements.txt file. Adds sanitiy checks for Ansible v2.9.
+      bugfixes:
+        - Adds dnacentersdk to requirements.
+      minor_changes:
+        - Adds sanity ignores for ansible-2.9.
   2.0.7:
     release_date: '2021-04-14'
     changes:
       release_summary: Changes the minimum supported version of Ansible to v2.9.
+      minor_changes:
+        - Changes the minimum supported version from Ansible v.2.10.5 to v2.9.10.
   3.0.0:
     release_date: '2021-08-05'
     changes:
@@ -102,11 +111,13 @@ releases:
       release_summary: Updates to support DNA version 2.2.2.3
       major_changes:
         - Adds new plugins related to DNA version 2.2.2.3.
-        - Updates previouse plugins to follow DNA version 2.2.2.3 specification.
+        - Updates previous plugins to follow DNA version 2.2.2.3 specification.
   3.1.1:
     release_date: '2021-09-03'
     changes:
       release_summary: Adds headers parameter to info modules.
+      minor_changes:
+        - Adds ``headers`` parameter to info modules.
   3.1.2:
     release_date: '2021-09-08'
     changes:
@@ -147,4 +158,12 @@ releases:
       bugfixes:
         - Fixes *delete modules that were calling update operation
         - Fixes *update modules that were calling delete operation
-        - Fixes *update modules that were calling create operation
+        - Fixes *update modules that were calling create operation
+  3.2.0:
+    release_date: '2021-10-22'
+    changes:
+      release_summary: Improves documentation and fixes check_mode behavior.
+      bugfixes:
+        - Improves the changelog.
+        - Improves the documentation of modules.
+        - Fixes check_mode behavior for non-info modules.

docs/conf.py

@@ -18,7 +18,7 @@
 import datetime
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../plugins/module_utils/'))
+sys.path.insert(0, os.path.abspath('../plugins/plugin_utils/'))
 # sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dnac
-version: 3.1.7
+version: 3.2.0
 readme: README.md
 authors:
 - Rafael Campos <[email protected]>
@@ -17,7 +17,7 @@ tags:
 - networking
 - sdn
 dependencies:
-  ansible.utils: ">=2.0.0"
+  ansible.utils: ">=2.0.0,<3.0"
 repository: https://github.com/cisco-en-programmability/dnacenter-ansible
 documentation: https://developer.cisco.com/docs/dna-center/#!ansible
 homepage: https://github.com/cisco-en-programmability/dnacenter-ansible

plugins/action/application_sets.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,13 +16,13 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
     dnac_compare_equality,
     get_dict_result,
 )
-from ansible_collections.cisco.dnac.plugins.module_utils.exceptions import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.exceptions import (
     InconsistentParameters,
 )
 
@@ -153,7 +159,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = False
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -180,6 +187,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            # in --check mode, always skip this module execution
+            self._result["skipped"] = True
+            return self._result
+
         dnac = DNACSDK(self._task.args)
         obj = ApplicationSets(self._task.args, dnac)
 

plugins/action/application_sets_count_info.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,7 +16,7 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
 )
@@ -33,7 +39,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = True
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -66,6 +73,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            self._result["changed"] = True
+            self._result.update(dict(dnac_response={}))
+            return self._result
+
         dnac = DNACSDK(params=self._task.args)
 
         response = dnac.exec(

plugins/action/application_sets_info.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,7 +16,7 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
 )
@@ -36,7 +42,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = True
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -72,6 +79,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            self._result["changed"] = True
+            self._result.update(dict(dnac_response={}))
+            return self._result
+
         dnac = DNACSDK(params=self._task.args)
 
         response = dnac.exec(

plugins/action/applications.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,13 +16,13 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
     dnac_compare_equality,
     get_dict_result,
 )
-from ansible_collections.cisco.dnac.plugins.module_utils.exceptions import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.exceptions import (
     InconsistentParameters,
 )
 
@@ -177,7 +183,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = False
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -204,6 +211,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            # in --check mode, always skip this module execution
+            self._result["skipped"] = True
+            return self._result
+
         dnac = DNACSDK(self._task.args)
         obj = Applications(self._task.args, dnac)
 

plugins/action/applications_count_info.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,7 +16,7 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
 )
@@ -33,7 +39,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = True
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -66,6 +73,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            self._result["changed"] = True
+            self._result.update(dict(dnac_response={}))
+            return self._result
+
         dnac = DNACSDK(params=self._task.args)
 
         response = dnac.exec(

plugins/action/applications_health_info.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 from ansible.plugins.action import ActionBase
@@ -10,7 +16,7 @@
 else:
     ANSIBLE_UTILS_IS_INSTALLED = True
 from ansible.errors import AnsibleActionFail
-from ansible_collections.cisco.dnac.plugins.module_utils.dnac import (
+from ansible_collections.cisco.dnac.plugins.plugin_utils.dnac import (
     DNACSDK,
     dnac_argument_spec,
 )
@@ -41,7 +47,8 @@ def __init__(self, *args, **kwargs):
         if not ANSIBLE_UTILS_IS_INSTALLED:
             raise AnsibleActionFail("ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'")
         super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = True
+        self._supports_async = False
+        self._supports_check_mode = True
         self._result = None
 
     # Checks the supplied parameters against the argument spec for this module
@@ -82,6 +89,11 @@ def run(self, tmp=None, task_vars=None):
         self._result["changed"] = False
         self._check_argspec()
 
+        if self._play_context.check_mode:
+            self._result["changed"] = True
+            self._result.update(dict(dnac_response={}))
+            return self._result
+
         dnac = DNACSDK(params=self._task.args)
 
         response = dnac.exec(