From db188cd7ba4595942096d43c288a2f0b788641a8 Mon Sep 17 00:00:00 2001 From: mikigo Date: Thu, 13 Jun 2024 14:40:20 +0800 Subject: [PATCH] fix: update Description: Log: --- docs/.vitepress/config.mts | 23 +++--- ...13\350\257\225\345\245\227\344\273\266.md" | 82 +++++++++++++++++++ ...76\350\256\241\350\247\204\345\210\222.md" | 2 +- 3 files changed, 95 insertions(+), 12 deletions(-) create mode 100644 "docs/\350\256\276\350\256\241/UOS\347\263\273\347\273\237\346\265\213\350\257\225\345\245\227\344\273\266.md" diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 6e826e7..252ce96 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -32,17 +32,18 @@ export default withMermaid( {text: '设计', link: '/设计/YouQu3架构设计规划'}, ], - // sidebar: { - // "/设计/": [ - // { - // text: "框架设计", - // collapsed: false, - // items: [ - // {text: "YouQu3架构设计规划", link: "/设计/YouQu3架构设计规划"}, - // ] - // }, - // ], - // }, + sidebar: { + "/设计/": [ + { + text: "框架设计", + collapsed: false, + items: [ + {text: "YouQu3架构设计规划", link: "/设计/YouQu3架构设计规划"}, + {text: "UOS系统测试套件", link: "/设计/UOS系统测试套件"}, + ] + }, + ], + }, search: { provider: 'local' }, diff --git "a/docs/\350\256\276\350\256\241/UOS\347\263\273\347\273\237\346\265\213\350\257\225\345\245\227\344\273\266.md" "b/docs/\350\256\276\350\256\241/UOS\347\263\273\347\273\237\346\265\213\350\257\225\345\245\227\344\273\266.md" new file mode 100644 index 0000000..2de0bf1 --- /dev/null +++ "b/docs/\350\256\276\350\256\241/UOS\347\263\273\347\273\237\346\265\213\350\257\225\345\245\227\344\273\266.md" @@ -0,0 +1,82 @@ +--- +Author : mikigo +--- + +# UOS 系统测试套件（UMTK） + +## 1. 简介 + +UOS 系统测试套件（全称：UOS 系统自动化测试操作方法套件，以下简称测试套件）是基于 YouQu3 封装的 UOS 操作系统预装应用的元素操作方法套件。 + +测试套件是一个独立项目，旨在提供系统预装应用所有的元素的操作方法，这些元素操作方法可以用于自动化用例调用，组装成自动化测试用例。 + +## 2. 工程设计 + +### 2.1. 工程结构 + +```shell +uos-method-toolkit +├── LICENSE +├── README.md +└── umtk + ├── dde_file_manager + │   ├── dde_file_manager_method.py + │   └── __init__.py + ├── deepin_music + │   ├── deepin_music_method.py + │   └── __init__.py + ├── deepin_movie + │   ├── deepin_music_method.py + ... ... + └── __init__.py +``` + +### 2.2. 方案说明 + +- 系统中各应用划分自己的模块，模块名称为应用包名，下划线连接单词。 + +- 每个应用存在一个唯一的出口文件，供外部用例调用。 + + ```python + from umtk.dde_file_manager import DdeFileManagerMethod + ``` + + `DdeFileManagerMethod` 可以调用 `dde-file-manager` 所有的元素操作方法。 + +- 所有方法以类的形式编写，遵循 PO 设计模式。 + +- 测试套件中所有的方法均为原子操作，不做复杂步骤的封装。 + +## 3. 套件的发布 + +- 套件分大版本发布，比如 V20、V25 是不同的测试套件版本，在不同的代码仓库中。 + +- 在同一个大版本中，套件持续保持更新，并在系统关键节点发布对应的版本； + + 比如 V20 阶段，1070 发布一个套件版本，1071 发布一个套件版本，一次类推，过程中如果根据需要出小版本。 + +- 套件通过 PyPI 发布，用户可直接通过 pip 命令安装使用： + + 安装： + + ```shell + pip install umtk + ``` + + 使用： + + ```python + from umtk.dde_file_manager import DdeFileManagerMethod + ``` + +## 4. 套件的维护 + +- 套件由专人主责维护（maintainer），其他人可以提需求或 issue，以保持套件的各方面一致性。 + +- 鼓励内外部开发者贡献 PR。 + +## 5. 对套件的测试 + +套件里面保存元素的操作方法，在操作方法多了之后，维护方法的稳定性有效性将成为一个问题。 + +因此，我们需要建立对套件的自动化测试，专门针对元素操作方法函数进行测试。 \ No newline at end of file diff --git "a/docs/\350\256\276\350\256\241/YouQu3\346\236\266\346\236\204\350\256\276\350\256\241\350\247\204\345\210\222.md" "b/docs/\350\256\276\350\256\241/YouQu3\346\236\266\346\236\204\350\256\276\350\256\241\350\247\204\345\210\222.md" index 773931b..2f60700 100644 --- "a/docs/\350\256\276\350\256\241/YouQu3\346\236\266\346\236\204\350\256\276\350\256\241\350\247\204\345\210\222.md" +++ "b/docs/\350\256\276\350\256\241/YouQu3\346\236\266\346\236\204\350\256\276\350\256\241\350\247\204\345\210\222.md" @@ -117,10 +117,10 @@ autotest-my-case # 用例工程名称 │   ├── image_res # 图像识别方法所需要的资源 │   ├── base_method.py # 方法基类 │   ├── my_case_method.py # 方法唯一出口类 +│   ├── assert_method.py # 断言方法类 │   ├── other_method.py # 其他方法类 │   ├── other.ini # 其他应用的基于相对位移元素定位方案的配置文件 │   └── ui.ini # 相对位移元素定位方案的配置文件 -├── my_case_assert.py # 断言方法类 ├── config.py # 配置模块，提供可调用的配置对象config ├── conftest.py # Pytest Fixture 插件库 ├── mycase.csv # 用例标签管理文件