Kea2-python 1.1.0b1__tar.gz → 1.1.2__tar.gz

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/Kea2_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Kea2-python
-Version: 1.1.0b1
+Version: 1.1.2
 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
@@ -290,7 +290,7 @@ Some notes:
 3. You need to insert the following code template into your existing test cases: Here, you can add your own hook logic in the commented sections, including starting or stopping the appium session, cleaning up instances, etc. This depends on how you want to design the setup and teardown. Apart from that, you only need to configure the `option` parameter and `configs_path` parameter(where your directory `configs` located, btw, `configs`'s location dependon where you executed `kea2 init`), then pass it to the `run_kea2_testing` function.
 
 ```python
-from kea2 import Kea2Tester, Options, U2Driver
+from kea2 import Kea2Tester, Options
 
 if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true': 
     '''
@@ -326,12 +326,28 @@ if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true':
 
 Kea2 automatically generates a HTML test report after each testing session. You can find the report in `output/` under your working directory.
 
-You can also manually generate the test report by `kea2 report` (see `kea2 report -h` for details).
+You can also manually generate the test report by 
+```bash
+kea2 report -p [RES_DIR]
+``` 
+
+Use `-s/--sync` to sync data from device before generating the report, and `-p/--path` to point to one or more result directories.
+For example:
+
+```bash
+`kea2 report -p output/res_YYYYMMDDHH_xxxxxx`
+`kea2 report -s -p output/res_YYYYMMDDHH_xxxxxx`
+``` 
+
+You can also merge the test report from multiple testing sessions by 
+
+```bash
+kea2 merge -p [RES_DIR1] [RES_DIR2] ... -o [OUTPUT_DIR]
+```
 
-You can also merge the test report from multiple testing sessions by `kea2 merge` (see `kea2 merge -h` for details).
 The merged test report is quite useful if you would test your apps for multiple sessions.
 
-You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
+> You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
 
 ## Documentations（更多文档）
 

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/Kea2_python.egg-info/SOURCES.txt

@@ -8,7 +8,6 @@ Kea2_python.egg-info/entry_points.txt
 Kea2_python.egg-info/requires.txt
 Kea2_python.egg-info/top_level.txt
 kea2/__init__.py
-kea2/absDriver.py
 kea2/adbUtils.py
 kea2/cli.py
 kea2/fastbotManager.py

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Kea2-python
-Version: 1.1.0b1
+Version: 1.1.2
 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
@@ -290,7 +290,7 @@ Some notes:
 3. You need to insert the following code template into your existing test cases: Here, you can add your own hook logic in the commented sections, including starting or stopping the appium session, cleaning up instances, etc. This depends on how you want to design the setup and teardown. Apart from that, you only need to configure the `option` parameter and `configs_path` parameter(where your directory `configs` located, btw, `configs`'s location dependon where you executed `kea2 init`), then pass it to the `run_kea2_testing` function.
 
 ```python
-from kea2 import Kea2Tester, Options, U2Driver
+from kea2 import Kea2Tester, Options
 
 if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true': 
     '''
@@ -326,12 +326,28 @@ if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true':
 
 Kea2 automatically generates a HTML test report after each testing session. You can find the report in `output/` under your working directory.
 
-You can also manually generate the test report by `kea2 report` (see `kea2 report -h` for details).
+You can also manually generate the test report by 
+```bash
+kea2 report -p [RES_DIR]
+``` 
+
+Use `-s/--sync` to sync data from device before generating the report, and `-p/--path` to point to one or more result directories.
+For example:
+
+```bash
+`kea2 report -p output/res_YYYYMMDDHH_xxxxxx`
+`kea2 report -s -p output/res_YYYYMMDDHH_xxxxxx`
+``` 
+
+You can also merge the test report from multiple testing sessions by 
+
+```bash
+kea2 merge -p [RES_DIR1] [RES_DIR2] ... -o [OUTPUT_DIR]
+```
 
-You can also merge the test report from multiple testing sessions by `kea2 merge` (see `kea2 merge -h` for details).
 The merged test report is quite useful if you would test your apps for multiple sessions.
 
-You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
+> You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
 
 ## Documentations（更多文档）
 

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/README.md

@@ -275,7 +275,7 @@ Some notes:
 3. You need to insert the following code template into your existing test cases: Here, you can add your own hook logic in the commented sections, including starting or stopping the appium session, cleaning up instances, etc. This depends on how you want to design the setup and teardown. Apart from that, you only need to configure the `option` parameter and `configs_path` parameter(where your directory `configs` located, btw, `configs`'s location dependon where you executed `kea2 init`), then pass it to the `run_kea2_testing` function.
 
 ```python
-from kea2 import Kea2Tester, Options, U2Driver
+from kea2 import Kea2Tester, Options
 
 if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true': 
     '''
@@ -311,12 +311,28 @@ if os.environ.get('KEA2_HYBRID_MODE', '').lower() == 'true':
 
 Kea2 automatically generates a HTML test report after each testing session. You can find the report in `output/` under your working directory.
 
-You can also manually generate the test report by `kea2 report` (see `kea2 report -h` for details).
+You can also manually generate the test report by 
+```bash
+kea2 report -p [RES_DIR]
+``` 
+
+Use `-s/--sync` to sync data from device before generating the report, and `-p/--path` to point to one or more result directories.
+For example:
+
+```bash
+`kea2 report -p output/res_YYYYMMDDHH_xxxxxx`
+`kea2 report -s -p output/res_YYYYMMDDHH_xxxxxx`
+``` 
+
+You can also merge the test report from multiple testing sessions by 
+
+```bash
+kea2 merge -p [RES_DIR1] [RES_DIR2] ... -o [OUTPUT_DIR]
+```
 
-You can also merge the test report from multiple testing sessions by `kea2 merge` (see `kea2 merge -h` for details).
 The merged test report is quite useful if you would test your apps for multiple sessions.
 
-You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
+> You can find a sample [test report](https://ecnusse.github.io/Kea2_sample_report/) from Opay (Thank you!). You can find more details on the test report in [this documentation](docs/test_report_introduction.md).
 
 ## Documentations（更多文档）
 

kea2_python-1.1.2/kea2/assets/quicktest.py

@@ -0,0 +1,148 @@
+import unittest
+import uiautomator2 as u2
+
+from time import sleep
+from kea2 import precondition, prob, KeaTestRunner, Options, keaTestLoader, invariant
+
+
+import unittest
+import random
+import uiautomator2 as u2
+from uuid import uuid4
+from kea2 import precondition, prob, max_tries
+
+from kea2 import state   # stateful testing
+
+
+URL = "https://github.com/federicoiosue/Omni-Notes/releases/download/6.2.0_alpha/OmniNotes-alphaRelease-6.2.0.apk"
+FALL_BACK_URL = "https://gitee.com/XixianLiang/Kea2/raw/main/omninotes.apk"
+PACKAGE_NAME = "it.feio.android.omninotes.alpha"
+FILE_NAME = "omninotes.apk"
+
+
+state["notes"] = list()
+
+def get_random_text():
+    return uuid4().hex[:6]
+
+class TestOmniNotes(unittest.TestCase):
+    d: u2.Device
+
+    @classmethod
+    def setUpClass(cls):
+        """Global setting for uiautomator2 (Optional)
+        """
+        cls.d.settings["wait_timeout"] = 5.0
+        cls.d.settings["operation_delay"] = (0, 1.0)
+        cls.d.app_clear(PACKAGE_NAME)
+
+    @prob(0.3)
+    @precondition(
+        lambda self: self.d(resourceId="it.feio.android.omninotes.alpha:id/fab_expand_menu_button").exists
+        and not self.d(resourceId="it.feio.android.omninotes.alpha:id/fab_note").exists
+        and not self.d(resourceId="it.feio.android.omninotes.alpha:id/navdrawer_title").exists
+    )
+    def add_note(self):
+        """stateful testing: add a note and store in state
+        """
+        self.d(resourceId="it.feio.android.omninotes.alpha:id/fab_expand_menu_button").long_click()
+        title = get_random_text()
+        self.d(resourceId="it.feio.android.omninotes.alpha:id/detail_title").set_text(title)
+        self.d(description="drawer open").click()
+        state["notes"].append(title)
+
+    @prob(0.3)
+    @precondition(
+        lambda self: self.d(resourceId="it.feio.android.omninotes.alpha:id/menu_search").exists 
+        and len(state["notes"]) > 0
+        and not self.d(resourceId="it.feio.android.omninotes.alpha:id/navdrawer_title").exists
+    )
+    def search_note(self):
+        """stateful testing: search an existed note.
+        """
+        expected_note = random.choice(state["notes"])
+        self.d(resourceId="it.feio.android.omninotes.alpha:id/menu_search").click()
+        self.d(resourceId="it.feio.android.omninotes.alpha:id/search_src_text").set_text(expected_note)
+        self.d.press("enter")
+        assert self.d(text=expected_note).exists, "the added note not found"
+    
+    @precondition(lambda self: "camera" in self.d.app_current().get("package", ""))
+    def exit_camera(self):
+        """Guided exploration: Exit camera if it is launched 
+        (fastbot can't exit camera app by itself, we use kea2 to exit it to avoid getting stuck in camera)
+        """
+        print("Exiting camera app")
+        pkg_camera = self.d.app_current().get("package", "")
+        print(f"Current package: {pkg_camera}")
+        if "camera" in pkg_camera:
+            self.d.app_stop(pkg_camera)
+    
+    @max_tries(1)
+    @precondition(lambda self: self.d(resourceId="it.feio.android.omninotes.alpha:id/next").exists)
+    def skip_welcome_tour(self):
+        """Guided exploration: skip welcome tour if it is shown.
+        This is a one-shot action to skip the welcome tour (@max_tries(1))
+        """
+        while self.d(resourceId="it.feio.android.omninotes.alpha:id/next").exists:
+            self.d(resourceId="it.feio.android.omninotes.alpha:id/next").click()
+        if self.d(resourceId="it.feio.android.omninotes.alpha:id/done").exists:
+            self.d(resourceId="it.feio.android.omninotes.alpha:id/done").click()
+            
+    @invariant
+    def search_button_and_search_input_box_should_not_exists_at_the_same_time(self):
+        """Search input box and search button should not exists at the same time
+        """
+        search_input_box_exists = self.d(resourceId="it.feio.android.omninotes.alpha:id/search_src_text").exists
+        serach_button_exists = self.d(resourceId="it.feio.android.omninotes.alpha:id/menu_search").exists
+        if search_input_box_exists or serach_button_exists:
+            assert search_input_box_exists ^ serach_button_exists
+            
+
+
+# Download Utils
+def download_omninotes():
+    import socket
+    socket.setdefaulttimeout(30)
+    try:
+        import urllib.request
+        urllib.request.urlretrieve(URL, FILE_NAME)
+    except Exception as e:
+        print(f"[WARN] Download from {URL} failed: {e}. Try to download from fallback URL {FALL_BACK_URL}", flush=True)
+        try:
+            urllib.request.urlretrieve(FALL_BACK_URL, FILE_NAME)
+        except Exception as e2:
+            print(f"[ERROR] Download from fallback URL {FALL_BACK_URL} also failed: {e2}", flush=True)
+            raise e2
+
+
+def check_installation(serial=None):
+    import os
+    from pathlib import Path
+    
+    d = u2.connect(serial)
+    # automatically install omni-notes
+    if PACKAGE_NAME not in d.app_list():
+        if not os.path.exists(Path(".") / FILE_NAME):
+            print(f"[INFO] omninote.apk not exists. Downloading from {URL}", flush=True)
+            download_omninotes()
+        print("[INFO] Installing omninotes.", flush=True)
+        d.app_install(FILE_NAME)
+    d.stop_uiautomator()
+
+
+if __name__ == "__main__":
+    check_installation(serial=None)
+    KeaTestRunner.setOptions(
+        Options(
+            driverName="d",
+            packageNames=[PACKAGE_NAME],
+            # serial="emulator-5554",   # specify the serial
+            maxStep=50,
+            profile_period=10,
+            take_screenshots=True,  # whether to take screenshots, default is False
+            # running_mins=10,  # specify the maximal running time in minutes, default value is 10m
+            # throttle=200,   # specify the throttle in milliseconds, default value is 200ms
+            agent="u2"  # 'native' for running the vanilla Fastbot, 'u2' for running Kea2
+        )
+    )
+    unittest.main(testRunner=KeaTestRunner, testLoader=keaTestLoader)

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/kea2/cli.py

@@ -58,6 +58,8 @@ def cmd_report(args):
     from .report.bug_report_generator import BugReportGenerator
     report_dirs = args.path
     
+    sync_data = args.sync
+     
     for report_dir in report_dirs:
         report_dir = Path(report_dir).resolve()
 
@@ -66,7 +68,7 @@ def cmd_report(args):
             continue
         
         logger.debug(f"Generating test report from directory: {report_dir}")
-        BugReportGenerator(report_dir).generate_report()
+        BugReportGenerator(report_dir, sync_data).generate_report()
 
 
 def cmd_merge(args):
@@ -136,6 +138,12 @@ _commands = [
                 nargs="+",
                 required=True,
                 help="Root directory path of the test results to generate report from"
+            ),
+            dict(
+                name=["sync_data"],
+                args=["-s", "--sync"],
+                action="store_true",
+                help="Sync data from device before generating report"
             )
         ]
     ),

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/kea2/fastbotManager.py

