Python+Selenium+Pytest+POM自动化测试框架封装（完备版）

🍅 点击文末小卡片 ，免费获取软件测试全套资料，资料在手，涨薪更快    
1、测试框架简介

1）测试框架的长处

• 代码复用率高，假如不利用框架的话，代码会显得很冗余。
  
• 可以组装日志、陈诉、邮件等一些高级功能。
  
• 提高元素等数据的可维护性，元素发生变化时，只须要更新一下设置文件。
  
• 利用更灵活的PageObject筹划模式。
  

2）测试框架的整体目次

【留意】 init.py 文件用以标识此目次为一个python包。
2、起首时间管理

起首，因为许多的模块都会用到当前时间的时间戳，大概日期等等字符串，以是先单独把时间操纵（我们须要获取的差别格式的时间信息）封装成一个模块。
然后让其他模块来调用即可。在 utils 目次新建 times.py 模块。

2. #!/usr/bin/env python3
3. # -*- coding:utf-8 -*-
4. import time
5. import datetime
6. from functools import wraps
8. def timestamp():
9.     """时间戳"""
10.     return time.time()
12. def dt_strftime(fmt="%Y%m"):
13.     """
14.     datetime格式化时间
15.     :param fmt "%Y%m%d %H%M%S
16.     """
17.     return datetime.datetime.now().strftime(fmt)
19. def sleep(seconds=1.0):
20.     """
21.     睡眠时间
22.     """
23.     time.sleep(seconds)
25. def running_time(func):
26.     """函数运行时间"""
28.     @wraps(func)
29.     def wrapper(*args, **kwargs):
30.         start = timestamp()
31.         res = func(*args, **kwargs)
32.         print("校验元素done！用时%.3f秒！" % (timestamp() - start))
33.         return res
35.     return wrapper
37. if __name__ == '__main__':
38.     print(dt_strftime("%Y%m%d%H%M%S"))

复制代码

3、添加设置文件

1）conf.py
UI自动化测试框架中应该有一个文件对整体的目次举行管理；
在项目中的 config 目次创建 conf.py 文件，全部的目次设置信息写在这个文件内里。

2. import os
3. from selenium.webdriver.common.by import By
4. from utils.times import dt_strftime
6. class ConfigManager(object):
7.     # 项目目录
8.     BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
10.     # 页面元素目录
11.     ELEMENT_PATH = os.path.join(BASE_DIR, 'page_element')
13.     # 报告文件
14.     REPORT_FILE = os.path.join(BASE_DIR, 'report.html')
16.     # 元素定位的类型
17.     LOCATE_MODE = {
18.         'css': By.CSS_SELECTOR,
19.         'xpath': By.XPATH,
20.         'name': By.NAME,
21.         'id': By.ID,
22.         'class': By.CLASS_NAME
23.     }
25.     # 邮件信息
26.     EMAIL_INFO = {
27.         'username': '[email protected]',  # 切换成你自己的地址
28.         'password': 'QQ邮箱授权码',
29.         'smtp_host': 'smtp.qq.com',
30.         'smtp_port': 465
31.     }
33.     # 收件人
34.     ADDRESSEE = [
35.         '[email protected]',
36.     ]
38.     @property
39.     def log_file(self):
40.         """日志目录"""
41.         log_dir = os.path.join(self.BASE_DIR, 'logs')
42.         if not os.path.exists(log_dir):
43.             os.makedirs(log_dir)
44.         return os.path.join(log_dir, '{}.log'.format(dt_strftime()))
46.     @property
47.     def ini_file(self):
48.         """配置文件"""
49.         ini_file = os.path.join(self.BASE_DIR, 'config', 'config.ini')
50.         if not os.path.exists(ini_file):
51.             raise FileNotFoundError("配置文件%s不存在！" % ini_file)
52.         return ini_file
54. cm = ConfigManager()
55. if __name__ == '__main__':
56.     print(cm.BASE_DIR)

复制代码

【留意】：QQ邮箱授权码：点击检察天生教程
2）config.ini
在项目 config 目次新建一个 config.ini 文件，内里临时先放入须要测试的URL。

