测试子系统.md 28.2 KB
Newer Older
S
stivn 已提交
1 2
# 测试子系统
OpenHarmony为开发者提供了一套全面的自测试框架,开发者可根据测试需求开发相关测试用例,开发阶段提前发现缺陷,大幅提高代码质量。
N
NEEN 已提交
3

S
stivn 已提交
4 5 6 7 8
本文从基础环境构建,用例开发,编译以及执行等方面介绍OpenHarmony测试框架如何运行和使用。
## 基础环境构建
测试框架依赖于python运行环境,在使用测试框架之前可参阅以下方式进行配置。
 - [环境配置](../device-dev/subsystems/subsys-testguide-envbuild.md)
 - [源码获取](../device-dev/get-code/sourcecode-acquire.md)
N
NEEN 已提交
9 10


S
stivn 已提交
11 12
## 测试框架目录简介
以下是测试框架的目录层级架构,在使用测试框架过程中可在相应目录查找对应组件。
N
NEEN 已提交
13
```
S
stivn 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27
test  # 测试子系统
├── developertest  # 开发者测试组件
│   ├── aw  # 测试框架的静态库
│   ├── config  # 测试框架配置
│   │   │ ...
│   │   └── user_config.xml  # 用户使用配置
│   ├── examples  # 测试用例示例
│   ├── src  # 测试框架源码
│   ├── third_party  # 测试框架依赖第三方组件适配
│   ├── reports  # 测试结果报告
│   ├── BUILD.gn  # 测试框架编译入口
│   ├── start.bat  # 开发者测试入口(Windows)
│   └── start.sh  # 开发者测试入口(Linux)
└── xdevice  # 测试框架依赖组件
N
NEEN 已提交
28
```
S
stivn 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41
## 测试用例编写
###  测试用例目录规划
使用测试框架过程中,可根据以下层级关系规划测试用例目录。
```
subsystem  # 子系统
├── partA  # 部件A
│   ├── moduleA  # 模块A
│   │   ├── include       
│   │   ├── src  # 业务代码
│   │   └── test  # 测试目录
│   │       ├── unittest  # 单元测试
│   │       │   ├── common  # 公共用例
│   │       │   │   ├── BUILD.gn  # 测试用例编译配置
S
stivn 已提交
42
│   │       │   │   └── testA_test.cpp  # 单元测试用例源码
S
stivn 已提交
43 44 45
│   │       │   ├── phone  # 手机形态用例
│   │       │   ├── ivi  # 车机形态用例
│   │       │   └── liteos-a  # ipcamera使用liteos内核的用例
S
stivn 已提交
46 47 48
│   │       ├── moduletest  # 模块测试
│   │       ...
│   │            
S
stivn 已提交
49 50
│   ├── moduleB  # 模块B   
│   ├── test               
S
stivn 已提交
51 52 53 54 55 56 57 58
│   │   └── resource  # 依赖资源    
│   │       ├── moduleA  # 模块A
│   │       │   ├── ohos_test.xml  # 资源配置文件
│   │       ... └── 1.txt  # 资源   
│   │            
│   ├── ohos_build  # 编译入口配置  
│   ...

S
stivn 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
...
```
> **注意:** 测试用例根据不同设备形态差异分为通用用例和非通用用例,建议将通用用例存放在common目录下,非通用用例存放在相应设备形态目录下。

###  测试用例编写
本测试框架支持多种语言用例编写,针对不同语言提供了不同的模板以供编写参考。

**C++参考示例**

- 用例源文件命名规范

    测试用例源文件名称和测试套内容保持一致,文件命名采用全小写+下划线方式命名,以test结尾,具体格式为:[功能]_[子功能]_test,子功能支持向下细分。
示例:
    ```
    calculator_sub_test.cpp
    ```

