applib-ui 0.0.1__py3-none-any.whl

applib_ui/__init__.py

@@ -0,0 +1,13 @@
+from .running.runner import main
+from .running.conf import App
+from .utils.config import FileConfig
+from .utils.pytest_util import *
+from .utils.allure_util import *
+from .utils.log import logger
+from .page import Page
+from .element import Elem
+from .case import TestCase
+
+
+__version__ = "0.0.1"
+__description__ = "Android / iOS 通用 UI 自动化测试框架"

applib_ui/case.py

@@ -0,0 +1,79 @@
+import time
+
+import pytest
+
+from .running.conf import App
+from .utils.log import logger
+
+
+class TestCase:
+    """pytest 测试基类；也可以直接在测试函数中使用 app_driver fixture。"""
+
+    dr = None
+
+    def start_class(self):
+        pass
+
+    def end_class(self):
+        pass
+
+    @classmethod
+    def setup_class(cls):
+        cls().start_class()
+
+    @classmethod
+    def teardown_class(cls):
+        cls().end_class()
+
+    def start(self):
+        pass
+
+    def end(self):
+        pass
+
+    @pytest.fixture(autouse=True)
+    def _app_lifecycle(self, app_driver):
+        self.dr = app_driver
+        try:
+            if getattr(self, '_platform', None) is not None:
+                self.dr.unlock()
+            self.start()
+            yield
+        finally:
+            self.end()
+
+    @staticmethod
+    def sleep(n: float):
+        logger.info(f"暂停: {n}s")
+        time.sleep(n)
+
+    def shot(self, name: str, delay=0):
+        if delay:
+            self.sleep(delay)
+        return self.dr.shot(name)
+
+    def start_record(self, video_name='record'):
+        """开始录屏"""
+        return self.dr.start_record(video_name)
+
+    def stop_record(self):
+        """结束录屏并上传 allure"""
+        return self.dr.stop_record()
+
+    def start_app(self, force=True, activity=None, use_monkey=False):
+        if force:
+            self.stop_app()
+        if App.platform == 'ios':
+            self.dr.start_app()
+        elif activity is not None:
+            self.dr.start_app(activity=activity)
+        elif use_monkey:
+            self.dr.start_app(use_monkey=True)
+        else:
+            self.dr.start_app()
+
+    def stop_app(self):
+        self.dr.stop_app()
+
+    def back(self):
+        self.dr.back()

applib_ui/cli.py

@@ -0,0 +1,75 @@
+import click
+from . import __version__
+
+@click.group()
+@click.version_option(version=__version__, help="Show version.")
+def main():
+    """applib-ui 移动端自动化工具。"""
+
+
+@main.command(context_settings={'ignore_unknown_options': True})
+@click.argument('pytest_args', nargs=-1, type=click.UNPROCESSED)
+def run(pytest_args):
+    """运行 pytest，透传路径、筛选条件和报告等参数。"""
+    import pytest
+
+    raise SystemExit(pytest.main(list(pytest_args)))
+
+
+@main.command()
+@click.option('-u', '--udid', help="Specify the udid.")
+def restart_wda(udid):
+    """
+    重启wda
+    @param udid: IOS设备udid
+    @return:
+    """
+    from .core.ios.local_wda import LocalWdaInit
+
+    LocalWdaInit(udid=udid).restart_wda()
+
+@main.command()
+@click.option('-u', '--udid', help="Specify the udid.")
+def start_wda(udid):
+    """
+    启动wda
+    @param udid: IOS设备udid
+    @return:
+    """
+    from .core.ios.local_wda import LocalWdaInit
+
+    LocalWdaInit(udid=udid).run()
+
+@main.command()
+@click.option('-u', '--udid', help="Specify the udid.")
+def stop_wda(udid):
+    """
+    杀掉wda
+    @param udid: IOS设备udid
+    @return:
+    """
+    from .core.ios.local_wda import LocalWdaInit
+
+    LocalWdaInit(udid=udid).kill_wda_server()
+
+
+# @main.command()
+# @click.option('-p', '--platform', help="Specify the platform.")
+# @click.option('-u', '--url', help="Specify the url.")
+# def inspector(platform, url):
+#     """
+#     获取元素定位信息
+#     @param platform: 平台，android、ios、web
+#     @param url：针对web，需要录制的页面的url
+#     @return:
+#     """
+#     import os
+#     if platform in ['android', 'ios', 'web']:
+#         os.system('weditor')
+#     elif platform == 'web':
+#         if not url:
+#             raise KeyError('url不能为空')
+#         os.system(f'playwright codegen {url}')
+#     else:
+#         raise KeyError('只支持android、ios、web')
+

