yjc930214 / sweetest

小而美的自动化测试解决方案，支持 Web UI 测试，Http 接口测试，DB 操作测试，App 测试，小程序测试

sweetest

🔥 iOS 测试支持目前处于开发阶段，详细情况请关注微信公众号 🔥

微信公众号：安装、配置、使用的详细图文说明，最新版本发布更新说明

QQ 交流群：158755338 (验证码：python)

扫描公众号及QQ群二维码加入我们

介绍

Sweetest 是一款小而美的自动化测试解决方案，同时支持 Web UI，Http 接口，DB 操作测试，Android App 测试，小程序测试；由于开始只支持 Web UI 测试，名字取自 Selenium，Web UI，Excel，Element， Test 含义。 特点:

1. 简单快速，轻松上手
2. 无需编码能力
3. 在 Excel 中以文本编写测试用例
4. 维护成本低
5. 支持千、万级别的用例规模
6. 拥抱变化，支持敏捷

背景

目前，自动化测试基本上是以 Selenium/Appium 等库为接口来编写测试代码，但效果往往不是很好，普遍遇到如下问题：

1. 用例设计人员的编码能力很弱，测试代码编写和维护成本高，效果差；
2. 测试代码量大，测试意图不直观，无法支撑千、万级别的用例规模；
3. 页面元素的定位非常繁琐，且页面结构经常变动，导致用例失效。

为了解决以上问题，使自动化测试更简单、可靠、容易落地，我们设计了此自动化测试框架，自动化测试用例和传统的手工测试用例一样在 Excel 中用文本编写。 同时我们的元素定位也设计的非常精巧，结合“变量定位法”，可以让页面自由的去变化，而我们的定位只做最小适用。

实现思路

1. Selenium 为底层接口；
2. 在 Excel 中用文本编写测试用例；
3. 元素定位表格化，且优先使用“变量定位法”；
4. 框架负责解析测试用例，执行用例，记录日志，输出测试结果。

方案

1. 开发语言：Python
2. 底层接口：Selenium
3. 用例工具：Excel

测试用例如下图：

安装

环境要求

• 系统要求：Windows
• Python 版本：3.6+
• 浏览器：Chrome
• Chrome 驱动: chromedriver (需和 Chrome 版本匹配，并配置环境变量，参考这里配置)

安装 sweetest

pip install sweetest

升级 sweetest

pip install -U sweetest

快速体验

打开 cmd 命令窗口，切换到某个目录，如：D:\Autotest

sweetest
cd sweetest_example
python start.py

OK，如果一切顺利的话，sweetest 已经跑起来了

目录结构

目录	说明
data\	测试数据目录
\Baidu-baidu.csv	测试数据文件，名称格式：project_name + '-' + sheet_name +".csv"
element\	页面元素表目录
\Baidu-Elements.xlsx	页面元素表，名称格式：project_name + "-Elements.xlsx"
junit\	junit格式测试结果目录
log\	自动化测试运行日志目录
report\	Excel 格式测试结果目录
snapshot\	错误截图目录
testcase\	测试用例目录
\Baidu-TestCase.xlsx	测试用例，名称格式：project_name + "-TestCase.xlsx"
start.py	启动脚本，test = Autotest(project_name, sheet_name)

备注：以上3处的 project_name 必须一致

页面元素表

页面元素表的作用主要是把元素定位独立出来，一是方便维护定位信息，二是测试用例中用元素名称书写，可读性更高。

字段	注释
page	element 所在的页面，在所有页面都可用的 element 放在“通用”下面，如 title
element	element 名称，在不同的 page 下面可以同名
by	Selenium 定位方式
value	Selenium 定位的值
custom	自定义字段，如 element 在 frame/iframe 中，则在此填写 frame id/name
备注	注释作用

元素定位

1. id, link_text, partial_link_text, xpath, class_name

如：

page	element	by	value
百度搜索页面	搜索框	id	kw

则自动化运行时会以 find_element_by_id('kw') 来定位

2. 带变量的定位方式

如示例中：

page	element	by	value
百度搜索页面	搜索结果#	xpath	//*[@id="#"]/h3/a

写用例时，需要在 搜索结果# 后面带上变量，如： 搜索结果#1

操作	页面	元素
点击	百度搜索页面	搜索结果#1

则自动化运行时会以 find_element_by_xpath('//*[@id="1"]/h3/a') 来定位

已定义好的常用变量定位方式：

• id#
• link#
• *link#
• xpath#
• class#
• name#
• div#
• input#
• button#
• table#
• url#

如：url#www.baidu.com

当然，如果#后面的变量不够直观的话，不建议太多使用这几个变量方式。

3. 页面title

页面的 title

4. 页面url

页面的 url

5. 通用

