python3+telnetlib实现简单自动测试

1 telnetlib介绍
1.1 简介
官方介绍文档：telnetlib – Telnet 客户端 — Python 3.9.6 文档

telnetlib 模块提供一个实现Telnet协议的类 Telnet。

1.2 库常用函数及使用
1.2.1 建立连接

建立连接有两种方式：1、实例化函数的时候，将可选参数 host 和 port 传递给构造函数，在这种情况下，到服务器的连接将在构造函数返回前建立。2、使用telnetlib.Telnet类的open函数建立连接。

如以下两种方式是等同的，参数timeout表示阻塞的时间（单位为秒），默认为一直阻塞：

import telnetlib


HOST = "10.102.1.12"

#方式1

tn = telnetlib.Telnet(HOST, port=21, timeout=10)


#方式2

tn = telnetlib.Telnet()

tn.open(HOST, port=21)

1.2.2 发送命令

发送命令使用的是Telnet类的write方法，注意参数buffer是字节字符串byte string，网络数据传输都是使用的byte string，也就是字节流，在发送的字符串前面加一个b，就可以将字符串转换为字节流。

Telnet.write(buffer)

例如，发送一个“exit”命令给服务器，也就是退出telnet连接。 

tn.write(b"exit\n")

1.2.3 读取返回数据

Telnet类提供的读取返回结果的函数比较多，这里列举3个：
Telnet.read_until(expected, timeout=None) 读取直到遇到给定字节串 expected 或 timeout 秒已经过去。默认为阻塞性的读。

Telnet.read_all() 读取数据，直到遇到 EOF；连接关闭前都会保持阻塞。

Telnet.read_very_eager() 在不阻塞 I/O 的情况下读取所有的内容（eager）。

1.2.4 关闭连接

关闭telnet连接直接使用Telnet.close()函数，或者发送"exit"命令，以下两种用法是一样的。

tn = telnetlib.Telnet()

#方式1

tn.close()

#方式2

tn.write(b"exit\n")

1.3 使用示例

首先，我们先使用IPOP创建一个FTP服务，端口为21，用户名为admin，密码为admin。

然后，编写一个简单的测试用例，连接telnet服务器，然后退出。 

import getpass

import telnetlib


HOST = "10.102.1.12"

user = input("Enter your remote account: ")

password = getpass.getpass()


tn = telnetlib.Telnet(HOST, port=21, timeout=10)


tn.write(user.encode('ascii') + b"\n")

if password:

tn.write(password.encode('ascii') + b"\n")


print(tn.read_very_eager().decode('ascii'))


tn.write(b"exit\n")


print ("exit")

 直接执行，结果如下，可以看出，连接了一次telnet服务器，然后退出了：

2 自动测试
参考代码：Python3+telnetlib实现telnet客户端 - 诸子流 - 博客园 (cnblogs.com)

先简单说明代码实现的功能，首先先运行一个程序，这个程序会创建一个telnet服务；然后使用python编写一个telnet客户端，连接telnet服务，并输入命令，获取命令返回结果，根据结果来判断命令是否执行正确。

命令及期望结果：命令和期望的结果存放在excel中，期望结果用来从命令的返回数据中进行字符串查找的，如果找到了，表示命令执行成功，否则认为执行失败。格式如下：

执行失败结果保存：如果命令执行失败，则将命令和得到的返回数据存放到一个单独的文件中。

下面说明代码目录结构：

1078885-20210817232240481-1025625638

C_parse_excel.py类用于解析excel，获取命令及返回结果：


# -*- coding: utf-8 -*-


import os

import sys

import re

import xlrd

import logging


logging.basicConfig(level=logging.NOTSET, format='[%(filename)s:%(lineno)d]-%(levelname)s %(message)s')



class CCsrConfig(object):


def __init__(self, excelName):

self._registerDict = {}

self._excelName = excelName


def OpenExcel(self):

if self._excelName == "":

self._excelName = None

else:

self._excelfd = xlrd.open_workbook(self._excelName)

for sheetName in self._excelfd.sheet_names():

pass


def ReadCSRCfg(self):

return_dict = {} #{sheetName: [cmdlist]}

for sheetName in self._excelfd.sheet_names():

