Merge pull request #75 from h4ndzdatm0ld/release/v2.1.0

Release/v2.1.0

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Lint & Code Format
         run: |
           echo 'Rnning Ruff' && \
-          poetry run ruff . && \
+          poetry run ruff check . && \
           echo 'Running Black' && \
           poetry run black --check --diff . && \
           echo 'Running Yamllint' && \
@@ -38,7 +38,7 @@ jobs:
       - "linters"
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11"]
     steps:
       - uses: actions/checkout@v2
       - name: Setup python

.github/workflows/documentation.yml

@@ -4,7 +4,7 @@ name: "Documentation"
 on:
   push:
     branches:
-      - "master"
+      - "develop"
 
 jobs:
   documentation:

.gitignore

@@ -125,3 +125,4 @@ clab-clab-topo-netconf.yml/
 .clab-arista.yml.bak
 clab-arista-testing.yml
 test/test_data/schemas
+tests/test_data/schema_path/nokia-conf-aaa.yang

Dockerfile

@@ -1,4 +1,4 @@
-ARG PYTHON_VER=3.8
+ARG PYTHON_VER=3.9
 
 FROM python:${PYTHON_VER} AS base
 
@@ -21,7 +21,7 @@ COPY . .
 RUN poetry install --no-interaction
 
 RUN echo 'Rnning Ruff' && \
-    ruff . && \
+    ruff check . && \
     echo 'Running Black' && \
     black --check --diff . && \
     echo 'Running Yamllint' && \

docs/changelog.md

@@ -4,6 +4,12 @@ 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.1.0] - 2024-10-13
+
+- Deprecation of Python 3.8
+- Formatting Changes with Black
+- Updated CI/CD to use `ruff check`
+
 ## [2.0.0] - 2022-03-14
 
 ### Added

docs/conf.py

@@ -1,4 +1,5 @@
 """Configuration for Documentation."""
+
 # pylint: disable-all
 # Configuration file for the Sphinx documentation builder.
 #

nornir_netconf/plugins/connections/__init__.py

@@ -1,4 +1,5 @@
 """Netconf Connection Plugin."""
+
 from nornir_netconf.plugins.connections.netconf import CONNECTION_NAME, Netconf
 
 __all__ = ("Netconf", "CONNECTION_NAME")

nornir_netconf/plugins/connections/netconf.py

@@ -1,4 +1,5 @@
 """Netconf Connection Plugin."""
+
 from typing import Any, Dict, Optional
 
 from ncclient import manager

nornir_netconf/plugins/helpers/__init__.py

@@ -1,4 +1,5 @@
 """Helper Functions."""
+
 from .general import check_file, create_folder, write_output
 from .models import RpcResult, SchemaResult
 from .rpc import check_capability

nornir_netconf/plugins/helpers/general.py

@@ -1,4 +1,5 @@
 """General Helpers."""
+
 import logging
 import os.path
 from pathlib import Path

nornir_netconf/plugins/helpers/models.py

@@ -1,4 +1,5 @@
 """Data Models."""
+
 from dataclasses import dataclass, field
 from typing import List, Optional
 

nornir_netconf/plugins/helpers/rpc.py

@@ -1,4 +1,5 @@
 """Helper to extract info from RPC reply."""
+
 from typing import List
 
 

nornir_netconf/plugins/tasks/__init__.py

@@ -2,6 +2,7 @@
 
 Operations are separated into their own categorized folder.
 """
+
 from .capabilities.netconf_capabilities import netconf_capabilities
 from .editing.netconf_commit import netconf_commit
 from .editing.netconf_edit_config import netconf_edit_config
@@ -10,6 +11,7 @@
 from .retrieval.netconf_get import netconf_get
 from .retrieval.netconf_get_config import netconf_get_config
 from .retrieval.netconf_get_schemas import netconf_get_schemas
+from .rpc.netconf_rpc import netconf_rpc
 
 __all__ = (
     "netconf_capabilities",
@@ -20,4 +22,5 @@
     "netconf_lock",
     "netconf_get_schemas",
     "netconf_validate",
+    "netconf_rpc",
 )

nornir_netconf/plugins/tasks/capabilities/netconf_capabilities.py

@@ -1,4 +1,5 @@
 """NETCONF capabilities."""
+
 from nornir.core.task import Result, Task
 
 from nornir_netconf.plugins.connections import CONNECTION_NAME

nornir_netconf/plugins/tasks/editing/netconf_commit.py

@@ -1,4 +1,5 @@
 """NETCONF commit."""
+
 from typing import Optional
 
 from ncclient.manager import Manager

nornir_netconf/plugins/tasks/editing/netconf_edit_config.py

@@ -1,4 +1,5 @@
 """NETCONF edit config."""
+
 from typing import Optional
 
 from ncclient.manager import Manager

nornir_netconf/plugins/tasks/editing/netconf_validate.py

@@ -1,4 +1,5 @@
 """NETCONF validate config."""
+
 from typing import Optional
 
 from ncclient.manager import Manager

nornir_netconf/plugins/tasks/locking/netconf_lock.py

@@ -1,4 +1,5 @@
 """NETCONF lock."""
+
 from typing import Optional
 
 from ncclient.manager import Manager

nornir_netconf/plugins/tasks/retrieval/netconf_get.py

@@ -1,4 +1,5 @@
 """NETCONF get."""
+
 from nornir.core.task import Optional, Result, Task
 
 from nornir_netconf.plugins.connections import CONNECTION_NAME

nornir_netconf/plugins/tasks/retrieval/netconf_get_config.py

@@ -1,4 +1,5 @@
 """NETCONF get config."""
+
 from typing import Any, Dict, Optional
 
 from nornir.core.task import Result, Task

nornir_netconf/plugins/tasks/retrieval/netconf_get_schemas.py

@@ -1,4 +1,5 @@
 """NETCONF Schemas."""
+
 from ncclient.operations.rpc import RPCError
 from nornir.core.task import List, Result, Task
 

nornir_netconf/plugins/tasks/rpc/netconf_rpc.py

@@ -0,0 +1,48 @@
+"""NETCONF rpc generic call."""
+
+import re
+from typing import Optional
+
+from ncclient import xml_
+from ncclient.manager import Manager
+from nornir.core.task import Result, Task
+
+from nornir_netconf.plugins.connections import CONNECTION_NAME
+from nornir_netconf.plugins.helpers import RpcResult
+
+
+def netconf_rpc(
+    task: Task,
+    payload: str,
+    manager: Optional[Manager] = None,
+) -> Result:
+    """This method is a "bare-bones" rpc call which does not apply any
+    formatting/standardization beyond the outer most rpc tag.
+
+    Arguments:
+        payload (str): Payload snippet to apply
+        manager (Manager): NETCONF Manager
+
+    Examples:
+        Simple example::
+            > desired_payload='<save-config xmlns="http://cisco.com/yang/cisco-ia"/>'
+            > nr.run(task= netconf_rpc, payload=desired_payload)
+
+
+    Returns:
+        Result object with the following attributes set::
+
+            * result (RpcResult): Rpc and Manager
+    """
+    if not manager:
+        manager = task.host.get_connection(CONNECTION_NAME, task.nornir.config)
+
+    # convert payload to element, set namespace (if not set) and send RPC
+    data = xml_.to_ele(payload)
+    if not re.match(r"{.*}.*", xml_.parse_root(payload)[0]):
+        data.set("xmlns", xml_.BASE_NS_1_0)
+
+    result = manager.rpc(data)
+
+    result = RpcResult(rpc=result, manager=manager)
+    return Result(host=task.host, result=result)