赞
踩
selenium自动化+ pytest测试框架
本章你需要
一定的python基础——至少明白类与对象,封装继承
一定的selenium基础——本篇不讲selenium,不会的可以自己去看selenium中文翻译网
测试框架有什么优点呢:
测试框架的整体目录
目录/文件 | 说明 | 是否为python包 |
---|---|---|
common | 这个包中存放的是常见的通用的类,如读取配置文件 | 是 |
config | 配置文件目录 | 是 |
logs | 日志目录 | |
page | 对selenium的方放进行深度的封装 | 是 |
page_element | 页面元素存放目录 | |
page_object | 页面对象POM设计模式,本人对这个的理解来自于苦叶子的博客 | 是 |
TestCase | 所有的测试用例集 | 是 |
utils | 工具类 | 是 |
script | 脚本文件 | |
conftest.py | pytest胶水文件 | |
pytest.ini | pytest配置文件 |
这样一个简单的框架结构就清晰了。
知道了以上这些我们就开始吧!
我们在项目中先按照上面的框架指引,建好每一项目录。
注意:python包为是的,都需要添加一个__init__.py
文件以标识此目录为一个python包。
首先呢,因为我们很多的模块会用到时间戳,或者日期等等字符串,所以我们先单独把时间封装成一个模块。
然后让其他模块来调用即可。在utils
目录新建times.py
模块
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> time <span style="color:#7171bf">import</span> datetime <span style="color:#7171bf">from</span> functools <span style="color:#7171bf">import</span> wraps <span style="color:#7171bf">def</span> <span style="color:#61aeee">timestamp</span>(): <span style="color:#98c379">"""时间戳"""</span> <span style="color:#7171bf">return</span> time.time() <span style="color:#7171bf">def</span> <span style="color:#61aeee">dt_strftime</span>(fmt=<span style="color:#98c379">"%Y%m"</span>): <span style="color:#98c379">""" datetime格式化时间 :param fmt "%Y%m%d %H%M%S """</span> <span style="color:#7171bf">return</span> datetime.datetime.now().strftime(fmt) <span style="color:#7171bf">def</span> <span style="color:#61aeee">sleep</span>(seconds=<span style="color:#d19a66">1.0</span>): <span style="color:#98c379">""" 睡眠时间 """</span> time.sleep(seconds) <span style="color:#7171bf">def</span> <span style="color:#61aeee">running_time</span>(func): <span style="color:#98c379">"""函数运行时间"""</span> <span style="color:#61aeee"> @wraps(func)</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">wrapper</span>(*args, **kwargs): start = timestamp() res = func(*args, **kwargs) <span style="color:#7171bf">print</span>(<span style="color:#98c379">"校验元素done!用时%.3f秒!"</span> % (timestamp() - start)) <span style="color:#7171bf">return</span> res <span style="color:#7171bf">return</span> wrapper <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: <span style="color:#7171bf">print</span>(dt_strftime(<span style="color:#98c379">"%Y%m%d%H%M%S"</span>)) </code></span></span>
配置文件总是项目中必不可少的部分!
将固定不变的信息集中在固定的文件中
项目中都应该有一个文件对整体的目录进行管理,我也在这个python项目中设置了此文件。
在项目config
目录创建conf.py
文件,所有的目录配置信息写在这个文件里面。
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> os <span style="color:#7171bf">from</span> selenium.webdriver.common.by <span style="color:#7171bf">import</span> By <span style="color:#7171bf">from</span> utils.times <span style="color:#7171bf">import</span> dt_strftime <span style="color:#7171bf">class</span> <span style="color:#61aeee">ConfigManager</span>(<span style="color:#61aeee">object</span>): <span style="color:#5c6370"><em># 项目目录</em></span> BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) <span style="color:#5c6370"><em># 页面元素目录</em></span> ELEMENT_PATH = os.path.join(BASE_DIR, <span style="color:#98c379">'page_element'</span>) <span style="color:#5c6370"><em># 报告文件</em></span> REPORT_FILE = os.path.join(BASE_DIR, <span style="color:#98c379">'report.html'</span>) <span style="color:#5c6370"><em># 元素定位的类型</em></span> LOCATE_MODE = { <span style="color:#98c379">'css'</span>: By.CSS_SELECTOR, <span style="color:#98c379">'xpath'</span>: By.XPATH, <span style="color:#98c379">'name'</span>: By.NAME, <span style="color:#98c379">'id'</span>: By.ID, <span style="color:#98c379">'class'</span>: By.CLASS_NAME } <span style="color:#5c6370"><em># 邮件信息</em></span> EMAIL_INFO = { <span style="color:#98c379">'username'</span>: <span style="color:#98c379">'1084502012@qq.com'</span>, <span style="color:#5c6370"><em># 切换成你自己的地址</em></span> <span style="color:#98c379">'password'</span>: <span style="color:#98c379">'QQ邮箱授权码'</span>, <span style="color:#98c379">'smtp_host'</span>: <span style="color:#98c379">'smtp.qq.com'</span>, <span style="color:#98c379">'smtp_port'</span>: <span style="color:#d19a66">465</span> } <span style="color:#5c6370"><em># 收件人</em></span> ADDRESSEE = [ <span style="color:#98c379">'1084502012@qq.com'</span>, ] <span style="color:#61aeee"> @property</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">log_file</span>(self): <span style="color:#98c379">"""日志目录"""</span> log_dir = os.path.join(self.BASE_DIR, <span style="color:#98c379">'logs'</span>) <span style="color:#7171bf">if</span> <span style="color:#7171bf">not</span> os.path.exists(log_dir): os.makedirs(log_dir) <span style="color:#7171bf">return</span> os.path.join(log_dir, <span style="color:#98c379">'{}.log'</span>.<span style="color:#7171bf">format</span>(dt_strftime())) <span style="color:#61aeee"> @property</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">ini_file</span>(self): <span style="color:#98c379">"""配置文件"""</span> ini_file = os.path.join(self.BASE_DIR, <span style="color:#98c379">'config'</span>, <span style="color:#98c379">'config.ini'</span>) <span style="color:#7171bf">if</span> <span style="color:#7171bf">not</span> os.path.exists(ini_file): <span style="color:#7171bf">raise</span> FileNotFoundError(<span style="color:#98c379">"配置文件%s不存在!"</span> % ini_file) <span style="color:#7171bf">return</span> ini_file cm = ConfigManager() <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: <span style="color:#7171bf">print</span>(cm.BASE_DIR) </code></span></span>
注意:QQ邮箱授权码:点击查看生成教程
这个conf文件我模仿了Django的settings.py文件的设置风格,但是又有些许差异。
在这个文件中我们可以设置自己的各个目录,也可以查看自己当前的目录。
遵循了约定:不变的常量名全部大写,函数名小写。看起来整体美观。
在项目config
目录新建一个config.ini
文件,里面暂时先放入我们的需要测试的URL
- <span style="color:#596172"><span style="background-color:#ffffff"><code class="language-ini"><span style="color:#e06c75">[HOST]</span>
- <span style="color:#d19a66">HOST</span> = https://www.baidu.com
- </code></span></span>
配置文件创建好了,接下来我们需要读取这个配置文件以使用里面的信息。
我们在common
目录中新建一个readconfig.py
文件
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> configparser <span style="color:#7171bf">from</span> config.conf <span style="color:#7171bf">import</span> cm HOST = <span style="color:#98c379">'HOST'</span> <span style="color:#7171bf">class</span> <span style="color:#61aeee">ReadConfig</span>(<span style="color:#61aeee">object</span>): <span style="color:#98c379">"""配置文件"""</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">__init__</span>(self): self.config = configparser.RawConfigParser() <span style="color:#5c6370"><em># 当有%的符号时请使用Raw读取</em></span> self.config.read(cm.ini_file, encoding=<span style="color:#98c379">'utf-8'</span>) <span style="color:#7171bf">def</span> <span style="color:#61aeee">_get</span>(self, section, option): <span style="color:#98c379">"""获取"""</span> <span style="color:#7171bf">return</span> self.config.get(section, option) <span style="color:#7171bf">def</span> <span style="color:#61aeee">_set</span>(self, section, option, value): <span style="color:#98c379">"""更新"""</span> self.config.<span style="color:#7171bf">set</span>(section, option, value) <span style="color:#7171bf">with</span> <span style="color:#7171bf">open</span>(cm.ini_file, <span style="color:#98c379">'w'</span>) <span style="color:#7171bf">as</span> f: self.config.write(f) <span style="color:#61aeee"> @property</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">url</span>(self): <span style="color:#7171bf">return</span> self._get(HOST, HOST) ini = ReadConfig() <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: <span style="color:#7171bf">print</span>(ini.url) </code></span></span>
可以看到我们用python内置的configparser模块对config.ini
文件进行了读取。
对于url值的提取,我使用了高阶语法@property
属性值,写法更简单。
日志,大家应该都很熟悉这个名词,就是记录代码中的动作。
在utils
目录中新建logger.py
文件。
这个文件就是我们用来在自动化测试过程中记录一些操作步骤的。
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> logging <span style="color:#7171bf">from</span> config.conf <span style="color:#7171bf">import</span> cm <span style="color:#7171bf">class</span> <span style="color:#61aeee">Log</span>: <span style="color:#7171bf">def</span> <span style="color:#61aeee">__init__</span>(self): self.logger = logging.getLogger() <span style="color:#7171bf">if</span> <span style="color:#7171bf">not</span> self.logger.handlers: self.logger.setLevel(logging.DEBUG) <span style="color:#5c6370"><em># 创建一个handle写入文件</em></span> fh = logging.FileHandler(cm.log_file, encoding=<span style="color:#98c379">'utf-8'</span>) fh.setLevel(logging.INFO) <span style="color:#5c6370"><em># 创建一个handle输出到控制台</em></span> ch = logging.StreamHandler() ch.setLevel(logging.INFO) <span style="color:#5c6370"><em># 定义输出的格式</em></span> formatter = logging.Formatter(self.fmt) fh.setFormatter(formatter) ch.setFormatter(formatter) <span style="color:#5c6370"><em># 添加到handle</em></span> self.logger.addHandler(fh) self.logger.addHandler(ch) <span style="color:#61aeee"> @property</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">fmt</span>(self): <span style="color:#7171bf">return</span> <span style="color:#98c379">'%(levelname)s\t%(asctime)s\t[%(filename)s:%(lineno)d]\t%(message)s'</span> log = Log().logger <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: log.info(<span style="color:#98c379">'hello world'</span>) </code></span></span>
在终端中运行该文件,就看到命令行打印出了:
- <span style="color:#596172"><span style="background-color:#ffffff"><code class="language-shell">INFO 2020-12-01 16:00:05,467 [logger.py:38] hello world
- </code></span></span>
然后在项目logs目录下生成了当月的日志文件。
由于下面要讲元素相关的,所以首先理解一下POM模型
Page Object模式具有以下几个优点。
该观点来自 《Selenium自动化测试——基于Python语言》
Page Object模式图
通过上图我们可以看出,通过POM模型思想,我们把:
以上四种代码主体进行了拆分,虽然在用例很少的情况下做会增加代码,但是当用例多的时候意义很大,代码量会在用例增加的时候显著减少。我们维护代码变得更加直观明显,代码可读性也变得比工厂模式强很多,代码复用率也极大的得到了提高。
在日常的工作中,我见过很多在浏览器中直接在浏览器中右键Copy Xpath
复制元素的同学。这样获得的元素表达式放在 webdriver 中去运行往往是不够稳定的,像前端的一些微小改动,都会引起元素无法定位的NoSuchElementException
报错。
所以在实际工作和学习中我们应该加强自己的元素定位能力,尽可能的采用xpath
和CSS selector
这种相对稳定的定位语法。由于CSS selector
的语法生硬难懂,对新手很不友好,而且相比xpath
缺少一些定位语法。所以我们选择xpath
进行我们的元素定位语法。
菜鸟教程中对于 xpath 的介绍是一门在 XML 文档中查找信息的语言。
表达式 | 介绍 | 备注 |
---|---|---|
/ | 根节点 | 绝对路径 |
// | 当前节点的所有子节点 | 相对路径 |
* | 所有节点元素的 | |
@ | 属性名的前缀 | @class @id |
*[1] | [] 下标运算符 | |
[] | [ ]谓词表达式 | //input[@id='kw'] |
Following-sibling | 当前节点之后的同级 | |
preceding-sibling | 当前节点之前的同级 | |
parent | 当前节点的父级节点 |
xpath
和CSS selector
语法积累,不太容易上手。本教程选择的测试地址是百度首页,所以对应的元素也是百度首页的。
项目框架设计中有一个目录page_element
就是专门来存放定位元素的文件的。
通过对各种配置文件的对比,我在这里选择的是YAML文件格式。其易读,交互性好。
我们在page_element
中新建一个search.yaml
文件。
- <span style="color:#596172"><span style="background-color:#ffffff"><code class="language-yaml"><span style="color:#98c379">搜索框:</span> <span style="color:#98c379">"id==kw"</span>
- <span style="color:#98c379">候选:</span> <span style="color:#98c379">"css==.bdsug-overflow"</span>
- <span style="color:#98c379">搜索候选:</span> <span style="color:#98c379">"css==#form div li"</span>
- <span style="color:#98c379">搜索按钮:</span> <span style="color:#98c379">"id==su"</span>
- </code></span></span>
元素定位文件创建好了,下来我们需要读取这个文件。
在common
目录中创建readelement.py
文件。
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> os <span style="color:#7171bf">import</span> yaml <span style="color:#7171bf">from</span> config.conf <span style="color:#7171bf">import</span> cm <span style="color:#7171bf">class</span> <span style="color:#61aeee">Element</span>(<span style="color:#61aeee">object</span>): <span style="color:#98c379">"""获取元素"""</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">__init__</span>(self, name): self.file_name = <span style="color:#98c379">'%s.yaml'</span> % name self.element_path = os.path.join(cm.ELEMENT_PATH, self.file_name) <span style="color:#7171bf">if</span> <span style="color:#7171bf">not</span> os.path.exists(self.element_path): <span style="color:#7171bf">raise</span> FileNotFoundError(<span style="color:#98c379">"%s 文件不存在!"</span> % self.element_path) <span style="color:#7171bf">with</span> <span style="color:#7171bf">open</span>(self.element_path, encoding=<span style="color:#98c379">'utf-8'</span>) <span style="color:#7171bf">as</span> f: self.data = yaml.safe_load(f) <span style="color:#7171bf">def</span> <span style="color:#61aeee">__getitem__</span>(self, item): <span style="color:#98c379">"""获取属性"""</span> data = self.data.get(item) <span style="color:#7171bf">if</span> data: name, value = data.split(<span style="color:#98c379">'=='</span>) <span style="color:#7171bf">return</span> name, value <span style="color:#7171bf">raise</span> ArithmeticError(<span style="color:#98c379">"{}中不存在关键字:{}"</span>.<span style="color:#7171bf">format</span>(self.file_name, item)) <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: search = Element(<span style="color:#98c379">'search'</span>) <span style="color:#7171bf">print</span>(search[<span style="color:#98c379">'搜索框'</span>]) </code></span></span>
通过特殊方法__getitem__
实现调用任意属性,读取yaml中的值。
这样我们就实现了定位元素的存储和调用。
但是还有一个问题,我们怎么样才能确保我们写的每一项元素不出错,人为的错误是不可避免的,但是我们可以通过代码来运行对文件的审查。当前也不能所有问题都能发现。
所以我们编写一个文件,在script
脚本文件目录中创建inspect.py
文件,对所有的元素yaml文件进行审查。
<span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span> <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span> <span style="color:#7171bf">import</span> os <span style="color:#7171bf">import</span> yaml <span style="color:#7171bf">from</span> config.conf <span style="color:#7171bf">import</span> cm <span style="color:#7171bf">from</span> utils.times <span style="color:#7171bf">import</span> running_time <span style="color:#61aeee">@running_time</span> <span style="color:#7171bf">def</span> <span style="color:#61aeee">inspect_element</span>(): <span style="color:#98c379">"""检查所有的元素是否正确 只能做一个简单的检查 """</span> <span style="color:#7171bf">for</span> files <span style="color:#7171bf">in</span> os.listdir(cm.ELEMENT_PATH): _path = os.path.join(cm.ELEMENT_PATH, files) <span style="color:#7171bf">with</span> <span style="color:#7171bf">open</span>(_path, encoding=<span style="color:#98c379">'utf-8'</span>) <span style="color:#7171bf">as</span> f: data = yaml.safe_load(f) <span style="color:#7171bf">for</span> k <span style="color:#7171bf">in</span> data.values(): <span style="color:#7171bf">try</span>: pattern, value = k.split(<span style="color:#98c379">'=='</span>) <span style="color:#7171bf">except</span> ValueError: <span style="color:#7171bf">raise</span> Exception(<span style="color:#98c379">"元素表达式中没有`==`"</span>) <span style="color:#7171bf">if</span> pattern <span style="color:#7171bf">not</span> <span style="color:#7171bf">in</span> cm.LOCATE_MODE: <span style="color:#7171bf">raise</span> Exception(<span style="color:#98c379">'%s中元素【%s】没有指定类型'</span> % (_path, k)) <span style="color:#7171bf">elif</span> pattern == <span style="color:#98c379">'xpath'</span>: <span style="color:#7171bf">assert</span> <span style="color:#98c379">'//'</span> <span style="color:#7171bf">in</span> value,\ <span style="color:#98c379">'%s中元素【%s】xpath类型与值不配'</span> % (_path, k) <span style="color:#7171bf">elif</span> pattern == <span style="color:#98c379">'css'</span>: <span style="color:#7171bf">assert</span> <span style="color:#98c379">'//'</span> <span style="color:#7171bf">not</span> <span style="color:#7171bf">in</span> value, \ <span style="color:#98c379">'%s中元素【%s]css类型与值不配'</span> % (_path, k) <span style="color:#7171bf">else</span>: <span style="color:#7171bf">assert</span> value, <span style="color:#98c379">'%s中元素【%s】类型与值不匹配'</span> % (_path, k) <span style="color:#7171bf">if</span> __name__ == <span style="color:#98c379">'__main__'</span>: inspect_element() </code></span></span>
执行该文件:
- <span style="color:#596172"><span style="background-color:#ffffff"><code class="language-powershell">校验元素done!用时<span style="color:#d19a66">0.002</span>秒!
- </code></span></span>
可以看到,很短的时间内,我们就对所填写的YAML文件进行了审查。
现在我们基本所需要的组件已经大致完成了。
接下来我们将进行最重要的一环,封装selenium。
在工厂模式种我们是这样写的:
- <span style="color:#596172"><span style="background-color:#ffffff"><code class="language-python"><span style="color:#5c6370"><em>#!/usr/bin/env python3</em></span>
- <span style="color:#5c6370"><em># -*- coding:utf-8 -*-</em></span>
- <span style="color:#7171bf">import</span> time
- <span style="color:#7171bf">from</span> selenium <span style="color:#7171bf">import</span> webdriver
-
-
- driver = webdriver.Chrome()
- driver.get(<span style="color:#98c379">'https://www.baidu.com'</span>)
- driver.find_element_by_xpath(<span style="color:#98c379">"//input[@id='kw']"</span>).send_keys(<span style="color:#98c379">'selenium'</span>)
- driver.find_element_by_xpath(<span style="color:#98c379">"//input[@id='su']"</span>).click()
- time.sleep(<span style="color:#d19a66">5</span>)
- driver.quit()
- </code></span></span>
很直白,简单,又明了。
创建driver对象,打开百度网页,搜索selenium,点击搜索,然后停留5秒,查看结果,最后关闭浏览器。
那我们为什么要封装selenium的方法呢。首先我们上述这种较为原始的方法,基本不适用于平时做UI自动化测试的,因为在UI界面实际运行情况远远比较复杂,可能因为网络原因,或者控件原因,我们元素还没有显示出来,就进行点击或者输入。所以我们需要封装selenium方法,通过内置的显式等待或一定的条件语句,才能构建一个稳定的方法。而且把selenium方法封装起来,有利于平时的代码维护。
我们在page
目录创建webpage.py
文件。
这是我整理的《2024最新Python自动化测试全套教程》,以及配套的接口文档/项目实战【网盘资源】,需要的朋友可以下方视频的置顶评论获取。肯定会给你带来帮助和方向。
【已更新】B站讲的最详细的Python接口自动化测试实战教程全集(实战最新版)
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。