scrapli 2.0.0a2__py3-none-manylinux2010_x86_64.whl

scrapli/definitions/cisco_nxos.yaml

@@ -0,0 +1,64 @@
+---
+prompt_pattern: '^.*[>#$]\s?+$'
+default_mode: 'privileged_exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^[\w.\-]{1,63}(\(maint\-mode\))?>\s?$'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_prompted_input:
+              input: 'enable'
+              prompt_exact: 'Password:'
+              response: '__lookup::enable'
+  - name: 'privileged_exec'
+    prompt_pattern: '^[\w.\-]{1,63}(\(maint\-mode\))?#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'disable'
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure terminal'
+      - name: 'tclsh'
+        instructions:
+          - send_input:
+              input: 'tclsh'
+  - name: 'configuration'
+    prompt_pattern: '^[\w.\-]{1,63}(\(maint\-mode\))?\(conf[\w.\-@/:\+]{0,32}\)#\s?$'
+    prompt_excludes:
+      - 'config-tcl'
+      - 'config-s)'
+      - 'config-s-'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'end'
+  - name: 'tclsh'
+    prompt_pattern: '(^[\w.\-]{1,63}\-tcl#\s?$)|(^[\w.\-]{1,63}\(config\-tcl\)#\s?$)|(^>\s?$)|(^[\w.\-]{1,63}\(maint\-mode\-tcl\)#\s?$)|(^[\w.\-]{1,63}\(maint\-mode\)\(config\-tcl\)#\s?$)'
+    accessible_modes:
+      - name: 'privileged_exec'
+        instructions:
+          - send_input:
+              input: 'tclquit'
+failure_indicators:
+  - '% Ambiguous command'
+  - '% Incomplete command'
+  - '% Invalid input detected'
+  - '% Invalid command at'
+  - '% Invalid parameter'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - send_input:
+      input: 'term width 511'
+  - send_input:
+      input: 'term len 0'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'privileged_exec'
+  - write:
+      input: 'exit'

scrapli/definitions/juniper_junos.yaml

@@ -0,0 +1,85 @@
+---
+prompt_pattern: '^.*[>#$%]\s?+$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    prompt_pattern: '^({\w+(:(\w+){0,1}\d){0,1}}\n){0,1}[\w\-@()/:\.]{1,63}>\s?$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'configure'
+      - name: 'configuration_exclusive'
+        instructions:
+          - send_input:
+              input: 'configure exclusive'
+      - name: 'configuration_private'
+        instructions:
+          - send_input:
+              input: 'configure private'
+      - name: 'shell'
+        instructions:
+          - send_input:
+              input: 'start shell'
+      - name: 'root_shell'
+        instructions:
+          - send_prompted_input:
+              input: 'start shell user root'
+              prompt_pattern: '^[pP]assword:\s?$'
+              response: '__lookup::root'
+  - name: 'configuration'
+    prompt_pattern: '^({\w+(:(\w+){0,1}\d){0,1}}\[edit\]\n){0,1}[\w\-@()/:\.]{1,63}#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit configuration-mode'
+  - name: 'configuration_exclusive'
+    prompt_pattern: '^({\w+(:(\w+){0,1}\d){0,1}}\[edit\]\n){0,1}[\w\-@()/:\.]{1,63}#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit configuration-mode'
+  - name: 'configuration_private'
+    prompt_pattern: '^({\w+(:(\w+){0,1}\d){0,1}}\[edit\]\n){0,1}[\w\-@()/:\.]{1,63}#\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit configuration-mode'
+  - name: 'shell'
+    prompt_pattern: '^.*[%\$]\s?$'
+    prompt_excludes:
+      - 'root'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+  - name: 'root_shell'
+    prompt_pattern: '^.*root@(?:\S*:?\S*\s?)?[%\#]\s?$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'exit'
+failure_indicators:
+  - 'is ambiguous'
+  - 'No valid completions'
+  - 'unknown command'
+  - 'syntax error'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'set cli screen-width 511'
+  - send_input:
+      input: 'set cli screen-length 0'
+  - send_input:
+      input: 'set cli complete-on-space off'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'exit'

scrapli/definitions/nokia_srlinux.yaml

