Implementing Dataclasses + simplifying results. Working towards 2.0 (#56)

* Feature/testing fixup (#53)

* Feature/drop xmltodict (#52)

* test passing, dropped xmltodict + arista ceos

* ci

* CI

* perms?

* testing

* testing

* clab command

* clab

* RPC Reply changed

* EOF L

* passing

* Various test modifications

* Implementing DataClass

* netconf lock replying RpcResult

* the past is the past

* Working through tests

* Tests passing

* dropped 3.7, pipeline, tests

* CI ruff

* ruff-poetry

* pass linters, before testing

* Documentation API updated

* test update

* Test rebase (#54)

* Feature/drop xmltodict (#52)

* test passing, dropped xmltodict + arista ceos

* ci

* CI

* perms?

* testing

* testing

* clab command

* clab

* RPC Reply changed

* EOF L

* passing

* rebased dev

Author: h4ndzdatm0ld

.dockerignore

@@ -22,5 +22,5 @@ LICENSE
 **/.vscode/
 invoke*.yml
 tasks.py
-clab-files/
 clab-files
+clab-*

.flake8

@@ -6,7 +6,7 @@ on: # yamllint disable-line rule:truthy rule:comments
 
 jobs:
   linters:
-    name: linters
+    name: "Code Quality - Linting"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -20,14 +20,12 @@ jobs:
 
       - name: Lint & Code Format
         run: |
-          echo 'Running Flake8' && \
-          poetry run flake8 . && \
+          echo 'Rnning Ruff' && \
+          poetry run ruff . && \
           echo 'Running Black' && \
           poetry run black --check --diff . && \
           echo 'Running Yamllint' && \
           poetry run yamllint . && \
-          echo 'Running pydocstyle' && \
-          poetry run pydocstyle . && \
           echo 'Running Bandit' && \
           poetry run bandit --recursive ./ --configfile .bandit.yml && \
           echo 'Running MyPy' && \
@@ -36,9 +34,11 @@ jobs:
   test:
     name: Testing on Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest
+    needs:
+      - "linters"
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
     steps:
       - uses: actions/checkout@v2
       - name: Setup python
@@ -47,22 +47,19 @@ jobs:
           python-version: ${{ matrix.python-version }}
           architecture: x64
 
-      - name: Start NETCONF Sysrepo container
-        run: docker-compose up -d sysrepo
-
-      - name: "Install Clab"
+      - name: "Install Containerlab"
         run: |
           sudo bash -c "$(curl -sL https://get.containerlab.dev)"
           
-      - name: Start Arista CEOS
-        run: sudo containerlab deploy -t clab-files/clab-arista.yml
+      - name: "Start Arista CEOS"
+        run: "sudo containerlab deploy -t clab-files/clab-arista.yml"
 
       - name: "Wait for Arista CEOS to be ready"
         uses: "jakejarvis/wait-action@master"
         with:
           time: "10"
 
-      - name: "CHOWN CLAB Files"
+      - name: "Change ownership of Containerlab files"
         run: "sudo chown -R $USER clab-arista-testing.yml"
 
       - name: Install dependencies

.github/workflows/ci.yml

@@ -23,16 +23,14 @@ COPY . .
 RUN poetry install --no-interaction
 
 # Runs all necessary linting and code checks
-RUN echo 'Running Flake8' && \
-    flake8 . && \
+RUN echo 'Rnning Ruff' && \
+    ruff . && \
     echo 'Running Black' && \
     black --check --diff . && \
     echo 'Running Yamllint' && \
     yamllint . && \
     echo 'Running Pylint' && \
     find . -name '*.py' | xargs pylint  && \
-    echo 'Running pydocstyle' && \
-    pydocstyle . && \
     echo 'Running Bandit' && \
     bandit --recursive ./ --configfile .bandit.yml  && \
     echo 'Running MyPy' && \

Dockerfile

@@ -195,7 +195,7 @@ def example_global_lock(task):
     lock = task.run(netconf_lock, datastore="candidate", operation="lock")
     # Retrieve the Manager(agent) from lock operation and store for further
     # operations.
-    task.host["manager"] = lock.result["manager"]
+    task.host["manager"] = lock.result.manager
 
 
 def example_edit_config(task):
@@ -247,7 +247,6 @@ if __name__ == "__main__":
 ## Additional Documentation
 
 - [NCClient](https://ncclient.readthedocs.io/en/latest/)
-- [Sysrepo](https://www.sysrepo.org/)
 
 ## Contributions
 
@@ -289,12 +288,6 @@ export SKIP_INTEGRATION_TESTS=False
 docker-compose up -d
 ```
 
-If you do not want to run integration tests, only bring up the `netconf_sysrepo` docker service and continue
-
-```bash
-docker-compose up netconf_sysrepo -d
-```
-
 ```bash
 poetry install && poetry shell
 ```
@@ -314,22 +307,6 @@ Devices testing against Always-ON Sandboxes (Cisco DevNet)
 
 - Cisco IOS-XE - Cisco IOS XE Software, Version 17.03.01a These tests are run locally.
 
-### Sysrepo: netopeer2
-
-The majority of integration tests are run against a docker instance of [netopeer2](https://hub.docker.com/r/sysrepo/sysrepo-netopeer2)
-
-From the [Sysrepo](https://www.sysrepo.org/) website:
-
-"Netopeer2 and Sysrepo provide a fully open source and standards compliant implementation of a NETCONF server and YANG configuration data stores."
-
 ## Documentation
 
 Documentation is generated with Sphinx and hosted with Github Pages. [Documentation](https://h4ndzdatm0ld.github.io/nornir_netconf/)
-
-To generate the latest documentation locally:
-
-```bash
-sphinx-build -vvv -b html ./docs ./docs/public
-cd docs/public
-python -m http.server
-```

README.md

@@ -11,11 +11,6 @@ topology:
       binds:
         - "mymapping.json:/mnt/flash/EosIntfMapping.json:ro"
   nodes:
-    ceos1:
+    ceos:
       kind: "ceos"
       mgmt_ipv4: "172.200.101.11"
-    ceos2:
-      kind: "ceos"
-      mgmt_ipv4: "172.200.101.12"
-  links:
-    - endpoints: ["ceos1:eth1", "ceos2:eth1"]

clab-files/clab-arista.yml

@@ -11,18 +11,8 @@ services:
     build:
       context: "."
       target: "test"
-    depends_on:
-      - "sysrepo"
     volumes:
       - "./:/usr/src/app"
-  sysrepo:
-    container_name: "sysrepo"
-    hostname: "netconf_sysrepo"
-    image: "sysrepo/sysrepo-netopeer2:latest"
-    ports:
-      - "1830:830"
-    environment:
-      NACM_RECOVERY_UID: "0"
   clab:
     image: "ghcr.io/srl-labs/clab"
     network_mode: "host"

docker-compose.yml

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2022-xx-xx
+
+### Added
+
+- `ruff` linter
+
+### Changed
+
+- `sysrepo` tests all got replaced by a containerized instance of Arista CEOS
+
+### Removed
+
+- Dropped Python3.7 - Only 3.8 and above is supported.
+- `sysrepo` container and dependencies. No tests or reliance on this container anymore.
+- `xmltodict` library has been removed. The user should parse XML as they please.
+- Flake8 (Replaced by Ruff)
+- Pydocstyle (Replaced by Ruff)
+
 ## [1.1.0] - 2022-10-06
 
 ### Added

docs/changelog.md

@@ -12,9 +12,6 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
 from shutil import copyfile
 
 # -- Project information -----------------------------------------------------
@@ -31,7 +28,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["autoapi.extension", "myst_parser"]  # Document Python Code
+extensions = ["autoapi.extension", "myst_parser", "sphinx.ext.napoleon"]
 autoapi_type = "python"
 autoapi_dirs = ["../nornir_netconf/"]
 
@@ -48,7 +45,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_pdj_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/conf.py

@@ -23,7 +23,7 @@ def example_global_lock(task):
     lock = task.run(netconf_lock, datastore="candidate", operation="lock")
     # Retrieve the Manager(agent) from lock operation and store for further
     # operations.
-    task.host["manager"] = lock.result["manager"]
+    task.host["manager"] = lock.result.manager
 
 
 def example_edit_config(task):