cloudshell-cli 4.0.6__zip → 4.1.2__zip

{cloudshell-cli-4.0.6/cloudshell_cli.egg-info → cloudshell-cli-4.1.2}/PKG-INFO

@@ -1,14 +1,11 @@
 Metadata-Version: 2.1
 Name: cloudshell-cli
-Version: 4.0.6
+Version: 4.1.2
 Summary: QualiSystems CloudShell CLI support package
 Home-page: http://www.qualisystems.com/
 Author: QualiSystems
 Author-email: info@qualisystems.com
-License: UNKNOWN
-Platform: UNKNOWN
 Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, <4
 License-File: LICENSE
 
-UNKNOWN
-
+QualiSystems CloudShell CLI support package

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/configurator.py

@@ -2,7 +2,13 @@
 # -*- coding: utf-8 -*-
 import sys
 from abc import ABCMeta, abstractmethod
+from collections import defaultdict
 
+from cloudshell.cli.factory.session_factory import (
+    CloudInfoAccessKeySessionFactory,
+    GenericSessionFactory,
+    SessionFactory,
+)
 from cloudshell.cli.service.cli import CLI
 from cloudshell.cli.session.ssh_session import SSHSession
 from cloudshell.cli.session.telnet_session import TelnetSession
@@ -16,39 +22,33 @@ else:
 
 
 class CLIServiceConfigurator(object):
-    REGISTERED_SESSIONS = (SSHSession, TelnetSession)
-
-    def __init__(self, resource_config, logger, cli=None, registered_sessions=None):
+    REGISTERED_SESSIONS = (CloudInfoAccessKeySessionFactory(SSHSession), TelnetSession)
+    """Using factories instead of """
+
+    def __init__(
+        self,
+        resource_config,
+        logger,
+        cli=None,
+        registered_sessions=None,
+        access_key=None,
+        access_key_passphrase=None,
+    ):
         """Initialize CLI service configurator.
 
         :param cloudshell.shell.standards.resource_config_generic_models.GenericCLIConfig resource_config:  # noqa: E501
         :param logging.Logger logger:
         :param cloudshell.cli.service.cli.CLI cli:
         :param registered_sessions: Session types and order
+        :param access_key: access key for the resource
+        :param access_key_passphrase: access key passphrase for the resource
         """
         self._cli = cli or CLI()
         self._resource_config = resource_config
         self._logger = logger
         self._registered_sessions = registered_sessions or self.REGISTERED_SESSIONS
-
-    @property
-    def _username(self):
-        return self._resource_config.user
-
-    @property
-    @lru_cache()
-    def _password(self):
-        return self._resource_config.password
-
-    @property
-    def _resource_address(self):
-        """Resource IP."""
-        return self._resource_config.address
-
-    @property
-    def _port(self):
-        """Connection port property, to open socket on."""
-        return self._resource_config.cli_tcp_port
+        self._access_key = access_key
+        self._access_key_passphrase = access_key_passphrase
 
     @property
     def _cli_type(self):
@@ -58,29 +58,28 @@ class CLIServiceConfigurator(object):
     @property
     @lru_cache()
     def _session_dict(self):
-        return {sess.SESSION_TYPE.lower(): [sess] for sess in self._registered_sessions}
+        session_dict = defaultdict(list)
+        for sess in self._registered_sessions:
+            session_dict[sess.SESSION_TYPE.lower()].append(sess)
+        return session_dict
 
     def _on_session_start(self, session, logger):
-        """Perform some default commands when session just opened.
-
-        Like 'no logging console'
-        """
         pass
 
