• 概述
  • 工具介绍
• 兼容性结论继承说明
  • 整机兼容性结论继承策略
  • 板卡兼容性结论继承策略
• 版本发行说明
• 工具使用
  • 使用流程
    • 用户使用流程
  • 运行环境
    • 环境要求
    • 运行环境组网
• 离线安装环境部署要求
• 工具安装
  • 前提条件
  • 获取安装包
    • 在线安装
    • 离线安装
  • 安装过程
    • 客户端
    • 服务端
• 测试项
  • 测试项介绍
  • 测试项策略
• 使用指导
  • 前提条件
  • 使用步骤
• 详细测试指导
• 结果获取
  • 查看结果
  • 结果说明
  • 测试结果审核
• FAQ

概述

工具介绍

oec-hardware工具是openEuler社区提供的一款硬件兼容性测试工具，oec-hardware提供服务器整机、板卡与openEuler的兼容性验证测试，验证仅限于基本功能验证，不包括性能测试等其它测试。

硬件厂商在需要验证硬件产品与openEuler的兼容性时，可以使用oec-hardware。社区提供硬件兼容性测试流程，硬件厂商可以参考 社区兼容性适配流程 进行和openEuler的适配。

通过oec-hardware工具测试的硬件产品，openEuler会在社区官网发布 兼容性清单 ，硬件厂商会在厂商官网发布对应的兼容性信息。

兼容性结论继承说明

整机兼容性结论继承策略

如果验证适配的服务器共主板、CPU代次相同，可以继承兼容性结论。

板卡兼容性结论继承策略

板卡型号一般通过四元组来进行确认。

四元组信息：
    vendorID：芯片厂商ID
    deviceID: 芯片型号ID
    svID：板卡厂商ID
    ssID: 板卡型号ID

四元组查看方式：
    - 通过iBMC查看
    - 在系统中执行命令"lspci -nvv"查看

板卡兼容性结论继承有以下三点:

1. vendorID和deviceID不同

   无法继承兼容性结论

2. vendorID和deviceID，svID不同

   芯片型号相同但是板卡厂商不同，无法继承兼容性结论。

3. vendorID、deviceID、svID相同

   代表同一个板卡厂商，使用同一种芯片做成的不同板卡，可以继承兼容性结论。

4. vendorID、deviceID、svID、ssID相同

   代表同一个板卡厂商，使用同一种芯片做成的同一系列板卡，四元组信息相同，可以继承兼容性结论。厂商自行评估此系列板卡，可以写代表性的板卡名称。

板卡厂商参考社区的兼容性清单以及正在适配中的板卡，如果可以继承兼容性结论，需要在对应的适配issue中进行说明，兼容性sig组会进行人工审核，审核通过后会发布对应的兼容性清单。

版本发行说明

版本发布策略

oec-hardware工具详细版本发布策略和版本发布方案请见 oec-hardware软件包发布设计文档

版本维护策略

oec-hardware工具发布新版本后，社区将只针对最新版本进行维护。

工具使用

使用流程

用户使用流程

运行环境

环境要求

整机测试环境要求

板卡测试环境要求

注意

如果要测试外部驱动，请提前安装驱动，配置测试环境。

GPU、VGPU、keycard等测试项需要提前安装外部驱动，保证环境部署完成，然后使用本工具进行测试。

运行环境组网

离线安装环境部署要求

1. 下载 openEuler 官方的 everything iso，挂载本地 repo 源。

   如果在 everything iso 中无法找到依赖的软件包，请手动从 openEuler 官方 repo 中下载软件包，上传至测试机中进行安装。

2. 根据不同的测试项，配置离线测试依赖

   测试项	文件名	路径
   GPU	https://github.com/wilicc/gpu-burn	/opt
   	https://github.com/NVIDIA/cuda-samples/archive/refs/heads/master.zip	/opt
   VGPU	NVIDIA vgpu client驱动软件包	/root
   	下载对应版本和架构的虚拟机镜像文件，此处以openEuler 22.03LTS、x86_64为例：https://repo.openeuler.org/openEuler-22.03-LTS/virtual_machine_img/x86_64/openEuler-22.03-LTS-x86_64.qcow2.xz	/opt

工具安装

前提条件

本工具支持在 openEuler 20.03 (LTS) 或更高版本上运行，详细支持操作系统版本信息请查看 oec-hardware/scripts/kernelrelease.json 文件。