2. [HOST]
3. HOST = https://www.baidu.com

复制代码

3）读取设置文件
①设置文件创建好了，接下来我们须要读取这个设置文件以利用内里的信息。
②利用python内置的 configparser 模块对 config.ini 文件信息举行了读取。
③对于测试url值的提取，利用python高阶语法 @property 属性值，写法更简单。
④在 common 目次中新建一个 readconfig.py 文件。

2. import configparser
3. from config.conf import cm
5. HOST = 'HOST'
7. class ReadConfig(object):
8.     """配置文件"""
10.     def __init__(self):
11.         self.config = configparser.RawConfigParser()  # 当有%的符号时请使用Raw读取
12.         self.config.read(cm.ini_file, encoding='utf-8')
14.     def _get(self, section, option):
15.         """获取"""
16.         return self.config.get(section, option)
18.     def _set(self, section, option, value):
19.         """更新"""
20.         self.config.set(section, option, value)
21.         with open(cm.ini_file, 'w') as f:
22.             self.config.write(f)
24.     @property
25.     def url(self):
26.         return self._get(HOST, HOST)
28. ini = ReadConfig()
30. if __name__ == '__main__':
31.     print(ini.url)

复制代码

4、记录操纵日志

在 utils 目次中新建 logger.py 文件。

2. import logging
3. from config.conf import cm
5. class Log:
6.     def __init__(self):
7.         self.logger = logging.getLogger()
8.         if not self.logger.handlers:
9.             self.logger.setLevel(logging.DEBUG)
11.             # 创建一个handle写入文件
12.             fh = logging.FileHandler(cm.log_file, encoding='utf-8')
13.             fh.setLevel(logging.INFO)
15.             # 创建一个handle输出到控制台
16.             ch = logging.StreamHandler()
17.             ch.setLevel(logging.INFO)
19.             # 定义输出的格式
20.             formatter = logging.Formatter(self.fmt)
21.             fh.setFormatter(formatter)
22.             ch.setFormatter(formatter)
24.             # 添加到handle
25.             self.logger.addHandler(fh)
26.             self.logger.addHandler(ch)
28.     @property
29.     def fmt(self):
30.         return '%(levelname)s\t%(asctime)s\t[%(filename)s:%(lineno)d]\t%(message)s'
32. log = Log().logger
34. if __name__ == '__main__':
35.     log.info('hello world')

复制代码

5、项目中元素相干

POM模子：PO模式详解
元素定位：①selenium UI自动化测试xpath定位详解 ；②selenium UI自动化测试之CSS元素定位语法详解
6、管理页面元素

1）新建page_element目次并在该目次下新建search.yaml文件
①本教程选择的测试地址是百度首页，以是对应的元素也是百度首页的。
②项目框架筹划中有一个page_element 目次就是专门来存放定位元素的文件的。
③通过对各种设置文件的对比，我在这里选择的是YAML文件格式。其易读，交互性好。
④在 page_element 中新建一个 search.yaml 文件。文件内容如下：
搜索框："id==kw"
候选："css==.bdsug-overflow"
搜索候选："css==#form div li"
搜索按钮："id==su"
2）在common目次中创建readelement.py文件。
①在 common 目次中创建 readelement.py 文件。实现了定位元素的存储和调用。文件内容如下：
②通过特别方法 getitem 实现调用恣意属性，读取yaml中的值。参考博客：python之__getitem__ 方法学习与利用 || python方法下划线定名规则

2. import os
3. import yaml
4. from config.conf import cm
6. class Element(object):
7.     """获取元素"""
9.     def __init__(self, name):
10.         self.file_name = '%s.yaml' % name
11.         self.element_path = os.path.join(cm.ELEMENT_PATH, self.file_name)
12.         if not os.path.exists(self.element_path):
13.             raise FileNotFoundError("%s 文件不存在！" % self.element_path)
14.         with open(self.element_path, encoding='utf-8') as f:
15.             self.data = yaml.safe_load(f)
17.     def __getitem__(self, item):
18.         """获取属性"""
19.         data = self.data.get(item)
20.         if data:
21.             name, value = data.split('==')
22.             return name, value
23.         raise ArithmeticError("{}中不存在关键字：{}".format(self.file_name, item))
25. if __name__ == '__main__':
26.     search = Element('search')
27.     print(search['搜索框'])

