Kea2-python 0.0.1a2__tar.gz → 0.0.1a4__tar.gz

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/Kea2_python.egg-info/PKG-INFO

@@ -1,18 +1,18 @@
 Metadata-Version: 2.4
 Name: Kea2-python
-Version: 0.0.1a2
+Version: 0.0.1a4
 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.9
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: rtree>=1.4.0
+Requires-Dist: rtree>=1.3.0
 Requires-Dist: uiautomator2>=3.2.9
 Dynamic: license-file
 
 # Introduction 
 
-Kea2 is an easy-to-use Python library for supporting and customizing automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
+Kea2 is an easy-to-use Python library for supporting, customizing and improving automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
 
 ### Kea2 has three 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*); 
@@ -27,7 +27,7 @@ These three features can be combined to customize and improve automated UI testi
     </div>
 </div>
 
-> Kea2 is designed to be capable of fusing the (property-based) *scripteds* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
+> Kea2 is designed to be capable of fusing the (property-based) *scripts* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
 
 **The ability of the three features in Kea2**
 |  | **Feature 1** | **Feature 2** | **Feature 3** |
@@ -52,7 +52,7 @@ In the future, Kea2 will be extended to support
 
 Running requirements/environment:
 - support Windows, MacOS and Linux
-- python 3.9+
+- python 3.8+
 - Android SDK installed
 - **VPN closed** (Features 2 and 3 required)
 
@@ -99,7 +99,7 @@ kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent native --
 ```
 
 The usage is similar to the the original [Fastbot](https://github.com/bytedance/Fastbot_Android?tab=readme-ov-file#run-fastbot-with-shell-command)'s shell commands. 
-See more options by `python kea_launcher.py driver -h`
+See more options by `kea2 run -h`
 
 
 ## Feature 2(自定义测试场景或事件序列): customizing testing scenarios by scripts
@@ -153,14 +153,13 @@ You can find the full example in script `quickstart.py` and run it by executing:
 python3 quickstart.py u2
 ```
 
+In real use, you can use `kea2 run` to launch the customizing script.
+
 ```bash
 # Launch Kea2 and load one single script quickstart.py.
-kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest quickstart.py
+kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest discover -p quickstart.py
 ```
 
-
-
-
 ## Feature 3(支持断言机制): Supporting auto-assertions by scripts.
 
 Kea2 supports auto-assertions when running Fastbot for finding *logic bugs* (i.e., *non-crashing bugs*). To achieve this, you can add assertions in the scripts. When an assertion fails during automated UI testing, we find a likely functional bug. This idea is inspired by  [property-based testing](https://en.wikipedia.org/wiki/Software_testing#Property_testing) inheritted from [Kea](https://github.com/ecnusse/Kea).

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/Kea2_python.egg-info/requires.txt

@@ -1,2 +1,2 @@
-rtree>=1.4.0
+rtree>=1.3.0
 uiautomator2>=3.2.9

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/PKG-INFO

@@ -1,18 +1,18 @@
 Metadata-Version: 2.4
 Name: Kea2-python
-Version: 0.0.1a2
+Version: 0.0.1a4
 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.9
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: rtree>=1.4.0
+Requires-Dist: rtree>=1.3.0
 Requires-Dist: uiautomator2>=3.2.9
 Dynamic: license-file
 
 # Introduction 
 
-Kea2 is an easy-to-use Python library for supporting and customizing automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
+Kea2 is an easy-to-use Python library for supporting, customizing and improving automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
 
 ### Kea2 has three 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*); 
@@ -27,7 +27,7 @@ These three features can be combined to customize and improve automated UI testi
     </div>
 </div>
 
-> Kea2 is designed to be capable of fusing the (property-based) *scripteds* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
+> Kea2 is designed to be capable of fusing the (property-based) *scripts* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
 
 **The ability of the three features in Kea2**
 |  | **Feature 1** | **Feature 2** | **Feature 3** |
@@ -52,7 +52,7 @@ In the future, Kea2 will be extended to support
 
 Running requirements/environment:
 - support Windows, MacOS and Linux
-- python 3.9+
+- python 3.8+
 - Android SDK installed
 - **VPN closed** (Features 2 and 3 required)
 
@@ -99,7 +99,7 @@ kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent native --
 ```
 
 The usage is similar to the the original [Fastbot](https://github.com/bytedance/Fastbot_Android?tab=readme-ov-file#run-fastbot-with-shell-command)'s shell commands. 
-See more options by `python kea_launcher.py driver -h`
+See more options by `kea2 run -h`
 
 
 ## Feature 2(自定义测试场景或事件序列): customizing testing scenarios by scripts
@@ -153,14 +153,13 @@ You can find the full example in script `quickstart.py` and run it by executing:
 python3 quickstart.py u2
 ```
 
+In real use, you can use `kea2 run` to launch the customizing script.
+
 ```bash
 # Launch Kea2 and load one single script quickstart.py.
-kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest quickstart.py
+kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest discover -p quickstart.py
 ```
 
-
-
-
 ## Feature 3(支持断言机制): Supporting auto-assertions by scripts.
 
 Kea2 supports auto-assertions when running Fastbot for finding *logic bugs* (i.e., *non-crashing bugs*). To achieve this, you can add assertions in the scripts. When an assertion fails during automated UI testing, we find a likely functional bug. This idea is inspired by  [property-based testing](https://en.wikipedia.org/wiki/Software_testing#Property_testing) inheritted from [Kea](https://github.com/ecnusse/Kea).

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/README.md

@@ -1,6 +1,6 @@
 # Introduction 
 
-Kea2 is an easy-to-use Python library for supporting and customizing automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
+Kea2 is an easy-to-use Python library for supporting, customizing and improving automated UI testing for mobile apps. The library is currently built on top of [Fastbot](https://github.com/bytedance/Fastbot_Android) and [uiautomator2](https://github.com/openatx/uiautomator2), and targeting [Android](https://en.wikipedia.org/wiki/Android_(operating_system)) apps.
 
 ### Kea2 has three 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*); 
@@ -15,7 +15,7 @@ These three features can be combined to customize and improve automated UI testi
     </div>
 </div>
 
-> Kea2 is designed to be capable of fusing the (property-based) *scripteds* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
+> Kea2 is designed to be capable of fusing the (property-based) *scripts* (e.g., written in uiautomator2) with automated UI testing tools (e.g., Fastbot), thus combining the strengths of human knowledge on app's business logics (empowered by the scripts) and random fuzzing. Many useful features (e.g., mimicing exploratory testing) can be implemented based on such a capability.
 
 **The ability of the three features in Kea2**
 |  | **Feature 1** | **Feature 2** | **Feature 3** |
@@ -40,7 +40,7 @@ In the future, Kea2 will be extended to support
 
 Running requirements/environment:
 - support Windows, MacOS and Linux
-- python 3.9+
+- python 3.8+
 - Android SDK installed
 - **VPN closed** (Features 2 and 3 required)
 
@@ -87,7 +87,7 @@ kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent native --
 ```
 
 The usage is similar to the the original [Fastbot](https://github.com/bytedance/Fastbot_Android?tab=readme-ov-file#run-fastbot-with-shell-command)'s shell commands. 
-See more options by `python kea_launcher.py driver -h`
+See more options by `kea2 run -h`
 
 
 ## Feature 2(自定义测试场景或事件序列): customizing testing scenarios by scripts
@@ -141,14 +141,13 @@ You can find the full example in script `quickstart.py` and run it by executing:
 python3 quickstart.py u2
 ```
 
+In real use, you can use `kea2 run` to launch the customizing script.
+
 ```bash
 # Launch Kea2 and load one single script quickstart.py.
-kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest quickstart.py
+kea2 run -s "emulator-5554" -p it.feio.android.omninotes.alpha --agent u2 --running-minutes 10 --throttle 200 --driver-name d unittest discover -p quickstart.py
 ```
 
-
-
-
 ## Feature 3(支持断言机制): Supporting auto-assertions by scripts.
 
 Kea2 supports auto-assertions when running Fastbot for finding *logic bugs* (i.e., *non-crashing bugs*). To achieve this, you can add assertions in the scripts. When an assertion fails during automated UI testing, we find a likely functional bug. This idea is inspired by  [property-based testing](https://en.wikipedia.org/wiki/Software_testing#Property_testing) inheritted from [Kea](https://github.com/ecnusse/Kea).

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/absDriver.py

@@ -2,12 +2,24 @@ import abc
 
 
 class AbstractScriptDriver(abc.ABC):
+    _instances = {}
+    def __new__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__new__(cls)
+        return cls._instances[cls]
+    
     @abc.abstractmethod
     def getInstance(self):
         pass
 
 
 class AbstractStaticChecker(abc.ABC):
+    _instances = {}
+    def __new__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__new__(cls)
+        return cls._instances[cls]
+    
     @abc.abstractmethod
     def getInstance(self):
         pass
@@ -18,6 +30,12 @@ class AbstractStaticChecker(abc.ABC):
 
 
 class AbstractDriver(abc.ABC):
+    _instances = {}
+    def __new__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__new__(cls)
+        return cls._instances[cls]
+    
     @classmethod
     @abc.abstractmethod
     def setDeviceSerial(self):

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/assets/quickstart.py

@@ -76,7 +76,9 @@ def check_installation():
 def _get_agent():
     import sys
     if len(sys.argv) == 0 or sys.argv[1] == "u2":
+        sys.argv=sys.argv[:1]
         return "u2"
+    sys.argv=sys.argv[:1]
     return "native"
 
 if __name__ == "__main__":

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/cli.py

@@ -156,16 +156,14 @@ def main():
             kwargs.pop('args', None)
             sp.add_argument(*args, **kwargs)
 
-    from .kea_launcher import _set_driver_parser
-    _set_driver_parser(subparser)
+    from .kea_launcher import _set_runner_parser
+    _set_runner_parser(subparser)
     actions["run"] = cmd_run
     if sys.argv[1:] == ["run"]:
         sys.argv.append("-h")
     args = parser.parse_args()
 
     import logging
-    logging.getLogger("urllib3").setLevel(logging.INFO)
-    logging.getLogger("uiautomator2").setLevel(logging.INFO)
     if args.debug:
         logging.basicConfig(level=logging.DEBUG)
         logger.debug("args: %s", args)

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/keaUtils.py

@@ -3,6 +3,7 @@ import os
 from pathlib import Path
 import subprocess
 import threading
+import traceback
 from typing import IO, Callable, Any, Dict, List, Literal, NewType, Optional, Union
 from unittest import TextTestRunner, registerResult, TestSuite, TestCase, TextTestResult
 import random
@@ -93,6 +94,8 @@ class Options:
     running_mins: int = 10
     # time(ms) to wait when exploring the app
     throttle: int = 200
+    # the output_dir for saving logs and results
+    output_dir: str = "output"
 
 
 @dataclass
@@ -260,6 +263,13 @@ class KeaTestRunner(TextTestRunner):
             options.Driver = None
         cls.options = options
 
+    def _setOuputDir(self):
+        output_dir = Path(self.options.output_dir).absolute()
+        os.mkdir(output_dir, parents=True, exist_ok=True)
+        global LOGFILE, RESFILE
+        LOGFILE = output_dir / Path(LOGFILE)
+        RESFILE = output_dir / Path(RESFILE)
+
     def run(self, test):
 
         self.allProperties = dict()
@@ -268,6 +278,8 @@ class KeaTestRunner(TextTestRunner):
         if len(self.allProperties) == 0:
             print("[Warning] No property has been found.", flush=True)
 
+        self._setOuputDir()
+
         JsonResult.setProperties(self.allProperties)
         self.resultclass = JsonResult
 
@@ -442,7 +454,13 @@ class KeaTestRunner(TextTestRunner):
                 # Dependency injection. Static driver checker for precond
                 setattr(test, self.options.driverName, staticCheckerDriver)
                 # excecute the precond
-                if not precond(test):
+                try:
+                    if not precond(test):
+                        valid = False
+                        break
+                except Exception as e:
+                    print(f"[ERROR] Error when checking precond: {getFullPropName(test)}", flush=True)
+                    traceback.print_exc()
                     valid = False
                     break
             # if all the precond passed. make it the candidate prop.

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/kea_launcher.py

@@ -1,9 +1,11 @@
+import os
 import sys
 import argparse
 import unittest
+from pathlib import Path
 from typing import List
 
-def _set_driver_parser(subparsers: "argparse._SubParsersAction[argparse.ArgumentParser]"):
+def _set_runner_parser(subparsers: "argparse._SubParsersAction[argparse.ArgumentParser]"):
     parser = subparsers.add_parser("run", help="run kea2")
     parser.add_argument(
         "-s",
@@ -23,6 +25,16 @@ def _set_driver_parser(subparsers: "argparse._SubParsersAction[argparse.Argument
         help="The target package names com.example.app",
     )
 
+    parser.add_argument(
+        "-o",
+        "--output-dir",
+        dest="output_dir",
+        type=str,
+        required=False,
+        default="output",
+        help="The output dir for saving logs and results."
+    )
+
     parser.add_argument(
         "--agent",
         dest="agent",
@@ -96,7 +108,7 @@ def parse_args(argv: List):
     parser = argparse.ArgumentParser(description="Kea2")
     subparsers = parser.add_subparsers(dest="command", required=True)
 
-    _set_driver_parser(subparsers)
+    _set_runner_parser(subparsers)
     args = parser.parse_args(argv)
     return args
 

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/kea2/u2Driver.py

@@ -12,6 +12,10 @@ from .utils import TimeStamp
 
 TIME_STAMP = TimeStamp().getTimeStamp()
 
+import logging
+logging.getLogger("urllib3").setLevel(logging.INFO)
+logging.getLogger("uiautomator2").setLevel(logging.INFO)
+
 """
 The definition of U2ScriptDriver
 """
@@ -29,13 +33,11 @@ class U2ScriptDriver(AbstractScriptDriver):
     """
 
     deviceSerial: str = None
-    
+    d = None
+
     @classmethod
     def setDeviceSerial(cls, deviceSerial):
         cls.deviceSerial = deviceSerial
-    
-    def __init__(self):
-        self.d = None
 
     def getInstance(self):
         if self.d is None:
@@ -117,7 +119,7 @@ class StaticU2UiObject(u2.UiObject):
 
     @property
     def exists(self):
-        dict.update(self.selector, {"covered": "true"})
+        dict.update(self.selector, {"covered": "false"})
         xpath = self._getXPath(self.selector)
         matched_widgets = self.session.xml.xpath(xpath)
         return bool(matched_widgets)
@@ -205,9 +207,11 @@ class _HindenWidgetFilter:
             )
             self._nodes.append(e)
 
+
 class U2StaticDevice(u2.Device):
-    def __init__(self):
+    def __init__(self, script_driver):
         self.xml: etree._Element = None
+        self._script_driver = script_driver
 
     def __call__(self, **kwargs):
         return StaticU2UiObject(session=self, selector=u2.Selector(**kwargs))
@@ -222,6 +226,10 @@ class U2StaticDevice(u2.Device):
             get_page_source, xpathEntry
         )
         return xpathEntry
+    
+    def __getattr__(self, attr):
+        """Proxy other methods to script_driver"""
+        return getattr(self._script_driver, attr)
 
 class _XPathEntry(u2.xpath.XPathEntry):
     def __init__(self, d):
@@ -246,7 +254,7 @@ class U2StaticChecker(AbstractStaticChecker):
     ```
     """
     def __init__(self):
-        self.d = U2StaticDevice()
+        self.d = U2StaticDevice(U2ScriptDriver().getInstance()) 
 
     def setHierarchy(self, hierarchy: str):
         if hierarchy is None:

{kea2_python-0.0.1a2 → kea2_python-0.0.1a4}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "Kea2-python"
-version = "0.0.1a2"
+version = "0.0.1a4"
 description = "A python library for supporting and customizing automated UI testing for mobile apps"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.8"
 dependencies = [
-    "rtree>=1.4.0",
+    "rtree>=1.3.0",
     "uiautomator2>=3.2.9",
 ]
 authors = [