Release v26.2 -> dev

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @CiscoTestAutomation/pyats-genie-devs

.github/workflows/run_tests.yml

@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Run Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        group: [1, 2, 3, 4, 5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pyats[full] pytest pytest-split
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip uninstall unicon.plugins -y
+    - name: Test Unit Tests
+      run: |
+        make develop
+        cd tests
+        py.test --splits 5 --group ${{ matrix.group}} -v -k 'test_ and not test_connect_mit'
+      shell: bash

.gitignore

@@ -55,7 +55,9 @@ uni.log
 # Files resulting from a git meld merge
 *.orig
 
+# VSCode
+.vscode
+.history
 
 # ignore auto generate docs
 docs/user_guide/services/service_dialogs.rst
-

Makefile

@@ -3,37 +3,42 @@ PKG_NAME      = unicon.plugins
 BUILD_DIR     = $(shell pwd)/__build__
 DIST_DIR      = $(BUILD_DIR)/dist
 SOURCEDIR     = .
-PROD_USER     = pyadm@pyats-ci
-PROD_PKGS     = /auto/pyats/packages/cisco-shared
-PYTHON        = python
+PYTHON        = python3
 TESTCMD       = runAll --path=tests/
 BUILD_CMD     = $(PYTHON) setup.py bdist_wheel --dist-dir=$(DIST_DIR)
 PYPIREPO      = pypitest
 
 
 DEPENDENCIES = robotframework pyyaml dill coverage Sphinx \
 			   sphinxcontrib-napoleon sphinxcontrib-mockautodoc \
-			   sphinx-rtd-theme asyncssh
+			   sphinx-rtd-theme asyncssh PrettyTable "cryptography>=43.0"
 
 
 .PHONY: clean package distribute develop undevelop help devnet\
-        docs test install_build_deps uninstall_build_deps
+        docs test install_build_deps uninstall_build_deps distribute_staging\
+        distribute_staging_external
 
 help:
 	@echo "Please use 'make <target>' where <target> is one of"
 	@echo ""
-	@echo "package               Build the package"
-	@echo "test                  Test the package"
-	@echo "distribute            Distribute the package to internal Cisco PyPi server"
-	@echo "clean                 Remove build artifacts"
-	@echo "develop               Build and install development package"
-	@echo "undevelop             Uninstall development package"
-	@echo "docs                  Build Sphinx documentation for this package"
-	@echo "install_build_deps    does nothing - just following pyATS pkg standard"
-	@echo "uninstall_build_deps  does nothing - just following pyATS pkg standard"
+	@echo "package                        Build the package"
+	@echo "test                           Test the package"
+	@echo "distribute                     Distribute the package to internal Cisco PyPi server"
+	@echo "distribute_staging             Distribute build pkgs to staging area"
+	@echo "distribute_staging_external    Distribute build pkgs to external staging area"
+	@echo "clean                          Remove build artifacts"
+	@echo "develop                        Build and install development package"
+	@echo "undevelop                      Uninstall development package"
+	@echo "docs                           Build Sphinx documentation for this package"
+	@echo "install_build_deps             does nothing - just following pyATS pkg standard"
+	@echo "uninstall_build_deps           does nothing - just following pyATS pkg standard"
+	@echo "changelogs			          Build compiled changelog file"
 	@echo ""
 
 install_build_deps:
+	@pip install --upgrade pip setuptools wheel
+	@echo ""
+	@echo "Done."
 	@echo ""
 
 uninstall_build_deps:
@@ -47,12 +52,13 @@ docs:
 	@echo "Building $(PKG_NAME) documentation for preview: $@"
 	@echo ""
 
-	python docs/gen_dialogs_rst.py > docs/user_guide/services/service_dialogs.rst
+	python3 docs/gen_dialogs_rst.py > docs/user_guide/services/service_dialogs.rst
 	sphinx-build -b html -c docs -d ./__build__/documentation/doctrees docs/ ./__build__/documentation/html
 
 	@echo "Completed building docs for preview."
 	@echo ""
-
+	@echo "Done."
+	@echo ""
 
 test:
 	@$(TESTCMD)
@@ -68,6 +74,8 @@ package:
 	@echo ""
 	@echo "Completed building: $@"
 	@echo ""
+	@echo "Done."
+	@echo ""
 
 develop:
 	@echo ""
@@ -76,22 +84,26 @@ develop:
 	@echo ""
 	@pip uninstall -y $(PKG_NAME)
 	@pip install $(DEPENDENCIES)
-	@$(PYTHON) setup.py develop --no-deps
+	@pip install -e . --no-deps
 	@echo ""
 	@echo "Completed building and installing: $@"
 	@echo ""
+	@echo "Done."
+	@echo ""
 
 undevelop:
 	@echo ""
 	@echo "--------------------------------------------------------------------"
 	@echo "Uninstalling $(PKG_NAME) development distributable: $@"
 	@echo ""
 
-	@$(PYTHON) setup.py develop --no-deps -q --uninstall
+	@pip uninstall $(PKG_NAME) -y
 
 	@echo ""
 	@echo "Completed uninstalling: $@"
 	@echo ""
+	@echo "Done."
+	@echo ""
 
 clean:
 	@echo ""
@@ -115,3 +127,36 @@ distribute:
 	@echo ""
 	@echo "Done."
 	@echo ""
+
+distribute_staging:
+	@echo ""
+	@echo "--------------------------------------------------------------------"
+	@echo "Copying all distributable to $(STAGING_PKGS)"
+	@test -d $(DIST_DIR) || { echo "Nothing to distribute! Exiting..."; exit 1; }
+	@ssh -q $(PROD_USER) 'test -e $(STAGING_PKGS)/$(PKG_NAME) || mkdir $(STAGING_PKGS)/$(PKG_NAME)'
+	@scp $(DIST_DIR)/* $(PROD_USER):$(STAGING_PKGS)/$(PKG_NAME)/
+	@echo ""
+	@echo "Done."
+	@echo ""
+
+distribute_staging_external:
+	@echo ""
+	@echo "--------------------------------------------------------------------"
+	@echo "Copying all distributable to $(STAGING_EXT_PKGS)"
+	@test -d $(DIST_DIR) || { echo "Nothing to distribute! Exiting..."; exit 1; }
+	@ssh -q $(PROD_USER) 'test -e $(STAGING_EXT_PKGS)/$(PKG_NAME) || mkdir $(STAGING_EXT_PKGS)/$(PKG_NAME)'
+	@scp $(DIST_DIR)/* $(PROD_USER):$(STAGING_EXT_PKGS)/$(PKG_NAME)/
+	@echo ""
+	@echo "Done."
+	@echo ""
+
+changelogs:
+	@echo ""
+	@echo "--------------------------------------------------------------------"
+	@echo "Generating changelog file"
+	@echo ""
+	@python3 -c "from ciscodistutils.make_changelog import main; main('./docs/changelog/undistributed', './docs/changelog/undistributed.rst')"
+	@python3 -c "from ciscodistutils.make_changelog import main; main('./docs/changelog_plugins/undistributed', './docs/changelog_plugins/undistributed.rst')"
+	@echo ""
+	@echo "Done."
+	@echo ""

docs/README.md

@@ -0,0 +1,45 @@
+#### Contribute to documentation
+
+To contribute, you need to fork the repository, do your modifications and create a new pull request.
+
+> :warning: **Please make sure you have the full pyats package installed via ```pip install pyats[full]```.**
+
+To build the docs locally on your machine. Please follow the instructions below
+
+  - Go to the [Unicon.plugins Github repository](https://github.com/CiscoTestAutomation/unicon.plugins)
+
+  - On the top right corner, click ```Fork```. (see https://help.github.com/en/articles/fork-a-repo)
+
+<img width="421" alt="Screen Shot 2020-12-21 at 2 37 19 PM" src="https://user-images.githubusercontent.com/30438439/102815289-1e75e700-439a-11eb-92bc-e424ddce9758.png">
+
+  - In your terminal, clone the repo using the command shown below:
+    ```shell
+    git clone https://github.com/<your_github_username>/unicon.plugins.git
+    ```
+
+  - ```cd unicon.plugins/docs```
+
+  - Use ```make install_build_deps```  to install all of the build dependencies
+
+  - Run ```make docs``` to generate documentation in HTML
+
+  - Wait until you see ```Done``` in your terminal
+
+  - The documentation is now built and stored under the directory
+  ```unicon.plugins/__build__```
+
+  - Run ```make serve``` to view the documentation on your browser
+
+    - Please create a PR after you have made your changes (see [commit your changes](https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/contribute/contribute.html#commit-your-changes) & [open a PR](https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/contribute/contribute.html#open-a-pull-request))
+
+Here are a few examples that could be great pull request:
+
+- Fix Typos
+- Better wording, easier explanation
+- More details, examples
+- Anything else to enhance the documentation
+
+
+#### How to contribute to the pyATS community
+
+- For detail on contributing to pyATS, please follow the [contribution guidelines](https://pubhub.devnetcloud.com/media/pyats-development-guide/docs/contribute/contribute.html#)

docs/api/modules.rst

@@ -0,0 +1,7 @@
+Unicon API Reference
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   unicon

docs/api/unicon.bases.linux.rst

@@ -0,0 +1,38 @@
+unicon.bases.linux package
+==========================
+
+Submodules
+----------
+
+unicon.bases.linux.connection module
+------------------------------------
+
+.. automodule:: unicon.bases.linux.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+unicon.bases.linux.connection_provider module
+---------------------------------------------
+
+.. automodule:: unicon.bases.linux.connection_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+unicon.bases.linux.services module
+----------------------------------
+
+.. automodule:: unicon.bases.linux.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: unicon.bases.linux
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/unicon.bases.routers.rst

@@ -0,0 +1,38 @@
+unicon.bases.routers package
+============================
+
+Submodules
+----------
+
+unicon.bases.routers.connection module
+--------------------------------------
+
+.. automodule:: unicon.bases.routers.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+unicon.bases.routers.connection_provider module
+-----------------------------------------------
+
+.. automodule:: unicon.bases.routers.connection_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+unicon.bases.routers.services module
+------------------------------------
+
+.. automodule:: unicon.bases.routers.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: unicon.bases.routers
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/unicon.bases.rst

@@ -0,0 +1,30 @@
+unicon.bases package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    unicon.bases.linux
+    unicon.bases.routers
+
+Submodules
+----------
+
+unicon.bases.settings module
+----------------------------
+
+.. automodule:: unicon.bases.settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: unicon.bases
+    :members:
+    :undoc-members:
+    :show-inheritance: