1.新建项目web-demotest
2.cd到该目录并执行创建虚拟环境的命令
cd web-demotest
python -m venv v(虚拟环境名称)
3.进入虚拟环境中执行
4.验证是否在虚拟环境中
在命令行shell中输入: pip list
Package
只有两个基础包,是我们刚创建的的虚拟环境。
5.简单验证结果
在项目中新建文件demo.py
import time from selenium import webdriver driver = webdriver.Firefox() driver.get("https://www.baidu.com") time.sleep(3) driver.quit()
测试框架简介
优点
- 代码复用率高,如果不使用框架的话,代码会很冗余
- 可以组装日志、报告、邮件等一些高级功能
- 提高元素等数据的可维护性,元素发生变化时,只需要更新一下配置文件
- 使用更灵活的PageObject设计模式
测试框架的整体目录
我们在项目中先按照上面的框架指引,建好每一项目录。
注意:python包都是的,都需要添加一个__init__.py
文件以标识此目录为一个python包。
首先管理时间
首先呢,因为我们很多的模块会用到时间戳,或者日期等等字符串,所以我们先单独把时间封装成一个模块。
然后让其他模块来调用即可。在utils
目录新建times.py
模块
import time import datetime from functools import wraps def timestamp(): '''时间戳''' return time.time() def dt_strftime(fmt="%Y%m"): '''datetime格式化时间''' return datetime.datetime.now().strftime(fmt) def sleep(seconds=1.0): '''睡眠时间''' time.sleep(seconds) def running_time(func): """函数运行时间""" @wraps(func) def wrapper(*args, **kwargs): start = timestamp() res = func(*args, **kwargs) print("校验元素done!用时%.3f秒!" % (timestamp() - start)) return res return wrapper if __name__ == '__main__': print(dt_strftime("%Y%m%d%H%M%S"))
添加配置文件
配置文件总是项目中必不可少的部分!将固定不变的信息集中在固定的文件中
conf.py:在项目config
目录创建conf.py
文件,所有的目录配置信息写在这个文件里面。
import os from selenium.webdriver.common.by import By from utils.times import dt_strftime class ConfigManager(object): # 项目目录 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # 页面元素目录 ELEMENT_PATH = os.path.join(BASE_DIR, 'page_element') # 报告文件 REPORT_FILE = os.path.join(BASE_DIR, 'report.html') # 元素定位的类型 LOCATE_MODE = { 'css': By.CSS_SELECTOR, 'xpath': By.XPATH, 'name': By.NAME, 'id': By.ID, 'class': By.CLASS_NAME } # 邮件信息 EMAIL_INFO = { 'username': '1234567890@qq.com', 'password': 'QQ邮箱授权码', 'smtp_host': 'smtp.qq.com', 'smtp_port': 465 } # 收件人 ADDRESSEE = [ '9876543210@qq.com' ] @property def log_file(self): """日志目录""" log_dir = os.path.join(self.BASE_DIR, 'logs') if not os.path.exists(log_dir): os.makedirs(log_dir) return os.path.join(log_dir, '{}.log'.format(dt_strftime())) @property def ini_file(self): """配置文件""" ini_file = os.path.join(self.BASE_DIR, 'config', 'config.ini') if not os.path.exists(ini_file): raise FileNotFoundError("配置文件%s不存在!" % ini_file) return ini_file cm = ConfigManager() if __name__ == '__main__': print(cm.BASE_DIR)
config.ini
在项目config
目录新建一个config.ini
文件,里面暂时先放入我们的需要测试的URL
[HOST] HOST = https://www.baidu.com
读取配置文件
在common
目录中新建一个readconfig.py
文件
import configparser from config.conf import cm HOST = 'HOST' class ReadConfig(object): """配置文件""" def __init__(self): self.config = configparser.RawConfigParser() # 当有%的符号时请使用Raw读取 self.config.read(cm.ini_file, encoding='utf-8') def _get(self, section, option): """获取""" return self.config.get(section, option) def _set(self, section, option, value): """更新""" self.config.set(section, option, value) with open(cm.ini_file, 'w') as f: self.config.write(f) @property def url(self): return self._get(HOST, HOST) ini = ReadConfig() if __name__ == '__main__': print(ini.url)
python内置的configparser模块对config.ini
文件进行了读取。url值的提取,使用了高阶语法@property
属性值,写法更简单。
记录操作日志
在utils
目录中新建logger.py
文件。
import logging from config.conf import cm class Log: def __init__(self): self.logger = logging.getLogger() if not self.logger.handlers: self.logger.setLevel(logging.DEBUG) # 创建一个handle写入文件 fh = logging.FileHandler(cm.log_file, encoding='utf-8') fh.setLevel(logging.INFO) # 创建一个handle输出到控制台 ch = logging.StreamHandler() ch.setLevel(logging.INFO) # 定义输出的格式 formatter = logging.Formatter(self.fmt) fh.setFormatter(formatter) ch.setFormatter(formatter) # 添加到handle self.logger.addHandler(fh) self.logger.addHandler(ch) @property def fmt(self): return '%(levelname)s %(asctime)s [%(filename)s:%(lineno)d] %(message)s' log = Log().logger if __name__ == '__main__': log.info('hello world')
在终端中运行该文件,就看到命令行打印出了
INFO 2020-12-01 16:00:05,467 [logger.py:38] hello world
然后在项目logs目录下生成了当月的日志文件。
简单理解POM模型
Page Object模式具有以下几个优点。
- 抽象出对象可以最大程度地降低开发人员修改页面代码对测试的影响, 所以, 你仅需要对页
面对象进行调整, 而对测试没有影响; - 可以在多个测试用例中复用一部分测试代码;
- 测试代码变得更易读、 灵活、 可维护
Page Object模式图
- basepage ——selenium的基类,对selenium的方法进行封装
- pageelements——页面元素,把页面元素单独提取出来,放入一个文件中
- searchpage ——页面对象类,把selenium方法和页面元素进行整合
- testcase ——使用pytest对整合的searchpage进行测试用例编写
通过上图我们可以看出,通过POM模型思想,我们把:
- selenium方法
- 页面元素
- 页面对象
- 测试用例
以上四种代码主体进行了拆分,虽然在用例很少的情况下做会增加代码,但是当用例多的时候意义很大,代码量会在用例增加的时候显著减少。我们维护代码变得更加直观明显,代码可读性也变得比工厂模式强很多,代码复用率也极大的得到了提高。
简单学习元素定位
xpath
管理页面元素
项目框架设计中有一个目录page_element
就是专门来存放定位元素的文件的。
通过对各种配置文件的对比,我在这里选择的是YAML文件格式。其易读,交互性好。
在page_element
中新建一个search.yaml
文件。
搜索框: "id==kw" 候选: "css==.bdsug-overflow" 搜索候选: "css==#form div li" 搜索按钮: "id==su"
在common
目录中创建readelement.py
文件。
import os import yaml from config.conf import cm class Element(object): """获取元素""" def __init__(self, name): self.file_name = '%s.yaml' % name self.element_path = os.path.join(cm.ELEMENT_PATH, self.file_name) if not os.path.exists(self.element_path): raise FileNotFoundError("%s 文件不存在!" % self.element_path) with open(self.element_path, encoding='utf-8') as f: self.data = yaml.safe_load(f) def __getitem__(self, item): """获取属性""" data = self.data.get(item) if data: name, value = data.split('==') return name, value raise ArithmeticError("{}中不存在关键字:{}".format(self.file_name, item)) if __name__ == '__main__': search = Element('search') print(search['搜索框'])
通过特殊方法__getitem__
实现调用任意属性,读取yaml中的值。
在script
脚本文件目录中创建inspect.py
文件,对所有的元素yaml文件进行审查。
import os import yaml from config.conf import cm from utils.times import running_time @running_time def inspect_element(): """检查所有的元素是否正确 只能做一个简单的检查 """ for files in os.listdir(cm.ELEMENT_PATH): _path = os.path.join(cm.ELEMENT_PATH, files) with open(_path, encoding='utf-8') as f: data = yaml.safe_load(f) for k in data.values(): try: pattern, value = k.split('==') except ValueError: raise Exception("元素表达式中没有`==`") if pattern not in cm.LOCATE_MODE: raise Exception('%s中元素【%s】没有指定类型' % (_path, k)) elif pattern == 'xpath': assert '//' in value, '%s中元素【%s】xpath类型与值不配' % (_path, k) elif pattern == 'css': assert '//' not in value, '%s中元素【%s]css类型与值不配' % (_path, k) else: assert value, '%s中元素【%s】类型与值不匹配' % (_path, k) if __name__ == '__main__': inspect_element()
执行该文件:
校验元素done!用时0.002秒!
在page
目录创建webpage.py
文件
from selenium.webdriver.support import expected_conditions as EC from selenium.webdriver.support.ui import WebDriverWait from selenium.common.exceptions import TimeoutException from config.conf import cm from utils.times import sleep from utils.logger import log class WebPage(object): """selenium基类""" def __init__(self, driver): # self.driver = webdriver.Chrome() self.driver = driver self.timeout = 20 self.wait = WebDriverWait(self.driver, self.timeout) def get_url(self, url): """打开网址并验证""" self.driver.maximize_window() self.driver.set_page_load_timeout(60) try: self.driver.get(url) self.driver.implicitly_wait(10) log.info("打开网页:%s" % url) except TimeoutException: raise TimeoutException("打开%s超时请检查网络或网址服务器" % url) @staticmethod def element_locator(func, locator): """元素定位器""" name, value = locator return func(cm.LOCATE_MODE[name], value) def find_element(self, locator): """寻找单个元素""" return WebPage.element_locator(lambda *args: self.wait.until( EC.presence_of_element_located(args)), locator) def find_elements(self, locator): """查找多个相同的元素""" return WebPage.element_locator(lambda *args: self.wait.until( EC.presence_of_all_elements_located(args)), locator) def elements_num(self, locator): """获取相同元素的个数""" number = len(self.find_elements(locator)) log.info("相同元素:{}".format((locator, number))) return number def input_text(self, locator, txt): """输入(输入前先清空)""" sleep(0.5) ele = self.find_element(locator) ele.clear() ele.send_keys(txt) log.info("输入文本:{}".format(txt)) def is_click(self, locator): """点击""" self.find_element(locator).click() sleep() log.info("点击元素:{}".format(locator)) def element_text(self, locator): """获取当前的text""" _text = self.find_element(locator).text log.info("获取文本:{}".format(_text)) return _text @property def get_source(self): """获取页面源代码""" return self.driver.page_source def refresh(self): """刷新页面F5""" self.driver.refresh() self.driver.implicitly_wait(30)
主要用了显式等待
对selenium的click,send_keys等方法,做了二次封装。提高了运行的成功率。
创建页面对象
在page_object
目录下创建一个searchpage.py
文件。
from page.webpage import WebPage, sleep from common.readelement import Element search = Element('search') class SearchPage(WebPage): """搜索类""" def input_search(self, content): """输入搜索""" self.input_text(search['搜索框'], txt=content) sleep() @property def imagine(self): """搜索联想""" return [x.text for x in self.find_elements(search['候选'])] def click_search(self): """点击搜索""" self.is_click(search['搜索按钮'])
pytest.ini
pytest项目中的配置文件,可以对pytest执行过程中操作做全局控制。
在项目根目录新建pytest.ini
文件。
[pytest]
addopts = --html=report.html --self-contained-html
- addopts 指定执行时的其他参数说明:
--html=report/report.html --self-contained-html
生成pytest-html带样式的报告-s
输出我们用例中的调式信息-q
安静的进行测试-v
可以输出用例更加详细的执行信息,比如用例所在的文件及用例名称等
编写测试用例
在TestCase
目录中创建test_search.py
文件
import re import pytest from utils.logger import log from common.readconfig import ini from page_object.searchpage import SearchPage class TestSearch: @pytest.fixture(scope='function', autouse=True) def open_baidu(self, drivers): """打开百度""" search = SearchPage(drivers) search.get_url(ini.url) def test_001(self, drivers): """搜索""" search = SearchPage(drivers) search.input_search("selenium") search.click_search() result = re.search(r'selenium', search.get_source) log.info(result) assert result def test_002(self, drivers): """测试搜索候选""" search = SearchPage(drivers) search.input_search("selenium") log.info(list(search.imagine)) assert all(["selenium" in i for i in search.imagine]) if __name__ == '__main__': pytest.main(['TestCase/test_search.py'])
-
pytest.fixture 这个实现了和unittest的setup,teardown一样的前置启动,后置清理的装饰器。
-
第一个测试用例:
- 我们实现了在百度selenium关键字,并点击搜索按钮,并在搜索结果中,用正则查找结果页源代码,返回数量大于10我们就认为通过。
-
第二个测试用例:
- 我们实现了,搜索selenium,然后断言搜索候选中的所有结果有没有selenium关键字。
conftest.py
在项目根目录下新建一个conftest.py
文件
import pytest from py.xml import html from selenium import webdriver driver = None @pytest.fixture(scope='session', autouse=True) def drivers(request): global driver if driver is None: driver = webdriver.Chrome() driver.maximize_window() def fn(): driver.quit() request.addfinalizer(fn) return driver @pytest.hookimpl(hookwrapper=True) def pytest_runtest_makereport(item): """ 当测试失败的时候,自动截图,展示到html报告中 :param item: """ pytest_html = item.config.pluginmanager.getplugin('html') outcome = yield report = outcome.get_result() report.description = str(item.function.__doc__) extra = getattr(report, 'extra', []) if report.when == 'call' or report.when == "setup": xfail = hasattr(report, 'wasxfail') if (report.skipped and xfail) or (report.failed and not xfail): file_name = report.nodeid.replace("::", "_") + ".png" screen_img = _capture_screenshot() if file_name: html = '<div><img src="data:image/png;base64,%s" alt="screenshot" style="1024px;height:768px;" ' 'onclick="window.open(this.src)" align="right"/></div>' % screen_img extra.append(pytest_html.extras.html(html)) report.extra = extra def pytest_html_results_table_header(cells): cells.insert(1, html.th('用例名称')) cells.insert(2, html.th('Test_nodeid')) cells.pop(2) def pytest_html_results_table_row(report, cells): cells.insert(1, html.td(report.description)) cells.insert(2, html.td(report.nodeid)) cells.pop(2) def pytest_html_results_table_html(report, data): if report.passed: del data[:] data.append(html.div('通过的用例未捕获日志输出.', class_='empty log')) def _capture_screenshot(): ''' 截图保存为base64 :return: ''' return driver.get_screenshot_as_base64()
执行用例
pytest
发送邮件
utils
目录中新建send_mail.py
文件
import zmail from config.conf import cm def send_report(): """发送报告""" with open(cm.REPORT_FILE, encoding='utf-8') as f: content_html = f.read() try: mail = { 'from': '1084502012@qq.com', 'subject': '最新的测试报告邮件', 'content_html': content_html, 'attachments': [cm.REPORT_FILE, ] } server = zmail.server(*cm.EMAIL_INFO.values()) server.send_mail(cm.ADDRESSEE, mail) print("测试邮件发送成功!") except Exception as e: print("Error: 无法发送邮件,{}!", format(e)) if __name__ == "__main__": '''请先在config/conf.py文件设置QQ邮箱的账号和密码''' send_report()