UiAutomatorHelper take optional adbClient argument

dtmilano · dtmilano · commit a71afe6a84c0 · 2023-09-20T22:51:03.000-07:00
- Change examples
diff --git a/examples/helper/calculator-wait-by-selector b/examples/helper/calculator-wait-by-selector
@@ -1,7 +1,7 @@
 #! /usr/bin/env python3
 # -*- coding: utf-8 -*-
 """
-Copyright (C) 2013-2019  Diego Torres Milano
+Copyright (C) 2013-2023  Diego Torres Milano
 Created on 2022-01-15 by Culebra v20.4.5
                       __    __    __    __
                      /  \  /  \  /  \  /  \ 
@@ -23,18 +23,14 @@ TAG = 'CULEBRA'
 
 def start_calculator():
     time.sleep(10)
-    vc.uiAutomatorHelper.target_context.start_activity('com.google.android.calculator',
-                                                       'com.android.calculator2.Calculator')
+    helper.target_context.start_activity('com.google.android.calculator',
+                                         'com.android.calculator2.Calculator')
 
 
-kwargs1 = {'verbose': False}
-device, serialno = ViewClient.connectToDeviceOrExit(**kwargs1)
-
-kwargs2 = {'useuiautomatorhelper': True, 'debug': {}}
-vc = ViewClient(device, serialno, **kwargs2)
+helper = ViewClient.view_client_helper()
 
 threading.Thread(target=start_calculator).start()
 
-search_condition_ref = vc.uiAutomatorHelper.until.find_object(by_selector='text@π').oid
+search_condition_ref = helper.until.find_object(by_selector='text@π')
 print("Let's wait until PI appears on the screen (Calculator)...")
-print(vc.uiAutomatorHelper.ui_device.wait(search_condition_ref=search_condition_ref, timeout=30000))
+print(helper.ui_device.wait(oid=search_condition_ref.oid, timeout=30000))
diff --git a/examples/helper/culebra/write_image_to_file_uiautomator_helper.py b/examples/helper/culebra/write_image_to_file_uiautomator_helper.py
diff --git a/examples/helper/start-activity-followed-by-dump b/examples/helper/start-activity-followed-by-dump
@@ -10,6 +10,7 @@ if len(sys.argv) != 2:
 
 app = sys.argv.pop(1)
 device, serialno = ViewClient.connectToDeviceOrExit()
+# we need adbClient because we call `forceStop()` in this script
 helper = ViewClient(device, serialno, useuiautomatorhelper=True).uiAutomatorHelper
 
 t = [time.time()]
diff --git a/src/com/dtmilano/android/common.py b/src/com/dtmilano/android/common.py
@@ -95,10 +95,10 @@ def is_exe(_fpath, _isWindows):
     return None
 
 
-def obtainAdbPath():
-    '''
+def obtainAdbPath() -> str:
+    """
     Obtains the ADB path attempting know locations for different OSs
