App UI自动化项目模板

完整的App UI自动化项目模板以下是一套工程化、可复用、易维护的App UI自动化项目模板基于PythonAppium2pytest实现包含BasePage封装、PO页面类、数据驱动、日志/报告/配置分离等核心工程化配置你只需替换业务相关的元素定位、操作逻辑、测试数据即可直接落地适配Android/iOS双端示例以Android为主。一、项目整体结构工程化分层app_ui_auto/ ├── config/ # 配置文件目录统一管理配置无需改代码 │ └── config.yaml # 核心配置Appium参数、路径配置等 ├── common/ # 通用工具目录封装通用逻辑一次封装终身复用 │ ├── base_page.py # BasePage通用操作封装点击、输入、查找元素等 │ ├── driver_manager.py # 驱动管理创建/销毁Appium驱动单例模式 │ └── log_config.py # 日志配置标准化日志输出 ├── page/ # PO页面类目录按业务页面拆分 │ └── login_page.py # 示例登录页PO类替换为自己的业务页面 ├── data/ # 测试数据目录外置数据非技术人员可编辑 │ └── login_data.yaml # 示例登录测试数据YAML格式 ├── test_case/ # 测试用例目录仅写业务逻辑不写基础操作 │ └── test_login.py # 示例登录用例数据驱动 ├── logs/ # 日志输出目录自动生成 ├── report/ # 测试报告目录自动生成Allure报告 ├── requirements.txt # 依赖清单一键安装 └── run_test.py # 用例运行入口批量执行、生成报告二、核心文件代码可直接复制1. 依赖清单requirements.txtappium-python-client2.11.0 pytest7.4.0 pyyaml6.0.1 allure-pytest2.13.2 loguru0.7.2 pandas2.0.0 # 可选如需读取Excel数据则安装 openpyxl3.1.2 # 可选读取Excel需安装2. 配置文件config/config.yaml# Appium核心配置替换为你的App信息appium:server:http://127.0.0.1:4723/wd/hub# Appium服务地址caps:# Android配置iOS需替换为对应caps见备注platformName:AndroiddeviceName:emulator-5554# 设备名真机/模拟器appPackage:com.test.demo# 替换你的App包名appActivity:.ui.login.LoginActivity# 替换登录页ActivitynoReset:True# 不重置App状态避免重复登录unicodeKeyboard:True# 支持中文输入resetKeyboard:True# 重置键盘automationName:UiAutomator2# Android自动化引擎# 路径配置无需修改自动生成path:log_path:./logs/app_ui_auto.logreport_path:./reportdata_path:./data# 日志配置log:level:INFOrotation:10 MB# 日志文件大小限制retention:7# 日志保留7天备注iOS的caps替换示例caps:platformName:iOSdeviceName:iPhone 15udid:你的iOS设备UDIDbundleId:com.test.demo# iOS包名bundle IDautomationName:XCUITest3. 通用工具common/log_config.pyimportyamlfromloguruimportloggerimportos# 读取配置文件withopen(./config/config.yaml,r,encodingutf-8)asf:configyaml.safe_load(f)# 日志配置log_pathconfig[path][log_path]log_diros.path.dirname(log_path)ifnotos.path.exists(log_dir):os.makedirs(log_dir)# 配置loguru日志替换默认loggerlogger.remove()# 移除默认输出logger.add(sinklog_path,levelconfig[log][level],rotationconfig[log][rotation],retentionconfig[log][retention],encodingutf-8,enqueueTrue,# 异步日志提升性能format{time:YYYY-MM-DD HH:mm:ss} | {level} | {file}:{line} | {message})# 同时输出到控制台logger.add(sinklambdamsg:print(msg,end),levelconfig[log][level],format{time:YYYY-MM-DD HH:mm:ss} | {level} | {message})# 对外暴露loggerLOGGERlogger4. 通用工具common/driver_manager.pyfromappiumimportwebdriverimportyamlfromcommon.log_configimportLOGGERfromselenium.common.exceptionsimportWebDriverException# 单例模式避免重复创建驱动classDriverManager:_driverNoneclassmethoddefget_driver(cls):获取Appium驱动单例ifcls._driverisNone:try:# 读取配置withopen(./config/config.yaml,r,encodingutf-8)asf:configyaml.safe_load(f)appium_configconfig[appium]# 创建驱动cls._driverwebdriver.Remote(command_executorappium_config[server],desired_capabilitiesappium_config[caps])LOGGER.info(Appium驱动创建成功)cls._driver.implicitly_wait(10)# 全局隐式等待exceptWebDriverExceptionase:LOGGER.error(fAppium驱动创建失败{e})raisereturncls._driverclassmethoddefquit_driver(cls):销毁驱动ifcls._driverisnotNone:cls._driver.quit()cls._driverNoneLOGGER.info(Appium驱动销毁成功)5. 通用工具common/base_page.pyfromappium.webdriver.common.appiumbyimportAppiumByfromselenium.common.exceptionsimportNoSuchElementException,TimeoutExceptionfromcommon.driver_managerimportDriverManagerfromcommon.log_configimportLOGGERclassBasePage:def__init__(self,driverNone):# 优先使用传入的driver否则用单例驱动self.driverdriverorDriverManager.get_driver()deffind_element(self,locator:tuple,timeout:int10): 查找单个元素优先ID定位兼容多类型定位 :param locator: 定位器格式(定位方式, 定位值)如(AppiumBy.ID, com.test.demo:id/et_username) :param timeout: 超时时间 :return: 元素对象 try:# 设置显式等待覆盖全局隐式等待self.driver.implicitly_wait(timeout)elemself.driver.find_element(*locator)LOGGER.info(f找到元素{locator})returnelemexceptNoSuchElementExceptionase:LOGGER.error(f未找到元素{locator}| 错误{e})raisefinally:# 恢复全局隐式等待self.driver.implicitly_wait(10)deffind_elements(self,locator:tuple,timeout:int10):查找多个元素用法同find_elementtry:self.driver.implicitly_wait(timeout)elemsself.driver.find_elements(*locator)LOGGER.info(f找到{len(elems)}个元素{locator})returnelemsexceptNoSuchElementExceptionase:LOGGER.error(f未找到任何元素{locator}| 错误{e})raisefinally:self.driver.implicitly_wait(10)defclick(self,locator:tuple,timeout:int10):通用点击操作链式调用elemself.find_element(locator,timeout)elem.click()LOGGER.info(f点击元素{locator})returnself# 链式调用如page.click(A).click(B)definput_text(self,locator:tuple,text:str,timeout:int10):通用输入操作先清空再输入elemself.find_element(locator,timeout)elem.clear()elem.send_keys(text)LOGGER.info(f输入文本{text}到元素{locator})returnselfdefget_text(self,locator:tuple,timeout:int10)-str:获取元素文本elemself.find_element(locator,timeout)textelem.text LOGGER.info(f获取元素{locator}的文本{text})returntextdefis_element_exist(self,locator:tuple,timeout:int5)-bool:判断元素是否存在返回布尔值不抛异常try:self.find_element(locator,timeout)returnTrueexceptNoSuchElementException:returnFalsedefwait_for_page(self,activity:str,timeout:int10):等待页面跳转Android等待ActivityiOS等待bundle ID页面标识try:self.driver.wait_activity(activity,timeout)LOGGER.info(f页面跳转至{activity})returnselfexceptTimeoutExceptionase:LOGGER.error(f页面跳转超时{activity}| 错误{e})raise6. PO页面类page/login_page.pyfromappium.webdriver.common.appiumbyimportAppiumByfromcommon.base_pageimportBasePagefromcommon.log_configimportLOGGERclassLoginPage(BasePage):登录页PO类替换为你的业务页面# ---------------------- 元素定位器统一管理仅需改这里 ----------------------# 替换你的登录页元素ID/定位值INPUT_USERNAME(AppiumBy.ID,com.test.demo:id/et_username)# 用户名输入框INPUT_PASSWORD(AppiumBy.ID,com.test.demo:id/et_password)# 密码输入框BTN_LOGIN(AppiumBy.ID,com.test.demo:id/btn_login)# 登录按钮TXT_ERROR_TIPS(AppiumBy.ID,com.test.demo:id/tv_error_tips)# 错误提示文本BTN_FORGET_PWD(AppiumBy.ID,com.test.demo:id/btn_forget_pwd)# 忘记密码按钮# ---------------------- 页面操作封装业务逻辑 ----------------------deflogin(self,username:str,password:str):执行登录操作封装业务逻辑用例直接调用LOGGER.info(f开始执行登录用户名{username}密码{password})self.input_text(self.INPUT_USERNAME,username)\.input_text(self.INPUT_PASSWORD,password)\.click(self.BTN_LOGIN)returnselfdefget_error_tips(self)-str:获取登录失败的错误提示returnself.get_text(self.TXT_ERROR_TIPS)defis_login_success(self,home_activity:str.ui.home.HomeActivity)-bool:判断是否登录成功跳转到首页try:self.wait_for_page(home_activity)LOGGER.info(登录成功跳转到首页)returnTrueexceptException:LOGGER.error(登录失败未跳转到首页)returnFalsedefclick_forget_pwd(self):点击忘记密码按钮示例扩展操作self.click(self.BTN_FORGET_PWD)returnself7. 测试数据data/login_data.yaml# 登录测试数据非技术人员可直接编辑无需改代码# 格式用例名称: {参数1: 值1, 参数2: 值2, expected: 预期结果}normal_login:username:test_user_001password:Test123456expected:success# 预期登录成功desc:正常登录-正确账号密码empty_username:username:password:Test123456expected:请输入用户名# 预期错误提示desc:异常登录-用户名为空empty_password:username:test_user_001password:expected:请输入密码desc:异常登录-密码为空wrong_password:username:test_user_001password:Wrong123456expected:用户名或密码错误desc:异常登录-密码错误8. 测试用例test_case/test_login.pyimportpytestimportyamlfrompage.login_pageimportLoginPagefromcommon.driver_managerimportDriverManagerfromcommon.log_configimportLOGGERimportos# 读取外置测试数据defload_login_data():data_pathos.path.join(./data,login_data.yaml)withopen(data_path,r,encodingutf-8)asf:datayaml.safe_load(f)# 转换为pytest参数化格式[(用例名, 用例数据), ...]return[(case_name,case_data)forcase_name,case_dataindata.items()]# pytest参数化遍历所有测试数据pytest.mark.parametrize(case_name, case_data,load_login_data())deftest_login(case_name,case_data):登录用例数据驱动LOGGER.info(f开始执行用例{case_name}-{case_data[desc]})# 初始化登录页PO类login_pageLoginPage()try:# 执行登录操作仅调用PO类的方法不写基础操作login_page.login(case_data[username],case_data[password])# 结果校验根据预期结果分支判断ifcase_data[expected]success:# 校验登录成功跳转到首页assertlogin_page.is_login_success(),登录失败未跳转到首页else:# 校验登录失败显示预期错误提示error_tipslogin_page.get_error_tips()asserterror_tipscase_data[expected],f错误提示不符实际{error_tips}预期{case_data[expected]}LOGGER.info(f用例{case_name}执行成功)exceptAssertionErrorase:LOGGER.error(f用例{case_name}执行失败{e})raisefinally:# 用例执行完销毁驱动如需批量执行可注释在run_test.py中统一销毁DriverManager.quit_driver()# 可选单独执行某个用例调试用if__name____main__:pytest.main([-v,test_login.py::test_login[normal_login]])9. 运行入口run_test.pyimportpytestimportosimportyamlfromcommon.driver_managerimportDriverManagerfromcommon.log_configimportLOGGER# 读取配置withopen(./config/config.yaml,r,encodingutf-8)asf:configyaml.safe_load(f)# 报告目录清理report_pathconfig[path][report_path]ifnotos.path.exists(report_path):os.makedirs(report_path)# 清空旧报告避免缓存forfileinos.listdir(report_path):iffile.endswith((.html,.json)):os.remove(os.path.join(report_path,file))defrun_all_tests():批量执行所有用例生成Allure报告LOGGER.info(开始执行所有测试用例)# pytest运行参数pytest_args[test_case/,# 用例目录-v,# 详细输出--alluredir,f{report_path}/allure-results,# 生成Allure结果文件--clean-alluredir,# 清理旧的Allure结果-s# 输出打印信息]# 执行用例pytest.main(pytest_args)# 生成Allure HTML报告需提前安装Allure见备注os.system(fallure generate{report_path}/allure-results -o{report_path}/allure-report --clean)LOGGER.info(f测试报告已生成{report_path}/allure-report/index.html)# 最后销毁驱动DriverManager.quit_driver()if__name____main__:run_all_tests()备注Allure报告安装需先装JavaWindows下载Allure压缩包解压后配置环境变量执行allure --version验证Mac/Linuxbrew install allure或sudo apt install allure。三、替换业务内容的步骤核心你只需按以下步骤替换模板中的“示例内容”即可适配自己的App步骤1修改配置文件config/config.yaml替换appium.caps中的appPackageApp包名、appActivity登录页Activity调整deviceName为你的测试设备名真机/模拟器如需适配iOS替换为iOS的caps配置。步骤2更新PO页面类page/xxx_page.py复制login_page.py创建自己的业务页面类如home_page.py、order_page.py替换元素定位器将INPUT_USERNAME等替换为你的App实际元素ID/定位值封装业务操作如login()、click_order()等调用BasePage的通用方法。步骤3补充测试数据data/xxx_data.yaml复制login_data.yaml创建对应业务的数据文件按用例名: {参数: 值, expected: 预期结果}格式填写测试数据非技术人员可直接编辑YAML/Excel文件如需Excel可修改load_login_data为pandas读取。步骤4编写测试用例test_case/test_xxx.py复制test_login.py修改用例逻辑调用对应PO页面类的方法按测试数据的预期结果编写断言无需写“点击/输入”等基础操作仅关注业务流程。四、运行与验证1. 环境准备# 1. 安装依赖pipinstall-rrequirements.txt# 2. 启动Appium服务终端执行appium--port4723# 3. 连接测试设备真机/模拟器# - 模拟器启动Android/iOS模拟器# - 真机开启开发者模式连接电脑执行adb devices确认设备在线。2. 运行用例# 方式1执行单个用例调试python test_case/test_login.py# 方式2批量执行所有用例生成Allure报告python run_test.py3. 查看结果日志logs/app_ui_auto.log查看执行详情/错误报告打开report/allure-report/index.html查看可视化测试报告。五、工程化扩展建议可选多环境适配在config.yaml中添加dev/test/prod环境配置运行时指定环境Excel数据支持修改load_login_data为pandas读取Excel适配非技术人员CI/CD集成将run_test.py集成到Jenkins/GitHub Actions实现提测后自动执行失败重跑在run_test.py中添加--reruns 2参数失败用例自动重跑2次页面等待优化在BasePage中添加wait_for_element显式等待元素可点击。总结这套模板的核心优势低耦合页面变更仅改PO类数据变更仅改YAML用例逻辑不变易维护通用操作封装在BasePage无需重复编写非技术友好测试数据外置产品/测试可直接维护工程化日志、报告、配置分离符合企业级落地标准。