- 用例示例
    ```
    /*
     * Copyright (c) 2021 XXXX Device Co., Ltd.
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    
    #include "calculator.h"
    #include <gtest/gtest.h>
    
    using namespace testing::ext;
    
    class CalculatorSubTest : public testing::Test {
    public:
        static void SetUpTestCase(void);
        static void TearDownTestCase(void);
        void SetUp();
        void TearDown();
    };
    
    void CalculatorSubTest::SetUpTestCase(void)
    {
        // input testsuit setup step,setup invoked before all testcases
    }
    
    void CalculatorSubTest::TearDownTestCase(void)
    {
        // input testsuit teardown step,teardown invoked after all testcases
    }
    
    void CalculatorSubTest::SetUp(void)
    {
        // input testcase setup step,setup invoked before each testcases
    }
    
    void CalculatorSubTest::TearDown(void)
    {
        // input testcase teardown step,teardown invoked after each testcases
    }
    
    /**
     * @tc.name: integer_sub_001
     * @tc.desc: Verify the sub function.
     * @tc.type: FUNC
     * @tc.require: Issue Number
     */
    HWTEST_F(CalculatorSubTest, integer_sub_001, TestSize.Level1)
    {
        // step 1:调用函数获取结果
        int actual = Sub(4,0);

        // Step 2:使用断言比较预期与实际结果
        EXPECT_EQ(4, actual);
    }
    ```
    详细内容介绍:
    1. 添加测试用例文件头注释信息
	    ```
    	/*
    	 * Copyright (c) 2021 XXXX Device Co., Ltd.
    	 * Licensed under the Apache License, Version 2.0 (the "License");
    	 * you may not use this file except in compliance with the License.
    	 * You may obtain a copy of the License at
    	 *
    	 *     http://www.apache.org/licenses/LICENSE-2.0
    	 *
    	 * Unless required by applicable law or agreed to in writing, software
    	 * distributed under the License is distributed on an "AS IS" BASIS,
    	 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    	 * See the License for the specific language governing permissions and
    	 * limitations under the License.
    	 */
    	```
    2. 引用测试框架头文件和命名空间
	    ```
    	#include <gtest/gtest.h>
    
    	using namespace testing::ext;
    	```
    3. 添加被测试类的头文件
	    ```
    	#include "calculator.h"
    	```
    4. 定义测试套(测试类)
	    ```
    	class CalculatorSubTest : public testing::Test {
    	public:
    	    static void SetUpTestCase(void);
    	    static void TearDownTestCase(void);
    	    void SetUp();
    	    void TearDown();
    	};
    
    	void CalculatorSubTest::SetUpTestCase(void)
    	{
    	    // input testsuit setup step,setup invoked before all testcases
    	}
    
    	void CalculatorSubTest::TearDownTestCase(void)
    	{
    	    // input testsuit teardown step,teardown invoked after all testcases
    	}
    
    	void CalculatorSubTest::SetUp(void)
    	{
    	    // input testcase setup step,setup invoked before each testcases
    	}
    
    	void CalculatorSubTest::TearDown(void)
    	{
    	    // input testcase teardown step,teardown invoked after each testcases
    	}
    	```
	    > **注意:** 在定义测试套时,测试套名称应与编译目标保持一致,采用大驼峰风格。

    5. 测试用例实现,包含用例注释和逻辑实现
	    ```
    	/**
    	 * @tc.name: integer_sub_001
    	 * @tc.desc: Verify the sub function.
    	 * @tc.type: FUNC
    	 * @tc.require: Issue Number
    	 */
    	HWTEST_F(CalculatorSubTest, integer_sub_001, TestSize.Level1)
    	{
    	    //step 1:调用函数获取结果
    	    int actual = Sub(4,0);

    	    //Step 2:使用断言比较预期与实际结果
    	    EXPECT_EQ(4, actual);
    	}
    	```
	    在编写用例时,我们提供了三种用例模板供您选择。
	
	    |      类型 |    描述 |
    	| ------------| ------------|
    	| HWTEST(A,B,C)| 用例执行不依赖Setup&Teardown时,可选取|
    	| HWTEST_F(A,B,C)| 用例执行(不含参数)依赖于Setup&Teardown时,可选取|
    	| HWTEST_P(A,B,C)| 用例执行(含参数)依赖于Set&Teardown时,可选取|

	    其中,参数A,B,C的含义如下:
	- 参数A为测试套名。
	- 参数B为测试用例名,其命名必须遵循[功能点]_[编号]的格式,编号为3位数字,从001开始。
	- 参数C为测试用例等级,具体分为门禁level0 以及非门禁level1-level4共五个等级,其中非门禁level1-level4等级的具体选取规则为:测试用例功能越重要,level等级越低。

	    **注意:**
	- 测试用例的预期结果必须有对应的断言。
	- 测试用例必须填写用例等级。
	- 测试体建议按照模板分步实现。
	- 用例描述信息按照标准格式@tc.xxx value书写,注释信息必须包含用例名称,用例类型,需求编号四项。其中用例测试类型@tc.type参数的选取,可参考下表。

