论坛 › 鸿蒙 › 鸿蒙Harmony实战：xDevice测试调度实行框架使用指南

小秦哥 发表于 2024-10-16 04:23:22

鸿蒙Harmony实战：xDevice测试调度实行框架使用指南

简介

xDevice测试调度框架是OpenHarmony中测试底子设施的焦点组件，提供调度主动化用例实行所依靠的相关服务，支持大量主动化用例的调度实行本领，并可自带生成可视化测试报告。而xDevice二进制包会跟踪随OpenHarmony的XTS套件编译，开辟者可以从XTS套件归档路径中获取xDevice工具，
根据设备范例的差别，xDevice主要测试的使命场景有以下三个：


[*]对轻量系统设备进行XTS测试（如：Hi3861开辟板)
[*]对小型系统设备进行XTS测试（如：Hi3516开辟板)
[*]对尺度系统设备进行XTS测试（如：RK3568开辟板)
实现原理

xDevice包罗以下功能模块：


[*]command：用户与测试平台下令行交互模块，提供用户输入下令剖析，下令处置惩罚。
[*]config：测试框架设置模块，提供测试平台串口毗连方式和USB毗连方式的差别设置选项。
[*]driver：测试用例实行器，提供测试用例分发，实行，效果收集等主要测试步骤定义。
[*]report：测试报告模块，提供测试效果剖析和测试报告生成。
[*]scheduler：测试框架调度模块，提供差别范例的测试实行器调度的调度功能。
[*]environment：测试框架的环境设置模块，提供设备发现，设备管理的功能。
[*]testkit：测试框架工具模块，提供json剖析，网络文件挂载等操作。
[*]log：测试框架日志模块，提供记载使命日志以及设备日志的功能。
除了上述功能模块之外，测试调度框架还依靠了用户自定义设置文件，设置文件主要分为两类。
测试使命设置文件
user_config.xml是框架提供的测试使命设置文件，用户可以根据自身环境信息设置相关内容，主要包罗以下设置内容。
environment环境相关设置，详解介绍如下。
<environment>

<!-- 富设备配置 -->
<device type="usb-hdc"><!-- type：设备连接方式,usb-hdc表示使用hdc控制设备(默认),当前框架只支持设置一个usb设备 -->
    <ip></ip>      <!-- ip: 远端设备地址,ip和port为空时使用本地设备,非空时使用远端设备 -->
    <port></port>    <!-- port: 远端设备端口号 -->
    <sn></sn>      <!-- sn: 设备串号列表，串号之间使用分号;分隔，sn为空时使用本地所有设备，非空时使用指定的sn设备 -->
</device>

<!-- 轻量系统设备配置 -->
<device type="com" label="wifiiot">    <!-- type: 设备连接方式，com表示连接方式是串口; label: 表示设备种类，如wifiiot -->
    <serial>                           <!-- serial:表示一个串口定义 -->
      <com></com>                  <!-- com: 表示本地连接的串口，如COM20 -->
      <type>cmd</type>               <!-- type 表示串口类型，cmd是命令串口 -->
      <baud_rate>115200</baud_rate><!-- baud_rate、data_bits、stop_bits、timeout: 为串口波特率等串口参数 ，一般采用默认值即可 -->
      <data_bits>8</data_bits>   
      <stop_bits>1</stop_bits>
      <timeout>20</timeout>
    </serial>
    <serial>                        
      <com></com>
      <type>deploy</type>            <!-- type 表示串口类型，deploy是刷机串口 -->
      <baud_rate>115200</baud_rate>
    </serial>
</device>

<!-- 小型系统设备本地连接配置 -->
<device type="com" label="ipcamera">
    <serial>
      <com></com>                     
      <type>cmd</type>
      <baud_rate>115200</baud_rate>
      <data_bits>8</data_bits>
      <stop_bits>1</stop_bits>
      <timeout>1</timeout>
    </serial>
</device>

<!-- 小型系统设备远端连接配置,可配置多个 -->
<device type="com" label="ipcamera">
    <ip></ip>
    <port></port>