applib_ui/core/android/__init__.py

@@ -0,0 +1,16 @@
+"""android 平台接口，按需加载驱动依赖。"""
+
+from importlib import import_module
+
+__all__ = ['Elem', 'Page', 'Driver', 'RemoteDriver', 'TestCase']
+
+_MODULES = {'Elem': 'element', 'Page': 'page', 'Driver': 'driver',
+            'RemoteDriver': 'remote_driver', 'TestCase': 'case'}
+
+
+def __getattr__(name):
+    if name not in _MODULES:
+        raise AttributeError(f'module {__name__!r} has no attribute {name!r}')
+    value = getattr(import_module(f'.{_MODULES[name]}', __name__), name)
+    globals()[name] = value
+    return value

applib_ui/core/android/case.py

@@ -0,0 +1,8 @@
+from ...case import TestCase as BaseTestCase
+
+
+class TestCase(BaseTestCase):
+    """Android pytest 测试基类。"""
+
+    _platform = 'android'
+

applib_ui/core/android/driver.py

@@ -0,0 +1,191 @@
+import allure
+import uiautomator2 as u2
+
+from applib_ui.utils.log import logger
+from applib_ui.utils.common import general_file_path, general_video_path
+from .recorder import ScrcpyRecorder
+
+
+class Driver:
+    """
+    u2库代码地址：https://github.com/openatx/uiautomator2
+    """
+
+    def __init__(self, serial: str, package: str = None):
+        """
+        @param serial: 设备序列号，通过adb devices获取，或者通过关于手机-序列号获取
+        @param package: 应用包名，通过adb shell pm list packages获取
+        """
+        logger.info(f"初始化本地设备连接: {serial}")
+        self.serial = serial
+        self.package = package
+        self.d = u2.connect(serial)
+        self._recorder = None
+
+    def uninstall_app(self, package: str = None):
+        """
+        卸载应用
+        @param package: 应用包名
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.package = package
+        logger.info(f"卸载应用: {self.package}")
+        self.d.app_uninstall(self.package)
+
+    def install_app(self, apk_url, package: str = None):
+        """
+        安装应用
+        @param apk_url: apk链接
+        @param package: 应用包名
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.package = package
+        self.d.app_uninstall(self.package)
+        logger.info(f"安装应用: {apk_url}")
+        self.d.app_install(apk_url)
+
+    def start_app(self, package: str = None, activity: str = None, use_monkey: bool = False):
+        """
+        启动应用
+        @param package: 应用包名
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.package = package
+        logger.info(f"启动应用: {self.package}")
+        if activity is not None:
+            self.d.app_start(package_name=self.package, activity=activity)
+        else:
+            self.d.app_start(package_name=self.package, use_monkey=use_monkey)
+
+    def stop_app(self, package: str = None):
+        """
+        停止应用
+        @param package: 应用包名
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.package = package
+        logger.info(f"停止应用: {self.package}")
+        self.d.app_stop(self.package)
+
+    def shot(self, file_name: str = None):
+        """
+        截图
+        @param file_name: 截图保存后的文件名
+        @return:
+        """
+        file_path = general_file_path(file_name, self.serial)
+        logger.info(f"截图保存至: {file_path}")
+        self.d.screenshot(file_path)
+
+        logger.info("截图上传allure报告")
+        allure.attach.file(
+            file_path,
+            attachment_type=allure.attachment_type.PNG,
+            name=f"{file_path}",
+        )
+        return file_path
+
+    def click(self, x, y):
+        """
+        点击坐标
+        @param x: 横坐标
+        @param y: 纵坐标
+        @return:
+        """
+        self.d.click(x, y)
+
+    def input(self, *args, **kwargs):
+        """
+        输入
+        @param args:
+        @param kwargs:
+        @return:
+        """
+        self.d.send_keys(*args, **kwargs)
+
+    def unlock(self):
+        """
+        设备解锁
+        @return:
+        """
+        self.d.unlock()
+
+    def shell(self, *args, **kwargs):
+        """
+        执行adb shell
+        @param args:
+        @param kwargs:
+        @return:
+        """
+        self.d.shell(*args, **kwargs)
+
+
+    def back(self):
+        logger.info("返回上一页")
+        self.d.press('back')
+
+    def start_record(self, file_name: str = "record"):
+        """
+        开始录屏
+        @param file_name: 录屏文件名
+        @return: 录像路径；录制没起来返回 None（最终产物以 stop_record 的返回值为准）
+        """
+        if self._recorder is not None:
+            self.stop_record()
+        file_path = general_video_path(file_name, self.serial)
+        self._recorder = ScrcpyRecorder(self.serial)
+        if not self._recorder.start(file_path):
+            # 没起来：原因已由 recorder 打成 ERROR，这里返回 None，别让调用方以为正在录
+            self._recorder = None
+            return None
+        return file_path
+
+    def stop_record(self):
+        """
+        停止录屏并上传allure
+        @return:
+        """
+        if self._recorder is None:
+            return None
+        file_path = self._recorder.stop()
+        self._recorder = None
+        return file_path
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