S
stivn 已提交
237 238 239 240 241 242 243
	    | 测试类型名称|类型编码|
    	| ------------|------------|
    	|功能测试      |FUNC|
        |性能测试      |PERF|
        |可靠性测试    |RELI|
        |安全测试      |SECU|
        |模糊测试      |FUZZ|
S
stivn 已提交
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    

**JavaScript参考示例**

- 用例源文件命名规范

    测试用例原文件名称采用大驼峰风格,以TEST结尾,具体格式为:[功能][子功能]TEST,子功能支持向下细分。
示例:
    ```
    AppInfoTest.js
    ```

- 用例示例
    ```
    /*
     * Copyright (C) 2021 XXXX Device Co., Ltd.
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    import app from '@system.app'
    
    import {describe, beforeAll, beforeEach, afterEach, afterAll, it, expect} from 'deccjsunit/index'
    
    describe("AppInfoTest", function () {
        beforeAll(function() {
            // input testsuit setup step,setup invoked before all testcases
             console.info('beforeAll caled')
        })
        
        afterAll(function() {
             // input testsuit teardown step,teardown invoked after all testcases
             console.info('afterAll caled')
        })
        
        beforeEach(function() {
            // input testcase setup step,setup invoked before each testcases
             console.info('beforeEach caled')
        })
        
        afterEach(function() {
            // input testcase teardown step,teardown invoked after each testcases
             console.info('afterEach caled')
        })
    
        /*
         * @tc.name:appInfoTest001
         * @tc.desc:verify app info is not null
         * @tc.type: FUNC
         * @tc.require: Issue Number
         */
        it("appInfoTest001", 0, function () {
            //step 1:调用函数获取结果
            var info = app.getInfo()

            //Step 2:使用断言比较预期与实际结果
            expect(info != null).assertEqual(true)
        })
    })
    ```
    详细内容介绍:
    1. 添加测试用例文件头注释信息
	    ```
    	/*
    	 * Copyright (C) 2021 XXXX Device Co., Ltd.
    	 * Licensed under the Apache License, Version 2.0 (the "License");
    	 * you may not use this file except in compliance with the License.
    	 * You may obtain a copy of the License at
    	 *
    	 *     http://www.apache.org/licenses/LICENSE-2.0
    	 *
    	 * Unless required by applicable law or agreed to in writing, software
    	 * distributed under the License is distributed on an "AS IS" BASIS,
    	 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    	 * See the License for the specific language governing permissions and
    	 * limitations under the License.
    	 */
    	```
    2. 导入被测api和jsunit测试库
	    ```
    	import app from '@system.app'
    
    	import {describe, beforeAll, beforeEach, afterEach, afterAll, it, expect} from 'deccjsunit/index'
    	```
    3. 定义测试套(测试类)
	    ```
    	describe("AppInfoTest", function () {
    	    beforeAll(function() {
    	        // input testsuit setup step,setup invoked before all testcases
    	         console.info('beforeAll caled')
    	    })
    	    
    	    afterAll(function() {
    	         // input testsuit teardown step,teardown invoked after all testcases
    	         console.info('afterAll caled')
    	    })
    	    
    	    beforeEach(function() {
    	        // input testcase setup step,setup invoked before each testcases
    	         console.info('beforeEach caled')
    	    })
    	    
    	    afterEach(function() {
    	        // input testcase teardown step,teardown invoked after each testcases
    	         console.info('afterEach caled')
    	    })
    	```
    4. 测试用例实现
	    ```
    	/*
    	 * @tc.name:appInfoTest001
    	 * @tc.desc:verify app info is not null
    	 * @tc.type: FUNC
    	 * @tc.require: Issue Number
    	 */
    	 it("appInfoTest001", 0, function () {
    	    //step 1:调用函数获取结果
            var info = app.getInfo()

            //Step 2:使用断言比较预期与实际结果
            expect(info != null).assertEqual(true)
    	 })
    	```

