[minor_change] Add module nd_pcv, nd_pcv_delta_analysis and nd_pcv_compliance, fix HTTPAPI Connection plugin when wrong login_domain and add ansible_httpapi_login_domain global variable.

Co-authored-by: Lionel Hercot <[email protected]>

Author: xinyuezhao

.github/workflows/ansible-test.yml

@@ -5,51 +5,71 @@ on:
   pull_request:
   schedule:
   # * is a special character in YAML so you have to quote this string
-  - cron:  '0 7 * * *'
+  - cron:  '0 6 * * *'
+env:
+  python_version: 3.9
 jobs:
   build:
     name: Build collection
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ansible: [2.9.17, 2.10.5, 2.11.0]
+        ansible: [v2.9.27, v2.10.17, v2.11.12, v2.12.10, stable-2.13, stable-2.14]
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python ${{ env.python_version }}
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: ${{ env.python_version }}
 
-    - name: Install ansible-base (v${{ matrix.ansible }})
-      run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+    - name: Install ansible-base (${{ matrix.ansible }})
+      run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
 
     - name: Build a collection tarball
       run: ansible-galaxy collection build --output-path "${GITHUB_WORKSPACE}/.cache/collection-tarballs"
 
     - name: Store migrated collection artifacts
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v3
       with:
         name: collection
         path: .cache/collection-tarballs
 
+  black-formating:
+    name: Using Black to check formating
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        experimental: [true]
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Run black against code
+        uses: psf/black@stable
+        with:
+          options: "--check --diff --color -l 159"
+
   importer:
     name: Galaxy-importer check
     needs:
     - build
     runs-on: ubuntu-latest
     steps:
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python ${{ env.python_version }}
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: ${{ env.python_version }}
 
-    - name: Install ansible-base (v2.11.0)
-      run: pip install https://github.com/ansible/ansible/archive/v2.11.0.tar.gz --disable-pip-version-check
+    - name: Install ansible-base (stable-2.14)
+      run: pip install https://github.com/ansible/ansible/archive/stable-2.14.tar.gz --disable-pip-version-check
 
     - name: Download migrated collection artifacts
-      uses: actions/download-artifact@v1
+      uses: actions/download-artifact@v3
       with:
         name: collection
         path: .cache/collection-tarballs
@@ -73,7 +93,7 @@ jobs:
       run: if grep -E 'WARNING|ERROR' .cache/collection-tarballs/log.txt; then exit 1; else exit 0; fi
 
     - name: Store galaxy_importer check log file
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v3
       with:
         name: galaxy-importer-log
         path: .cache/collection-tarballs/importer_result.json
@@ -85,22 +105,23 @@ jobs:
     - build
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ansible: [2.9.17, 2.10.5, 2.11.0]
+        ansible: [v2.9.27, v2.10.17, v2.11.12, v2.12.10, stable-2.13, stable-2.14]
     steps:
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python ${{ env.python_version }}
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: ${{ env.python_version }}
 
-    - name: Install ansible-base (v${{ matrix.ansible }})
-      run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+    - name: Install ansible-base (${{ matrix.ansible }})
+      run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
 
     - name: Install coverage (v4.5.4)
       run: pip install coverage==4.5.4
 
     - name: Download migrated collection artifacts
-      uses: actions/download-artifact@v1
+      uses: actions/download-artifact@v3
       with:
         name: collection
         path: .cache/collection-tarballs
@@ -109,15 +130,15 @@ jobs:
       run: ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
 
     - name: Run sanity tests
-      run: ansible-test sanity --docker -v --color --truncate 0
+      run: ansible-test sanity --docker -v --color --truncate 0 --coverage
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
     - name: Generate coverage report
       run: ansible-test coverage xml -v --requirements --group-by command --group-by version
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
-  
+
     - name: Push coverate report to codecov.io
