xbot.plugins.ssh 0.1.0__tar.gz

xbot.plugins.ssh-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2022-2023, zhaowcheng <zhaowcheng@163.com>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xbot.plugins.ssh-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include requirements.txt
+include README*

xbot.plugins.ssh-0.1.0/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.1
+Name: xbot.plugins.ssh
+Version: 0.1.0
+Summary: SSH library for xbot.framework
+Home-page: https://github.com/zhaowcheng/xbot.plugins.ssh
+Author: zhaowcheng
+Author-email: zhaowcheng@163.com
+License: UNKNOWN
+Project-URL: Homepage, https://github.com/zhaowcheng/xbot.plugins.ssh
+Project-URL: Issues, https://github.com/zhaowcheng/xbot.plugins.ssh/issues
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+## Introduction
+
+`xbot.plugins.ssh` provides ssh and sftp support for [xbot.framework](https://github.com/zhaowcheng/xbot.framework)
+
+## Installation
+
+Install via pip:
+
+```
+pip install xbot.plugins.ssh
+```
+
+## Getting Started
+
+```python
+import os
+import shutil
+
+from xbot.plugins.ssh.ssh import SSHConnection
+from xbot.plugins.ssh.sftp import SFTPConnection
+
+# Modify the following information to your own before trying to run.
+host = '192.168.8.8'
+user = 'xbot'
+pwd = 'xbot'
+
+# Create ssh connection.
+sshconn = SSHConnection()
+sshconn.connect(host, user, pwd)
+
+# Expect the return code of command is 0.
+sshconn.exec('ls -l', expect=0)
+
+# Expect the return code of command is 2.
+sshconn.exec('ls /errpath', expect=2)
+
+# Expect the output of command contains `username`.
+sshconn.exec('whoami', expect=user)
+
+# Don't check the result of command.
+sshconn.exec('ls -l', expect=None)
+sshconn.exec('ls /errpath', expect=None)
+
+# Execute command with sudo.
+sshconn.sudo('whoami', expect='root')
+
+# Interactive command.
+sshconn.exec("read -p 'input: '", prompts={'input:': 'hello'})
+
+# Attributes and methods of SSHCommandResult.
+cmd = 'echo -e "jack 20\ntom 30"'
+result = sshconn.exec(cmd)
+assert str(result) == 'jack 20\ntom 30'
+assert result.rc == 0
+assert result.cmd == cmd
+assert result.getfield('tom', 2) == '30'
+assert result.getcol(2) == ['20', '30']
+
+# Create sftp connection.
+sftpconn = SFTPConnection()
+sftpconn.connect(host, user, pwd)
+
+# Preparing for sftp testing.
+lhome = os.environ.get('HOME') or os.environ['HOMEPATH']
+lputdir = os.path.join(lhome, 'lputdir')
+lgetdir = os.path.join(lhome, 'lgetdir')
+rputdir = '/tmp/rputgetdir'
+rgetdir = rputdir
+if os.path.exists(lputdir):
+    shutil.rmtree(lputdir)
+if sftpconn.exists(rputdir):
+    sshconn.exec(f'rm -rf {rputdir}')
+sftpconn.makedirs(rputdir)
+os.makedirs(os.path.join(lputdir, 'dir', 'subdir'))
+os.system('whoami > %s' % os.path.join(lputdir, 'file'))
+os.system('whoami > %s' % os.path.join(lputdir, 'dir', 'subfile'))
+
+# Put directory.
+l = os.path.join(lputdir, 'dir')
+sftpconn.putdir(l, rputdir)
+p1 = sftpconn.join(rputdir, 'dir', 'subdir')
+assert sftpconn.exists(p1) == True
+p2 = sftpconn.join(rputdir, 'dir', 'subfile')
+assert sftpconn.exists(p2) == True
+
+# Put file.
+l = os.path.join(lputdir, 'file')
+sftpconn.putfile(l, rputdir)
+p1 = sftpconn.join(rputdir, 'file')
+assert sftpconn.exists(p1) == True
+sftpconn.putfile(l, rputdir, 'newfile')  # rename
+p2 = sftpconn.join(rputdir, 'newfile')
+assert sftpconn.exists(p2) == True
+
+# Get directory.
+r = sftpconn.join(rgetdir, 'dir')
+sftpconn.getdir(r, lgetdir)
+p1 = os.path.join(lgetdir, 'dir', 'subdir')
+assert os.path.exists(p1) == True
+p2 = os.path.join(lgetdir, 'dir', 'subfile')
+assert os.path.exists(p2) == True
+
+# Get file.
+r = sftpconn.join(rgetdir, 'file')
+sftpconn.getfile(r, lgetdir)
+p1 = os.path.join(lgetdir, 'file')
+assert os.path.exists(p1) == True
+sftpconn.getfile(r, lgetdir, 'newfile')  # rename
+p2 = os.path.join(lgetdir, 'newfile')
+assert os.path.exists(p2) == True
+
+# Open file.
+p = sftpconn.join(rputdir, 'file')
+with sftpconn.open(p, 'w') as fp:
+    fp.write('xbot')
+with sftpconn.open(p, 'r') as fp:
+    assert fp.read().decode('utf-8') == 'xbot'
+```
+
+## Demo Project
+
+Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo) project showing how to use `xbot.plugins.ssh` in a test project.
+
+***
+
+## 简介
+
+`xbot.plugins.ssh` 是为 [xbot.framework](https://github.com/zhaowcheng/xbot.framework) 提供 ssh 和 sftp 支持的插件。
+
+## 安装
+
+使用 pip 安装:
+
+```
+pip install xbot.plugins.ssh
+```
+
+## 入门
+
+```python
+import os
+import shutil
+
+from xbot.plugins.ssh.ssh import SSHConnection
+from xbot.plugins.ssh.sftp import SFTPConnection
+
+# Modify the following information to your own before trying to run.
+host = '192.168.8.8'
+user = 'xbot'
+pwd = 'xbot'
+
+# Create ssh connection.
+sshconn = SSHConnection()
+sshconn.connect(host, user, pwd)
+
+# Expect the return code of command is 0.
+sshconn.exec('ls -l', expect=0)
+
+# Expect the return code of command is 2.
+sshconn.exec('ls /errpath', expect=2)
+
+# Expect the output of command contains `username`.
+sshconn.exec('whoami', expect=user)
+
+# Don't check the result of command.
+sshconn.exec('ls -l', expect=None)
+sshconn.exec('ls /errpath', expect=None)
+
+# Execute command with sudo.
+sshconn.sudo('whoami', expect='root')
+
+# Interactive command.
+sshconn.exec("read -p 'input: '", prompts={'input:': 'hello'})
+
+# Attributes and methods of SSHCommandResult.
+cmd = 'echo -e "jack 20\ntom 30"'
+result = sshconn.exec(cmd)
+assert str(result) == 'jack 20\ntom 30'
+assert result.rc == 0
+assert result.cmd == cmd
+assert result.getfield('tom', 2) == '30'
+assert result.getcol(2) == ['20', '30']
+
+# Create sftp connection.
+sftpconn = SFTPConnection()
+sftpconn.connect(host, user, pwd)
+
+# Preparing for sftp testing.
+lhome = os.environ.get('HOME') or os.environ['HOMEPATH']
+lputdir = os.path.join(lhome, 'lputdir')
+lgetdir = os.path.join(lhome, 'lgetdir')
+rputdir = '/tmp/rputgetdir'
+rgetdir = rputdir
+if os.path.exists(lputdir):
+    shutil.rmtree(lputdir)
+if sftpconn.exists(rputdir):
+    sshconn.exec(f'rm -rf {rputdir}')
+sftpconn.makedirs(rputdir)
+os.makedirs(os.path.join(lputdir, 'dir', 'subdir'))
+os.system('whoami > %s' % os.path.join(lputdir, 'file'))
+os.system('whoami > %s' % os.path.join(lputdir, 'dir', 'subfile'))
+
+# Put directory.
+l = os.path.join(lputdir, 'dir')
+sftpconn.putdir(l, rputdir)
+p1 = sftpconn.join(rputdir, 'dir', 'subdir')
+assert sftpconn.exists(p1) == True
+p2 = sftpconn.join(rputdir, 'dir', 'subfile')
+assert sftpconn.exists(p2) == True
+
+# Put file.
+l = os.path.join(lputdir, 'file')
+sftpconn.putfile(l, rputdir)
+p1 = sftpconn.join(rputdir, 'file')
+assert sftpconn.exists(p1) == True
+sftpconn.putfile(l, rputdir, 'newfile')  # rename
+p2 = sftpconn.join(rputdir, 'newfile')
+assert sftpconn.exists(p2) == True
+
+# Get directory.
+r = sftpconn.join(rgetdir, 'dir')
+sftpconn.getdir(r, lgetdir)
+p1 = os.path.join(lgetdir, 'dir', 'subdir')
+assert os.path.exists(p1) == True
+p2 = os.path.join(lgetdir, 'dir', 'subfile')
+assert os.path.exists(p2) == True
+
+# Get file.
+r = sftpconn.join(rgetdir, 'file')
+sftpconn.getfile(r, lgetdir)
+p1 = os.path.join(lgetdir, 'file')
+assert os.path.exists(p1) == True
+sftpconn.getfile(r, lgetdir, 'newfile')  # rename
+p2 = os.path.join(lgetdir, 'newfile')
+assert os.path.exists(p2) == True
+
+# Open file.
+p = sftpconn.join(rputdir, 'file')
+with sftpconn.open(p, 'w') as fp:
+    fp.write('xbot')
+with sftpconn.open(p, 'r') as fp:
+    assert fp.read().decode('utf-8') == 'xbot'
+```
+
+## 示例项目
+
+展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/v0.1.0/demo)
+
+

