公共方法.md · chenchunhu/anolis-sys-tests

# anolis-pkg-tests公共方法说明
## 1. package.PackageManager
> **包相关公共方法**
#### 1.1 PackageManager.skip()
> **跳过测试**
```
PackageManager.skip(self, message=None)
参数：message，异常信息，默认为None
返回：跳过时抛出信息
    类型：str
```
#### 1.2 PackageManager.setup_rpm_install()
> **对传入的包依次进行检查，未安装的则安装，已安装的会检测是否需要升级**
```
PackageManager.setup_rpm_install(self, pkg_name, host="local")
参数：pkg_name，用例需使用的包,多个包已空格间隔；
     host本地主机或远程主机，默认本地主机
返回：key值为包名，value为1或0的字典，1表示包为用例中新安装包，0为已安装包
    类型：dict
```
#### 1.3 PackageManager.rpm_uninstall()
> **对传入记录进行检查，如有执行用例时安装的包进行卸载**
```
PackageManager.rpm_uninstall(self, rpm_flag, host="local")
参数：rpm_flag，setup_rpm_install返回的记录；
     host，本地主机或远程主机，默认本地主机
返回：退出状态码和标准输出/退出状态码和标准错误输出
```

## 2. basetest
### *2.1. basetest.BaseTest*
> **所有测试用例的BaseTest类**
```
BaseTest.setUp(self)
参数：无
功能：打印setup信息
```
```
BaseTest.tearDown(self)
参数：无
功能：打印tearDown信息
```
```
BaseTest.skip(self, message=None)
参数：message，异常信息，默认为None
返回：异常信息
```
### *2.2 basetest.LocalTest*

> **LocalTest类表示在本地主机上运行的测试用例，父类为BaseTest**
>
> 如果您将远程主机参数传递给测试用例， 您还可以在远程主机上运行测试用例
#### 2.2.1 LocalTest.setUp()
> **对param_dic中传入包名检查，进行安装**
```
LocalTest.setUp(self, param_dic={})
参数：param_dic，传入参数，字典形式传参，传参为包名时key值为pkg_name，value为包名，多个包已空格分隔
返回：key值为包名，value为1或0的字典，1表示包为用例中新安装包，0为已安装包
    类型：dict
```
#### 2.2.2 LocalTest.cmd()
> **对param_dic中传入包名检查，进行安装**
```
LocalTest.cmd(self, command, host="local", ignore_status=False)
参数：command，命令行；
     host，本地主机或远程主机，默认本地主机；
     ignore_status，忽视命令行执行状态码异常，默认False
功能：执行命令行
返回：退出状态码和标准输出/退出状态码和标准错误输出
```
#### 2.2.3 LocalTest.tearDown()
> **对param_dic中传入包名检查，进行卸载**
```
LocalTest.tearDown(self, param_dic={})
参数：param_dic，参数信息
功能：若param_dic中检测到有包名参数，会依据setUp中包名记录卸载包，如果软件包默认没有安装的话，会进行卸载，否则不会
返回：退出状态码和标准输出/退出状态码和标准错误输出
```

### *2.3. basetest.RemoteTest*
> **RemoteTest类表示在远程主机上运行的测试用例**
#### 2.3.1 RemoteTest.setUp()
> **对param_dic中传入包名检查，进行安装**
```
RemoteTest.setUp(self, param_dic={})
参数：param_dic，传入参数，字典形式传参，传参为包名时key值为pkg_name，value为包名，已空格分隔
返回：key值为包名，value为1或0的字典，1表示包为用例中新安装包，0为已安装包
    类型：dict
```
#### 2.3.2 RemoteTest.cmd()
> **远程主机执行命令**
```
RemoteTest.cmd(self, command, host="remote", ignore_status=False)
参数：command，命令行；
     host，本地主机或远程主机，默认远程主机；
     ignore_status，忽视命令行执行状态码异常，默认False
功能：执行命令行
返回：退出状态码和标准输出/退出状态码和标准错误输出
```
#### 2.3.3 RemoteTest.wait_ssh_connect()
> **等待ssh连接**
```
RemoteTest.wait_ssh_connect(self, timeout=600)
参数：timeout，超时时间，默认600
返回：无
```
#### 2.3.4 RemoteTest._get_image_info()
> **根据系统中配置文件信息获取镜像信息**
```
RemoteTest._get_image_info()
参数：无
返回：镜像信息，包括镜像环境、镜像类型、镜像版本、镜像架构、镜像内核、镜像id
```
#### 2.3.5 RemoteTest.tearDown()
> **对param_dic中传入包名检查，进行卸载**
```
RemoteTest.tearDown(self, param_dic={})
参数：param_dic，参数信息
功能：若param_dic中检测到有包名参数，会依据setUp中包名记录卸载包，如果软件包默认没有安装的话，会进行卸载，否则不会。
返回：退出状态码和标准输出/退出状态码和标准错误输出
```