### 测试用例编译文件编写
根据测试用例目录规划,当执行某一用例时,测试框架会根据编译文件逐层查找,最终找到所需用例进行编译。下面通过不同示例来讲解gn文件如何编写。

#### 测试用例编译配置文件
针对不同语言,下面提供不同的编译模板以供参考。

- **C++用例编译配置示例**
    ```
    # Copyright (c) 2021 XXXX Device Co., Ltd.
    
    import("//build/test.gni")
    
    module_output_path = "subsystem_examples/calculator"
    
    config("module_private_config") {
      visibility = [ ":*" ]
    
      include_dirs = [ "../../../include" ]
    }
    
    ohos_unittest("CalculatorSubTest") {
      module_out_path = module_output_path
    
      sources = [
        "../../../include/calculator.h",
        "../../../src/calculator.cpp",
      ]
    
      sources += [ "calculator_sub_test.cpp" ]
    
      configs = [ ":module_private_config" ]
    
      deps = [ "//third_party/googletest:gtest_main" ]
    }
    
    group("unittest") {
      testonly = true
      deps = [":CalculatorSubTest"]
    }
    ```
    详细内容如下:

    1. 添加文件头注释信息
	    ```
    	# Copyright (c) 2021 XXXX Device Co., Ltd.
    	```
    2. 导入编译模板文件
	    ```
    	import("//build/test.gni")
    	```
    3. 指定文件输出路径
    	```
    	module_output_path = "subsystem_examples/calculator"
    	```
    	> **说明:** 此处输出路径为部件/模块名。
    
    4. 配置依赖包含目录
    
    	```
    	config("module_private_config") {
    	  visibility = [ ":*" ]
    	   
    	  include_dirs = [ "../../../include" ]
    	}
    	```
    	> **说明:** 一般在此处对相关配置进行设置,在测试用例编译脚本中可直接引用。
    
    5. 指定测试用例编译目标输出的文件名称
    
    	```
    	ohos_unittest("CalculatorSubTest") {
    	}
    	```
    6. 编写具体的测试用例编译脚本(添加需要参与编译的源文件、配置和依赖)
    	```
    	ohos_unittest("CalculatorSubTest") {
    	  module_out_path = module_output_path
    	  sources = [
    	    "../../../include/calculator.h",
    	    "../../../src/calculator.cpp",
    	    "../../../test/calculator_sub_test.cpp"
    	  ]
    	  sources += [ "calculator_sub_test.cpp" ]
    	  configs = [ ":module_private_config" ]
    	  deps = [ "//third_party/googletest:gtest_main" ]
    	}
    	```

	    > **说明:根据测试类型的不同,在具体编写过程中可选择不同的测试类型:**
    	> - ohos_unittest:单元测试
    	> - ohos_moduletest:模块测试
    	> - ohos_systemtest:系统测试
    	> - ohos_performancetest:性能测试
    	> - ohos_securitytest:安全测试
    	> - ohos_reliabilitytest:可靠性测试
    	> - ohos_distributedtest:分布式测试

    7. 对目标测试用例文件进行条件分组
    
    	```
    	group("unittest") {
    	  testonly = true
    	  deps = [":CalculatorSubTest"]
    	}
    	```
    	> **说明:** 进行条件分组的目的在于执行用例时可以选择性的执行某一种特定类型的用例。
    