复制代码

3）新建script脚本文件目次并新建inspect.py文件
在 script 脚本文件目次中创建 inspect.py 文件，对全部的元素yaml文件内容举行检察。

2. import os
3. import yaml
4. from config.conf import cm
5. from utils.times import running_time
7. @running_time
8. def inspect_element():
9.     """检查所有的元素是否正确
10.     只能做一个简单的检查
11.     """
12.     for files in os.listdir(cm.ELEMENT_PATH):
13.         _path = os.path.join(cm.ELEMENT_PATH, files)
14.         with open(_path, encoding='utf-8') as f:
15.             data = yaml.safe_load(f)
16.         for k in data.values():
17.             try:
18.                 pattern, value = k.split('==')
19.             except ValueError:
20.                 raise Exception("元素表达式中没有`==`")
21.             if pattern not in cm.LOCATE_MODE:
22.                 raise Exception('%s中元素【%s】没有指定类型' % (_path, k))
23.             elif pattern == 'xpath':
24.                 assert '//' in value,\
25.                     '%s中元素【%s】xpath类型与值不配' % (_path, k)
26.             elif pattern == 'css':
27.                 assert '//' not in value, \
28.                     '%s中元素【%s]css类型与值不配' % (_path, k)
29.             else:
30.                 assert value, '%s中元素【%s】类型与值不匹配' % (_path, k)
32. if __name__ == '__main__':
33.     inspect_element()

复制代码

7、封装Selenium基类

①工厂模式的写法：很直白，简单，又明确。
【创建driver对象，打开百度网页，搜索selenium，点击搜索，然后停顿5秒，检察效果，末了关闭欣赏器。】

2. import time
3. from selenium import webdriver
5. driver = webdriver.Chrome()
6. driver.get('https://www.baidu.com')
7. driver.find_element_by_xpath("//input[@id='kw']").send_keys('selenium')
8. driver.find_element_by_xpath("//input[@id='su']").click()
9. time.sleep(5)
10. driver.quit()

复制代码

②那为什么要封装selenium的方法呢？
起首我们上述这种较为原始的方法，根本不实用于平时做UI自动化测试的：因为在UI界面实际运行环境远远比力复杂，大概因为网络缘故原由，大概控件缘故原由，我们元素还没有表现出来，就举行点击大概输入。
以是我们须要封装selenium方法，通过内置的显式等待或肯定的条件语句，才气构建一个稳固的方法。而且把selenium方法封装起来，有利于平时的代码维护。
新建page目次并创建webpage.py文件
①在 page 目次创建 webpage.py 文件。文件内容如下：
②在文件中我们对主要用了表现等待对selenium的 click ， send_keys 等方法，做了二次封装。提高了运行的乐成率。

