README_ZH.md
1# NAPI框架生成工具story测试
2
3## 概述
4为了将一个大的特性划分成小颗粒度的功能块，根据功能点确定输入和输出以便获得快速反馈。需要编写story测试对功能进行用例验证。
5本文主要介绍NAPI框架代码生成工具story功能测试使用指导。
6
7## 目录
8
9 ├── napi_generator # NAPI框架代码生成工具
10 │ ├── ... # 其他文件夹
11 │ ├── test # 测试用例
12 │ | ├── ... # 其他文件夹
13 │ | ├── storytest # story测试代码
14 │ | | ├── test_$ # ts文件输入以$开头的函数测试用例
15 │ | | ├── test_[] # ts文件输入[]格式数组测试用例
16 │ | | ├── test_any # ts文件输入any测试用例
17 │ | | ├── test_any[] # ts文件输入any数组测试用例
18 │ | | ├── test_array # ts文件输入array<>格式数组测试用例
19 │ | | ├── test_test_array_map # ts文件输入map数组测试用例
20 │ | | ├── test_bool # ts文件输入boolean测试用例
21 │ | | ├── test_callback # ts文件输入callback测试用例
22 │ | | ├── test_direct # 同步直接返回函数用例
23 │ | | ├── test_enum # ts文件输入enum测试用例
24 │ | | ├── test_enum_interface # ts文件输入interface嵌套enum测试用例
25 │ | | ├── test_enum_js # ts文件输入enum测试用例
26 │ | | ├── test_extends # ts文件输入继承测试用例
27 │ | | ├── test_interface # ts文件输入interface测试用例
28 │ | | ├── test_import # ts文件输入import测试用例
29 │ | | ├── test_interface_no_name # ts文件输入interface测试用例
30 │ | | ├── test_map # ts文件输入map测试用例
31 │ | | ├── test_namespace # ts文件输入namespace测试用例
32 │ | | ├── test_number # ts文件输入number测试用例
33 │ | | ├── test_object # ts文件输入object测试用例
34 │ | | ├── test_static # ts文件输入static的函数测试用例
35 │ | | ├── test_optional # ts文件输入可选参数的函数测试用例
36 │ | | ├── test_promise # ts文件输入promise的函数测试用例
37 │ | | ├── test_string # ts文件输入string测试用例
38 │ | | ├── test_union # ts文件输入联合参数测试用例
39 │ | | ├── basic.d.ts # 基础函数模板
40 │ | | ├── README_ZH.md # 测试用例使用指导
41 │ | | └── test.py # 用例执行脚本
42
43## 软件环境准备
44
45系统：建议Ubuntu 20.04
46
47依赖版本：python3.8
48
49步骤一：
50
51napi_generator目录下安装以下依赖：
52
531.下载node_modules包。
54
55 npm i
56
572.标准输入输出函数的头文件。
58
59 npm i stdio
60
613.将源码形式的node modules编译成适应于本地环境的、编译好的node modules。
62
63 npm i node-gyp
64
65步骤二：
66
67napi_generator/src目录下安装以下依赖：
68
691.下载node_modules包。
70
71 npm i
72
732.标准输入输出函数的头文件。
74
75 npm i stdio
76
773.将源码形式的node modules编译成适应于本地环境的、编译好的node modules。
78
79 npm i node-gyp
80
81## 使用说明
82
83进入napi_generator/目录。
84
851.执行所有用例，命令为：
86
87 python test/storytest/test.py
88
892.执行单个用例,如test_interface，命令为：
90
91 python test/storytest/test.py test_interface
92
93## 查看结果
94
95红色：用例执行失败，代表修改的代码有bug或者用例的输出发生变化，需要修复bug或修改用例。
96
97绿色：用例执行成功。
98
99## 相关仓
100
101暂无
102