- **JavaScript用例编译配置示例**

    ```
    # Copyright (C) 2021 XXXX Device Co., Ltd.
    
    import("//build/test.gni")
    
    module_output_path = "subsystem_examples/app_info"
    
    ohos_js_unittest("GetAppInfoJsTest") {
      module_out_path = module_output_path
    
      hap_profile = "./config.json"
      certificate_profile = "//test/developertest/signature/openharmony_sx.p7b"
    }
    
    group("unittest") {
      testonly = true
      deps = [ ":GetAppInfoJsTest" ]
    }
    ```

    详细内容如下:

    1. 添加文件头注释信息
    
    	```
    	# Copyright (C) 2021 XXXX Device Co., Ltd.
    	```
    2. 导入编译模板文件
    
    	```
    	import("//build/test.gni")
    	```
    3. 指定文件输出路径
    
    	```
    	module_output_path = "subsystem_examples/app_info"
    	```
    	> **说明:** 此处输出路径为部件/模块名。
    	
    4. 指定测试用例编译目标输出的文件名称
    
    	```
    	ohos_js_unittest("GetAppInfoJsTest") {
    	}
    	```
    	> **说明:**
    	>- 使用模板ohos_js_unittest定义js测试套,注意与C++用例区分。
    	>- js测试套编译输出文件为hap类型,hap名为此处定义的测试套名,测试套名称必须以JsTest结尾。
    
    5. 指定hap包配置文件config.json和签名文件,两个配置为必选项
    
    	```
    	ohos_js_unittest("GetAppInfoJsTest") {
    	  module_out_path = module_output_path
    	   
    	  hap_profile = "./config.json"
    	  certificate_profile = "//test/developertest/signature/openharmony_sx.p7b"
    	}
    	```
    	 config.json为hap编译所需配置文件,需要开发者根据被测sdk版本配置“target”项,其余项可默认,具体如下所示:
    
    	```
    	{
    	  "app": {
    	    "bundleName": "com.example.myapplication",
    	    "vendor": "example",
    	    "version": {
    	      "code": 1,
    	      "name": "1.0"
    	    },
    	    "apiVersion": {
    	           "compatible": 4,
    	         "target": 5     // 根据被测sdk版本进行修改,此例为sdk5
    	    }
    	  },
    	  "deviceConfig": {},
    	  "module": {
    	    "package": "com.example.myapplication",
    	    "name": ".MyApplication",
    	    "deviceType": [
    	      "phone"
    	    ],
    	    "distro": {
    	      "deliveryWithInstall": true,
    	      "moduleName": "entry",
    	      "moduleType": "entry"
    	    },
    	    "abilities": [
    	      {
    	      "skills": [
    	          {
    	            "entities": [
    	              "entity.system.home"
    	            ],
    	            "actions": [
    	              "action.system.home"
    	            ]
    	          }
    	        ],
    	        "name": "com.example.myapplication.MainAbility",
    	        "icon": "$media:icon",
    	        "description": "$string:mainability_description",
    	        "label": "MyApplication",
    	        "type": "page",
    	        "launchType": "standard"
    	      }
    	    ],
    	    "js": [
    	      {
    	        "pages": [
    	          "pages/index/index"
    	        ],
    	        "name": "default",
    	          "window": {
    	             "designWidth": 720,
    	             "autoDesignWidth": false
    	          }
    	        }
    	      ]
    	    }
    	  }
    	```
    6. 对目标测试用例文件进行条件分组
    	```
    	group("unittest") {
    	  testonly = true
    	  deps = [ ":GetAppInfoJsTest" ]
    	}
    	```
    	> **说明:** 进行条件分组的目的在于执行用例时可以选择性的执行某一种特定类型的用例。
      
#### 编译入口配置文件ohos.build
    
当完成用例编译配置文件编写后,需要进一步编写部件编译配置文件,以关联到具体的测试用例。
```
"partA": {
    "module_list": [
          
    ],
    "inner_list": [
          
    ],
    "system_kits": [
          
    ],
    "test_list": [
      "//system/subsystem/partA/calculator/test:unittest"  //配置模块calculator下的test
    ]
 }
```
> **说明:** test_list中配置的是对应模块的测试用例。

### 测试用例资源配置
测试依赖资源主要包括测试用例在执行过程中需要的图片文件,视频文件、第三方库等对外的文件资源。

依赖资源文件配置步骤如下:
S
stivn 已提交
641
1. 在部件的test目录下创建resource目录,在resource目录下创建对应的模块,在模块目录中存放该模块所需要的资源文件
S
stivn 已提交
642

S
stivn 已提交
643
2. 在resource目录下对应的模块目录中创建一个ohos_test.xml文件,文件内容格式如下:
S
stivn 已提交
644 645 646 647 648 649 650 651 652 653 654 655 656 657
	```
	<?xml version="1.0" encoding="UTF-8"?>
	<configuration ver="2.0">
	    <target name="CalculatorSubTest">
	        <preparer>
	            <option name="push" value="test.jpg -> /data/test/resource" src="res"/>
	            <option name="push" value="libc++.z.so -> /data/test/resource" src="out"/>
	        </preparer>
	    </target>
	</configuration>
	```