-    @property
-    @lru_cache()
-    def _session_kwargs(self):
-        return {
-            "host": self._resource_address,
-            "username": self._username,
-            "password": self._password,
-            "port": self._port,
-            "on_session_start": self._on_session_start,
-        }
+    def initialize_session(self, session):
+        if not isinstance(session, SessionFactory):
+            session = GenericSessionFactory(session)
+        return session.init_session(
+            self._resource_config,
+            self._logger,
+            on_session_start=self._on_session_start,
+            access_key=self._access_key,
+            access_key_passphrase=self._access_key_passphrase,
+        )
 
     def _defined_sessions(self):
         return [
-            sess(**self._session_kwargs)
+            self.initialize_session(sess)
             for sess in self._session_dict.get(
                 self._cli_type.lower(), self._registered_sessions
             )

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/examples/cli_demo/connect_to_switch/SwitchClihandler.py

@@ -96,7 +96,6 @@ class SwitchCliHandler(CliHandlerImpl):
         session.hardware_expect("exit", EnableCommandMode.PROMPT, logger)
 
     def enter_enable_mode(self, session, logger):
-
         enable_password = get_attribute_by_name(
             attribute_name="Enable Password", context=self._context
         )

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/examples/cli_demo/connect_to_ubuntu/runnur.py

@@ -13,7 +13,6 @@ class CliCommandMode(CommandMode):
     EXIT_COMMAND = "exit"
 
     def __init__(self, context):
-
         CommandMode.__init__(
             self,
             CliCommandMode.PROMPT,

cloudshell-cli-4.1.2/cloudshell/cli/factory/session_factory.py

@@ -0,0 +1,96 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+from abc import ABCMeta, abstractmethod
+
+ABC = ABCMeta("ABC", (object,), {"__slots__": ()})
+
+
+class SessionFactory(ABC):
+    """Session factory.
+
+    Help to initialize session for specified session class.
+    """
+
+    def __init__(self, session_class):
+        """:param session_class: Session class."""
+        self.session_class = session_class
+
+    @abstractmethod
+    def init_session(
+        self,
+        resource_config,
+        logger,
+        on_session_start=None,
+        access_key=None,
+        access_key_passphrase=None,
+    ):
+        """Initialize session instance.
+
+        Encapsulate the logic of the session instance creation.
+        :param resource_config:
+        :param logging.Logger logger:
+        :param on_session_start: function that will be called on session start
+        :param access_key: access key for the resource
+        :param access_key_passphrase: access key passphrase for the resource
+        """
+        raise NotImplementedError
+
+
+class GenericSessionFactory(SessionFactory):
+    def init_session(
+        self,
+        resource_config,
+        logger,
+        on_session_start=None,
+        access_key=None,
+        access_key_passphrase=None,
+    ):
+        return self.session_class(
+            **self._session_kwargs(
+                resource_config,
+                logger,
+                on_session_start,
+                access_key,
+                access_key_passphrase,
+            )
+        )
+
+    @property
+    def SESSION_TYPE(self):
+        return self.session_class.SESSION_TYPE
+
+    def _session_kwargs(
+        self,
+        resource_config,
+        logger,
+        on_session_start,
+        access_key,
+        access_key_passphrase,
+    ):
+        return {
+            "host": resource_config.address,
+            "username": resource_config.user,
+            "password": resource_config.password,
+            "port": resource_config.cli_tcp_port,
+            "on_session_start": on_session_start,
+        }
+
+
+class CloudInfoAccessKeySessionFactory(GenericSessionFactory):
+    def _session_kwargs(
+        self,
+        resource_config,
+        logger,
+        on_session_start,
+        access_key,
+        access_key_passphrase,
+    ):
+        return {
+            "host": resource_config.address,
+            "username": resource_config.user,
+            "password": resource_config.password,
+            "port": resource_config.cli_tcp_port,
+            "pkey": access_key,
+            "pkey_passphrase": access_key_passphrase,
+            "on_session_start": on_session_start,
+        }

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/service/command_mode_helper.py

@@ -35,7 +35,7 @@ class CommandModeHelper(NodeOperations):
 
         :rtype: OrderedDict
         """
-        # noqa
+
         def _get_child_nodes(command_node):
             return reduce(
                 lambda x, y: x + _get_child_nodes(y),
@@ -60,7 +60,7 @@ class CommandModeHelper(NodeOperations):
 
         :rtype: dict
         """
-        # noqa
+
         def _create_child_modes(instance, child_dict):
             instance_dict = {}
             for mode_type in child_dict:

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/session/expect_session.py

@@ -308,7 +308,6 @@ class ExpectSession(Session, ABC):
             self._loop_detector_max_combination_length,
         )
         while retries == 0 or retries_count < retries:
-
             read_buffer = self._receive_all(timeout, logger)
 
             if read_buffer:

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/session/scpi_session.py

@@ -38,7 +38,6 @@ class SCPISession(TCPSession):
         remove_command_from_output=True,
         **optional_args
     ):
