Python Selenium搭建UI自动化测试框架

自动化测试是软件测试中非常重要的一部分，可以提高测试效率和测试覆盖率。在UI自动化测试中，Selenium是非常流行的工具。本文将介绍如何使用Python和Selenium搭建UI自动化测试框架。

一、环境准备

在开始搭建UI自动化测试框架之前，需要先安装Python和Selenium。可以从Python官网下载Python安装包，并使用pip命令安装Selenium。

二、框架目录结构

在搭建UI自动化测试框架之前，需要先规划好框架的目录结构。以下是一个比较完整的目录结构：

1. ├── config

2. │   ├── __init__.py

3. │   ├── config.ini

4. │   └── logger.ini

5. ├── data

6. │   ├── __init__.py

7. │   ├── test_data.xlsx

8. │   └── test_data.json

9. ├── logs

10. │   ├── __init__.py

11. │   └── test.log

12. ├── page

13. │   ├── __init__.py

14. │   └── login_page.py

15. ├── report

16. │   ├── __init__.py

17. │   └── test_report.html

18. │   └── screenshots

19. │       ├── test_login_failure_2022-05-01_08-30-00.png

20. │       └── test_login_success_2022-05-01_08-30-00.png

21. ├── testcase

22. │   ├── __init__.py

23. │   └── test_login.py

24. ├── utils

25. │   ├── __init__.py

26. │   ├── driver.py

27. │   ├── logger.py

28. │   └── read_config.py

29. │   └── take_screenshot.py

30. ├── .gitignore

31. ├── README.md

32. ├── requirements.txt

33. └── run.py

config：存放配置文件，包括config.ini和logger.ini。

data：存放测试数据，包括Excel和JSON格式的数据。

logs：存放日志文件，包括test.log。

page：存放页面对象，每个页面对应一个.py文件。

report：存放测试报告，包括test_report.html。

screenshots：用于存放测试过程中的截图。

testcase：存放测试用例，每个用例对应一个.py文件。

utils：存放工具类，包括driver.py、logger.py和read_config.py。

.gitignore：Git忽略文件列表。

README.md：项目说明文件。

requirements.txt：Python依赖包列表。

run.py：测试执行入口。

三、框架搭建

1.创建项目目录

在本地创建一个项目目录，进入该目录，执行以下命令：

1. mkdir config data logs page report report/screenshots testcase utils

2. touch .gitignore README.md requirements.txt run.py

3. cd config && touch __init__.py config.ini logger.ini && cd ..

4. cd data && touch __init__.py test_data.xlsx test_data.json && cd ..

5. cd logs && touch __init__.py test.log && cd ..

6. cd page && touch __init__.py login_page.py && cd ..

7. cd report && touch __init__.py test_report.html && cd  ..

8. cd testcase && touch __init__.py test_login.py && cd ..

9. cd utils && touch __init__.py driver.py logger.py read_config.py && cd ..

2.安装依赖包

在项目目录下执行以下命令，安装依赖包：

pip install selenium openpyxl configparser loguru

3.编写配置文件

在config目录下的config.ini文件中，配置浏览器类型和网站地址：

1. [Browser]

2. browser_name = chrome

4. [URL]

5. base_url = https://www.example.com

在config目录下的logger.ini文件中，配置日志文件路径和日志级别：

1. [loggers]

2. keys=root

4. [handlers]

5. keys=consoleHandler,fileHandler

7. [formatters]

8. keys=formatter

10. [logger_root]

11. level=DEBUG

12. handlers=consoleHandler,fileHandler

14. [handler_consoleHandler]

15. class=StreamHandler

16. level=DEBUG

17. formatter=formatter

18. args=(sys.stdout,)

20. [handler_fileHandler]

21. class=handlers.TimedRotatingFileHandler

22. level=DEBUG

23. formatter=formatter

24. args=('logs/test.log', 'D', 1, 30)

26. [formatter_formatter]

27. format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

28. datefmt=%Y-%m-%d %H:%M:%S

4.编写工具类

在utils目录下的driver.py文件中，封装获取浏览器驱动的方法：

1. import os

2. from selenium import webdriver

3. from configparser import ConfigParser