3. 在测试用例的编译配置文件中定义resource_config_file进行指引,用来指定对应的资源文件ohos_test.xml
	```
	ohos_unittest("CalculatorSubTest") {
S
stivn 已提交
658
	  resource_config_file = "//system/subsystem/partA/test/resource/calculator/ohos_test.xml"
S
stivn 已提交
659 660 661 662
	}
	```
	>**说明:**
	>- target_name: 测试套的名称,定义在测试目录的BUILD.gn中。preparer: 表示该测试套执行前执行的动作。
S
stivn 已提交
663
	>- src="res": 表示测试资源位于test目录下的resource目录下,src="out":表示位于out/release/$(部件)目录下。
S
stivn 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714

## 测试用例执行
在执行测试用例之前,针对用例使用设备的不同,需要对相应配置进行修改,修改完成即可执行测试用例。

### user_config.xml配置
```
<user_config>
  <build>
    <!-- 是否编译demo用例, 默认为false,如果需要编译demo可修改为true -->
    <example>false</example>
    <!-- 是否编译版本, 默认为false -->
    <version>false</version>
    <!-- 是否编译测试用例, 默认为true,若已完成编译,再执行用例之前可修改为false,防止重新编译 -->
    <testcase>true</testcase>
  </build>
  <environment>
    <!-- 配置远程映射机器的IP及端口,以支持HDC连接的设备 -->
    <device type="usb-hdc">
      <ip></ip>
      <port></port>
      <sn></sn>
    </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>
  </environment>
  <!-- 配置测试用例路径,若测试用例未编译,即<testcase>标签属性为true时,此处默认不填写;若编译已完成,需在此处指定测试用例的实际路径 -->
  <test_cases>
    <dir></dir>
  </test_cases>
  <!-- 配置覆盖率编译路径 -->
  <coverage>
    <outpath></outpath>
  </coverage>
  <!-- NFS挂载信息配置,被测设备仅支持串口连接时配置,指定NFS的映射路径,host_dir为PC侧的NFS目录,board_dir为板侧创建的目录 -->
  <NFS>
    <host_dir></host_dir>
    <mnt_cmd></mnt_cmd>
    <board_dir></board_dir>
  </NFS>
</user_config>
```
>**说明:** 在执行测试用例之前,若使用HDC连接设备,用例仅需配置设备IP和端口号即可,其余信息均默认不修改。
N
NEEN 已提交
715

S
stivn 已提交
716 717
### Windows环境执行
#### 测试用例编译
N
NEEN 已提交
718

S
stivn 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
由于Windows环境下无法实现用例编译,因此执行用例前需要在Linux环境下进行用例编译,用例编译命令:
```
./build.sh --product-name Hi3516DV300 --build-target make_test
```
编译完成后,测试用例将自动保存在out/ohos-arm-release/packages/phone/images/tests目录下。

>说明: Hi3516DV300为当前版本所支持的平台,make_test表示全部用例。根据不同需求,编译选项可进行不同选择:
> -  --product-name   # 编译产品名称(必选)
> - --build-target   # 指定编译目标(可选)

#### 搭建执行环境
1. 在Windows环境创建测试框架目录Test,并在此目录下创建testcase目录

2. 从Linux环境拷贝测试框架developertest和xdevice到创建的Test目录下,拷贝编译好的测试用例到testcase目录下
	>**说明:** 将测试框架及测试用例从Linux环境移植到Windows环境,以便后续执行。

3. 修改user_config.xml
	```
	<build>
	  <!-- 由于测试用例已编译完成,此标签属性需改为false -->
	  <testcase>false</testcase>
	</build>
	<test_cases>
	  <!-- 由于已将测试用例拷贝到Windows环境下,测试用例输出路径发生改变,需要修改为拷贝后所存放的路径 -->
	  <dir>D:\Test\testcase\tests</dir>
	</test_cases>
	```
	>**说明:** `<testcase>`标签表示是否需要编译用例;`<dir>`标签表示测试用例查找路径。