获取安装包

在线安装

配置 openEuler 官方 repo 中对应版本的 everything 和 update repo源，使用 dnf 获取软件包进行安装。

离线安装

1. 本地挂载openEuler everything镜像，配置repo源，用于依赖获取
2. 从 openEuler 官方 repo 的 update 目录获取最新软件包进行安装

安装过程

客户端

1. 使用 dnf 安装客户端 oec-hardware。

   dnf install oec-hardware

2. 输入 oech 命令，可正常运行，则表示安装成功。

服务端

1. 使用 dnf 安装服务端 oec-hardware-server。

   dnf install oec-hardware-server

2. 启动服务。本服务通过搭配 nginx 服务提供 web 服务，默认使用 80 端口，可以通过 nginx 服务配置文件修改对外端口，启动前请保证这些端口未被占用。

   systemctl start oech-server.service
   systemctl start nginx.service

3. 关闭防火墙和 SElinux。

   systemctl stop firewalld
   iptables -F
   setenforce 0

测试项

测试项介绍

请查看 测试项介绍

测试项策略

使用指导

前提条件

• /usr/share/oech/kernelrelease.json 文件中列出了当前支持的所有系统版本，使用uname -a 命令确认当前系统内核版本是否属于框架支持的版本。

• 框架默认会扫描所有网卡，对网卡进行测试前，请自行筛选被测网卡；要求测试端口连通，状态为up。建议不要使用业务网口进行网卡测试。

• /usr/share/oech/lib/config/test_config.yaml 是硬件测试项配置文件模板，fc、raid、disk、ethernet、infiniband硬件测试前需先根据实际环境进行配置，其它硬件测试不需要配置。对于网卡测试，如果是工具自动添加的IP地址，测试完成后，为了安全，服务端的IP需手动删除。

使用步骤

1. 在客户端启动测试框架。客户端启动 oech，选择测试类别，compatible表示兼容性，virtualization表示虚拟化，填写类别序号，即输入1表示选择的兼容性类别。

   # oech
   Please select test category.
   No.   category
   1     compatible
   2     virtualization
   Please select test category No:1

2. 填写ID、URL、Server配置项

ID 建议填写 gitee 上的 issue ID（注意：ID中不能带特殊字符）；URL建议填写产品链接；Server 必须填写为客户端可以直接访问的服务器域名或 ip，用于展示测试报告和作网络测试的服务端。服务端nginx默认端口号是80，如果服务端安装完成后没有修改该端口，Compatibility Test Server 的值只需要输入服务端的业务IP地址；否则需要带上端口号，比如：172.167.145.2:90。

The openEuler Hardware Compatibility Test Suite
Please provide your Compatibility Test ID:
Please provide your Product URL:
Please provide the Compatibility Test Server (Hostname or Ipaddr):

3. 进入测试套选择界面。在用例选择界面，框架将自动扫描硬件并选取当前环境可供测试的测试套，输入 edit 可以进入测试套选择界面。

   These tests are recommended to complete the compatibility test: 
   No. Run-Now?  status    Class         Device         driverName     driverVersion     chipModel           boardModel
   1     yes     NotRun    acpi                                                                              
   2     yes     NotRun    clock                                                                             
   3     yes     NotRun    cpufreq                                                                           
   4     yes     NotRun    disk                                                                              
   5     yes     NotRun    ethernet      enp3s0         hinic          2.3.2.17          Hi1822              SP580
   6     yes     NotRun    ethernet      enp4s0         hinic          2.3.2.17          Hi1822              SP580
   7     yes     NotRun    ethernet      enp125s0f0     hns3                             HNS GE/10GE/25GE    TM210/TM280
   8     yes     NotRun    ethernet      enp125s0f1     hns3                             HNS GE/10GE/25GE    TM210/TM280
   9     yes     NotRun    raid          0000:04:00.0   megaraid_sas   07.714.04.00-rc1  SAS3408             SR150-M
   10    yes     NotRun    gpu           0000:03:00.0   amdgpu                           Navi                Radeon PRO W6800
   11    yes     NotRun    ipmi                                                                              
   12    yes     NotRun    kabi                                                                              
   13    yes     NotRun    kdump                                                                             
   14    yes     NotRun    memory                                                                            
   15    yes     NotRun    perf                                                                              
   16    yes     NotRun    system                                                                            
   17    yes     NotRun    usb                                                                               
   18    yes     NotRun    watchdog                                                      
   Ready to begin testing? (run|edit|quit)