@@ -0,0 +1,35 @@
+---
+# https://regex101.com/r/U5mgK9/1
+prompt_pattern: '^--.*--\s*\n[abcd]:\S+#\s*$'
+default_mode: 'exec'
+modes:
+  - name: 'exec'
+    # https://regex101.com/r/PGLSJJ/1
+    prompt_pattern: '^--{(\s\[[\w\s]+\]){0,5}[\+\*\s]{1,}running\s}--\[.+?\]--\s*\n[abcd]:\S+#\s*$'
+    accessible_modes:
+      - name: 'configuration'
+        instructions:
+          - send_input:
+              input: 'enter candidate private'
+  - name: 'configuration'
+    # https://regex101.com/r/JsaUZy/1
+    prompt_pattern: '^--{(\s\[[\w\s]+\]){0,5}[\+\*\!\s]{1,}candidate[\-\w\s]+}--\[.+?\]--\s*\n[abcd]:\S+#\s*$'
+    accessible_modes:
+      - name: 'exec'
+        instructions:
+          - send_input:
+              input: 'discard now'
+failure_indicators:
+  - 'Error:'
+on_open_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - send_input:
+      input: 'environment cli-engine type basic'
+  - send_input:
+      input: 'environment complete-on-space false'
+on_close_instructions:
+  - enter_mode:
+      requested_mode: 'exec'
+  - write:
+      input: 'quit'

scrapli/exceptions.py

@@ -0,0 +1,49 @@
+"""scrapli.exceptions"""
+
+
+class ScrapliException(Exception):
+    """Base Exception for all scrapli exceptions"""
+
+
+class LibScrapliException(ScrapliException):
+    """Exception raised when encountering errors loading libscrapli shared library"""
+
+
+class OptionsException(ScrapliException):
+    """Exception raised when encountering errors applying options"""
+
+
+class AllocationException(ScrapliException):
+    """Exception raised when encountering errors allocating a cli/netconf object"""
+
+
+class OpenException(ScrapliException):
+    """Exception raised when encountering errors opening a cli/netconf object"""
+
+
+class CloseException(ScrapliException):
+    """Exception raised when encountering errors closing a cli/netconf object"""
+
+
+class GetResultException(ScrapliException):
+    """Exception raised when encountering errors polling/fetching an operation result"""
+
+
+class SubmitOperationException(ScrapliException):
+    """Exception raised when encountering errors submitting an operation result"""
+
+
+class NotOpenedException(ScrapliException):
+    """Exception raised when attempting to call methods of cli/netconf object and ptr is None"""
+
+
+class OperationException(ScrapliException):
+    """Exception raised when an error is returned from an operation"""
+
+
+class ParsingException(ScrapliException):
+    """Exception raised when parsing (usually cli) output fails"""
+
+
+class NoMessagesException(ScrapliException):
+    """Exception raised when attempting to request notifications or subscriptions and none exist"""

scrapli/ffi.py

@@ -0,0 +1,76 @@
+"""scrapli.ffi"""
+
+import importlib.resources
+import os
+import sys
+from logging import getLogger
+from pathlib import Path
+
+from scrapli.exceptions import LibScrapliException
+
+logger = getLogger(__name__)
+
+LIBSCRAPLI_VERSION = "0.0.1-alpha.10"
+LIBSCRAPLI_PATH_OVERRIDE_ENV = "LIBSCRAPLI_PATH"
+LIBSCRAPLI_CACHE_PATH_OVERRIDE_ENV = "LIBSCRAPLI_CACHE_PATH"
+XDG_CACHE_HOME_ENV = "XDG_CACHE_HOME"
+
+
+def get_libscrapli_shared_object_filename(version: str = LIBSCRAPLI_VERSION) -> str:
+    """
+    Returns the name of the libscrapli shared object for the given version/platform.
+
+    Args:
+        version: the libscrapli version
+
+    Returns:
+        str: filename of the shared object
+
+    Raises:
+        LibScrapliException: if unsupported platform
+
+    """
+    if sys.platform == "linux":
+        lib_filename = f"libscrapli.so.{version}"
+    elif sys.platform == "darwin":
+        lib_filename = f"libscrapli.{version}.dylib"
+    else:
+        raise LibScrapliException("unsupported platform")
+
+    return lib_filename
+
+
+def get_libscrapli_path() -> str:
+    """
+    Returns the file path to the libscrapli shared library.
+
+    Attempts to load from override paths or from installed path in scrapli itself -- this would be
+    either the shared object(s) from source (i.e. cloning the repo) or from the installation either
+    via a wheel or sdist.
+
+    Args:
+        N/A
+
+    Returns:
+        str: libscrapli shared library path
+
+    Raises:
+        LibScrapliException: if libscrapli is not found at override path or default installation
+            path
+
+    """
+    override_path = os.environ.get(LIBSCRAPLI_PATH_OVERRIDE_ENV)
+    if override_path is not None:
+        logger.debug("using libscrapli path override '%s'", override_path)
+
+        return override_path
+
+    source_lib_dir = importlib.resources.files("scrapli.lib")
+    source_lib_filename = f"{source_lib_dir}/{get_libscrapli_shared_object_filename()}"
+
+    logger.debug("loading libscrapli from scrapli installation '%s'", source_lib_filename)
+
+    if Path(source_lib_filename).exists():
+        return source_lib_filename
+
+    raise LibScrapliException("libscrapli not available")