-    '''
+    """
 
     FORCE_FAIL = False
     ''' Sometimes, you want it to fail to check the error messages '''
diff --git a/src/com/dtmilano/android/uiautomator/uiautomatorhelper.py b/src/com/dtmilano/android/uiautomator/uiautomatorhelper.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Copyright (C) 2012-2022  Diego Torres Milano
+Copyright (C) 2012-2023  Diego Torres Milano
 Created on Feb 2, 2015
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -112,7 +112,8 @@ class UiAutomatorHelper:
     TEST_CLASS = PACKAGE + '.test'
     TEST_RUNNER = 'com.dtmilano.android.culebratester2.UiAutomatorHelper'
 
-    def __init__(self, adbclient, adb=None, localport=9987, remoteport=9987, hostname='localhost', api_version='v2'):
+    def __init__(self, adbclient: Optional[AdbClient] = None, adb=None, localport=9987, remoteport=9987,
+                 hostname='localhost', api_version='v2'):
         """
         UiAutomatorHelper constructor used when the backend selected is **CulebraTester2-public**.
         This class holds references to the different API's:
@@ -124,14 +125,14 @@ def __init__(self, adbclient, adb=None, localport=9987, remoteport=9987, hostnam
          - UiObject2
          - Until
 
-        :param adbclient: the adb client
-        :param adb: adb if known
-        :param localport: the local port used in CulebraTester2-public port forwarding
-        :param remoteport: the remote port used in CulebraTester2-public port forwarding
+        :param adbclient: the adb client (optional and usually not needed for normal cases with this backend)
+        :param adb: adb if known (also optional)
+        :param localport: the local port used in CulebraTester2-public port forwarding (must be forwarded already)
+        :param remoteport: the remote port used in CulebraTester2-public port forwarding (not usually needed)
         :param hostname: the hostname used by CulebraTester2-public
         :param api_version: the api version
         """
-        self.adbClient = adbclient
+        self.adbClient: Optional[AdbClient] = adbclient
         ''' The adb client (a.k.a. device) '''
         self.adb = self.__whichAdb(adb)
         ''' The adb command '''
@@ -189,7 +190,7 @@ def __connectSession(self):
         return session
 
     @staticmethod
-    def __whichAdb(adb):
+    def __whichAdb(adb: Optional[str]):
         if adb:
             if not os.access(adb, os.X_OK):
                 raise Exception('adb="%s" is not executable' % adb)
@@ -200,7 +201,10 @@ def __whichAdb(adb):
 
         return adb
 
-    def __redirectPort(self, localport, remoteport):
+    def __redirectPort(self, localport: int, remoteport: int) -> None:
+        if not self.adbClient:
+            print("__redirectPort: cannot redirect port when adbClient is not set")
+            return
         self.localPort = localport
         self.remotePort = remoteport
         subprocess.check_call([self.adb, '-s', self.adbClient.serialno, 'forward', 'tcp:%d' % self.localPort,
@@ -209,6 +213,8 @@ def __redirectPort(self, localport, remoteport):
     def __runTests(self):
         if DEBUG:
             print("__runTests: start", file=sys.stderr)
+        if not self.adbClient:
+            return
         # We need a new AdbClient instance with timeout=None (means, no timeout) for the long running test service
         newAdbClient = AdbClient(self.adbClient.serialno, self.adbClient.hostname, self.adbClient.port, timeout=None)
         self.thread = RunTestsThread(adbClient=newAdbClient, testClass=self.TEST_CLASS, testRunner=self.TEST_RUNNER)
diff --git a/src/com/dtmilano/android/viewclient.py b/src/com/dtmilano/android/viewclient.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Copyright (C) 2012-2022  Diego Torres Milano
+Copyright (C) 2012-2023  Diego Torres Milano
 Created on Feb 2, 2012
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +26,7 @@
 import culebratester_client
 from culebratester_client import WindowHierarchyChild, WindowHierarchy
 
-__version__ = '22.7.2'
+__version__ = '23.0.0'
 
 import sys
 import warnings
@@ -2761,8 +2761,9 @@ def __del__(self):
             self.uiAutomatorHelper.quit()
 
     @staticmethod
-    def view_client_helper(kato=False):
-        helper = ViewClient(*ViewClient.connectToDeviceOrExit(), useuiautomatorhelper=True).uiAutomatorHelper
+    def view_client_helper(hostname: str = "localhost", port: int = CULEBRATESTER2_PORT,
+                           kato: bool = False) -> UiAutomatorHelper:
+        helper = UiAutomatorHelper(hostname=hostname, localport=port)
         helper.kato.enabled = kato
         return helper
 
@@ -2773,7 +2774,6 @@ def __obtainAdbPath():
     @staticmethod
     def __mapSerialNo(serialno):
         serialno = serialno.strip()
-        # ipRE = re.compile('^\d+\.\d+.\d+.\d+$')
         if IP_RE.match(serialno):
             if DEBUG_DEVICE: print("ViewClient: adding default port to serialno", serialno, ADB_DEFAULT_PORT,
                                    file=sys.stderr)