#### 执行用例
1. 启动测试框架
	```
	start.bat
	```
2. 选择产品形态

    进入测试框架,系统会自动提示您选择产品形态,请根据实际的开发板进行选择。例如:Hi3516DV300。

3. 执行测试用例

    当选择完产品形态,可参考如下指令执行测试用例。
	```
	run -t UT -ts CalculatorSubTest -tc interger_sub_00l
	```
	执行命令参数说明:
	```
	-t [TESTTYPE]: 指定测试用例类型,有UT,MST,ST,PERF等。(必选参数)
S
stivn 已提交
766 767 768 769
	-tp [TESTPART]: 指定部件,可独立使用。
	-tm [TESTMODULE]: 指定模块,不可独立使用,需结合-tp指定上级部件使用。
	-ts [TESTSUITE]: 指定测试套,可独立使用。
	-tc [TESTCASE]: 指定测试用例,不可独立使用,需结合-ts指定上级测试套使用。
S
stivn 已提交
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
	-h : 帮助命令。
	```
### Linux环境执行
#### 远程端口映射
为了在Linux远程服务器以及Linux虚拟机两种环境下执行测试用例,需要对端口进行远程映射,以实现与设备的数据通路连接。具体操作如下:
1. HDC Server指令:
	```
	hdc_std kill
	hdc_std -m -s 0.0.0.0:8710
	```
	>**说明:** IP和端口号为默认值。

2. HDC Client指令:
	```
	hdc_std -s xx.xx.xx.xx:8710 list targets
	```
	>**说明:** 此处IP填写设备侧IP地址。

#### 执行用例
1. 启动测试框架
	```
	./start.sh
	```
2. 选择产品形态

    进入测试框架,系统会自动提示您选择产品形态,请根据实际的开发板进行选择。例如:Hi3516DV300。

3. 执行测试用例

    测试框架在执行用例时会根据指令找到所需用例,自动实现用例编译,执行过程,完成自动化测试。
	```
	run -t UT -ts CalculatorSubTest -tc interger_sub_00l
	```
	执行命令参数说明:
	```
	-t [TESTTYPE]: 指定测试用例类型,有UT,MST,ST,PERF等。(必选参数)
S
stivn 已提交
806 807 808 809
	-tp [TESTPART]: 指定部件,可独立使用。
	-tm [TESTMODULE]: 指定模块,不可独立使用,需结合-tp指定上级部件使用。
	-ts [TESTSUITE]: 指定测试套,可独立使用。
	-tc [TESTCASE]: 指定测试用例,不可独立使用,需结合-ts指定上级测试套使用。
S
stivn 已提交
810 811 812 813 814 815 816 817 818 819 820 821
	-h : 帮助命令。
	```

## 测试报告日志
当执行完测试指令,控制台会自动生成测试结果,若需要详细测试报告您可在相应的数据文档中进行查找。

### 测试结果
测试结果输出根路径如下:
```
test/developertest/reports/xxxx_xx_xx_xx_xx_xx
```
>**说明:** 测试报告文件目录将自动生成。
N
NEEN 已提交
822

S
stivn 已提交
823 824 825 826 827 828 829
该目录中包含以下几类结果:
| 类型 | 描述|
| ------------ | ------------ |
| result/ |测试用例格式化结果|
| log/plan_log_xxxx_xx_xx_xx_xx_xx.log | 测试用例日志 |
| summary_report.html | 测试报告汇总 |
| details_report.html | 测试报告详情 |
N
NEEN 已提交
830

S
stivn 已提交
831 832 833 834
### 测试框架日志
```
reports/platform_log_xxxx_xx_xx_xx_xx_xx.log
```
N
NEEN 已提交
835

S
stivn 已提交
836 837 838 839
### 最新测试报告
```
reports/latest
```
N
NEEN 已提交
840

S
stivn 已提交
841
## 涉及仓
N
NEEN 已提交
842

S
stivn 已提交
843
[test\_xdevice](https://gitee.com/openharmony/test_xdevice/blob/master/README_zh.md)
N
NEEN 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

























M
mamingshuai 已提交
869 870


N
NEEN 已提交
871