## 3. service.ServiceManager
> **服务相关的通用方法**
### *3.1. ServiceManager.service_test(）*
> **遍历服务，依次对已安装服务测试restart, stop, start, status，reload命令**
```
ServiceManager.service_test(self, service_name, host="local")
参数：service_name，服务名；host，本地主机或远程主机，默认远程主机
返回：服务测试成功返回0，服务测试失败返回状态码及对应标准错误输出
```
## 4. disk.DiskManager
> **硬盘相关的通用方法**
### *4.1 DiskManager.prepare_datadisk()*
> **创建一个临时测试盘**
```
DiskManager.prepare_datadisk(self, host="local", test_img="/tmp/test100.img", mnt_dir="/mnt/testpoint", fs_type="ext4", fs_opt="")
参数：host，，本地主机或远程主机，默认本地主机；
     test_img，输出文件名，默认/tmp/test100.img；
     mnt_dir，挂载路径，默认/mnt/testpoint；
     fs_type，格式，默认ext4；
     fs_opt，文件系统构建器的参数，默认空；
返回：数据盘名称
```
### *4.2 DiskManager.cleanup_datadisk()*
> **卸载已挂载目录，删除测试文件及挂载目录**
```
DiskManager.cleanup_datadisk(self, test_img, mnt_dir, host="local")
参数：test_img，测试文件；
     mnt_dir，挂载路径；
host，，本地主机或远程主机，默认本地主机；
返回：无
```
### *4.2 DiskManager.get_data_disk()*
> **遍历本机所有硬盘，返回非系统盘的第一个有空闲空间盘**
```
DiskManager.get_data_disk(self)
参数：无
host，，本地主机或远程主机，默认本地主机；
返回：硬盘名
```
## 5. host
> **主机相关的通用方法**
### *5.1 hosts.LocalHost*
> **LocalHost类表示一个本地主机**
#### *5.1.1 LocalHost.cmd()*
> **本机执行命令行**
```
LocalHost.cmd(self, command, ignore_status=False)
参数：command,命令行；
     ignore_status，如果为True则忽略异常，否则抛出异常。默认为False
返回：退出状态码和标准输出/退出状态码和标准错误输出
```
### *5.2 hosts.RemoteHost*
> **RemoteHost类表示远程主机**
#### *5.2.1 RemoteHost.cmd()*
> **远程主机执行命令行**
```
RemoteHost.cmd(self, command, ignore_status=False)
注意:不支持单引号的awk命令
参数：command,命令行；
     ignore_status，如果为True则忽略异常，否则抛出异常。默认为False
返回：退出状态码和标准输出/退出状态码和标准错误输出
```

## 6. sysinfo
> **用于获取操作系统信息的通用**
### *6.1 SysInfo.cmd()*
> **本机/远程主机执行命令行**
```
SysInfo.cmd(self, command, host, ignore_status=False)
参数：command,命令行；
     host，，本地主机或远程主机；
     ignore_status，如果为True则忽略异常，否则抛出异常。默认为False
返回：退出状态码和标准输出/退出状态码和标准错误输出
```
### *6.2 SysInfo.get_os_version()*
> **获取系统版本**
```
SysInfo.get_os_version(self, host="local")
参数：host，本地主机或远程主机,默认本机主机；
返回：系统版本
```
### *6.3 SysInfo.skip_arch()*
> **如系统架构与参数传入架构一致，跳过测试**
```
SysInfo.skip_arch()
参数：arch，系统架构；
返回：跳过信息
```

chenchunhu/anolis-sys-tests

简介

发行版

贡献者

近期动态

chenchunhu/anolis-sys-tests .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

chenchunhu/anolis-sys-tests