├── .gitignore
├── README.md
├── common
└── tools.py
├── config
└── dev.yaml
├── conftest.py
├── fixtures
└── dev
│ └── baidu_search.yaml
├── page
└── baidu
│ ├── baidu_search2_page.py
│ └── baidu_search_page.py
├── poetry.lock
├── pyproject.toml
├── pytest.ini
└── testcase
├── baidu
├── baidu_search2_test.py
├── baidu_search_test.py
└── baidu_search_with_multi-browser_test.py
└── shopxo
└── admin_login_test.py
/.gitignore:
--------------------------------------------------------------------------------
1 | # 缓存目录
2 | __pycache__/
3 |
4 | # pre-commit目录
5 | .mypy_cache/
6 | .pytest_cache/
7 |
8 | # 日志目录
9 | output/
10 |
11 | # 其他
12 | .idea
13 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # playwright test
2 |
3 | 本测试项目依赖于pytest，可参考以下中文文档
4 |
5 | playwright 文档
6 | https://pypi.org/project/playwright/
7 | https://playwright.dev/python/docs/intro/
8 |
9 | pytest-playwright 文档
10 | https://pypi.org/project/pytest-playwright/
11 |
12 | 本项目参考了虫师 & Yusuke Iwaki 的项目
13 | https://github.com/defnngj/playwright-pro
14 | https://zenn.dev/yusukeiwaki/articles/cfda648dc170e5
15 |
16 |
17 | ## 1. 安装
18 | ### 1.1 clone 或 下载
19 | ```bash
20 | # clone 项目
21 | git clone https://github.com/tomoyachen/playwright-test.git
22 | ```
23 |
24 | ### 1.2 安装依赖
25 | ```bash
26 | # 本地安装 poetry
27 | pip install poetry
28 |
29 | # 创建虚拟环境并安装依赖 (在项目根目录执行)
30 | poetry install
31 |
32 | # PlayWright 安装浏览器驱动
33 | poetry run playwright install
34 | ```
35 |
36 |
37 | ## 2. 执行测试
38 | ## 2.1 PyCharm 执行
39 | 查看虚拟环境路径
40 | ```
41 | poetry shell
42 | ```
43 |
44 | PyCharm 配置运行环境
45 | Preferences -> Project Interpreter -> Show All -> + (添加) -> Existing environment -> … (浏览) -> 选择刚才创建的虚拟环境目录
46 |
47 | PyCharm 设置 Pytest 为 默认测试运行器
48 | Preferences -> Tools -> Python Integrated Tools -> Testing -> pytest
49 |
50 | PyCharm 执行 测试用例
51 | 配置成功后，符合命名规则的测试类与测试方法可以在行数列快速执行
52 |
53 | ## 2.2 命令行执行
54 | 命令：
55 |
56 | pytest 用例路径 -参数 --参数
57 |
58 |
59 | 例：
60 | ```bash
61 | 例（虚拟环境）：
62 | pytest testcase -s -v
63 |
64 | 例（本地环境）
65 | poetry run pytest testcase --ignore=testcase/aaa/bbb -s -v
66 | ```
67 |
68 | 常用参数：
69 | * -s 显示打印内容
70 | * -v 显示详细执行过程
71 | * --browser 指定浏览器 chromium, webkit, firefox（pytest-playwright）
72 | * --headed 有头模式执行，不传此参数就是无头浏览器执行（pytest-playwright）
73 |
74 | pytest.ini 文件中，addopts 可以配置默认附带参数
75 |
76 |
77 | ## 3. 配置信息
78 |
79 | 业务相关配置在 `config` 目录下的 yaml 文件中
80 | * test 方法 或 fixture 方法中，使用 env fixture 来读取配置信息
81 | * 其他代码中，使用Tools.get_config() 来读取配置信息
82 |
83 | Pytest 配置 在pytest.ini 文件中
84 |
85 | ## 4. 预检查【扩展】
86 | ### 4.1 pre-commit
87 |
88 | 每次git commit都会自动检查，并且会自动修复一部分格式问题，通过检查才会提交成功
89 | * 记得 git add . 来更新被检测文件
90 |
91 | ```bash
92 | #第一次需要手动执行如下内容
93 | pre-commit install #安装git hook脚本
94 | pre-commit run --all-files #运行所配置的所有规则，使其起作用
95 | ```
96 |
97 |
98 | ## 5. 其他
99 | ### 5.1 Playwrigth 录制功能
100 | ```bash
101 | # 快速启动录制工具
102 | python -m playwright codegen
103 |
104 | # 指定输出 py 文件、指定 baseUrl
105 | python -m playwright codegen --target python -o testcase/sample.py https://www.baidu.com/
106 |
107 | # 查看帮助
108 | python -m playwright codegen --help
109 | ```
110 |
111 | ### 5.2 已知的编码问题
112 | mac、linux 和 windows 系统下 对 pytest.int 文件中的中文解码方式不同。
113 | mac、linux 使用 utf-8，windows 使用 ASCII
114 | 最简单的方式就是不使用中文
--------------------------------------------------------------------------------
/common/tools.py:
--------------------------------------------------------------------------------
1 | import os
2 | import platform
3 | import yaml
4 |
5 |
6 | class Tools:
7 | def __init__(self, cookies=None):
8 | self.cookies = cookies
9 |
10 | @staticmethod
11 | def get_file_dir(file):
12 | o_path = os.getcwd()
13 | separator = '\\' if 'Windows' in platform.system() else '/'
14 | str = o_path
15 | str = str.split(separator)
16 | while len(str) > 0:
17 | spath = separator.join(str) + separator + file
18 | leng = len(str)
19 | if os.path.exists(spath):
20 | return os.path.dirname(spath)
21 | str.remove(str[leng - 1])
22 |
23 | @staticmethod
24 | def get_root_dir():
25 | return Tools.get_file_dir('conftest.py')
26 |
27 | @staticmethod
28 | def set_env(key, value):
29 | os.environ[key] = str(value)
30 |
31 | @staticmethod
32 | def get_env(key=None):
33 | tmp_system_env = {}
34 | for tmp_key in os.environ:
35 | tmp_value = os.environ[tmp_key]
36 | if tmp_value == "True":
37 | tmp_value = True
38 | elif tmp_value == "False":
39 | tmp_value = False
40 | tmp_system_env[tmp_key] = tmp_value
41 | if key:
42 | return tmp_system_env.get(key)
43 | return tmp_system_env
44 |
45 | @staticmethod
46 | def get_config(key=None):
47 | env = Tools.get_env("TEST_ENV")
48 | with open(os.path.join(Tools.get_root_dir(), 'config', f"{env}.yaml"), encoding="UTF-8") as f:
49 | config = yaml.load(f.read(), Loader=yaml.SafeLoader)
50 | if key is not None:
51 | return config[key]
52 | return config
53 |
54 | @staticmethod
55 | def get_fixtures(filename, key=None):
56 | env = Tools.get_env("TEST_ENV")
57 | with open(os.path.join(Tools.get_root_dir(), 'fixtures', f"{env}", f"{filename}.yaml"), encoding="UTF-8") as f:
58 | fixtures = yaml.load(f.read(), Loader=yaml.SafeLoader)
59 | if key is not None:
60 | return fixtures[key]
61 | return fixtures
--------------------------------------------------------------------------------
/config/dev.yaml:
--------------------------------------------------------------------------------
1 | # 域名
2 | base_url: https://www.baidu.com
--------------------------------------------------------------------------------
/conftest.py:
--------------------------------------------------------------------------------
1 | import os
2 | import pytest
3 | from py.xml import html
4 | import time
5 | # from playwright.sync_api import sync_playwright
6 | from playwright.async_api import Page, Browser
7 |
8 | ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
9 | OUTPUT_DIR = os.path.join(ROOT_DIR, "output", time.strftime("%Y%m%d%H%M%S"))
10 |
11 |
12 | @pytest.fixture(scope="class")
13 | def page(browser: Browser):
14 | # 用例每执行一个class前new page，执行结束后close()
15 | page:Page = browser.new_page(locale="zh-CN")
16 | # 设定浏览器地区为中文
17 | # ref: https://playwright.bootcss.com/docs/api/class-browser#browsernewpageoptions
18 |
19 | yield page
20 |
21 | page.close()
22 |
23 | @pytest.fixture(scope="session", autouse=True)
24 | def init_system_env(request):
25 | """
26 | 自定义初始化系统环境变量
27 | :param request:
28 | :return:
29 | """
30 | from common.tools import Tools
31 | # 读取命令行入参，写入系统本地环境变量
32 | run_env = request.config.getoption('environment') if request.config.getoption('environment') else 'dev'
33 | Tools.set_env("TEST_ENV", run_env)
34 |
35 |
36 | @pytest.fixture(scope="session")
37 | def env(request):
38 | """
39 | 配置信息 fixture 对象，可以在 test 方法 & fixture 里使用
40 | :param request:
41 | :return:
42 | """
43 | import yaml
44 | run_env = request.config.getoption('environment') if request.config.getoption('environment') else 'dev'
45 | # 这里没有用 Tools.get_config() 是因为执行顺序或速度的原因，init_system_env 还没执行，会报错。
46 | config_path = os.path.join(request.config.rootdir, "config", f"{run_env}.yaml")
47 | with open(config_path, encoding="UTF-8") as f:
48 | env_config = yaml.load(f.read(), Loader=yaml.SafeLoader)
49 | yield env_config
50 |
51 | # 骚操作，不建议这么写。用法是 fixtures("search_baidu")['kerwords']
52 | # @pytest.fixture(scope="class")
53 | # def fixtures():
54 | # """
55 | # 测试数据，存放在fixtures目录下，这里是我习惯性引入 Cypress的概念，实际就是测试数据
56 | # :return:
57 | # """
58 | # def _fixtures(filename: str):
59 | # from common.tools import Tools
60 | # return Tools.get_fixtures(filename)
61 | #
62 | # yield _fixtures
63 |
64 | # ref: https://github.com/microsoft/playwright-pytest
65 | @pytest.fixture(scope="session")
66 | def browser_context_args(browser_context_args):
67 | """
68 | pytest-playwrigt 内置钩子
69 | :param browser_context_args:
70 | :param tmpdir_factory:
71 | :return:
72 | """
73 | return {
74 | **browser_context_args,
75 | "record_video_dir": os.path.join(OUTPUT_DIR, "videos") #开始录制时并不知道测试结果正确与否，所以成功失败都会录制
76 | }
77 |
78 | def pytest_addoption(parser):
79 | """
80 | 接收命令行参数
81 | :param parser:
82 | :return:
83 | """
84 | parser.addoption("--env", action="store", dest="environment", default="dev", help="environment: dev, dev-01, prod")
85 |
86 |
87 | def pytest_configure(config):
88 | """
89 | 初始化配置，最先执行
90 | :param config:
91 | :return:
92 | """
93 |
94 | # 添加接口地址与项目名称
95 | config._metadata["项目名称"] = "xxxx"
96 | config._metadata["项目地址"] = "https://xxxx.xxxx.com/aaaa/api-test"
97 |
98 |
99 | @pytest.mark.hookwrapper
100 | def pytest_runtest_makereport(item):
101 | """
102 | 用于向测试用例中添加用例的开始时间、内部注释，和失败截图等.
103 | :param item:
104 | """
105 |
106 | pytest_html = item.config.pluginmanager.getplugin('html')
107 | callers = yield
108 | report = callers.get_result()
109 | report.description = description_html(item.function.__doc__)
110 | report.extra = []
111 |
112 | if "page" not in item.funcargs:
113 | return "page not in item.funcargs"
114 | page = item.funcargs["page"]
115 | if report.when == 'call':
116 | xfail = hasattr(report, 'wasxfail')
117 | if (report.skipped and xfail) or (report.failed and not xfail):
118 | case_name = report.nodeid.replace("::", "_") + ".png"
119 | image_relative_path = os.path.join("images", case_name.replace('testcase/', ''))
120 | image_absolute_path = os.path.join(OUTPUT_DIR, image_relative_path)
121 | capture_screenshots(image_absolute_path, page)
122 | if image_relative_path:
123 | html = '