-
         if ";:system:error?" not in command.lower():
             command += ";:system:error?"
 

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/session/ssh_session.py

@@ -1,3 +1,5 @@
+from io import StringIO
+
 import paramiko
 from scp import SCPClient
 
@@ -22,6 +24,7 @@ class SSHSession(ExpectSession, ConnectionParams):
         port=None,
         on_session_start=None,
         pkey=None,
+        pkey_passphrase=None,
         *args,
         **kwargs
     ):
@@ -36,6 +39,7 @@ class SSHSession(ExpectSession, ConnectionParams):
         self.username = username
         self.password = password
         self.pkey = pkey
+        self.pkey_passphrase = pkey_passphrase
 
         self._handler = None
         self._current_channel = None
@@ -52,6 +56,7 @@ class SSHSession(ExpectSession, ConnectionParams):
                 self.username == other.username,
                 self.password == other.password,
                 self.pkey == other.pkey,
+                self.pkey_passphrase == other.pkey_passphrase,
             ]
         )
 
@@ -80,7 +85,7 @@ class SSHSession(ExpectSession, ConnectionParams):
                 banner_timeout=30,
                 allow_agent=False,
                 look_for_keys=False,
-                pkey=self.pkey,
+                pkey=self._get_pkey_object(self.pkey, self.pkey_passphrase, logger),
             )
         except Exception as e:
             logger.exception("Failed to initialize session:")
@@ -161,3 +166,18 @@ class SSHSession(ExpectSession, ConnectionParams):
         sftp.putfo(file_stream, dest_pathname)
         sftp.chmod(dest_pathname, int(dest_permissions, base=8))
         sftp.close()
+
+    @staticmethod
+    def _get_pkey_object(key_material, passphrase, logger):
+        """Try to detect private key type and return paramiko.PKey object."""
+        if not key_material:
+            return None
+
+        for cls in [paramiko.RSAKey, paramiko.DSSKey, paramiko.ECDSAKey]:
+            try:
+                key = cls.from_private_key(StringIO(key_material), password=passphrase)
+            except paramiko.ssh_exception.SSHException as e:
+                # Invalid key, try other key type
+                logger.warning(e)
+            else:
+                return key

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/session/tcp_session.py

@@ -5,7 +5,6 @@ from cloudshell.cli.session.expect_session import ExpectSession
 
 
 class TCPSession(ExpectSession, ConnectionParams):
-
     SESSION_TYPE = "TCP"
     BUFFER_SIZE = 1024
 

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell/cli/session/telnet_session.py

@@ -99,4 +99,4 @@ class TelnetSession(ExpectSession, ConnectionParams):
         self._handler.get_socket().settimeout(timeout)
 
     def _read_byte_data(self):
-        self._handler.read_some()
+        return self._handler.read_some()

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2/cloudshell_cli.egg-info}/PKG-INFO

@@ -1,14 +1,11 @@
 Metadata-Version: 2.1
 Name: cloudshell-cli
-Version: 4.0.6
+Version: 4.1.2
 Summary: QualiSystems CloudShell CLI support package
 Home-page: http://www.qualisystems.com/
 Author: QualiSystems
 Author-email: info@qualisystems.com
-License: UNKNOWN
-Platform: UNKNOWN
 Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, <4
 License-File: LICENSE
 
-UNKNOWN
-
+QualiSystems CloudShell CLI support package

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/cloudshell_cli.egg-info/SOURCES.txt

@@ -26,6 +26,8 @@ cloudshell/cli/examples/cli_demo/connect_to_switch/runner.py
 cloudshell/cli/examples/cli_demo/connect_to_ubuntu/__init__.py
 cloudshell/cli/examples/cli_demo/connect_to_ubuntu/readfrom.txt
 cloudshell/cli/examples/cli_demo/connect_to_ubuntu/runnur.py