5. def get_driver():

6.     config = ConfigParser()

7.     config.read(os.path.join(os.path.dirname(__file__), '../config/config.ini'))

9.     browser_name = config.get('Browser', 'browser_name')

10.     if browser_name.lower() == 'chrome':

11.         return webdriver.Chrome()

12.     elif browser_name.lower() == 'firefox':

13.         return webdriver.Firefox()

14.     elif browser_name.lower() == 'edge':

15.         return webdriver.Edge()

16.     else:

17.         raise ValueError('Unsupported browser: {}'.format(browser_name))

在utils目录下的logger.py文件中，封装日志记录的方法：

1. import os

2. from loguru import logger

3. from configparser import ConfigParser

5. config = ConfigParser()

6. config.read(os.path.join(os.path.dirname(__file__), '../config/logger.ini'))

8. logger.add(config.get('handler_fileHandler', 'class'), level=config.get('logger_root', 'level'), rotation=config.getint('handler_fileHandler', 'args')[2], retention=config.getint('handler_fileHandler', 'args')[3])

10. def get_logger(name):

11.     return logger.bind(name=name)

在utils目录下的read_config.py文件中，封装读取配置文件的方法：

1. import os

2. from configparser import ConfigParser

4. config = ConfigParser()

5. config.read(os.path.join(os.path.dirname(__file__), '../config/config.ini'))

7. def get_base_url():

8.     return config.get('URL', 'base_url')

在utils目录下新增了一个take_screenshot.py文件，用于封装截图的方法：

1. import os

2. from datetime import datetime

3. from utils.driver import get_driver

5. def take_screenshot(name):

6.     driver = get_driver()

7.     screenshot_dir = os.path.join(os.path.dirname(__file__), '../report/screenshots')

8.     os.makedirs(screenshot_dir, exist_ok=True)

9.     screenshot_file = os.path.join(screenshot_dir, '{}_{}.png'.format(name, datetime.now().strftime('%Y-%m-%d_%H-%M-%S')))

10.     driver.save_screenshot(screenshot_file)

5.编写页面对象

在page目录下的login_page.py文件中，封装登录页面的元素定位和操作方法：

1. from selenium.webdriver.common.by import By

2. from utils.driver import get_driver

4. class LoginPage:

5.     url = '/login.html'

6.     username_input = (By.ID, 'username')

7.     password_input = (By.ID, 'password')

8.     login_button = (By.ID, 'login-button')

10.     def __init__(self):

11.         self.driver = get_driver()

13.     def open(self):

14.         self.driver.get(get_base_url() + self.url)

16.     def close(self):

17.         self.driver.quit()

19.     def login(self, username, password):

20.         self.driver.find_element(*self.username_input).send_keys(username)

21.         self.driver.find_element(*self.password_input).send_keys(password)

22.         self.driver.find_element(*self.login_button).click()

6.编写测试用例

在testcase目录下的test_login.py文件中，编写登录测试用例：

1. import unittest

2. from page.login_page import LoginPage

3. from utils.take_screenshot import take_screenshot

5. class TestLogin(unittest.TestCase):

6.     def setUp(self):

7.         self.page = LoginPage()

9.     def tearDown(self):

10.         self.page.close()

12.     def test_login_success(self):

13.         self.page.open()

14.         self.page.login('admin', 'admin123')

15.         self.assertIn('Welcome', self.page.driver.title)

17.     def test_login_failure(self):

18.         self.page.open()

19.         self.page.login('admin', 'wrong_password')

20.         self.assertIn('Login failed', self.page.driver.page_source)

21.         take_screenshot('test_login_failure')

7.编写测试执行入口

在run.py文件中，编写测试执行入口：

1. import unittest

2. from datetime import datetime

3. from utils.logger import get_logger

4. from report import HTMLTestRunner

6. logger = get_logger(__name__)

8. if __name__ == '__main__':

9.     logger.info('Start testing...')

10.     suite = unittest.defaultTestLoader.discover('testcase')

11.     report_file = 'report/test_report_{}.html'.format(datetime.now().strftime('%Y-%m-%d_%H-%M-%S'))

12.     with open(report_file, 'wb') as f:

