Ridding of MPLS sdn era and embracing all generic content (#24)

.flake8

@@ -5,4 +5,4 @@ ignore = E203, E266, E501, W503
 max-line-length = 120
 max-complexity = 18
 ; select = B,C,E,F,W,T4,B9
-exclude = ./mpls_in_the_sdn_era/spauto_batfish/
+exclude = ./spauto/spauto_batfish/

.gitignore

@@ -359,7 +359,7 @@ docs/public
 # ncs files
 ncs*
 
-mpls_in_the_sdn_era/spauto_nornir/Logs/
+spauto/spauto_nornir/Logs/
 *__pycache__*
 *.log
 *config*

.pydocstyle.ini

@@ -2,4 +2,4 @@
 convention = google
 inherit = false
 match = (?!__init__).*\.py
-match-dir = (?!tests)[^\.].*
+match-dir = (?!tests)[^\.].*

.yamllint

@@ -59,6 +59,6 @@ rules:
     level: "warning"
 extends: default
 ignore: |
-  mpls_in_the_sdn_era/spauto_batfish/
+  spauto/spauto_batfish/
   .github/
   clab-spauto-topology.yml/

README.md

@@ -8,13 +8,13 @@ All of the study notes have now been moved to use auto-generated documentation t
 
 [Cisco Certified DevNet Specialist - Service Provider Automation and Programmability](https://developer.cisco.com/certification/devnet-sp-auto/)
 
-## Why MPLS in the SDN Era?
+### Why MPLS in the SDN Era?
 
 Simple. This is an incredible book for any and all Network Engineers interested
 in learning technologies used in Service Provider environments. The book is heavily focused
 on MPLS, SDN, Segment-Routing, BGP, L2VPN/L3VPNs, over-all traffic engineering and much more. These are common terms within SP networks and the book does an incredible job in guiding the readers while exploring the device configurations in this topology. However, many other topics are not covered by the book and this repository will hopefully fill in the gaps. This book lays the foundation for our lab topology, but it has increased and grown over time. Additional material used for studying is the book `Network Programmability with YANG`, which covers a lot of the topics in the blueprint!
 
-![MPLS IN THE SDN ERA](mpls_in_the_sdn_era/images/mpls_sdn_era_topology.png)
+![MPLS IN THE SDN ERA](./docs/images/mpls_sdn_era_topology.png)
 
 This book goes through a number of device configurations in a multi-vendor lab topology
 (Cisco IOSXR && Juniper). However, *For this lab, all devices have been replaced with Cisco-IOSXR/XE as we are working on a Cisco Certification.*
@@ -140,7 +140,7 @@ poetry shell
 Locate the Nornir playground
 
 ```
-cd mpls_in_the_sdn_era/spauto_nornir
+cd spauto/spauto_nornir
 ```
 
 Automate

docs/conf.py

@@ -33,7 +33,7 @@
 # ones.
 extensions = ["autoapi.extension", "myst_parser"]  # Document Python Code
 autoapi_type = "python"
-autoapi_dirs = ["../mpls_in_the_sdn_era/"]
+autoapi_dirs = ["../spauto/"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "mpls_in_the_sdn_era"
+name = "spauto"
 version = "0.1.0"
 description = "Playground to study for Cisco Devnet Service Provider Automation exam."
 authors = ["h4ndzdatm0ld <[email protected]>"]
@@ -28,7 +28,6 @@ napalm = "^3.3.1"
 pyiosxr = "^0.53"
 markupsafe = "2.0.1"
 
-
 [tool.poetry.dev-dependencies]
 isort = "*"
 flake8 = "*"
@@ -41,8 +40,8 @@ myst-parser = "*"
 sphinx = "*"
 pytest = "*"
 ipython = "*"
-pybandit = "^0.0.1"
-ansible-lint = "^6.7.0"
+pybandit = "*"
+ansible-lint = "*"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

mpls_in_the_sdn_era/spauto_batfish/bf_mpls_sdn.py → spauto/spauto_batfish/bf_mpls_sdn.py

@@ -18,7 +18,7 @@
 # At the moment this doesn't work. NAPALM Getters is extracting these configurations, however
 # the top line of the config is being stipped out, which identifies the IOSXR version - this is how
 # Batfish determines this is an iosxr device. (One method at least)
-# CONFIGS = "../../mpls_in_the_sdn_era/spauto_nornir/napalm_getters/mpls_sdn_era/"
+# CONFIGS = "../../spauto/spauto_nornir/napalm_getters/mpls_sdn_era/"
 
 # Run 'pytest' from root dir to rebuild the latest configs before running interactive
 CONFIGS = "../../tests/network_data/mpls_sdn_era"

tests/conftest.py

@@ -10,7 +10,7 @@
 # import itertools
 
 # # Tell nornir where our inventory data is
-nornir_path = "mpls_in_the_sdn_era/spauto_nornir"
+nornir_path = "spauto/spauto_nornir"
 
 # Evaluate wether running this locally or not to allow pipeline to execute
 # properly and as well as local testing with docker-compose. The batfish

tests/integration/test_network_health.py

@@ -51,7 +51,7 @@ def batfish_setup():
     """Initialize the test setup with correctly setting the snapshot
     into memory"""
     SNAPSHOT_PATH = "tests/network_data/mpls_sdn_era"
-    # configs_dir = "mpls_in_the_sdn_era/spauto_nornir/napalm_getters/ASN65000"
+    # configs_dir = "spauto/spauto_nornir/napalm_getters/ASN65000"
     snapshot_loader(SNAPSHOT_PATH, "mpls_sdn_era")
     yield
     # At the moment, there is no tear down necessary.

tests/unit/test_mpls_in_the_sdn_era.py

@@ -1,4 +1,4 @@
-from mpls_in_the_sdn_era import __version__
+from spauto import __version__
 
 
 def test_version():