tmp_list = []

sheet = self._excelfd.sheet_by_name(sheetName)

if None != sheet:

if sheet.nrows == 0: # no content

continue

sheetName = str(sheetName.strip()).lower()

logging.debug(sheetName)

row_start = 0

for row in range(sheet.nrows):

if sheet.cell(row, 0).value.strip() == u"command":

row_start = row + 1

break

for row in range(row_start, sheet.nrows, 1):

cmd = str(sheet.cell(row, 0).value).strip()

exp_ret = str(sheet.cell(row, 1).value).strip()

tmp_list.append([cmd, exp_ret])

return_dict[sheetName.lower()] = tmp_list

return return_dict

C_telnet.py类实现telnet连接，以及发送命令和获取结果，并解析结果信息：

# -*- coding:utf-8 -*-


import logging

import telnetlib

import time


class TelnetClient():

def __init__(self,):

self.tn = telnetlib.Telnet()


# 此函数实现telnet登录主机

def login_host(self, host_ip, remote_port, username, password):

try:

self.tn.open(host_ip, port = remote_port)

except:

logging.warning('%s网络连接失败' % host_ip)

return False

# 等待login出现后输入用户名，最多等待10秒

self.tn.read_until(b'login: ', timeout=2)

self.tn.write(username.encode('ascii') + b'\n')

# 等待Password出现后输入用户名，最多等待10秒

self.tn.read_until(b'Password: ', timeout=2)

self.tn.write(password.encode('ascii') + b'\n')

# 延时两秒再收取返回结果，给服务端足够响应时间

time.sleep(2)

# 获取登录结果

command_result = self.tn.read_very_eager().decode('ascii')

if 'Login incorrect' not in command_result:

logging.debug(u'%s登录成功' % host_ip)

return True

else:

logging.warning(u'%s登录失败，用户名或密码错误' % host_ip)

return False


def start_test_cmd(self, cmd_dict):

for sheet_item in cmd_dict:

for sheet in sheet_item:

cmd_list = sheet_item[sheet]

tmp_err_list = []

for cmd in cmd_list:

cmd_in = cmd[0]

exp_ret = cmd[1]

self.tn.write(cmd_in.encode('ascii')+b'\n')

time.sleep(1)

# 获取命令结果

command_result = self.tn.read_very_eager().decode('ascii')

if command_result.find(exp_ret) == -1:

tmp_err_list.append([cmd_in, command_result])

else:

print('%s' % command_result)


if len(tmp_err_list) != 0: # 将错误信息记录到文件中

with open("./out_file/%s_err_log.txt" % sheet, "w+", newline="") as f:

for err_item in tmp_err_list:

logging.debug(err_item[0])

f.write("%s" % err_item[0])

f.write("%s" % err_item[1])


# 退出telnet

def logout_host(self):

self.tn.write(b"exit\n")

main_func.py是主函数入口：

# -*- coding:utf-8 -*-


import logging

import os

import sys

from C_telnet import *

from C_parse_excel import *


Host_ip = '192.168.17.128'

Username = 'admin'

Password = 'admin'

Remote_port = 8000


def parse_cmd_excel(dir_name):

objList = []

list_f = os.listdir(dir_name)

for item in list_f:

item = dir_name + item

if os.path.isfile(item) and (item[-5:] == '.xlsx' or item[-5:] == '.xlsm'):

if item.find("$") != -1:

continue

csrConfig = CCsrConfig(item)

csrConfig.OpenExcel()

tmp = csrConfig.ReadCSRCfg()

objList.append(tmp)

elif os.path.isdir(item):

item = item + '/'

new_obj_list = []

new_obj_list = parse_cmd_excel(item)

for each in new_obj_list:

objList.append(each)


return objList


if __name__ == '__main__':

# 从表格中获取测试的命令

all_cmd_dict = {}

all_cmd_dict = parse_cmd_excel("./src_file/")


#启动telnet客户端连接，并进行测试

telnet_client = TelnetClient()

if telnet_client.login_host(Host_ip, Remote_port, Username, Password) == False:

print("Telnet disconnected!\n")

else:

telnet_client.start_test_cmd(all_cmd_dict)

telnet_client.logout_host()

最后感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

​

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你！