13.         runner = HTMLTestRunner.HTMLTestRunner(stream=f, title='Test Report', description='Test Result')

14.         runner.run(suite)

15.     logger.info('Testing finished. Report file: {}'.format(report_file))

16.     

17.     # 将截图嵌入测试报告

18.     with open(report_file, 'r+', encoding='utf-8') as f:

19.         content = f.read()

20.         for root, dirs, files in os.walk('report/screenshots'):

21.             for file in files:

22.                 screenshot_file = os.path.join(root, file)

23.                 if 'test_report' not in screenshot_file:

24.                     screenshot_name = os.path.splitext(os.path.basename(screenshot_file))[0]

25.                     screenshot_time = datetime.strptime(screenshot_name.split('_')[-2], '%Y-%m-%d')

26.                     screenshot_url = os.path.join(get_base_url(), screenshot_file)

27.                     content = content.replace('{}"'.format(screenshot_name), '{}" width="50%"'.format(screenshot_url))

28.         f.seek(0)

29.         f.write(content)

四、测试执行

在项目目录下执行以下命令，执行测试：

python run.py

测试完成后，测试报告将保存在report目录下的test_report.html文件中。

五、Jenkins持续集成

持续集成是软件开发过程中非常重要的一环，可以帮助开发团队实现快速迭代和快速交付。Jenkins是一个开源的持续集成工具，可以帮助团队实现自动化构建、自动化测试和自动化部署。本文将介绍如何使用Jenkins进行UI自动化测试的持续集成。

1.Jenkins安装和配置

安装Jenkins

Jenkins可以从官网下载安装包，根据操作系统选择相应的安装包进行安装。安装完成后，启动Jenkins服务。

安装插件

Jenkins需要安装一些插件来支持UI自动化测试，包括：

Selenium Plugin：用于集成Selenium和Jenkins。

HTML Publisher Plugin：用于生成测试报告。

在Jenkins的插件管理页面中，搜索并安装这两个插件。

配置Jenkins

在Jenkins的系统管理页面中，配置全局环境变量和全局工具配置。

配置全局环境变量：设置PYTHONPATH变量，指向Python的安装目录。

配置全局工具：添加Python和浏览器驱动的安装路径。

2.Jenkins配置UI自动化测试任务

创建Jenkins任务

在Jenkins的首页中，点击“新建任务”，选择“自由风格软件项目”，输入任务名称，点击“确定”。

配置源码管理

在任务配置页面中，选择“Git”作为源码管理方式，填写代码仓库地址和分支信息。

配置构建触发器

在任务配置页面中，选择“构建触发器”，配置定时构建或者代码提交构建。

配置构建环境

在任务配置页面中，选择“构建环境”，配置Python环境和浏览器驱动。

配置构建步骤

在任务配置页面中，选择“构建步骤”，配置构建脚本。

构建脚本如下：

1. #!/bin/bash

3. # 安装依赖包

4. pip install -r requirements.txt

6. # 执行测试

7. python run.py

9. # 生成测试报告

10. cp report/test_report.html $WORKSPACE

12. # 发布测试报告

13. echo '<h2>UI自动化测试报告</h2>' > report.html

14. echo '<iframe src="test_report.html" width="100%" height="600"></iframe>' >> report.html

15. cp report.html $WORKSPACE

配置构建后操作

在任务配置页面中，选择“构建后操作”，配置测试报告的发布方式。

发布方式如下：

发布HTML测试报告：选择“HTML Publisher Plugin”，设置测试报告路径为$WORKSPACE/report.html。

3.Jenkins测试执行

在Jenkins的任务页面中，点击“立即构建”，Jenkins将自动拉取代码，执行测试，并生成测试报告。测试报告将发布到Jenkins的测试报告页面中。

本文主要介绍了如何使用Python Selenium框架搭建UI自动化测试框架，并给出了一个完整的目录结构示例进行参考。通过UI自动化测试框架，可以帮助团队快速构建自动化测试框架，提高测试效率和测试质量。希望本文能对你有所帮助。

感谢每一个认真阅读我文章的人，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走：

这些资料，对于【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴上万个测试工程师们走过最艰难的路程，希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取