applib_ui/core/android/element.py

@@ -0,0 +1,291 @@
+import typing
+from .driver import Driver
+
+from applib_ui.utils.log import logger
+from uiautomator2 import UiObject
+from uiautomator2.xpath import XPathSelector
+
+
+# 链式调用临时存储定位方式
+# class BaseLocator:
+#
+#     def __init__(self, **kwargs):
+#         self.rid = kwargs.get('rid', None)
+#         self.text = kwargs.get('text', None)
+#         self.xpath = kwargs.get('xpath', None)
+#         self.type = 'current'
+
+
+class ChildLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'child'
+
+
+class SiblingLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'sibling'
+
+
+class LeftLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'left'
+
+
+class RightLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'right'
+
+
+class UpLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'up'
+
+
+class DownLocator:
+
+    def __init__(self, *args, **kwargs):
+        self.args = args
+        self.kwargs = kwargs
+        self.type = 'down'
+
+
+class Elem(object):
+    """
+    安卓控件定义
+    https://github.com/openatx/uiautomator2
+    """
+
+    def __init__(self,
+                 tag=None,
+                 ):
+        """
+        @param tag: 元素名称，方面后续维护
+        """
+        self.tag = tag
+        # self._kwargs = kwargs
+        self._driver: Driver = None
+        # self._xpath = kwargs.get('xpath', None)
+        # self._watch = watch
+        self._first_locator = None
+        self._locators = []
+        # if 'rid' in self._kwargs:
+        #     self._kwargs['resourceId'] = self._kwargs.pop('rid')
+        # self._pkg = App.pkg
+        # if 'resourceId' in self._kwargs:
+        #     if not self._kwargs['resourceId'].startswith(self._pkg):
+        #         if not self._pkg:
+        #             raise KeyError('应用包名不能为空')
+        #         else:
+        #             self._kwargs['resourceId'] = self._pkg + ":" + self._kwargs['resourceId']
+
+    def __get__(self, instance, owner):
+        """po模式中element初始化不需要带driver的关键"""
+        if instance is None:
+            return None
+
+        self._driver = instance.driver
+        return self
+
+    # 链式调用方法
+    # def get_by_rid(self, rid):
+    #     self.locators.append(BaseLocator(rid=rid))
+    #     return self
+    #
+    # def get_by_text(self, text):
+    #     self.locators.append(BaseLocator(text=text))
+    #     return self
+    #
+    # def get_by_xpath(self, xpath):
+    #     self.locators.append(BaseLocator(xpath=xpath))
+    #     return self
+
+    def loc(self, **kwargs):
+        if not kwargs:
+            raise KeyError('定位方式不能为空')
+        if 'xpath' in kwargs:
+            self._first_locator = kwargs.pop('xpath')
+        else:
+            self._first_locator = kwargs
+        return self
+
+    def child(self, *args, **kwargs):
+        self._locators.append(ChildLocator(*args, **kwargs))
+        return self
+
+    def sibling(self, *args, **kwargs):
+        self._locators.append(SiblingLocator(*args, **kwargs))
+        return self
+
+    def left(self, *args, **kwargs):
+        self._locators.append(LeftLocator(*args, **kwargs))
+        return self
+
+    def right(self, *args, **kwargs):
+        self._locators.append(RightLocator(*args, **kwargs))
+        return self
+
+    def up(self, *args, **kwargs):
+        self._locators.append(UpLocator(*args, **kwargs))
+        return self
+
+    def down(self, *args, **kwargs):
+        self._locators.append(DownLocator(*args, **kwargs))
+        return self
+
+    # # 公共方法
+    # def watch_handler(self):
+    #     """
+    #     异常弹窗处理
+    #     @return:
+    #     """
+    #     logger.info(f"开始弹窗检测: {self._watch}")
+    #     ctx = self._driver.d.watch_context()
+    #     for loc in self._watch:
+    #         ctx.when(loc).click()
+    #     ctx.wait_stable()
+    #     ctx.close()
+    #     logger.info("检测结束")
+
+    def find(self, timeout=5):
+        """
+        增加截图的方法
+        @param timeout: 每次查找时间
+        @return:
+        """
+        logger.info(f"查找: {self.tag}")
+        # 第一个定位
+        if isinstance(self._first_locator, dict):
+            _element = self._driver.d(**self._first_locator)
+        else:
+            _element = self._driver.d.xpath(self._first_locator)
+
+        # 后面的定位
+        if self._locators:
+            for loc_obj in self._locators:
+                if loc_obj.type == "child":
+                    _element = _element.child(*loc_obj.args, **loc_obj.kwargs)
+                elif loc_obj.type == 'sibling':
+                    _element = _element.sibling(*loc_obj.args, **loc_obj.kwargs)
+                elif loc_obj.type == 'left':
+                    _element = _element.left(*loc_obj.args, **loc_obj.kwargs)
+                elif loc_obj.type == 'right':
+                    _element = _element.right(*loc_obj.args, **loc_obj.kwargs)
+                elif loc_obj.type == 'up':
+                    _element = _element.up(*loc_obj.args, **loc_obj.kwargs)
+                elif loc_obj.type == 'down':
+                    _element = _element.down(*loc_obj.args, **loc_obj.kwargs)
+
+        if _element.wait(timeout=timeout):
+            logger.info(f"查找成功")
+            return _element
+        else:
+            logger.info("查找失败")
+            self._driver.shot(f"{self.tag}_查找失败")
+            raise Exception(f"{self.tag}, 查找失败")
+
+    # 属性获取
+    def get_text(self, timeout=5):
+        logger.info(f"获取{self.tag}的文本")
+        _elem = self.find(timeout=timeout)
+        text = _elem.get_text()
+        logger.info(f"获取成功: {text}")
+        return text
+
+    def get_texts(self, timeout=5):
+        logger.info(f"获取{self.tag}的文本")
+        _elem = self.find(timeout=timeout)
+        texts = []
+        if isinstance(_elem, XPathSelector):
+            elems = _elem.all()
+            for elem in elems:
+                texts.append(elem.text)
+        else:
+            elems = list(_elem)
+            for elem in elems:
+                texts.append(elem.get_text())
+        logger.info(f"获取成功: {texts}")
+        return texts
+
+    def exists(self, timeout=5):
+        logger.info(f"判断{self.tag}是否存在")
+        result = False
+        try:
+            _element = self.find(timeout=timeout)
+            result = True
+        except:
+            result = False
+        finally:
+            logger.info(result)
+            return result
+
+    def center(self, timeout=5, *args, **kwargs):
+        return self.find(timeout=timeout).center(*args, **kwargs)
+
+    @staticmethod
+    def _adapt_center(e: typing.Union[UiObject, XPathSelector],
+                      offset=(0.5, 0.5)):
+        """
+        修正控件中心坐标
+        """
+        if isinstance(e, UiObject):
+            return e.center(offset=offset)
+        else:
+            return e.offset(offset[0], offset[1])
+
+    # 操作
+    def click_exists(self, timeout=5):
+        logger.info(f"{self.tag}存在才点击")
+        try:
+            element = self.find(timeout=timeout)
+            x, y = self._adapt_center(element)
+            self._driver.click(x, y)
+            logger.info("点击完成")
+        except:
+            logger.info("不存在，不进行操作")
+
+    def click(self, timeout=5):
+        logger.info(f"{self.tag}点击")
+        element = self.find(timeout=timeout)
+        x, y = self._adapt_center(element)
+        self._driver.click(x, y)
+        logger.info("点击完成")
+
+    def input(self, text, timeout=5, clear=False, pwd_check=False):
+        logger.info(f"{self.tag}输入: {text}")
+        element = self.find(timeout=timeout)
+        # 清空输入框
+        if clear is True:
+            element.clear_text()
+        # 点击输入框
+        x, y = self._adapt_center(element)
+        self._driver.click(x, y)
+        # 输入
+        if pwd_check is True:
+            self._driver.d(focused=True).set_text(text)
+        else:
+            self._driver.input(text)
+        logger.info("输入完成")
+
+
+
+
+
+
+
+
+

applib_ui/core/android/page.py

@@ -0,0 +1,6 @@
+class Page(object):
+    """页面基类，用于pom模式封装"""
+
+    def __init__(self, driver):
+        self.driver = driver
+