2. from selenium.webdriver.support import expected_conditions as EC
3. from selenium.webdriver.support.ui import WebDriverWait
4. from selenium.common.exceptions import TimeoutException
6. from config.conf import cm
7. from utils.times import sleep
8. from utils.logger import log
10. """
11. selenium基类
12. 本文件存放了selenium基类的封装方法
13. """
15. class WebPage(object):
16.     """selenium基类"""
18.     def __init__(self, driver):
19.         # self.driver = webdriver.Chrome()
20.         self.driver = driver
21.         self.timeout = 20
22.         self.wait = WebDriverWait(self.driver, self.timeout)
24.     def get_url(self, url):
25.         """打开网址并验证"""
26.         self.driver.maximize_window()
27.         self.driver.set_page_load_timeout(60)
28.         try:
29.             self.driver.get(url)
30.             self.driver.implicitly_wait(10)
31.             log.info("打开网页：%s" % url)
32.         except TimeoutException:
33.             raise TimeoutException("打开%s超时请检查网络或网址服务器" % url)
35.     @staticmethod
36.     def element_locator(func, locator):
37.         """元素定位器"""
38.         name, value = locator
39.         return func(cm.LOCATE_MODE[name], value)
41.     def find_element(self, locator):
42.         """寻找单个元素"""
43.         return WebPage.element_locator(lambda *args: self.wait.until(
44.             EC.presence_of_element_located(args)), locator)
46.     def find_elements(self, locator):
47.         """查找多个相同的元素"""
48.         return WebPage.element_locator(lambda *args: self.wait.until(
49.             EC.presence_of_all_elements_located(args)), locator)
51.     def elements_num(self, locator):
52.         """获取相同元素的个数"""
53.         number = len(self.find_elements(locator))
54.         log.info("相同元素：{}".format((locator, number)))
55.         return number
57.     def input_text(self, locator, txt):
58.         """输入(输入前先清空)"""
59.         sleep(0.5)
60.         ele = self.find_element(locator)
61.         ele.clear()
62.         ele.send_keys(txt)
63.         log.info("输入文本：{}".format(txt))
65.     def is_click(self, locator):
66.         """点击"""
67.         self.find_element(locator).click()
68.         sleep()
69.         log.info("点击元素：{}".format(locator))
71.     def element_text(self, locator):
72.         """获取当前的text"""
73.         _text = self.find_element(locator).text
74.         log.info("获取文本：{}".format(_text))
75.         return _text
77.     @property
78.     def get_source(self):
79.         """获取页面源代码"""
80.         return self.driver.page_source
82.     def refresh(self):
83.         """刷新页面F5"""
84.         self.driver.refresh()
85.         self.driver.implicitly_wait(30)

复制代码

8、创建页面临象

新建page_object目次并创建一个searchpage.py文件
①在 page_object 目次下创建一个 searchpage.py 文件。
②在该文件中我们对，输入搜索关键词，点击搜索，搜索遐想，举行了封装。【在平时中我们应该养成写解释的风俗，因为过一段时间后，没有解释，代码读起来很费劲。】
9、应用pytest测试框架

pytest.ini文件创建
①pytest项目中的设置文件，可以对pytest实验过程中操纵做全局控制。
②在项目根目次新建 pytest.ini 文件。文件内容如下：

2. [pytest]
3. addopts = --html=report.html --self-contained-html

复制代码

③addopts 指定实验时的其他参数分析：

• –html=report/report.html --self-contained-html 天生pytest-html带样式的陈诉
  
• -s 输出我们用例中的调式信息
  
• -q 安静的举行测试
  
• -v 可以输出用例更加详细的实验信息，比如用例地点的文件及用例名称等
  

10、编写测试用例

新建TestCase目次并创建test_search.py文件
①在 TestCase 目次中创建 test_search.py 文件。文件内容如下：
② pytest.fixture装饰器实现了和unittest的setup，teardown一样的前置启动，后置清算的装饰器。
③第一个测试用例：实现了在百度搜索selenium关键字，并点击搜索按钮，并在搜索效果中，用正则查找效果页源代码，返回数量大于10我们就认为通过。
④第二个测试用例：实现了百度搜索selenium关键字，然后断言搜索候选中的全部效果有没有selenium关键字。

2. import re
3. import pytest
4. from utils.logger import log
5. from common.readconfig import ini
6. from page_object.searchpage import SearchPage
8. class TestSearch:
9.     @pytest.fixture(scope='function', autouse=True)
10.     def open_baidu(self, drivers):
11.         """打开百度"""
12.         search = SearchPage(drivers)
13.         search.get_url(ini.url)
15.     def test_001(self, drivers):
16.         """搜索"""
17.         search = SearchPage(drivers)
18.         search.input_search("selenium")
19.         search.click_search()
20.         result = re.search(r'selenium', search.get_source)
21.         log.info(result)
22.         assert result
24.     def test_002(self, drivers):
25.         """测试搜索候选"""
26.         search = SearchPage(drivers)
27.         search.input_search("selenium")
28.         log.info(list(search.imagine))
29.         assert all(["selenium" in i for i in search.imagine])
31. if __name__ == '__main__':
32.     pytest.main(['TestCase/test_search.py'])

复制代码