</device>
</environment>
测试用例目录设置。
<testcases>
<!-- dir标签和server标签同时配置时只有一个会起作用 -->
<!-- 指定测试用例目录,为空则默认设置为当前项目下的testcase文件夹 -->
<dir></dir>

<!-- nfs挂载配置，label取值为NfsServer -->
<server label="NfsServer">
      <ip></ip>             <!-- 挂载环境IP地址 -->
      <port></port>         <!-- 挂载环境端口 -->
      <dir></dir>         <!-- 对应挂载的外部路径 -->
      <username></username> <!-- 登录用户名 -->
      <password></password> <!-- 登录用户密码 -->
      <remote></remote>   <!-- nfs服务器与xDevice执行机不在同一台机器时,remote配置为true,否则为false -->
</server>
</testcases>
资源目录设置。
<resource>
<!-- 指定资源目录,为空则默认设置为当前项目下的resource文件夹 -->
<dir></dir>
</resource>
日志打印级别设置。
<!-- 默认为INFO,如需更加详细的信息可切换为DEBUG -->
<loglevel>INFO</loglevel>
测试套设置文件
设备实行的测试支持套件是由测试设置文件所指定。
每个测试套都都有一个测试设置文件，主要设置了必要使用的测试支持套件（kits）等信息，并支持设置实行预制和整理操作。
以下为设置文件样例。
{
    // 测试支撑套件描述
    "description": "Configuration for aceceshi Tests",
   
    // 指定执行当前测试支撑套的设备
    "environment": {
      "type": "device",
      "label": "wifiiot"
    },

    // 指定设备执行的驱动
    "driver": {
      "type": "OHJSUnitTest",
      "test-timeout": "700000",
      "bundle-name": "com.open.harmony.acetestfive",
      "package-name": "com.open.harmony.acetestfive",
      "shell-timeout": "700000"
    },
    // kit的作用主要是为了支撑测试执行活动，在测试前执行预制操作(Setup)，在测试后执行清理操作(Teardown)
    "kits": [
       {
            "type": "ShellKit",
            "run-command": [
                "remount",
                "mkdir /data/data/resource",
                "chmod -R 777 /data/data/resource",
                "settings put secure adb_install_need_confirm 0"
            ],
            "teardown-command": [
                "remount",
                "rm -rf /data/data/resource"
            ]
      },
    ]
}
测试下令

测试下令可以分为三组：help、list、run。在指令序列中，以run为最常用的实行指令。
输入help指令可以查询框架指令资助信息。
help:
   use help to get information.
usage:
   run:Display a list of supported run command.
   list: Display a list of supported device and task record.
Examples:
   help run
   help list
说明：
help run：展示run指令相关说明 。
help list：展示 list指令相关说明。
list指令用来展示设备和相关的使命信息。
list:
   This command is used to display device list and task record.
usage:
      list
      list history
      list <id>
Introduction:
   list:         display device list
   list history: display history record of a serial of tasks
   list <id>:    display history record about task what contains specific id
Examples:
   list
   list history
   list 6e****90
说明：
list: 展示设备信息。
list history: 展示使命汗青信息 。
list : 展示特定id的使命其汗青信息。
run指令主要用于实行测试使命。
run:
   This command is used to execute the selected testcases.
   It includes a series of processes such as use case compilation, execution, and result collection.
usage: run [-l TESTLIST | -tf TESTFILE
            ] [-tc TESTCASE] [-c CONFIG] [-sn DEVICE_SN]
            [-rp REPORT_PATH ]
            [-respath RESOURCE_PATH ]
            [-tcpath TESTCASES_PATH ]
            [-ta TESTARGS ] [-pt]
            [-env TEST_ENVIRONMENT ]
            [-e EXECTYPE] [-t ]]
            [-td TESTDRIVER] [-tl TESTLEVEL] [-bv BUILD_VARIANT]
            [-cov COVERAGE] [--retry RETRY] [--session SESSION]
            [--dryrun] [--reboot-per-module] [--check-device]
            [--repeat REPEAT]
            action task