-      run: bash <(curl -s https://codecov.io/bash) -s 'tests/output/reports/' -F integration
+      run: bash <(curl -s https://codecov.io/bash) -s 'tests/output/reports/' -F sanity
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
   units:
@@ -126,91 +147,97 @@ jobs:
     - build
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ansible: [2.9.17, 2.10.5, 2.11.0]
+        ansible: [v2.10.17, v2.11.12, v2.12.10, stable-2.13, stable-2.14]
+        python-version: [3.9]
+        include:
+          - ansible: v2.9.27
+            python-version: 3.8
     steps:
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
+        python-version: ${{ matrix.python-version }}
 
-    - name: Install ansible-base (v${{ matrix.ansible }})
-      run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+    - name: Install ansible-base (${{ matrix.ansible }})
+      run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
 
     - name: Install coverage (v4.5.4)
       run: pip install coverage==4.5.4
 
     - name: Download migrated collection artifacts
-      uses: actions/download-artifact@v1
+      uses: actions/download-artifact@v3
       with:
         name: collection
         path: .cache/collection-tarballs
 
     - name: Install the collection tarball
       run: ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
 
-    #- name: Run unit tests
-    #  run: ansible-test units --docker -v --color --truncate 0 --python 3.8 --coverage
-    #  working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
+    # - name: Run unit tests
+    #   run: ansible-test units --docker -v --color --truncate 0 --python ${{ matrix.python-version }} --coverage
+    #   working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
-    #- name: Generate coverage report.
-    #  run: ansible-test coverage xml -v --requirements --group-by command --group-by version
-    #  working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
+    # - name: Generate coverage report.
+    #   run: ansible-test coverage xml -v --requirements --group-by command --group-by version
+    #   working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
-    #- uses: codecov/codecov-action@v1
-    #  with:
-    #    fail_ci_if_error: false
-    #    file: /home/runner/.ansible/collections/ansible_collections/cisco/nd/tests/output/reports/coverage.xml
+    # - name: Push coverate report to codecov.io
+    #   run: bash <(curl -s https://codecov.io/bash) -s 'tests/output/reports/' -F unit
+    #   working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
   integration:
     name: Integration in ubuntu-latest
     needs:
     - build
     runs-on: ubuntu-latest
     steps:
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
+    - name: Set up Python ${{ env.python_version }}
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.8
-  
-    - name: Install ansible-base (v2.9.17)
-      run: pip install https://github.com/ansible/ansible/archive/v2.9.17.tar.gz --disable-pip-version-check
-  
+        python-version: ${{ env.python_version }}
+
+    - name: Install ansible-base (stable-2.13)
+      run: pip install https://github.com/ansible/ansible/archive/stable-2.13.tar.gz --disable-pip-version-check
+
     - name: Install coverage (v4.5.4)
       run: pip install coverage==4.5.4
-  
+
     - name: Download migrated collection artifacts
-      uses: actions/download-artifact@v1
+      uses: actions/download-artifact@v3
       with:
         name: collection
         path: .cache/collection-tarballs
-  
+
     - name: Install the collection tarball
       run: ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
 
     - name: Requesting integration mutex
       uses: nev7n/wait_for_response@v1
       with:
-        url: ${{ format('https://8v7s765ibh.execute-api.us-west-1.amazonaws.com/v1/ansible-nd?repo={0}', github.repository) }}
+        url: ${{ format('https://8v7s765ibh.execute-api.us-west-1.amazonaws.com/v1/ansible-nd?repo={0}&run_id={1}', github.repository, github.run_id) }}
         responseCode: 200
         timeout: 2000000
         interval: 5000
 
-    - name: Run integration tests on Python 3.8
-      run: ansible-test network-integration --docker -v --color --retry-on-error --python 3.8 --truncate 0 --continue-on-error --coverage
+    - name: Run integration tests on Python ${{ env.python_version }}
+      run: ansible-test network-integration --docker -v --color --retry-on-error --python ${{ env.python_version }} --truncate 0 --continue-on-error --coverage
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
 
     - name: Releasing integration mutex
       uses: nev7n/wait_for_response@v1
       if: always()
       with:
-        url: ${{ format('https://8v7s765ibh.execute-api.us-west-1.amazonaws.com/v1/ansible-nd/release?repo={0}', github.repository) }}
+        url: ${{ format('https://8v7s765ibh.execute-api.us-west-1.amazonaws.com/v1/ansible-nd/release?repo={0}&run_id={1}', github.repository, github.run_id) }}
         responseCode: 200
 
     - name: Generate coverage report
+      if: always()
       run: ansible-test coverage xml -v --requirements --group-by command --group-by version
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd
-  
+
     - name: Push coverate report to codecov.io
+      if: always()
       run: bash <(curl -s https://codecov.io/bash) -s 'tests/output/reports/' -F integration
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/nd

.github/workflows/changelog-generation.yml

@@ -0,0 +1,32 @@
+name: Generate Changelog
+on:
+  push:
+    branches: master
+jobs:
+  generate-changelog:
+    name: Run automation script
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out script code
+      uses: actions/checkout@v3
+      with:
+        repository: ciscoecosystem/release_script
+        path: ./release_script
+
+    - name: Check out collection code
+      uses: actions/checkout@v3
+      with:
+        path: ./collection
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.9
+
+    - name: Install release script requirements
+      run: pip install -r ./release_script/requirements.txt
+
+    - name: Run automation script
+      run: python ./release_script/script.py
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,43 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+
+  schedule:
+    - cron: '40 8 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.gitignore

@@ -100,6 +100,7 @@ flycheck_*.el
 
 # Generated files
 .idea/**/contentModel.xml
+.DS_Store
 
 # Sensitive or high-churn files
 .idea/**/dataSources/

plugins/doc_fragments/modules.py

@@ -3,13 +3,14 @@
 # Copyright: (c) 2018, Dag Wieers (@dagwieers) <[email protected]>
 # 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)
+from __future__ import absolute_import, division, print_function
+
 __metaclass__ = type
 
 
 class ModuleDocFragment(object):
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   host:
     description:
@@ -68,13 +69,12 @@ class ModuleDocFragment(object):
   login_domain:
     description:
     - The login domain name to use for authentication.
-    - The default value is Local.
+    - The default value is DefaultAuth.
     - If the value is not specified in the task, the value of environment variable C(ND_LOGIN_DOMAIN) will be used instead.
     type: str
-    default: local
 requirements:
 - Nexus Dashboard v2.0 or newer
 notes:
 - Please read the :ref:`nd_guide` for more detailed information on how to manage your ND infrastructure using Ansible.
 - This module was written to support Nexus Dashboard v2.0 or newer. Some or all functionality may not work on earlier versions.
-'''
+"""