conftest.py
①在项目根目次下新建一个 conftest.py 文件。
②conftest.py是测试框架pytest的胶水文件，内里用到了fixture函数，封装并转达出了driver。

2. import pytest
3. from py.xml import html
4. from selenium import webdriver
6. driver = None
8. @pytest.fixture(scope='session', autouse=True)
9. def drivers(request):
10.     """
11.    
12.     :param request: python内置的fixture函数，本函数中用来注册终结函数
13.     :return: 返回driver实例
14.     """
15.     global driver
16.     if driver is None:
17.         driver = webdriver.Chrome()
18.         driver.maximize_window()
20.     def fn():
21.         driver.quit()
23.     request.addfinalizer(fn)
24.     return driver
26. @pytest.hookimpl(hookwrapper=True)
27. def pytest_runtest_makereport(item):
28.     """
29.     当测试失败的时候，自动截图，展示到html报告中
30.     :param item:
31.     """
32.     pytest_html = item.config.pluginmanager.getplugin('html')
33.     outcome = yield
34.     report = outcome.get_result()
35.     report.description = str(item.function.__doc__)
36.     extra = getattr(report, 'extra', [])
38.     if report.when == 'call' or report.when == "setup":
39.         xfail = hasattr(report, 'wasxfail')
40.         if (report.skipped and xfail) or (report.failed and not xfail):
41.             file_name = report.nodeid.replace("::", "_") + ".png"
42.             screen_img = _capture_screenshot()
43.             if file_name:
44.                 html = '<div><img src="data:image/png;base64,%s" alt="screenshot" style="width:1024px;height:768px;" ' \
45.                        'οnclick="window.open(this.src)" align="right"/></div>' % screen_img
46.                 extra.append(pytest_html.extras.html(html))
47.         report.extra = extra
49. def pytest_html_results_table_header(cells):
50.     cells.insert(1, html.th('用例名称'))
51.     cells.insert(2, html.th('Test_nodeid'))
52.     cells.pop(2)
54. def pytest_html_results_table_row(report, cells):
55.     cells.insert(1, html.td(report.description))
56.     cells.insert(2, html.td(report.nodeid))
57.     cells.pop(2)
59. def pytest_html_results_table_html(report, data):
60.     if report.passed:
61.         del data[:]
62.         data.append(html.div('通过的用例未捕获日志输出.', class_='empty log'))
64. def _capture_screenshot():
65.     '''
66.     截图保存为base64
67.     :return:
68.     '''
69.     return driver.get_screenshot_as_base64()

复制代码

11、发送邮件

①当项目实验完成之后，须要发送到自己大概其他人邮箱里检察效果。
②编写发送邮件的模块。
③在 utils 目次中新建 send_mail.py 文件，文件内容如下：

2. import zmail
3. from config.conf import cm
5. def send_report():
6.     """发送报告"""
7.     with open(cm.REPORT_FILE, encoding='utf-8') as f:
8.         content_html = f.read()
9.     try:
10.         mail = {
11.             'from': '[email protected]',
12.             'subject': '最新的测试报告邮件',
13.             'content_html': content_html,
14.             'attachments': [cm.REPORT_FILE, ]
15.         }
16.         server = zmail.server(*cm.EMAIL_INFO.values())
17.         server.send_mail(cm.ADDRESSEE, mail)
18.         print("测试邮件发送成功！")
19.     except Exception as e:
20.         print("Error: 无法发送邮件，{}！", format(e))
22. if __name__ == "__main__":
23.     '''请先在config/conf.py文件设置QQ邮箱的账号和密码'''
24.     send_report()

复制代码

④在 config/conf.py 文件中设置我们自己的QQ邮箱账号以及QQ邮箱授权码。运行 send_report() 函数。
末了感谢每一个认真阅读我文章的人，礼尚往来总是要有的，固然不是什么很值钱的东西，假如你用得到的话可以直接拿走：

这些资料，对于做【软件测试】的朋侪来说应该是最全面最完备的备战堆栈，这个堆栈也伴随我走过了最艰巨的旅程，盼望也能资助到你！凡事要趁早，特别是技能行业，肯定要提升技能功底。