RobotFramework中SSHLibrary学习与总结.pdf

RobotFramework中 中SSHLibrary学习与总结 学习与总结 ⼀、安装SSHLibrary ⼆.关键字 1.与连接相关的 Open Connection Get Connection Get Connections Switch Connection Close Connection Close All Connections Login Login With Public Key Set Client Configuration Set Default Configuration Enable Ssh Logging 2.与⽂件/⽬录相关的 2.1 File Should Exist , File Should Not Exist, Directory Should Exist , Directory Should Not Exist 2.2 List Directory, List Files In Directory , List Directories In Directory 2.3 Put Directory ,Get Directory,Put File,Get File 3.与读写执⾏相关的 Write Write Bare Write Until Expected Output Read Read Until Read Until Prompt Read Until Regexp Execute Command Start Command Read Command Output ⼀、安装 ⼀、安装SSHLibrary 安装命令：pip install robotframework-sshlibrary ⼆ ⼆.关键字 关键字 1.与连接相关的 与连接相关的 Open Connection ⽤法: [ host " alias=None " port=22 " timeout=None " newline=None " prompt=None " term_type=None " width=None " height=None " path_separator=None " encoding=None ] 默认设置：timeout=3 seconds, newline=LF, prompt=None, loglevel=INFO, term_type=vt100, width=80,height=24, path_separator=/, encoding=UTF-8.其 中，newline=LF/CRLF(\n,\r\n) 更改默认设置： 1.导⼊库时： Library SSHLibrary 10 seconds prompt=$ 2.使⽤ Set Client Configuration/Set Default Configuration 3.调⽤Open Connection时： 结果： ${con1} =index=1 path_separator=/ prompt=# width=80 newline= height=24 encoding=UTF-8 alias=backend host=10.69.140.112 timeout=3 seconds term_type=vt100 port=2222 Get Connection ⽤法：[ index_or_alias=None " index=False " host=False " alias=False " port=False " timeout=False " newline=False " prompt=False " term_type=False " width=False " height=False " encoding=False ] 1.获取connection的信息，如果调⽤时没有加 index_or_alias，返回当前的conection信息。 2.获取connection的特定属性信息，后边加属性名=⾮false/False字符串。 结果： ${con1} =index=1 path_separator=/ prompt=# width=80 newline= height=24 encoding=UTF-8 alias=backend host=10.69.140.112 timeout=3 seconds term_type=vt100 port=2222 ${con2} = (2222, 3.0) Get Connections ⽤法:没有输⼊值，获取所有打开的connection的信息 结果： ${con1} = index=1 path_separator=/ prompt=$ width **Robot Framework中的SSHLibrary** SSHLibrary是Robot Framework的一个扩展库，用于通过SSH协议与远程主机进行交互，包括连接、执行命令、传输文件等操作。在本文中，我们将深入探讨SSHLibrary的一些关键知识点。 ### 一、安装SSHLibrary 安装SSHLibrary非常简单，只需通过Python的包管理器pip执行以下命令： ```bash pip install robotframework-sshlibrary ``` 安装完成后，你就可以在Robot Framework测试套件中导入SSHLibrary并使用它的各种关键字了。 ### 二、SSHLibrary的关键字 #### 1. 与连接相关的关键字 - **Open Connection**：建立到远程主机的SSH连接。参数包括主机名、端口、超时时间、换行符、提示符等。例如： ```robotframework Open Connection host=10.69.140.112 port=2222 timeout=10 seconds prompt=$ ``` - **Get Connection**：获取已建立的连接信息，可以指定索引或别名，如果不指定，则返回当前连接的信息。 ```robotframework ${con1} = Get Connection ``` - **Get Connections**：获取所有已打开的连接信息。 ```robotframework ${connections} = Get Connections ``` - **Close Connection** 和 **Close All Connections**：关闭单个连接或所有连接。 - **Login** 和 **Login With Public Key**：用用户名和密码或公钥进行认证登录。 - **Set Client Configuration** 和 **Set Default Configuration**：配置SSH客户端的默认设置，如超时、换行符等。 #### 2. 与文件/目录相关的关键字 - **File Should Exist** 和 **File Should Not Exist**：检查远程主机上的文件是否存在。 - **Directory Should Exist** 和 **Directory Should Not Exist**：检查远程目录是否存在。 - **List Directory**，**List Files In Directory** 和 **List Directories In Directory**：列出目录中的文件和子目录。 - **Put Directory** 和 **Get Directory**：上传或下载整个目录。 - **Put File** 和 **Get File**：上传或下载单个文件。 #### 3. 与读写执行相关的关键字 - **Write**，**Write Bare** 和 **Write Until Expected Output**：向远程主机发送命令或数据。 - **Read**，**Read Until**，**Read Until Prompt** 和 **Read Until Regexp**：从远程主机读取输出，直到满足特定条件。 - **Execute Command** 和 **Start Command**：执行远程命令，并可获取命令输出。 - **Read Command Output**：读取已启动命令的输出。 ### 示例用法 下面是一个简单的使用示例，展示了如何建立连接、执行命令并断开连接： ```robotframework *** Settings *** Library SSHLibrary *** Test Cases *** Example SSH Interaction Open Connection host=localhost port=22 username=myuser password=mypassword Execute Command echo "Hello, SSHLibrary!" ${output} = Read Should Be Equal As Strings ${output} Hello, SSHLibrary! Close Connection ``` ### 总结 SSHLibrary提供了丰富的关键字，使得在Robot Framework中进行SSH操作变得简单而直观。无论是连接管理、文件传输还是命令执行，都可以通过这些关键字实现自动化。通过熟练掌握这些关键字的使用，你可以构建出高效、可靠的远程系统自动化测试框架。