+cloudshell/cli/factory/__init__.py
+cloudshell/cli/factory/session_factory.py
 cloudshell/cli/service/__init__.py
 cloudshell/cli/service/cli.py
 cloudshell/cli/service/cli_exception.py

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/setup.py

@@ -26,5 +26,6 @@ setup(
     version=version_from_file,
     package_data={"": ["*.txt"]},
     description="QualiSystems CloudShell CLI support package",
+    long_description="QualiSystems CloudShell CLI support package",
     include_package_data=True,
 )

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/tests/cli/session/test_ssh_session.py

@@ -443,9 +443,6 @@ class TestSshSession(TestCase):
             )
         )
 
-        pkey = paramiko.RSAKey.from_private_key(
-            StringIO(KEY_WITH_PASSPHRASE), password=KEY_PASSPHRASE
-        )
         self.assertFalse(
             self._instance.__eq__(
                 SSHSession(
@@ -454,23 +451,22 @@ class TestSshSession(TestCase):
                     "",
                     port=self._port,
                     on_session_start=self._on_session_start,
-                    pkey=pkey,
+                    pkey=KEY_WITH_PASSPHRASE,
+                    pkey_passphrase=KEY_PASSPHRASE,
                 )
             )
         )
 
     @patch("cloudshell.cli.session.ssh_session.ExpectSession")
     def test_eq_rsa(self, expect_session):
-        pkey = paramiko.RSAKey.from_private_key(
-            StringIO(KEY_WITH_PASSPHRASE), password=KEY_PASSPHRASE
-        )
         self._instance = SSHSession(
             self._hostname,
             self._username,
             self._password,
             port=self._port,
             on_session_start=self._on_session_start,
-            pkey=pkey,
+            pkey=KEY_WITH_PASSPHRASE,
+            pkey_passphrase=KEY_PASSPHRASE,
         )
 
         self.assertTrue(
@@ -481,7 +477,8 @@ class TestSshSession(TestCase):
                     self._password,
                     port=self._port,
                     on_session_start=self._on_session_start,
-                    pkey=pkey,
+                    pkey=KEY_WITH_PASSPHRASE,
+                    pkey_passphrase=KEY_PASSPHRASE,
                 )
             )
         )
@@ -640,16 +637,13 @@ class TestSshSession(TestCase):
             "",
             port=server.port,
             on_session_start=self._on_session_start,
-            pkey=pkey,
+            pkey=KEY_WITH_PASSPHRASE,
+            pkey_passphrase=KEY_PASSPHRASE,
         )
         self._instance.connect(">", logger=Mock())
         self._instance.hardware_expect("dummy command", ">", Mock())
 
     def test_rsa_failure(self):
-        pkey = paramiko.RSAKey.from_private_key(
-            StringIO(KEY_WITH_PASSPHRASE), password=KEY_PASSPHRASE
-        )
-
         server = SSHServer(user2key={})
 
         with self.assertRaises(SSHSessionException):
@@ -659,7 +653,8 @@ class TestSshSession(TestCase):
                 "",
                 port=server.port,
                 on_session_start=self._on_session_start,
-                pkey=pkey,
+                pkey=KEY_WITH_PASSPHRASE,
+                pkey_passphrase=KEY_PASSPHRASE,
             )
             self._instance.connect(">", logger=Mock())
             self._instance.hardware_expect("dummy command", ">", Mock())

{cloudshell-cli-4.0.6 → cloudshell-cli-4.1.2}/tox.ini

@@ -19,7 +19,7 @@ commands =
     pytest --cov=cloudshell.cli tests --cov-report=xml
 
 [testenv:pre-commit]
-basepython = python3
+basepython = python3.9
 skip_install = true
 deps = pre-commit
 commands = pre-commit run --all-files --show-diff-on-failure

cloudshell-cli-4.1.2/version.txt

@@ -0,0 +1 @@
+4.1.2

cloudshell-cli-4.0.6/version.txt

@@ -1 +0,0 @@
-4.0.6