一般来讲，导航栏在所有页面都存在，应该把导航栏放在“通用”下面，做成变量定位方式，如示例中的：

page	element	by	value
通用	搜索页导航栏#	xpath	//*[@class="s_tab"]//a[text()="#"]

用例中的写法：

操作	页面	元素
点击	通用	搜索页导航栏#新闻

注意：链接必须放在通用下面

page	element	by	value
通用	百度搜索链接	url	https://www.baidu.com/

测试用例

用例字段

必填字段：

• 用例编号
• 测试步骤
• 操作
• 页面
• 元素

前置条件：

• BASE： 整个测试套件的基础，必须通过才会执行下一步，如：登录；如果有的话应该为第一个测试用例。
• SETUP：每个测试用例执行前需要执行的用例，只有 SETUP 执行成功才会执行该用例，如：返回首页。
• MAIN：一组用例的第一用例，和 SUB 一起使用，一个 MAIN 后面可以带多个连续的 SUB 用例。此用例需要先执行 SETUP 用例。
• SUB：和 MAIN 一起使用，当前一个用例(MAIN or SUB)执行结果为通过时才会执行，否则测试结果置为 Blocked；且执行此用例前不会执行 SETUP 用例。
• SKIP: 该用例跳过 SETUP 执行。
• SNIPPET：用例片段，运行到此用例时不会立即执行，需要在其他用例中使用“执行”关键字调用此“用例片段”，才会执行；配合“执行”关键字的变量赋值功能，可以实现用例复用。

注意事项：

• 一般必须有 SETUP 用例。当执行 SETUP 失败，会尝试执行一次 BASE->SETUP 作为 SETUP 的执行结果。
• BASE 用例可以有 0 到多个，但作为 SETUP 中 BASE->SETUP 的 BASE 只有最后一个 BASE 用例。
• SETUP 用例只能有 1 条，如果写了多条，只有最后一条起作用。

操作(关键字)及对应的测试数据：

1. 打开

即 get 方法，打开一个链接。

打开操作，一般要在测试数据中指定新标签页名称，如：标签页名=百度搜索窗口。

操作	页面	元素	测试数据
打开	通用	百度首页	标签页名=百度搜索窗口

如果需要清理缓存再打开，则在测试数据中写上：清理缓存=是

操作	页面	元素	测试数据
打开	通用	百度首页	标签页名=百度搜索窗口，清理缓存=是

注意：打开操作的页面必须是：通用，这也意味着在元素定义表中，链接必须定义在通用中。

2. 检查

取页面元素的值、属性和预期结果对比。

测试数据中如果没有写“k=v”的方式，则默认是取元素的 text。

• 检查 text：

操作	页面	元素	测试数据
检查	百度搜索页面	搜索按钮	百度一下

等价于

操作	页面	元素	测试数据
检查	百度搜索页面	搜索按钮	text=百度一下

• 检查属性：

操作	页面	元素	测试数据
检查	百度搜索页面	搜索框	name=wd

• “页面title”和“页面url”直接在测试数据中写预期结果即可。

操作	页面	元素	测试数据
检查	百度搜索页面	页面title	百度一下\，你就知道

注意：测试数据中，由于逗号(，or ,)是多个“k=v”的分隔符，所以如果 v 中有逗号，要用反斜杠(\)转义；但等号(=)无需转义。

3. 输入

在输入框中输入文本:

操作	页面	元素	测试数据
输入	百度搜索页	搜索框	搜狗

框架会先做 clear() 操作，以防止输入框中已有文本。 如果不信做 clear() 操作，需在测试数据中，加上：清除文本=否，如:

操作	页面	元素	测试数据
输入	百度搜索页	搜索框	搜狗，清除文本=否

测试数据列为要输入的内容。

按键操作，如：回车键

操作	页面	元素	测试数据
输入	百度搜索页	搜索框	<Keys.ENTER>

组合按键操作，如：ctrl+a，如下：

操作	页面	元素	测试数据
输入	百度搜索页	搜索框	<Keys.CONTROL\, 'a'>

这里的逗号前需要加反斜杠来转义。

文本+按键操作，如：Sweetest+回车

操作	页面	元素	测试数据
输入	百度搜索页	搜索框	text=Sweetest, text1=<Keys.ENTER>

4. 点击/右击/双击

点击按钮或者链接等(一切可点击操作的)元素，如：

操作	页面	元素
点击	百度搜索页面	搜索按钮

5. 移动到

有些页面元素，当鼠标移动到上面时，会弹出下拉菜单等。此操作同关键字“点击”类似。

6. 拖拽

把元素拖拽到另一个元素上

操作	页面	元素
拖拽	看板	测试任务 | 已完成阶段

7. 滑动

