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

chore: deprecate cisco.dnac collection in favor of cisco.catalystcent…

Author: bvargasre

.github/workflows/sanity_tests.yml

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Check out code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: cisco-en-programmability/dnacenter-ansible
 
@@ -34,7 +34,7 @@ jobs:
         run: mv ./cisco-en-programmability/dnacenter-ansible ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
 

.github/workflows/sanity_tests_devel.yml

@@ -49,20 +49,36 @@ jobs:
 
       - name: Run sanity tests
         run: |
-          if [ -s changed_files.txt ]; then
-            changed_files=$(cat changed_files.txt)
-            for file in $changed_files; do
-              # Ensure file paths are relative to the working directory
-              if [ -f "$file" ]; then
-                echo "Running ansible sanity test for file: $file"
-                ansible-test sanity --docker -v --color yes $file
-              else
-                echo "File not found: $file"
-              fi
-            done
-            echo "Ansible sanity tests completed successfully."
-          else
+          if [ ! -s changed_files.txt ]; then
             echo "No changed files to test."
+            exit 0
+          fi
+
+          testable_files=""
+          file_count=0
+          while IFS= read -r file; do
+            if [ -f "$file" ]; then
+              testable_files="$testable_files $file"
+              file_count=$((file_count + 1))
+            fi
+          done < changed_files.txt
+
+          echo "Testable files: $file_count"
+
+          if [ "$file_count" -eq 0 ]; then
+            echo "No existing files to test."
+            exit 0
+          elif [ "$file_count" -le 50 ]; then
+            echo "Running targeted sanity tests on $file_count files..."
+            ansible-test sanity --docker -v --color yes $testable_files
+          else
+            echo "Large changeset ($file_count files). Running full sanity tests..."
+            while true; do echo "Sanity tests still running..."; sleep 60; done &
+            KEEPALIVE_PID=$!
+            timeout 55m ansible-test sanity --docker -v --color
+            EXIT_CODE=$?
+            kill $KEEPALIVE_PID 2>/dev/null
+            exit $EXIT_CODE
           fi
         working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
 
@@ -71,29 +87,24 @@ jobs:
 
       - name: Run yamllint
         run: |
-          if [ -s changed_files.txt ]; then
-            changed_files=$(cat changed_files.txt)
-            lintable_files=""
-            for file in $changed_files; do
-              # Check if the file belongs to the playbooks directory and has .yml or .yaml extension
-              if [[ $file == playbooks/*.yml || $file == playbooks/*.yaml ]]; then
-                # Verify the file exists before adding it
-                if [ -f "$file" ]; then
-                  lintable_files="$lintable_files $file"
-                fi
-              fi
-            done
-
-            echo "Lintable Files: $lintable_files"
-
-            if [ -n "$lintable_files" ]; then
-              echo "Running yamllint test for files: $lintable_files"
-              yamllint -c .yamllint.yml $lintable_files
-              echo "Yamllint tests completed successfully."
-            else
-              echo "No relevant files to lint."
-            fi
-          else
+          if [ ! -s changed_files.txt ]; then
             echo "No changed files to lint."
+            exit 0
           fi
+
+          lintable_files=""
+          while IFS= read -r file; do
+            if [ -f "$file" ] && [[ "$file" == playbooks/*.yml || "$file" == playbooks/*.yaml ]]; then
+              lintable_files="$lintable_files $file"
+            fi
+          done < changed_files.txt
+
+          if [ -z "$lintable_files" ]; then
+            echo "No relevant playbook files to lint."
+            exit 0
+          fi
+
+          echo "Running yamllint on:$lintable_files"
+          yamllint -c .yamllint.yml $lintable_files
+          echo "Yamllint completed successfully."
         working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

README.md

@@ -1,5 +1,9 @@
 # Ansible Collection: cisco.dnac
 
+> **DEPRECATED:** This collection is deprecated and will be removed in a future release.
+> Please migrate to [cisco.catalystcenter](https://galaxy.ansible.com/cisco/catalystcenter),
+> which provides the same functionality under the updated Cisco Catalyst Center branding.
+
 ## Overview
 
 The cisco.dnac Ansible Collection enables enterprise automation and management of Cisco CATALYST Center environments. It provides modules that interact with Cisco CATALYST Center APIs to automate provisioning, configuration, and operational workflows.

changelogs/changelog.yaml

@@ -1963,3 +1963,11 @@ releases:
         - Changes in wireless_design_workflow_manager module
         - Standardized README format and content to match Catalyst Center Ansible collection documentation practices.
         - Added build_ignore configuration to optimize Ansible Galaxy collection packaging.
+
+  6.48.1:
+    release_date: "2026-03-05"
+    changes:
+      release_summary: Deprecation of the cisco.dnac collection in favor of cisco.catalystcenter.
+      deprecated_features:
+        - The cisco.dnac collection is now deprecated. Please migrate to cisco.catalystcenter, which provides the same functionality under the updated Cisco Catalyst Center branding.
+        - All modules now emit a deprecation warning at runtime directing users to cisco.catalystcenter.

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dnac
-version: 6.48.0
+version: 6.48.1
 readme: README.md
 authors:
   - Rafael Campos <rcampos@cloverhound.com>
@@ -32,7 +32,7 @@ authors:
   - Sunil Shatagopa <sshatago@cisco.com>
   - Vivek Raj Penke <vpenke@cisco.com>
 
-description: Ansible Modules for Cisco DNA Center
+description: "DEPRECATED - Use cisco.catalystcenter instead. Ansible Modules for Cisco DNA Center."
 license_file: "LICENSE"
 tags:
   - cisco

plugins/module_utils/dnac.py

@@ -17,7 +17,7 @@
     DNAC_SDK_IS_INSTALLED = False
 else:
     DNAC_SDK_IS_INSTALLED = True
-from ansible.module_utils._text import to_native
+from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.common import validation
 from abc import ABCMeta, abstractmethod
 try:
@@ -47,6 +47,11 @@ class DnacBase():
 
     def __init__(self, module):
         self.module = module
+        module.deprecate(
+            msg="The cisco.dnac collection is deprecated. Please migrate to cisco.catalystcenter.",
+            version="7.0.0",
+            collection_name="cisco.dnac",
+        )
         self.params = module.params
         self.config = copy.deepcopy(module.params.get("config"))
         self.have = {}

plugins/plugin_utils/dnac.py

@@ -14,7 +14,10 @@
 else:
     DNAC_SDK_IS_INSTALLED = True
 from ansible.module_utils.basic import env_fallback
-from ansible.module_utils._text import to_native
+from ansible.module_utils.common.text.converters import to_native
+from ansible.utils.display import Display
+
+display = Display()
 
 try:
     import logging
@@ -182,6 +185,11 @@ def dnac_argument_spec():
 
 class DNACSDK(object):
     def __init__(self, params):
+        display.deprecated(
+            "The cisco.dnac collection is deprecated. Please migrate to cisco.catalystcenter.",
+            version="7.0.0",
+            collection_name="cisco.dnac",
+        )
         self.result = dict(changed=False, result="")
         self.validate_response_schema = params.get("validate_response_schema")
         if DNAC_SDK_IS_INSTALLED: