Kea2-python 0.1.3__py3-none-any.whl → 0.2.0__py3-none-any.whl

kea2/u2Driver.py

@@ -1,10 +1,13 @@
 import random
 import socket
+from time import sleep
 import uiautomator2 as u2
+import adbutils
 import types
 import rtree
 import re
-from typing import Dict, List, Union
+from typing import Any, Dict, List, Union
+from http.client import HTTPResponse
 from lxml import etree
 from .absDriver import AbstractScriptDriver, AbstractStaticChecker, AbstractDriver
 from .adbUtils import list_forwards, remove_forward, create_forward
@@ -16,7 +19,7 @@ import logging
 logging.getLogger("urllib3").setLevel(logging.INFO)
 logging.getLogger("uiautomator2").setLevel(logging.INFO)
 
-logger = getLogger(__name__)
+logger = getLogger(__name__) 
 
 """
 The definition of U2ScriptDriver
@@ -35,34 +38,24 @@ class U2ScriptDriver(AbstractScriptDriver):
     """
 
     deviceSerial: str = None
+    transportId: str = None
     d = None
 
+    @classmethod
+    def setTransportId(cls, transportId):
+        cls.transportId = transportId
+
     @classmethod
     def setDeviceSerial(cls, deviceSerial):
         cls.deviceSerial = deviceSerial
 
     def getInstance(self):
         if self.d is None:
-            self.d = (
-                u2.connect() if self.deviceSerial is None
-                else u2.connect(self.deviceSerial)
-            )
-
-            def get_u2_forward_port() -> int:
-                """rewrite forward_port mothod to avoid the relocation of port
-                :return: the new forward port
-                """
-                print("Rewriting forward_port method", flush=True)
-                self.d._dev.forward_port = types.MethodType(
-                                forward_port, self.d._dev)
-                lport = self.d._dev.forward_port(8090)
-                setattr(self.d._dev, "msg", "meta")
-                print(f"[U2] local port: {lport}", flush=True)
-                return lport
-
-            self._remove_remote_port(8090)
-            self.d.lport = get_u2_forward_port()
-            self._remove_remote_port(9008)
+            adb = adbutils.device(serial=self.deviceSerial, transport_id=self.transportId)
+            print("[INFO] Connecting to uiautomator2. Please wait ...")
+            self.d = u2.connect(adb)
+            sleep(5)
+            self.d._device_server_port = 8090
 
         return self.d
 
@@ -76,10 +69,11 @@ class U2ScriptDriver(AbstractScriptDriver):
                 remove_forward(local_spec=forward_local, device=self.deviceSerial)
 
     def tearDown(self):