scrapli/ffi_mapping.py

@@ -0,0 +1,202 @@
+"""scrapli.ffi_mapping"""
+
+from collections.abc import Callable
+from ctypes import (
+    CDLL,
+    c_bool,
+    c_char_p,
+    c_int,
+    c_uint8,
+    c_uint32,
+)
+
+from scrapli.ffi import get_libscrapli_path
+from scrapli.ffi_mapping_cli import LibScrapliCliMapping
+from scrapli.ffi_mapping_netconf import LibScrapliNetconfMapping
+from scrapli.ffi_mapping_options import LibScrapliOptionsMapping
+from scrapli.ffi_types import (
+    DriverPointer,
+    IntPointer,
+    StringPointer,
+)
+
+
+class LibScrapliSharedMapping:
+    """
+    Mapping to libscrapli shared (between cli/netconf) object functions mapping.
+
+    Should not be used/called directly.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    def __init__(self, lib: CDLL) -> None:
+        self._get_poll_fd: Callable[
+            [
+                DriverPointer,
+            ],
+            c_uint32,
+        ] = lib.ls_shared_get_poll_fd
+        lib.ls_shared_get_poll_fd.argtypes = [
+            DriverPointer,
+        ]
+        lib.ls_cli_alloc.restype = c_uint32
+
+        self._free: Callable[
+            [
+                DriverPointer,
+            ],
+            int,
+        ] = lib.ls_shared_free
+        lib.ls_shared_free.argtypes = [
+            DriverPointer,
+        ]
+        lib.ls_shared_free.restype = None
+
+        self._read: Callable[
+            [
+                DriverPointer,
+                StringPointer,
+                IntPointer,
+            ],
+            int,
+        ] = lib.ls_shared_read_session
+        lib.ls_shared_read_session.argtypes = [
+            DriverPointer,
+            StringPointer,
+            IntPointer,
+        ]
+        lib.ls_shared_read_session.restype = c_int
+
+        self._write: Callable[
+            [
+                DriverPointer,
+                c_char_p,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_shared_write_session
+        lib.ls_shared_write_session.argtypes = [
+            DriverPointer,
+            c_char_p,
+            c_bool,
+        ]
+        lib.ls_shared_write_session.restype = c_uint8
+
+    def get_poll_fd(self, ptr: DriverPointer) -> c_uint32:
+        """
+        Get the operation poll fd from the driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+
+        Returns:
+            c_uint32: the poll fd for the driver.
+
+        Raises:
+            N/A
+
+        """
+        return self._get_poll_fd(ptr)
+
+    def free(self, ptr: DriverPointer) -> int:
+        """
+        Free the driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+
+        Returns:
+            c_uint8: return code, non-zero value indicates an error.
+
+        Raises:
+            N/A
+
+        """
+        return self._free(ptr)
+
+    def read(self, ptr: DriverPointer, buf: StringPointer, read_size: IntPointer) -> int:
+        """
+        Read from the session of driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+            buf: buffer to fill during the read operation.
+            read_size: c_int pointer that is filled with number of bytes written into buf.
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._read(ptr, buf, read_size)
+
+    def write(self, ptr: DriverPointer, buf: c_char_p, redacted: c_bool) -> int:
+        """
+        Write to the session of driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+            buf: buffer contents to write during the write operation..
+            redacted: bool indicated if the write contents should be redacted from logs.
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._write(ptr, buf, redacted)
+
+
+class LibScrapliMapping:
+    """
+    Single mapping to libscrapli shared library exported functions.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    _instance = None
+
+    def __new__(cls) -> "LibScrapliMapping":
+        """Returns the singleton instance of the ffi mapping"""
+        if not cls._instance:
+            cls._instance = super().__new__(cls)
+
+        return cls._instance
+
+    def __init__(self) -> None:
+        self.lib = CDLL(get_libscrapli_path())
+        self.shared_mapping = LibScrapliSharedMapping(self.lib)
+        self.cli_mapping = LibScrapliCliMapping(self.lib)
+        self.netconf_mapping = LibScrapliNetconfMapping(self.lib)
+        self.options_mapping = LibScrapliOptionsMapping(self.lib)