Specify tests to run.
positional arguments:
   action                Specify action
   task                  Specify task name,such as "ssts", "acts", "hits"
run指令根本使用方法如下。
xDevice下令功能示例run xts运行所有指定范例的XTS模块，如acts，hits，ssys等run actsrun -l xxx运行指定的模块测试套，模块间用分号隔离run -l ActsWifiServiceTest;ActsLwipTestrun -sn指定运行设备的SN号，多个SN号用分号隔离run acts -sn 10.117.183.37:17001
run acts -sn 88Y0257723;VEG0216642run -rp指定报告生成的路径，默认会在工作目录的reports下用时间戳或使命ID建立子目录run acts -rp /suites/hits/xdevice_reports/2020.09.28-14.21.26run -respath指定测试资源路径，默以为resource目录run acts -respath /cloud/zidane/xts/release/suites/resourcerun -ta指定模块运行参数，可以指定运行模块用例中指定的用例，多个用例用逗号隔离，目前支持JS驱动测试套run acts -ta class:ohos.hardware.soundtrigger.SoundTriggerTest#testKeyphraseParcelUnparcel_noUsersrun --retry重新运行上一次使命的失败用例，生成新的测试报告run –retryrun --retry --session 2020-10-30-17-15-11（使命目录名） 测试报告

框架实行run指令，控制台会输出对应的log打印，还会生成对应的实行效果报告。如果使用了-rp参数指定报告路径，那么报告就会生成在指定的路径下。否则报告会存放在默认目录。
当前报告目录（默认目录/指定目录）
    ├── result(模块执行结果存放目录)
    │   ├── <模块名>.xml
    │   ├──... ...
    │      
    ├── log (设备和任务运行log存放目录)
    │   ├── <设备1>.log
    │   ├── ... ...
    │   ├── <任务>.log
    ├── summary_report.xml(任务汇总数据报告)
    ├── summary_report.html(任务汇总可视化报告)
    ├── details_report.html(用例执性可视化报告)
    ├── failures_report.html(失败用例可视化报告,无失败用例时不生成)
    ├── summary.ini(记录测试类型,使用的设备,开始和结束时间等信息)
    ├── task_info.record(记录执行命令，失败用例清单等信息)
    ├── xxxx.zip(对上述文件进行压缩得到的压缩文件)
    ├── summary_report.hash(对压缩文件进行sha256加密得到的文件)
    └── ... ...
环境准备

环境要求



[*]python版本>=3.7
[*]pyserial>=3.3
[*]paramiko>=2.7.1
[*]rsa>=4.0
安装xDevice



[*] 安装底子框架xDevice。

[*] 进入xDevice根目录。
cd testfwk_xdevice



[*] 打开控制台，实行如下下令。
python setup.py install



[*] 安装OpenHarmony驱动插件ohos。

[*] 进行plugin/ohos目录。
cd testfwk_xdevice


/plugin/ohos
[*] 打开控制台，当前用户下实行如下下令。
python setup.py install



检验环境是否搭建乐成

检验xDevice是否安装乐成。

[*] 进入xDevice根目录。
cd testfwk_xdevice



[*] 打开控制台，实行如下下令。
python -m pip list

[*] 查看是否已经乐成安装xdevice以及xdevice-ohos两个库。
xdevice               0.0.0
xdevice-ohos            0.0.0

查看xDevice工具是否能够正常运行。

[*] 进入xDevice根目录。
cd testfwk_xdevice



[*] 打开控制台，实行如下下令。
python -m xdevice




[*] 查看控制台是否正常输出如下信息。
[*************** xDevice Test Framework 2.11.0.1091 Starting ***************]



>>>

轻量系统设备XTS测试引导（wifiiot）