-        logger.debug("U2Driver tearDown: stop_uiautomator")
-        self.d.stop_uiautomator()
-        logger.debug("U2Driver tearDown: remove forward")
-        self._remove_remote_port(8090)
+        # logger.debug("U2Driver tearDown: stop_uiautomator")
+        # self.d.stop_uiautomator()
+        # logger.debug("U2Driver tearDown: remove forward")
+        # self._remove_remote_port(8090)
+        pass
 
 """
 The definition of U2StaticChecker
@@ -207,7 +201,7 @@ class StaticU2UiObject(u2.UiObject):
     
     def sibling(self, **kwargs):
         return StaticU2UiObject(self.session, self.selector.clone().sibling(**kwargs))
-    
+
     def __getattr__(self, attr):
         return getattr(super(), attr)
 
@@ -366,8 +360,11 @@ class U2Driver(AbstractDriver):
     staticChecker = None
 
     @classmethod
-    def setDeviceSerial(cls, deviceSerial):
-        U2ScriptDriver.setDeviceSerial(deviceSerial)
+    def setDevice(cls, kwarg):
+        if kwarg.get("serial"):
+            U2ScriptDriver.setDeviceSerial(kwarg["serial"])
+        if kwarg.get("transport_id"):
+            U2ScriptDriver.setTransportId(kwarg["transport_id"])
 
     @classmethod
     def getScriptDriver(self):
@@ -400,7 +397,7 @@ def forward_port(self, remote: Union[int, str]) -> int:
                 and f.remote == remote
                 and f.local.startswith("tcp:")
             ):  # yapf: disable
-                return int(f.local[len("tcp:") :])
+                return int(f.local[len("tcp:"):])
         local_port = get_free_port()
         self.forward("tcp:" + str(local_port), remote)
         logger.debug(f"forwading port: tcp:{local_port} -> {remote}")

kea2/utils.py

@@ -13,6 +13,7 @@ def getLogger(name: str) -> logging.Logger:
         if not logger.handlers:
             # Configure handler
             handler = logging.StreamHandler()
+            handler.flush = lambda: handler.stream.flush()  # 确保每次都flush
             formatter = logging.Formatter('[%(levelname)1s][%(asctime)s %(module)s:%(lineno)d pid:%(process)d] %(message)s')
             handler.setFormatter(formatter)
             logger.addHandler(handler)

{kea2_python-0.1.3.dist-info → kea2_python-0.2.0.dist-info}/METADATA

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: Kea2-python
-Version: 0.1.3
+Version: 0.2.0
 Summary: A python library for supporting and customizing automated UI testing for mobile apps
 Author-email: Xixian Liang <xixian@stu.ecnu.edu.cn>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: rtree>=1.3.0
-Requires-Dist: uiautomator2>=3.2.9
 Requires-Dist: jinja2>=3.0.0
+Requires-Dist: uiautomator2>=3.3.3
+Requires-Dist: adbutils>=2.9.3
 Dynamic: license-file
 
 
@@ -22,21 +23,36 @@ Dynamic: license-file
     <img src="https://github.com/user-attachments/assets/aa5839fc-4542-46f6-918b-c9f891356c84" style="border-radius: 14px; width: 20%; height: 20%;"/> 
 </div>
 
-## About
+### Github repo link
+[https://github.com/ecnusse/Kea2](https://github.com/ecnusse/Kea2)
 
-Kea2 is an easy-to-use Python library for supporting, customizing and improving automated UI testing for mobile apps. Kea2's novelty is able to fuse the scripts (usually written by human) with automated UI testing tools, thus allowing many interesting and powerful features. 
+### [点击此处：查看中文文档](README_cn.md)
 
-Kea2 is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2) and targets [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
+## About 
+
+Kea2 is an easy-to-use tool for fuzzing mobile apps. Its key *novelty* is able to fuse automated UI testing with scripts (usually written by human), thus empowering automated UI testing with human intelligence for effectively finding *crashing bugs* as well as *non-crashing functional (logic) bugs*. 
+
+Kea2 is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android), *an industrial-strength automated UI testing tool*, and [uiautomator2](https://github.com/openatx/uiautomator2), *an easy-to-use and stable Android automation library*.
+Kea2 currently targets [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
+
+## Novelty & Important features
+
+<div align="center">
+    <div style="max-width:80%; max-height:80%">
+    <img src="docs/intro.png" style="border-radius: 14px; width: 80%; height: 80%;"/> 
+    </div>
+</div>
 
-## Important features
 - **Feature 1**(查找稳定性问题): coming with the full capability of [Fastbot](https://github.com/bytedance/Fastbot_Android) for stress testing and finding *stability problems* (i.e., *crashing bugs*); 
 
 - **Feature 2**(自定义测试场景\事件序列\黑白名单\黑白控件[^1]): customizing testing scenarios when running Fastbot (e.g., testing specific app functionalities, executing specific event traces, entering specifc UI pages, reaching specific app states, blacklisting specific activities/UI widgets/UI regions) with the full capability and flexibility powered by *python* language and [uiautomator2](https://github.com/openatx/uiautomator2);
 
-- **Feature 3**(支持断言机制[^2]): supporting auto-assertions when running Fastbot, based on the idea of [property-based testing](https://en.wikipedia.org/wiki/Software_testing#Property_testing) inheritted from [Kea](https://github.com/ecnusse/Kea), for finding *logic bugs* (i.e., *non-crashing bugs*)
+- **Feature 3**(支持断言机制[^2]): supporting auto-assertions when running Fastbot, based on the idea of [property-based testing](https://en.wikipedia.org/wiki/Software_testing#Property_testing) inheritted from [Kea](https://github.com/ecnusse/Kea), for finding *logic bugs* (i.e., *non-crashing functional bugs*).
 
+    For **Feature 2 and 3**, Kea2 allows you to focus on what app functionalities to be tested. You do not need to worry about how to reach these app functionalities. Just let Fastbot help. As a result, your scripts are usually short, robust and easy to maintain, and the corresponding app functionalities are much more stress-tested!
 
 **The ability of the three features in Kea2**
+
 |  | **Feature 1** | **Feature 2** | **Feature 3** |
 | --- | --- | --- | ---- |
 | **Finding crashes** | :+1: | :+1: | :+1: |
@@ -44,24 +60,17 @@ Kea2 is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot
 | **Finding non-crashing functional (logic) bugs** |  |  | :+1: |
 
 
-<div align="center">
-    <div style="max-width:80%; max-height:80%">
-    <img src="docs/intro.png" style="border-radius: 14px; width: 80%; height: 80%;"/> 
-    </div>
-</div>
-
-
 
 ## Design & Roadmap
-Kea2, released as a Python library, currently works with:
-- [unittest](https://docs.python.org/3/library/unittest.html) as the testing framework;
+Kea2 currently works with:
+- [unittest](https://docs.python.org/3/library/unittest.html) as the testing framework to manage the scripts;
 - [uiautomator2](https://github.com/openatx/uiautomator2) as the UI test driver; 
 - [Fastbot](https://github.com/bytedance/Fastbot_Android) as the backend automated UI testing tool.
 
 In the future, Kea2 will be extended to support
-- [pytest](https://docs.pytest.org/en/stable/)
-- [Appium](https://github.com/appium/appium), [Hypium](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/hypium-python-guidelines) (for HarmonyOS/Open Harmony)
-- other automated UI testing tools (not limited to Fastbot)
+- [pytest](https://docs.pytest.org/en/stable/), another popular python testing framework;
+- [Appium](https://github.com/appium/appium), [Hypium](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/hypium-python-guidelines) (for HarmonyOS/Open Harmony);
+- any other automated UI testing tools (not limited to Fastbot)
 
 
 ## Installation
@@ -115,7 +124,7 @@ Test your app with the full capability of Fastbot for stress testing and finding
 kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent native --running-minutes 10 --throttle 200
 ```
 
-理解上述选项含义请查看[文档](docs/manual_en.md#launching-kea2)
+To understand the meanings of the options, you can see our [manual](docs/manual_en.md#launching-kea2).
 
 > The usage is similar to the the original Fastbot's [shell commands](https://github.com/bytedance/Fastbot_Android?tab=readme-ov-file#run-fastbot-with-shell-command). 
 
@@ -178,13 +187,14 @@ In Feature 3, a script is composed of three elements:
 
 In a social media app, message sending is a common feature. On the message sending page, the `send` button should always appears when the input box is not empty (i.e., has some message).
 
-<div align="center" >
-    <div >
-        <img src="docs/socialAppBug.png" style="border-radius: 14px; width:30%; height:40%;"/>
-    </div>
-    <p>The expected behavior (the upper figure) and the buggy behavior (the lower figure).
-<p/>
+<div align="center">
+    <img src="docs/socialAppBug.png" style="border-radius: 14px; width:30%; height:40%;"/>
+</div>
+
+<div align="center">
+    The expected behavior (the upper figure) and the buggy behavior (the lower figure).
 </div>
+    
 
 For the preceding always-holding property, we can write the following script to validate the functional correctness: when there is an `input_box` widget on the message sending page, we can type any non-empty string text into the input box and assert `send_button` should always exists.
 
@@ -209,12 +219,12 @@ You can run this example by using the similar command line in Feature 2.
 
 ## Documentations（更多文档）
 
-[更多文档](docs/manual_en.md)，包括了：
-- Kea2的案例教程（基于微信介绍）、
-- Kea2脚本的定义方法，支持的脚本装饰器(如`@precondition`、`@prob`、`@max_tries`)、
-- Kea2的启动方式、命令行选项
-- 查看/理解Kea2的运行结果（如界面截图、测试覆盖率、脚本执行成功与否）。
-- [如何黑白控件/区域](docs/blacklisting.md)
+You can find the [user manual](docs/manual_en.md), which includes:
+- Examples of using Kea2 on WeChat (in Chinese);
+- How to define Kea2's scripts and use the decorators (e.g., `@precondition`、`@prob`、`@max_tries`);
+- How to run Kea2 and Kea2's command line options
+- How to find and understand Kea2's testing results
+- How to [whitelist or blacklist](docs/blacklisting.md) specific activities, UI widgets and UI regions during fuzzing
 
 ## Open-source projects used by Kea2
 

{kea2_python-0.1.3.dist-info → kea2_python-0.2.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
 kea2/__init__.py,sha256=JFJjqgf5KB4bXUFQ3upkEug0cFMFIk9p3OHV9vzulHw,75
-kea2/absDriver.py,sha256=X99d-OP77EIiDwTLvWVkgDUtqscoxmWeOb-EcaOPWGI,1294
-kea2/adbUtils.py,sha256=j6goAAzV1Ikmv26DZEE0Oi8S1PrejcV1Io3u_Xw4ws4,9910
-kea2/bug_report_generator.py,sha256=G5h9nI1w1UaksjF3gkMC8UrXgiNmtU1D5VIuPiciOak,22792
+kea2/absDriver.py,sha256=NzmsLs1Ojz-yEXctGAqj7aKBwAQW19zd83l65RABCe8,1288
+kea2/adbUtils.py,sha256=1t5oxr3CVen2kn4ilPy7lZolnEDawVXAjfDwXJMjBIk,19532
+kea2/bug_report_generator.py,sha256=avpZgUywmUePO1_2dDXBgUkxAAa0gpiTpaDtyjInw7Q,20245
 kea2/cli.py,sha256=YgWOe5JB0_WBTKyBShBEymhLIqj6K5gNR4Aaj6Pbtn0,2796
-kea2/fastbotManager.py,sha256=Ru7Aitcjlem52npJJLg-3KX5ctCoflaaLG4N0IgQ2QU,4828
-kea2/keaUtils.py,sha256=XylgzSS4_DcQn3SjbJJ2bA82v0LQV1qmbgZPRjBh-ZE,25932
-kea2/kea_launcher.py,sha256=xDMHAzD2Ig2Dug9K4MzkTPwieKvLASmjUahEst8aaVU,5291
+kea2/fastbotManager.py,sha256=DI5jtUEf2ro9I2MNKxw6Oh42nmEjcpLecEMj0IhKZGs,6974
+kea2/keaUtils.py,sha256=yNuEIIWfxTBfApiasKy9eMD-iKeLLH0LKunZbuxL_j8,25595
+kea2/kea_launcher.py,sha256=eV8MvWWRwbhXJ2IaxjSIRL9ZyZF6OKlEeWzAfwkoXLg,5712
 kea2/logWatcher.py,sha256=qpIsflbP37eX5b4EaWnrqyPbGP9lzQhRr3ainGFfZeI,2211
-kea2/resultSyncer.py,sha256=f3qfne8WQCo1AA3cwx9IZzLdenjjMWbEpAqPdvddAqk,1984
-kea2/u2Driver.py,sha256=__rP_d5uY029_eAxPNUiNw3lq8PVLf8QZRe3uwZEmb4,15779
-kea2/utils.py,sha256=8b4y-_B7knKRN_HqpWZM900IdRiZXwmzQnduVVN0GxQ,1384
+kea2/resultSyncer.py,sha256=9kb3H0Innwj7oPboDDTf97nbjam7EP6HYxywR9B8SvM,2437
+kea2/u2Driver.py,sha256=nRleo-NmKuqgY-_4aiPREDQ2Yw-9yawd9hdslD1RmE4,15539
+kea2/utils.py,sha256=ErMUCwKddA6xETE8xKFI281N6iiVzpDBEhfSZ_JFNGQ,1467
 kea2/assets/fastbot-thirdpart.jar,sha256=0SZ_OoZFWDGMnazgXKceHgKvXdUDoIa3Gb2bcifaikk,85664
 kea2/assets/framework.jar,sha256=rTluOJJKj2DFwh7ascXso1udYdWv00BxBwSQ3Vmv-fw,1149240
 kea2/assets/kea2-thirdpart.jar,sha256=HYdtG2gqDLuLb72dpK3lX-Y6QUNTrJ-bfQopU5aWpfo,359346
@@ -27,10 +27,10 @@ kea2/assets/fastbot_libs/arm64-v8a/libfastbot_native.so,sha256=tAFrG73pJi7XakRxS
 kea2/assets/fastbot_libs/armeabi-v7a/libfastbot_native.so,sha256=UV8bhaiPoPKdd3q0vj3kSZqPR9anllai_tz_2QkMMbQ,1335372
 kea2/assets/fastbot_libs/x86/libfastbot_native.so,sha256=k-aw1gEXRWMKZRNHIggKNuZy0wC1y2BnveJGEIO6rbo,2036856
 kea2/assets/fastbot_libs/x86_64/libfastbot_native.so,sha256=tiofhlf4uMQcU5WAvrdLgTBME0lb83hVUoGtTwxmE8A,2121416
-kea2/templates/bug_report_template.html,sha256=sQ0Uu8SPeOIiyX5vPPTZPVKxh9-9raAZcCjSRS8YFe0,40624
-kea2_python-0.1.3.dist-info/licenses/LICENSE,sha256=nM9PPjcsXVo5SzNsjRqWgA-gdJlwqZZcRDSC6Qf6bVE,2034
-kea2_python-0.1.3.dist-info/METADATA,sha256=Y2ICVucbBO8JybwZMNKtTQSl_rJdndmKkD4PAVPwQWk,13234
-kea2_python-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kea2_python-0.1.3.dist-info/entry_points.txt,sha256=mFX06TyxXiUAJQ6JZn8QHzfn8n5R8_KJ5W-pTm_fRCA,39
-kea2_python-0.1.3.dist-info/top_level.txt,sha256=TsgNH4PQoNOVhegpO7AcjutMVWp6Z4KDL1pBH9FnMmk,5
-kea2_python-0.1.3.dist-info/RECORD,,
+kea2/templates/bug_report_template.html,sha256=59KL5rRwGwKs7mNgtiWSSUD_NG_5Cu5Agq4QfydCLt8,37935
+kea2_python-0.2.0.dist-info/licenses/LICENSE,sha256=nM9PPjcsXVo5SzNsjRqWgA-gdJlwqZZcRDSC6Qf6bVE,2034
+kea2_python-0.2.0.dist-info/METADATA,sha256=zszS6ye6p4gYZLscTZdxah8GI3-dowxlEJNKAuRxijg,14023
+kea2_python-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kea2_python-0.2.0.dist-info/entry_points.txt,sha256=mFX06TyxXiUAJQ6JZn8QHzfn8n5R8_KJ5W-pTm_fRCA,39
+kea2_python-0.2.0.dist-info/top_level.txt,sha256=TsgNH4PQoNOVhegpO7AcjutMVWp6Z4KDL1pBH9FnMmk,5
+kea2_python-0.2.0.dist-info/RECORD,,