@@ -237,7 +237,7 @@ class FastbotManager:
 
         outfile = open(self.log_file, "w", encoding="utf-8", buffering=1)
 
-        logger.info("Options info: {}".format(asdict(self.options)))
+        logger.info("Options info: {}".format(self.options.to_dict()))
         logger.info("Launching fastbot with shell command:\n{}".format(" ".join(full_cmd)))
         logger.info("Fastbot log will be saved to {}".format(outfile.name))
 
@@ -265,5 +265,3 @@ class FastbotManager:
         self.thread.join()
 
 
-
-

{kea2_python-1.1.0b1 → kea2_python-1.1.2}/kea2/kea2_api.py

@@ -106,11 +106,15 @@ class Kea2Tester:
         
         output_dir = self.options.output_dir
         
-        from .keaUtils import STAMP, LOGFILE, RESFILE
+        from .utils import StampManager
         
         bug_report_path = output_dir / "bug_report.html"
-        result_json_path = output_dir / RESFILE.name if hasattr(RESFILE, 'name') else output_dir / f"result_{STAMP}.json"
-        log_file_path = output_dir / LOGFILE.name if hasattr(LOGFILE, 'name') else output_dir / f"fastbot_{STAMP}.log"
+        stamp_manager = StampManager()
+        stamp = stamp_manager.stamp or self.options.log_stamp
+        result_name = stamp_manager.result_file.name if stamp_manager.result_file else f"result_{stamp}.json"
+        log_name = stamp_manager.log_file.name if stamp_manager.log_file else f"fastbot_{stamp}.log"
+        result_json_path = output_dir / result_name
+        log_file_path = output_dir / log_name
         
         return {
             'executed': True,