[*] 识别串口用途，修改根目录中的user_config.xml文件。
type为cmd的com口对应板子上的AT下令串口，用于对设备发送指令，示例中设置为ChA(COM20)串标语。
type为deploy的com口对应板子上的日志输出串口，用于镜像烧录和日志打印，示例中设置为ChB(COM18)串标语。
若AT下令串口和日志输出串口共用，可以设置为相同，即user_config中的type为cmd的com口与type为deploy的com口可设置为一样的端口，如COM18。
user_config.xml的修改示比方下。
<user_config>
    <environment>
      <device type="com" label="wifiiot">
            <serial>
                <com>com20</com>
                <type>cmd</type>
                <baud_rate>115200</baud_rate>
                <data_bits>8</data_bits>
                <stop_bits>1</stop_bits>
                <timeout>20</timeout>
            </serial>
            <serial>
                <com>com18</com>
                <type>deploy</type>
                <baud_rate>115200</baud_rate>
            </serial>
      </device>
    </environment>
    <testcases>
      <dir></dir>
      <server label="NfsServer">
            <ip></ip>
            <port></port>
            <dir></dir>
            <username></username>
            <password></password>
            <remote></remote>
      </server>
    </testcases>
    <resource>
      <dir></dir>
    </resource>
    <loglevel>DEBUG</loglevel>
</user_config>

[*] 在xDevice根目录下新建testcase文件夹用于存放测试套文件，具体XTS测试套从系统构建的逐日构建中获取。
逐日构建：http://ci.openharmony.cn/dailys/dailybuilds
测试套测试设置文件json，示比方下。
{
        "description": "Config for ActsAllTest test cases",
        "environment": [
                {
                        "type": "device",
                        "label": "wifiiot"
                }
        ],
        "kits": [
                {
                        "type": "DeployKit",
                        "timeout": "20000",
                        "burn_file": "acts/Hi3861_wifiiot_app_allinone.bin"
                }
        ],
        "driver": {
                "type": "CTestLite"
        }
}

[*] 实行用例
进入xDevice根目录；打开控制台进入xDevice控制台，实行如下下令。
python -m xdevice



实行测试套下令。
run -l ActsAllTest
实行效果如下。
小型系统设备XTS测试引导（ipcamera）


[*] 识别串口用途。
type为cmd的com口对应板子上的AT下令串口，用于对设备发送指令，示例中设置为ChA(COM20)串标语。
ipcamera设备有两种毗连方式，一种是本地串口毗连，一种是通过局域网ip毗连。
[*] 设置NFS服务器
NFS挂载方式有两种，一种是远程PC挂载方式，一种是本地局域网挂载方式。
本地局域网NFS服务的设置方法如下。

[*] 下载安装NFS服务器。下载地址：https://www.hanewin.net/nfs-e.htm
[*] 设置输出->编辑输出表文件。
[*] 添加路径NFS共享路径（如：D:\HS\NFS_Share_File -public –alldirs），这里要注意ftp的IP地址192.168.1.10为开辟板的IP。
[*] 停止NFS服务器->重启运行NFS服务器使刚才添加的共享路径见效。
[*] 找到ipcamera设备在PC上面映射的网口：控制面板->网络和Internet->网络共享中心->以太网状态->以太网属性->手动设置IP地址为:192.168.1.11。

[*] 修改根目录中的user_config.xml文件，示比方下。
<user_config>
    <environment>
      <device type="com" label="ipcamera">   <!--两种方式二选一：本地连接方式-->
            <serial>
                <com>com20</com>
                <type>cmd</type>
                <baud_rate>115200</baud_rate>
                <data_bits>8</data_bits>
                <stop_bits>1</stop_bits>
                <timeout>1</timeout>
            </serial>
      </device>
      <device type="com" label="ipcamera">   <!--两种方式二选一：局域网连接方式-->
            <ip>10.176.49.47</ip>
            <port>10003</port>
      </device>
    </environment>
    <testcases>
      <dir></dir>
      <server label="NfsServer">               <!--两种方式二选一：远程挂载方式-->
            <ip>10.176.48.202</ip>
            <port>1022</port>
            <dir>/data/data/local/</dir>
            <username>root</username>
            <password>xxx</password>
            <remote>true</remote>               
      </server>
      <server label="NfsServer">               <!--两种方式二选一：局域网挂载方式-->
            <ip>192.168.1.11</ip>
            <port>2049</port>
            <dir>D:\test</dir>
            <remote>false</remote>               
      </server>
    </testcases>
    <resource>
      <dir></dir>
    </resource>
    <loglevel>DEBUG</loglevel>