拖动元素在 x，y 方向上移动移动一段距离

操作	页面	元素	测试数据
拖拽	解锁界面	滑动条	x=500,y=100

7. 执行: 用例片段

即执行测试用例片段，支持在测试数据中给变量赋值，如我们有用例片段 SNIPPET_001，则测试用例 BAIDU_002 中，步骤1如下：

操作	页面	元素	测试数据
执行	用例片段	SNIPPET_001	keywords=搜狗

把变量 keyswords 赋值为“搜狗”，此步骤会执行用例片段 SNIPPET_001，其搜索的关键字为“搜狗”。

执行 关键字支持循环次数，只需要在元素列中，SNIPPET_ID*N，如：

操作	页面	元素	测试数据
执行	用例片段	SNIPPET_001*6

在循环执行过程中，如果用例片段执行失败，则直接退出。如果想某次循环失败后还继续执行，则只需要在N后加上一个*，如：

操作	页面	元素	测试数据
执行	用例片段	SNIPPET_001*6*

同时，循环执行还支持循环结束条件，值可取：成功 或 失败，即当用例片段执行 成功/失败 即跳出。循环结束条件 优先级高于循环次数，但是如果已经把循环次数执行完，还未触发 循环结束条件，循环也会结束。如下：

操作	页面	元素	测试数据
执行	用例片段	SNIPPET_001*6	循环结束条件=成功

8. 脚本

即：执行 js 脚本，js 脚本写在元素列

操作	页面	元素
脚本	通用	window.alert('这是一个测试Alert弹窗');

注意：如果需要在 frame 中执行脚本，需要在元素定义表中定义元素，并填写 custom，如：

• 元素定义表：

page	element	by	value	custom
首页	点击链接	js	$("a.xxx")[0].click())	frame1

• 用例：

操作	页面	元素
脚本	首页	点击链接

9. 对话框(Alert,confirm,prompt)

弹出对话框操作，支持如下几个操作：

• 确认
• 取消
• 关闭
• 输入

如：

操作	页面	元素	测试数据
对话框	通用	确认

操作	页面	元素	测试数据
对话框	通用	输入	hello world

注：输入操作，默认自动点击确认按钮

10. #检查

把检查结果反向。

11. 上传文件

需要安装 win32com

pip install pypiwin32

测试用例写法如下：

操作	页面	元素	测试数据
上传文件	通用	文件	file=D:\doc\test.txt

备注：

1. 测试数据中，“file=” 可以省略
2. 不支持路径中包含中文

测试数据：

测试数据支持模糊匹配，如下：

操作	页面	元素	测试数据
检查	通用	页面标题	*知乎

则，页面标题中含有“知乎”即为通过。注意星号(*)要写在开头。

输出数据：

在运行时，把元素的值或属性赋值给变量，此变量可以在之后的步骤中使用"<>"引用变量名。

操作	页面	元素	测试数据	输出数据
点击	百度搜索页面	搜索结果#1		title=text
检查	通用	页面标题	<title>

测试步骤：

除了控制语句符号外，测试步骤必须为数字，建议在 Excel 中设置为文本格式。

控制语句：

• if then else

测试步骤	操作	页面	元素	测试数据
^3	检查	通用	页面标题	*知乎
>4	点击	通用	link#登录
<5	点击	通用	link#注册机构号

^ 表示 if 语句

> 表示 then 语句

< 表示 else 语句

if(^) 语句为真时，执行 then(>) 语句，为否时执行 else(<) 语句。无论后面有没有 then 或者 else 语句，不影响后续步骤执行。

then 语句 或者 else 语句，当不被执行时，测试结果为 '-'，不影响测试用例结果和后续步骤执行。当执行时，和正常步骤一样，成功则继续，失败则该用例失败。

在if(^) 语句后，then(>) 或 else(<) 可以出现0次或多次，框架按步骤顺序进行判断执行。

进阶

等待时间

有些页面可能会加载比较慢，需要显式的指明等待时间，则直接在测试数据写上：等待时间=N ，指定在执行此步骤之前，先等待 N 秒，如下：

操作	页面	元素	测试数据
检查	百度搜索页面	搜索按钮	text=百度一下，等待时间=3

变量、运行时变量及测试数据文件：

1. 变量

在 操作(关键字)及对应的测试数据 -> 执行 章节里我们讲的 keyswords=搜狗 就是变量赋值。

2. 运行时变量

当某一变量是在测试执行时才能获取到，并在获取之后的步骤中才能使用的变量，我们叫运行时变量。在 输出数据 章节里的 title=text 就是运行时变量。

3. 测试数据文件：

有些测试用例中的值，在每次执行用例时都需要是唯一的，不能和之前使用过的重复。这时候我们就需要使用测试数据文件，如 Baidu-baidu.csv，如下表：

