ves7in/terminalsconnectivitytester

大量终端的网络连接性批量测试工具🛠。Network connectivity test tool for a large number of terminals🛠.

TerminalsConnectivityTester

大量终端的网络连接性批量测试工具🛠。

Network connectivity test tool for a large number of terminals🛠.

🗝简介 - Brief

当内网中包含大量网络设备，个别不常用的终端连接异常时很难及时被发现，应避免需要使用时才处理异常。

使用此工具可以周期性地对内网中的大量终端进行连通性测试，有助于及时发现网络问题并给予解决。

👨🏻‍💻特性 - Features

1. 支持以 .json 格式保存和打开工具测试结果；
2. 支持以 .csv 格式导出和导入工具测试结果；
3. 支持以测试结果筛选列表显示项；
4. 支持以不同颜色区分测试结果；
5. 支持配置 SQL 查询命令直接从 MySQL 数据库转储设备信息以显示并可立即测试；
6. 支持无延迟高速测试模式，及测试间增加延迟的低速模式；
7. 所有设置通过 config.yaml 更改，请保证此配置文件位于软件同目录，不可更名。

⚙️使用说明 - Usage

1. 配置文件说明

注意缩进且冒号后有一个空格

# ./config.yaml
# -*- coding: GBK -*-

文件名需为“config.yaml”，且与主程序同目录，GBK编码；

## MySQL database basic settings
## *hostname(IP), serving port, username, password
database:
  host: localhost
  port: 3306
  username: root
  password: 123456

此项定义了数据库基本设置（字典），依次需指定服务主机名(IP)、服务端口、数据库用户名、数据库密码；

## All departments and database name lists
departments:
  DeptA: ['a1', 'a2', 'a3']
  DeptB: ['b']
  DeptC: ['c1', 'c2']

此项定义了主程序内所有分类名（键）及此分类下所有数据库名列表（值），键值均可修改；

## Column IDs and each column's display name and width
## Categorized by the first column by default
## *Modifications may cause early terminals record files to unable to open
columns:
  '#0':       # Necessary, do not change column ID
    fullname: 'Department'
    width: 140
  name:       # Unnecessary, column ID matchs SELECT names below
    fullname: 'Name'
    width: 180
  type:       # Unnecessary, do not change column ID
    fullname: 'Type'
    width: 120
  ip:         # Unnecessary, column ID matchs SELECT names below
    fullname: 'IP Address'
    width: 100
  latency:    # Necessary, do not change column ID
    fullname: 'Latency'
    width: 100

此项定义了软件列ID（键），及其显示列名和初始列宽（字典），默认按第一列分类，且至少包含“'#0'”列和“latency”列。软件中“type”列下显示内容将与下一项设置键名对应；

## 'type'(terminal's type) and SQL SELECT code for each types
## *Needs 'name'(terminal's name) and 'ip'(terminal's IP)£¬match column IDs
dumpcodes:
  TypeX: "SELECT name, ip FROM tablex"
  TypeY: "SELECT devicename 'name', ip FROM devicetable, iptable WHERE devicetable.deviceid = iptable.deviceid"

此项定义了所有设备类型（键）及其SQL查询语句（值），查询结果的列名（或别名）需与上一项设置的列ID对应。

2. 主程序使用说明

(i) 菜单项：

File                      #   [文件操作]
  ┣ Open ...              # 打开此程序保存的 .json 记录文件
  ┣ Save                  # 以 .json 记录形式保存当前列表内容
  ┣ Save as ...           # 以 .json 记录形式另存为当前列表内容
  ┣ Import ...            # 导入此程序导出的 .csv 记录文件
  ┣ Export ...            # 以 .csv 记录形式导出当前列表内容
  ┗ Quit                  # 退出此程序
Filter                    #   [过滤器]（默认不筛选，点击以下任一项切换筛选状态）
  ┣ Normal                # 测试通过项
  ┣ Timeout               # 测试超时项
  ┣ Unknown               # 测试未成功项（检查IP是否有误）
  ┗ Untested              # 未测试项
Database                  #   [数据库下载数据]
  ┣ Dump (Config file)    # 从配置文件设定的数据库主机下载数据
  ┣ Dump from localhost   # 从本地数据库下载数据
  ┗ Dump from remote ...  # 从指定数据库下载数据
ConnectivityTest          #   [启动测试]
  ┣ Run (Performance)     # 高速模式
  ┗ Run                   # 低速模式
About                     #   [关于此程序]
  ┗ TerminalsConnectivityTester

(ii) 主程序一般使用流程：

• 从数据库下载数据并测试：

  • Database > Dump (Config file)，等待数据下载完成；
  • ConnectivityTest > Run (Performance)，运行测试并等待测试完成；
  • Filter > xxx，筛选掉不需要的项。

• 从保存的 .json 记录加载数据并测试：

  • File > Open ...，等待数据加载完成；
  • ConnectivityTest > Run (Performance)，运行测试并等待测试完成；
  • Filter > xxx，筛选掉不需要的项。

• 从导出的 .csv 记录导入数据并测试：

  • File > Import ...，等待数据导入完成；
  • ConnectivityTest > Run (Performance)，运行测试并等待测试完成；
  • Filter > xxx，筛选掉不需要的项。

📙更新日志 - Update logs

2023/04/07 - v0.2.3(1)

1. 发布v0.2.3(1)，开发环境基于python 3.11.1。