</user_config>

[*] 在xDevice根目录下新建testcase文件夹用于存放测试套文件，具体XTS测试套从系统构建的逐日构建。
逐日构建：http://ci.openharmony.cn/dailys/dailybuilds
测试套测试设置文件json，示比方下。
{
        "description": "Config for kernel test cases",
        "environment": [
                {
                        "type": "device",
                        "label": "ipcamera"
                }
        ],
        "kits": [
                {
                        "type": "MountKit",
            "server": "NfsServer",
            "mount": [
                {
                  "source": "testcases/kernel",
                  "target": "/test_root/kernel"
                }
            ]
                }
        ],
        "driver": {
                "type": "CppTestLite",
      "excute": "/test_root/kernel/ActsKernelIPCTest.bin"
        }
}

[*] 实行用例。
进入xDevice根目录，打开控制台进入xDevice控制台，实行如下下令。
python -m xdevice



实行测试套下令。
run -l kernel
实行效果如下。
尺度系统设备XTS测试引导（RK3568）


[*] 设置hdc工具，从逐日构建上下载ohos_sdk最新版本即可。
逐日构建地址：http://ci.openharmony.cn/dailys/dailybuilds
下载工具后，把hdc设置到环境变量中，设置方法：右键单击我的电脑->属性->高级系统设置->环境变量->Path。
[*] 实行如下下令查看设备是否正常毗连。
hdc_std list targets

[*] 修改user_config.xml文件，示比方下。
<user_config>
    <environment>
      <device type="usb-hdc">
            <ip></ip>
            <port></port>
            <sn>xxx;xxx</sn>                        <!--连接多个设备的SN号用分号分割-->
      </device>
    </environment>
    <testcases>
      <dir></dir>
    </testcases>
    <resource>
      <dir></dir>
    </resource>
    <loglevel>DEBUG</loglevel>
</user_config>

[*] 在xDevice根目录下新建testcase文件夹用于存放测试套文件，具体XTS测试套从系统构建的逐日构建中获取。
逐日构建：http://ci.openharmony.cn/dailys/dailybuilds
测试套测试设置文件json，示比方下。
{
    "description": "Configuration for hjunit demo Tests",
    "driver": {
      "type": "OHJSUnitTest",
      "test-timeout": "180000",
      "bundle-name": "ohos.acts.bundle.stage.test",
      "module-name": "phone",
      "shell-timeout": "600000",
      "testcase-timeout": 70000
    },
    "kits": [
      {
            "test-file-name": [
                "ActBmsStageEtsTest.hap"
            ],
            "type": "AppInstallKit",
            "cleanup-apps": true
      },
      {
            "type": "ShellKit",
            "teardown-command":[
                "bm uninstall -n ohos.acts.bundle.stage.test"
            ]
      }
    ]
}

[*] 实行用例。
进入xDevice根目录，打开控制台进入xDevice控制台，实行如下下令。
python -m xdevice



实行测试套下令。
run -l ActBmsStageEtsTest
实行效果如下。
常见题目

hdc list targets能查找到设备，但xDevice识别不到设备。

题目描述
出现如下错误。
可能原因
环境变量中曾设置过HDC_SERVER_PORT变量修改过hdc的端口，由于xDevice默认必要使用8710端口，若曾修改过该端口会导致xDevice框架无法识别设备。
解决方法
查抄是否有设置HDC_SERVER_PROT变量，若有设置，请把该端口的值修改为8710，然后重启xDevice即可。
最后