4. 选择测试套。all|none 分别用于 全选|全取消（必测项 system 不可取消，多次执行成功后 system 的状态会变为Force）；数字编号可选择测试套，每次只能选择一个数字，按回车符之后 no 变为 yes，表示已选择该测试套。

   Select tests to run:
   No. Run-Now?  status    Class         Device         driverName     driverVersion     chipModel           boardModel
   1     no      NotRun    acpi                                                                              
   2     no      NotRun    clock                                                                             
   3     no      NotRun    cpufreq                                                                           
   4     no      NotRun    disk                                                                              
   5     yes     NotRun    ethernet      enp3s0         hinic          2.3.2.17          Hi1822              SP580
   6     no      NotRun    ethernet      enp4s0         hinic          2.3.2.17          Hi1822              SP580
   7     no      NotRun    ethernet      enp125s0f0     hns3                             HNS GE/10GE/25GE    TM210/TM280
   8     no      NotRun    ethernet      enp125s0f1     hns3                             HNS GE/10GE/25GE    TM210/TM280
   9     yes     NotRun    raid          0000:04:00.0   megaraid_sas   07.714.04.00-rc1  SAS3408             SR150-M
   10    yes     NotRun    gpu           0000:03:00.0   amdgpu                           Navi                Radeon PRO W6800
   11    yes     NotRun    ipmi                                                                              
   12    yes     NotRun    kabi                                                                              
   13    yes     NotRun    kdump                                                                             
   14    yes     NotRun    memory                                                                            
   15    yes     NotRun    perf                                                                              
   16    yes     NotRun    system                                                                            
   17    yes     NotRun    usb                                                                               
   18    yes     NotRun    watchdog     
   Selection (<number>|all|none|quit|run):

5. 开始测试。选择完成后输入 run 开始测试。

6. 上传测试结果。测试完成后可以上传测试结果到服务器，便于结果展示和日志分析。如果上传失败，请检查网络配置，然后重新上传测试结果。

   ...
   -------------  Summary  -------------
   ethernet-enp3s0                  PASS
   system                           PASS
   Log saved to /usr/share/oech/logs/oech-20200228210118-TnvUJxFb50.tar succ.
   Do you want to submit last result? (y|n) y
   Uploading...
   Successfully uploaded result to server X.X.X.X.

详细测试指导

使用oec-hardware进行测试的详细指导请查看 oec-hardware测试使用指导

结果获取

查看结果

测试日志查看

测试完成后，测试日志会保存在/usr/share/oech/logs/目录下，将测试日志导出并解压即可查看测试日志

浏览器查看测试报告

tips：浏览器查看测试报告，前提需要配置server端接收测试结果

1. 浏览器打开服务端 IP 地址，点击导航栏 Results 界面，找到对应的测试 id 进入。

   

2. 进入单个任务页可以看到具体的测试结果展示，包括环境信息和执行结果等。

   • Summary 查看所有测试结果。

   • Devices 查看所有硬件设备信息。

   • Runtime 查看测试运行时间和总任务执行日志。

   • Attachment 下载测试日志附件。

     

结果说明

在 Result 列展示测试结果，结果有两种：PASS 或者 FAIL。如果结果为FAIL，可以直接点击结果来查看执行日志，根据报错对照用例代码进行排查。

测试结果审核

如果测试的硬件、整机需要发布到openEuler的兼容性清单，请将以下测试结果全部上传至相关的适配issue下：

• oec-hardware 测试日志（/usr/share/oech/logs/下）

• oec-hardware-server 生成的html测试报告

• 兼容性清单文件（模板）

  注意： oec-hardware 执行结束后会自动为测试通过的硬件生成兼容性信息文件hw_compatibility.json, 可参考该文件填写兼容性清单信息

  整机适配需要测试至少一张RAID卡、一张网卡，并提供对应的信息。

FAQ

鲲鹏小智 提供了oec-hardware测试过程中可能遇到的问题的解决方案，用户可以通过检索获取问题的解决方法。 常见问题案例请查看 oec-hardware使用常见问题解答 ，或查询 openEuler官方论坛 ，用户可以根据场景获取解决方案。

如果仍有问题无法解决，可在本仓库下提issue反馈或者发邮件至openEuler社区兼容性SIG组邮箱：oecompatibility@openeuler.org。