Paramiko远程操作Linux服务器

蔡坨坨2023-06-042024-08-10

转载请注明出处❤️

作者：测试蔡坨坨

原文链接：caituotuo.top/48d77133.html

前言

你好，我是测试蔡坨坨。

在日常工作中我们经常会跟Linux打交道，对于测试同学来说，使用Linux的场景还是比较多的，比如：搭建测试环境、查看日志信息、修改配置文件、监控服务资源等（关于Linux的更多应用可参考往期文章「学会 Linux，看完这篇就行了！」）。

本篇将介绍一个Python的第三方库Paramiko，使用Paramiko，我们可以在Python脚本中进行SSH连接Linux服务器并远程执行Linux命令。

那么，我们为何要学习Paramiko呢，它可以解决什么问题呢，又能给我们日常工作带来什么呢？

在「测试打工人如何学习」一文中说过，职场打工人学习技能和工具的很大原因是为了解决工作中遇到的某些具体问题，我们学习Paramiko当然也是为了解决某些问题。

例如要想在Linux服务器上进行测试环境的部署，传统的做法是使用SSH工具（例如：Xshell、Xftp、FinalShell、secureCRT、PuTTY等）连接远程服务器，然后手动在Linux服务器上输入一条一条的命令，最终完成测试环境的搭建。其实每次搭建环境所用的Linux命令几乎都是相同的，于是我们就可以借助Paramiko，将这些命令编写成Python脚本，进而实现自动搭建测试环境。并且还可以结合接口自动化以及UI自动化，完成部署、激活、数据初始化、自动化测试等一条龙服务，实现整个流程的自动化。

安装及使用

安装Paramiko库
1
pip install paramiko

安装完成后，可以使用以下代码进行远程操作Linux服务器

# author: 测试蔡坨坨
# datetime: 2023/5/28 17:16
# function: 远程操作Linux服务器demo

import paramiko

# 创建SSH客户端
client = paramiko.SSHClient()

# 设置自动添加主机密钥
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 连接服务器
client.connect(hostname='服务器地址', port='端口', username='用户名', password='密码')

# 执行远程命令
# 使用exec_command()方法执行远程命令，并使用stdout对象获取命令的输出、stderr对象获取命令的报错信息，可以根据需要对输出进行处理和显示
stdin, stdout, stderr = client.exec_command('你要执行的命令')

# 获取命令输出
output = stdout.read().decode('utf-8')
print(output)

# 关闭连接
client.close()

一些坑

运行时报错ModuleNotFoundError: No module named ‘_cffi_backend’

出现这个错误通常是由于缺少cffi模块导致的，cffi是Paramiko库的一个依赖项，在安装Paramiko时会附带安装。但是，当我们尝试使用pip install cffi重新安装cffi模块时，又提示我们cffi库已经存在，此时的做法可以先使用pip uninstall cffi卸载已存在的库，然后重新执行pip install cffi。
使用cd命令进行目录切换时不生效

当使用Paramiko库远程执行命令时，cd命令无法直接切换目录，这是因为cd是一个shell内置命令，无法直接通过Paramiko执行，此时可以通过在执行命令时添加额外的命令前缀来模拟cd命令的行为。

PS：shell内置命令就是有bash shell自身提供的命令，而不是文件系统中的可执行脚本文件。

可以使用type命令来确定一个命令是否是内置命令：

二者的区别在于：内置命令执行速度快，内置命令是当前shell环境的一部分，就在当前进程内执行，减少了上下文切换；外部脚本文件执行速度慢，需要磁盘I/O操作，并且fork一个新的进程运行脚本文件，导致进行之间上下文切换。

对于这种内置命令不生效的问题，我们的解决方案如下：
1
2
3
# 切换目录
command = 'cd /opt && your_command' # 在目标目录中执行其他命令
stdin, stdout, stderr = client.exec_command(command)
在上述示例中，使用了 && 运算符来在单个命令中组合 cd 命令和其他命令。&& 运算符表示只有在前一个命令成功执行后，才会执行后续的命令。因此，我们将 cd 命令和需要在目标目录中执行的其他命令连接在一起。

在实际应用中，将 ‘/opt’ 替换为想要切换到的实际目录，并将 ‘your_command’ 替换为需要在该目录中执行的实际命令，例如：cd /opt && pwd。

通过类似的方法，可以模拟其他shell内置命令的行为，但并非所有的shell内置命令都能以这种方式执行，因为某些命令可能依赖于shell的上下文环境。
使用wget命令下载文件时文件为0KB

刚开始使用wget http://XXX/file.tar.gz下载文件时发现下载下来的文件为0KB，原因是在执行wget命令时，Python脚本挂起，解决方案就是在wget命令中添加一个超时，如下：
1
wget -q -T90 http://XXX/file.tar.gz
使用tar命令解压文件时报错gzip: stdin: unexpected end of file

通常在使用wget命令下载文件压缩包后会使用tar命令对文件进行解压，但是在解压时报错。

解决方案就是在wget和tar命令之间添加等待时间，如下：
1
2
3
client.exec_command('wget -q -T90 http://XXX/file.tar.gz')
time.sleep(5) # 添加等待时间
client.exec_command('tar -zxvf file.tar.gz -C /xxx')

将Paramiko封装成工具类

为了方便在不同的项目中引用，我们可以将Paramiko封装成工具类，如下：

# author: 测试蔡坨坨
# datetime: 2023/5/25 20:45
# function: 远程连接Linux服务器工具类封装

import paramiko


class SSHUtils():
    def __init__(self):
        try:
            # 创建SSH客户端
            self.ssh = paramiko.SSHClient()
            # 允许连接不在known_hosts文件中的主机
            self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
            # 连接远程服务器
            self.ssh.connect(hostname='',
                             port=22,
                             username='',
                             password='')
        except:
            print('SSH连接异常……')

    def __del__(self):
        self.ssh.close()
        print('SSH connection closed.')

    def exe_cmd(self, cmd, info=True, error=True):
        """
        执行远程命令
        :param cmd: 要执行的命令
        :param info: 是否打印正确信息，默认为True
        :param error: 是否打印错误信息，默认为True
        :return:
        """
        print('\n' + "=============== 开始执行命令 ===============" + '\n' + str(cmd))
        stdin, stdout, stderr = self.ssh.exec_command(cmd)
        stdout = stdout.read().decode('utf-8')
        stderr = stderr.read().decode('utf-8')
        if stdout and info:
            print(stdout)
        elif stderr and error:
            print(stderr)
        print('\n' + "=============== 命令执行完成 ===============" + '\n' + str(cmd))