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中，期望結果用來從命令的返回資料中進行字串查詢的，如果找到了，表示命令執行成功，否則認為執行失敗。格式如下：

執行失敗結果儲存：如果命令執行失敗，則將命令和得到的返回資料存放到一個單獨的檔案中。

下面說明程式碼目錄結構：

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()

這樣就能實現一個簡單的自動測試命令的方式。