xbot.plugins.ssh-0.1.0/README.md

@@ -0,0 +1,128 @@
+<p align="center">
+  <br>English | <a href="README.zh.md">中文</a>
+</p>
+
+***
+
+## Introduction
+
+`xbot.plugins.ssh` provides ssh and sftp support for [xbot.framework](https://github.com/zhaowcheng/xbot.framework)
+
+## Installation
+
+Install via pip:
+
+```
+pip install xbot.plugins.ssh
+```
+
+## Getting Started
+
+```python
+import os
+import shutil
+
+from xbot.plugins.ssh.ssh import SSHConnection
+from xbot.plugins.ssh.sftp import SFTPConnection
+
+# Modify the following information to your own before trying to run.
+host = '192.168.8.8'
+user = 'xbot'
+pwd = 'xbot'
+
+# Create ssh connection.
+sshconn = SSHConnection()
+sshconn.connect(host, user, pwd)
+
+# Expect the return code of command is 0.
+sshconn.exec('ls -l', expect=0)
+
+# Expect the return code of command is 2.
+sshconn.exec('ls /errpath', expect=2)
+
+# Expect the output of command contains `username`.
+sshconn.exec('whoami', expect=user)
+
+# Don't check the result of command.
+sshconn.exec('ls -l', expect=None)
+sshconn.exec('ls /errpath', expect=None)
+
+# Execute command with sudo.
+sshconn.sudo('whoami', expect='root')
+
+# Interactive command.
+sshconn.exec("read -p 'input: '", prompts={'input:': 'hello'})
+
+# Attributes and methods of SSHCommandResult.
+cmd = 'echo -e "jack 20\ntom 30"'
+result = sshconn.exec(cmd)
+assert str(result) == 'jack 20\ntom 30'
+assert result.rc == 0
+assert result.cmd == cmd
+assert result.getfield('tom', 2) == '30'
+assert result.getcol(2) == ['20', '30']
+
+# Create sftp connection.
+sftpconn = SFTPConnection()
+sftpconn.connect(host, user, pwd)
+
+# Preparing for sftp testing.
+lhome = os.environ.get('HOME') or os.environ['HOMEPATH']
+lputdir = os.path.join(lhome, 'lputdir')
+lgetdir = os.path.join(lhome, 'lgetdir')
+rputdir = '/tmp/rputgetdir'
+rgetdir = rputdir
+if os.path.exists(lputdir):
+    shutil.rmtree(lputdir)
+if sftpconn.exists(rputdir):
+    sshconn.exec(f'rm -rf {rputdir}')
+sftpconn.makedirs(rputdir)
+os.makedirs(os.path.join(lputdir, 'dir', 'subdir'))
+os.system('whoami > %s' % os.path.join(lputdir, 'file'))
+os.system('whoami > %s' % os.path.join(lputdir, 'dir', 'subfile'))
+
+# Put directory.
+l = os.path.join(lputdir, 'dir')
+sftpconn.putdir(l, rputdir)
+p1 = sftpconn.join(rputdir, 'dir', 'subdir')
+assert sftpconn.exists(p1) == True
+p2 = sftpconn.join(rputdir, 'dir', 'subfile')
+assert sftpconn.exists(p2) == True
+
+# Put file.
+l = os.path.join(lputdir, 'file')
+sftpconn.putfile(l, rputdir)
+p1 = sftpconn.join(rputdir, 'file')
+assert sftpconn.exists(p1) == True
+sftpconn.putfile(l, rputdir, 'newfile')  # rename
+p2 = sftpconn.join(rputdir, 'newfile')
+assert sftpconn.exists(p2) == True
+
+# Get directory.
+r = sftpconn.join(rgetdir, 'dir')
+sftpconn.getdir(r, lgetdir)
+p1 = os.path.join(lgetdir, 'dir', 'subdir')
+assert os.path.exists(p1) == True
+p2 = os.path.join(lgetdir, 'dir', 'subfile')
+assert os.path.exists(p2) == True
+
+# Get file.
+r = sftpconn.join(rgetdir, 'file')
+sftpconn.getfile(r, lgetdir)
+p1 = os.path.join(lgetdir, 'file')
+assert os.path.exists(p1) == True
+sftpconn.getfile(r, lgetdir, 'newfile')  # rename
+p2 = os.path.join(lgetdir, 'newfile')
+assert os.path.exists(p2) == True
+
+# Open file.
+p = sftpconn.join(rputdir, 'file')
+with sftpconn.open(p, 'w') as fp:
+    fp.write('xbot')
+with sftpconn.open(p, 'r') as fp:
+    assert fp.read().decode('utf-8') == 'xbot'
+```
+
+## Demo Project
+
+Here is a [demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/master/demo) project showing how to use `xbot.plugins.ssh` in a test project.

xbot.plugins.ssh-0.1.0/README.zh.md

@@ -0,0 +1,128 @@
+<p align="center">
+  <br>中文 | <a href="README.md">English</a>
+</p>
+
+***
+
+## 简介
+
+`xbot.plugins.ssh` 是为 [xbot.framework](https://github.com/zhaowcheng/xbot.framework) 提供 ssh 和 sftp 支持的插件。
+
+## 安装
+
+使用 pip 安装:
+
+```
+pip install xbot.plugins.ssh
+```
+
+## 入门
+
+```python
+import os
+import shutil
+
+from xbot.plugins.ssh.ssh import SSHConnection
+from xbot.plugins.ssh.sftp import SFTPConnection
+
+# Modify the following information to your own before trying to run.
+host = '192.168.8.8'
+user = 'xbot'
+pwd = 'xbot'
+
+# Create ssh connection.
+sshconn = SSHConnection()
+sshconn.connect(host, user, pwd)
+
+# Expect the return code of command is 0.
+sshconn.exec('ls -l', expect=0)
+
+# Expect the return code of command is 2.
+sshconn.exec('ls /errpath', expect=2)
+
+# Expect the output of command contains `username`.
+sshconn.exec('whoami', expect=user)
+
+# Don't check the result of command.
+sshconn.exec('ls -l', expect=None)
+sshconn.exec('ls /errpath', expect=None)
+
+# Execute command with sudo.
+sshconn.sudo('whoami', expect='root')
+
+# Interactive command.
+sshconn.exec("read -p 'input: '", prompts={'input:': 'hello'})
+
+# Attributes and methods of SSHCommandResult.
+cmd = 'echo -e "jack 20\ntom 30"'
+result = sshconn.exec(cmd)
+assert str(result) == 'jack 20\ntom 30'
+assert result.rc == 0
+assert result.cmd == cmd
+assert result.getfield('tom', 2) == '30'
+assert result.getcol(2) == ['20', '30']
+
+# Create sftp connection.
+sftpconn = SFTPConnection()
+sftpconn.connect(host, user, pwd)
+
+# Preparing for sftp testing.
+lhome = os.environ.get('HOME') or os.environ['HOMEPATH']
+lputdir = os.path.join(lhome, 'lputdir')
+lgetdir = os.path.join(lhome, 'lgetdir')
+rputdir = '/tmp/rputgetdir'
+rgetdir = rputdir
+if os.path.exists(lputdir):
+    shutil.rmtree(lputdir)
+if sftpconn.exists(rputdir):
+    sshconn.exec(f'rm -rf {rputdir}')
+sftpconn.makedirs(rputdir)
+os.makedirs(os.path.join(lputdir, 'dir', 'subdir'))
+os.system('whoami > %s' % os.path.join(lputdir, 'file'))
+os.system('whoami > %s' % os.path.join(lputdir, 'dir', 'subfile'))
+
+# Put directory.
+l = os.path.join(lputdir, 'dir')
+sftpconn.putdir(l, rputdir)
+p1 = sftpconn.join(rputdir, 'dir', 'subdir')
+assert sftpconn.exists(p1) == True
+p2 = sftpconn.join(rputdir, 'dir', 'subfile')
+assert sftpconn.exists(p2) == True
+
+# Put file.
+l = os.path.join(lputdir, 'file')
+sftpconn.putfile(l, rputdir)
+p1 = sftpconn.join(rputdir, 'file')
+assert sftpconn.exists(p1) == True
+sftpconn.putfile(l, rputdir, 'newfile')  # rename
+p2 = sftpconn.join(rputdir, 'newfile')
+assert sftpconn.exists(p2) == True
+
+# Get directory.
+r = sftpconn.join(rgetdir, 'dir')
+sftpconn.getdir(r, lgetdir)
+p1 = os.path.join(lgetdir, 'dir', 'subdir')
+assert os.path.exists(p1) == True
+p2 = os.path.join(lgetdir, 'dir', 'subfile')
+assert os.path.exists(p2) == True
+
+# Get file.
+r = sftpconn.join(rgetdir, 'file')
+sftpconn.getfile(r, lgetdir)
+p1 = os.path.join(lgetdir, 'file')
+assert os.path.exists(p1) == True
+sftpconn.getfile(r, lgetdir, 'newfile')  # rename
+p2 = os.path.join(lgetdir, 'newfile')
+assert os.path.exists(p2) == True
+
+# Open file.
+p = sftpconn.join(rputdir, 'file')
+with sftpconn.open(p, 'w') as fp:
+    fp.write('xbot')
+with sftpconn.open(p, 'r') as fp:
+    assert fp.read().decode('utf-8') == 'xbot'
+```
+
+## 示例项目
+
+展示如何在一个测试项目中使用本插件的示例：[demo](https://github.com/zhaowcheng/xbot.plugins.ssh/tree/master/demo)

xbot.plugins.ssh-0.1.0/demo/lib/testbed.py

@@ -0,0 +1,48 @@
+from typing import Union
+
+from xbot.framework import testbed
+from xbot.plugins.ssh.ssh import SSHConnection
+from xbot.plugins.ssh.sftp import SFTPConnection
+
+
+class TestBed(testbed.TestBed):
+    """
+    TestBed for ssh demo.
+    """
+    def __init__(self, filepath: str):
+        """
+        :param filepath: testbed filepath.
+        """
+        super().__init__(filepath)
+        self._conns = {
+            'ssh': {},
+            'sftp': {}
+        }
+
+    def get_conn(
+        self, 
+        typ: str,
+        role: str
+    ) -> Union[SSHConnection, SFTPConnection]:
+        """
+        Get specific connection to the specified role.
+
+        :param typ: connection type, 'ssh' or 'sftp'.
+        :param role: user role.
+        """
+        typs = ('ssh', 'sftp')
+        if typ not in typs:
+            raise ValueError(f'Invalid connection type: {typ}, should be one of {typs}.')
+        for user in self.get('host.users'):
+            if user['role'] == role:
+                if role not in self._conns[typ]:
+                    conn = SSHConnection() if typ == 'ssh' else SFTPConnection()
+                    conn.connect(self.get('host.ip'), 
+                                 user['name'], 
+                                 user['password'], 
+                                 port=self.get('host.sshport'))
+                    self._conns[typ][role] = conn
+                return self._conns[typ][role]
+        raise ValueError(f'No such user: role={role}')
+
+    

xbot.plugins.ssh-0.1.0/demo/lib/testcase.py

@@ -0,0 +1,15 @@
+from xbot.framework import testcase
+
+from .testbed import TestBed
+
+
+class TestCase(testcase.TestCase):
+    """
+    TestCase for ssh demo.
+    """
+    @property
+    def testbed(self) -> TestBed:
+        """
+        TestBed instance.
+        """
+        return self.__testbed