_keywords	_title	flag
segmentfault	SegmentFault 思否	Y
豆瓣	豆瓣

测试数据文件中，第一行为变量名称，建议以下划线(_)开头，如 _title，以便和测试用例里定义的变量名称区分，但最后一个字段 flag 为是否使用标识(不能作为变量使用)。

当我们写测试用例时，就可以直接使用 <_keywords>, <_title> 这些变量。如测试用例:BAIDU_005

测试步骤	操作	页面	元素	测试数据
1	执行	用例片段	SNIPPET_001	keywords=<_keywords>
2	点击	百度搜索页面	搜索结果#1
3	检查	通用	页面title	<_title>

当自动化运行时，会自动去查找对应的测试数据文件，如果有，则会顺序读取文件行，当读到某一行 flag 不为‘Y’时，就把该行数据导入到变量列表里，同时把测试数据文件中的该行的 flag 列写入'Y'。 需要注意的是，当测试数据文件中的所有行的 flag 都为'Y'时，就无数据导入了，测试用例执行就会失败。所以需要在测试数据文件中准备好足够多的数据行，或者及时维护添加数据。

frame 切换

如果有元素在 iframe/frame 中，则在元素定义表中，该元素需要定义 custom 的值，此值可以为 id/name/index/WebElement

1. id 或 name 直接写值即可
2. index 以 # 开头，如：#1。
3. WebElement 必须以变量定位法来定义，如 id#su，xpath#//*[@class="tabIframe"]

注意，index 是从 0 开始，在嵌套的 frame 里，也是从 0 开始。

示例：

page	element	by	value	custom
通用	查询	id	su	#1

如果是多层 frame,则 custom 中要以依次写上以‘|’分割的值，如：

page	element	by	value	custom
通用	查询	id	su	frame1|frame2

元素管理

测试用例中元素是以 page + element 为唯一标识，来页面元素表中查找定位信息的。因此，不同 page 下的元素 element 可以相同，但不能和“通用”下的相同。

测试用例中，如果 page 不为“通用”，当 \ + element 查找不到，会继续以 “通用” + element 为标识符来查找。

自动义函数

定义

在 lib/c.py 中添加自己定义的函数。

调用

在测试用例的测试数据/预期结果中，可以使用类似 <c.today()> 方式来调用。

窗口管理(浏览器标签页)

在浏览器中，有可能会打开多个标签页，我们叫它为窗口。当你新打开一个标签页时，你可以在测试数据中给它起个名字，格式为：新窗口=<window_name>, 如：

操作	页面	元素	测试数据
打开	通用	百度搜索链接	新窗口=百度搜索窗口
检查	百度搜索页面	页面标题	百度一下\，你就知道

当你给新的标签页起了窗口名字，它之后步骤的页面("通用"除外)就会绑定到这个窗口。如上面第 2 步，“百度搜索页面”会绑定到“百度搜索窗口”。

那么之后的步骤或用例中，即使打开了多个标签页，只要页面是“百度搜索页面”，就会切换到“百度搜索窗口”这个标签页上操作。

注意：“通用”是不绑定到任何窗口的，也不做窗口切换，它直接在“当前窗口”操作。

“当前窗口”规则为：

• 执行到某个步骤时，“当前窗口”是浏览器焦点所在的窗口，也就是上个步骤执行操作的窗口。
• 如果此步骤的页面已绑定到其他窗口，则“当前窗口”会切换过去。
• 如果此步骤的页面尚未捆定任何窗口，则会捆定到“当前窗口”。
• 上个步骤如果是新打开的窗口，则“当前窗口”是新打开的窗口。

注意：

• 如果打开了 2 个或以上窗口，没有起名字的窗口，在执行到切换窗口的步骤时，会自动被关掉。
• 起了名字的窗口不会被关掉。
• 但如果起了同样的名字，则原先的那个窗口会被关掉，绑定在其上面的页面也会被注销。

测试执行

python start.py

按条件筛选用例执行,在启动脚本(start.py)里配置：

# 按条件执行,支持筛选的属性有：'id', 'title', 'designer', 'priority'
sweet.fliter(priority='H')
# or
sweet.fliter(priority=['H', 'L'])

测试报告

Excel 格式

见 report 目录

Junit 格式

见 Junit 目录

Allure Report

前提条件：已安装 Allure (https://docs.qameta.io/allure/)

在自动化测试目录(如：sweetest_example)，使用如下命令启动 Allure Report：

allure serve Junit

测试报告详细数据

见启动脚本，其中 sweet.report_data 为测试报告详细数据

# 测试报告详细数据，可以自行处理后写入其他测试报告系统
print(sweet.report_data)