小编在之前的鸿蒙系统扫盲中，有很多朋侪给我留言，差别的角度的问了一些题目，我明显感觉到一点，那就是许多人加入鸿蒙开辟，但是又不知道从那里下手，由于资料太多，太杂，教授的人也多，无从选择。有很多小伙伴不知道学习哪些鸿蒙开辟技能？不知道必要重点把握哪些鸿蒙应用开辟知识点？而且学习时频仍踩坑，最终浪费大量时间。所以有一份实用的鸿蒙（HarmonyOS NEXT）资料用来跟着学习是非常有必要的。 
为了确保高效学习，建议规划清楚的学习门路，涵盖以下关键阶段：
 点击→【纯血版鸿蒙全套最新学习资料】希望这一份鸿蒙学习资料能够给大家带来资助~


 鸿蒙（HarmonyOS NEXT）最新学习门路
https://i-blog.csdnimg.cn/direct/3122d81d94a44d6cbeecef3af13638dd.png​
该门路图包罗底子技能、就业必备技能、多媒体技能、六大电商APP、进阶高级技能、实战就业级设备开辟，不仅增补了华为官网未涉及的解决方案
门路图得当人群：
IT开辟人员：想要拓展职业边界
零底子小白：鸿蒙爱好者，希望从0到1学习，增加一项技能。
技能提升/进阶跳槽：发展瓶颈期，提升职场竞争力，快速把握鸿蒙技能
点击→纯血版全套鸿蒙HarmonyOS学习资料
2.视频学习资料+学习PDF文档
这份鸿蒙（HarmonyOS NEXT）资料包罗了鸿蒙开辟必把握的焦点知识要点，内容包罗了（ArkTS、ArkUI开辟组件、Stage模子、多端部署、分布式应用开辟、音频、视频、WebGL、OpenHarmony多媒体技能、Napi组件、OpenHarmony内核、（南向驱动、嵌入式等）鸿蒙项目实战等等）鸿蒙（HarmonyOS NEXT）技能知识点。
HarmonyOS Next 最新全套视频教程
https://i-blog.csdnimg.cn/blog_migrate/1615adbee6620c7ab5f9ff9c8717f9bb.png​​
 （鸿蒙语法ArkTS、TypeScript、ArkUI教程……）
https://i-blog.csdnimg.cn/direct/2ae03454d20146e1b1abad425ed4f473.png
 纯血版鸿蒙全套学习资料（面试、文档、全套视频等）
                   https://i-blog.csdnimg.cn/direct/c910754a4ca14a91bc2bf41d142dc7f0.png
​​
鸿蒙南向开辟技能
https://i-blog.csdnimg.cn/blog_migrate/c8692deacd7801cfc886f2aeb5c9de68.png​​
鸿蒙APP开辟必备
https://i-blog.csdnimg.cn/blog_migrate/c510342c258bd907f950db431ae04b02.png​​
《鸿蒙 (OpenHarmony)开辟底子到实战手册》
OpenHarmony北向、南向开辟环境搭建
https://i-blog.csdnimg.cn/blog_migrate/f96a88a74813128e1530e4e3019ee879.png​​
《鸿蒙开辟底子》
https://i-blog.csdnimg.cn/blog_migrate/a7471ed423974112f9e6d24c7d036cca.png​​
《鸿蒙开辟进阶》
https://i-blog.csdnimg.cn/blog_migrate/c4814cf44a41e19b838a0676d4665a5f.png
《鸿蒙进阶实战》
https://i-blog.csdnimg.cn/blog_migrate/8107cce2a9b629ecb6698a532fec37ad.png​​

点击→纯血版全套鸿蒙HarmonyOS学习资料
总结
总的来说，华为鸿蒙不再兼容安卓，对程序员来说是一个挑战，也是一个机会。只有积极应对变化，不断学习和提升自己，才能在这个变革的期间中立于不败之地。 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

查看完整版本: 鸿蒙Harmony实战：xDevice测试调度实行框架使用指南