modernization

Author: simingy

.gitignore

@@ -0,0 +1,104 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

NOTICE

@@ -1,3 +1,3 @@
-Copyright (c) 2019 Cisco Systems, Inc. and/or its affiliates
+Copyright (c) 2020 Cisco Systems, Inc. and/or its affiliates
 
 This project includes software developed at Cisco Systems, Inc. and/or its affiliates.

README.md

@@ -1,40 +1,56 @@
 [![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/CiscoTestAutomation/solutions_examples)
 
-# pyATS and Genie Solutions examples
+# pyATS Solutions Examples
 
-This repository contains several scripts for network health checking using the
-[pyATS Framework](https://developer.cisco.com/site/pyats/)
+This repository contains several NetDevOps scripts build by our user community
+using [pyATS Framework](https://developer.cisco.com/pyats/)
 
-These are intended be examples/starting points for solving common network operations
-challenges.
+## Contributions
 
+Everyone is welcome to leverage these scripts as starting points on solving 
+common network operations challenges. 
 
-# Installation / configuration
+If you have additional thoughts, ideas, or samples you'd like to contribute,
+feel free to open a PR and become a member of the development community!
 
-##### Installation
-```
-git clone https://github.com/CiscoTestAutomation/solutions_examples.git
+## Installation
+
+```bash
+# first, ensure you have a pyATS virtual environment
+# eg:
+mkdir -p ~/workspace/pyats
+cd ~/workspace/pyats
+python3 -m venv .
+source bin/activate
+pip install --upgrade pip setuptools
+pip install pyats[full]
+
+# now, clone this repository
+git clone https://github.com/CiscoTestAutomation/solutions_examples
 cd solutions_examples
-python3 -m venv venv
-source venv/bin/activate
+
+# install the common dependencies
 pip install -r requirements.txt
+
+# you're good to go!
 ```
 
-You can visit our [documentation](https://pubhub.devnetcloud.com/media/pyats-packages/docs/genie/cookbooks/genie.html#how-to-install-genie) for more information.
+You can visit our [documentation](https://developer.cisco.com/docs/pyats/) for more information.
 
-##### Simulation
+## VIRL Simulation
 
 We've provided a [topology.virl](./topology.virl) file for you to test with.
 
-##### Testbed configuration
+## Testbed configuration
 
 We've provided a [default_testbed.yaml](./testedbed.yaml) to go along with the
 sample topology.  you'll likely need to change it to match your devices
 
-# checks
+## Notable Examples
+
+* [bgp_adjacencies](./bgp_adjacencies) - "if a neighbor is configured, it should be established"
 
-* #### [bgp_adjacencies](./bgp_adjacencies) - "if a neighbor is configured, it should be established"
+* [crc_errors](./crc_errors) - "No interface should be accumulating CRC errors"
 
-* #### [crc_errors](./crc_errors) - "No interface should be accumulating CRC errors"
+* [hostname_checker](./hostname_checker) - "Verify devices hostname with Testbed file names"
 
-* #### [hostname_checker](./hostname_checker) - "Verify devices hostname with Testbed file names"

bgp_adjacencies/BGP_Neighbors_Established.py

@@ -7,8 +7,8 @@
 from tabulate import tabulate
 
 # Needed for aetest script
-from ats import aetest
-from ats.log.utils import banner
+from pyats import aetest
+from pyats.log.utils import banner
 
 # Genie Imports
 from genie.conf import Genie

bgp_adjacencies/BGP_check_job.py

@@ -2,13 +2,11 @@
 # pyats run job BGP_check_job.py --testbed-file <testbed_file.yaml>
 # Description: This job file checks that all BGP neighbors are in Established state
 import os
-from ats.easypy import run
-
 
 # All run() must be inside a main function
-def main():
+def main(runtime):
     # Find the location of the script in relation to the job file
-    bgp_tests = os.path.join('./BGP_Neighbors_Established.py')
+    bgp_tests = os.path.join(os.path.dirname(__file__), 
+                             'BGP_Neighbors_Established.py')
     # Execute the testscript
-    # run(testscript=testscript)
-    run(testscript=bgp_tests)
+    runtime.tasks.run(testscript=bgp_tests)

bgp_adjacencies/README.md

@@ -5,5 +5,5 @@ This check connects to all devices defined in the testbed, and parses BGP operat
 # Running
 
 ```
-easypy BGP_check_job.py -html_logs -testbed_file ../default_testbed.yaml
+pyats run job BGP_check_job.py --html-logs --testbed-file ../default_testbed.yaml
 ```