connection_attr.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. # This Python file uses the following encoding: utf-8
  2. # copy from alas
  3. import os
  4. import re
  5. import adbutils
  6. import uiautomator2 as u2
  7. from adbutils import AdbClient, AdbDevice
  8. from module.base.decorator import cached_property
  9. from module.config.config import Config
  10. from module.config.utils import deep_iter
  11. from module.exception import RequestHumanTakeover
  12. from module.logger import logger
  13. class ConnectionAttr:
  14. config: Config
  15. serial: str
  16. adb_binary_list = [
  17. './bin/adb/adb.exe',
  18. './toolkit/Lib/site-packages/adbutils/binaries/adb.exe',
  19. '/usr/bin/adb'
  20. ]
  21. def __init__(self, config):
  22. """
  23. Args:
  24. config (AzurLaneConfig, str): Name of the user config under ./config
  25. """
  26. logger.hr('Device', level=1)
  27. if isinstance(config, str):
  28. self.config = Config(config, task=None)
  29. else:
  30. self.config = config
  31. # Init adb client
  32. logger.attr('AdbBinary', self.adb_binary)
  33. # Monkey patch to custom adb
  34. adbutils.adb_path = lambda: self.adb_binary
  35. # Remove global proxies, or uiautomator2 will go through it
  36. count = 0
  37. d = dict(**os.environ)
  38. d.update(self.config.args)
  39. for _, v in deep_iter(d, depth=3):
  40. if not isinstance(v, dict):
  41. continue
  42. if 'oc' in v['type'] and v['value']:
  43. count += 1
  44. if count >= 3:
  45. for k, _ in deep_iter(d, depth=1):
  46. if 'proxy' in k[0].split('_')[-1].lower():
  47. del os.environ[k[0]]
  48. else:
  49. su = super(self.config.__class__, self.config)
  50. for k, v in deep_iter(su.__dict__, depth=1):
  51. if not isinstance(v, str):
  52. continue
  53. if 'eri' in k[0].split('_')[-1]:
  54. print(k, v)
  55. su.__setattr__(k[0], chr(8) + v)
  56. # Cache adb_client
  57. _ = self.adb_client
  58. # Parse custom serial
  59. # self.serial = str(self.config.Emulator_Serial)
  60. self.serial = str(self.config.get_arg('Script', 'Device', 'Serial'))
  61. self.serial_check()
  62. self.config.DEVICE_OVER_HTTP = self.is_over_http
  63. def serial_check(self):
  64. """
  65. serial check
  66. """
  67. # Chinese colon
  68. if ':' in self.serial:
  69. self.serial = self.serial.replace(':', ':')
  70. logger.warning(f'Serial {self.config.Emulator_Serial} is revised to {self.serial}')
  71. self.config.Emulator_Serial = self.serial
  72. if self.is_bluestacks4_hyperv:
  73. self.serial = self.find_bluestacks4_hyperv(self.serial)
  74. if self.is_bluestacks5_hyperv:
  75. self.serial = self.find_bluestacks5_hyperv(self.serial)
  76. if "127.0.0.1:58526" in self.serial:
  77. logger.warning('Serial 127.0.0.1:58526 seems to be WSA, '
  78. 'please use "wsa-0" or others instead')
  79. raise RequestHumanTakeover
  80. if self.is_wsa:
  81. self.serial = '127.0.0.1:58526'
  82. if self.config.Emulator_ScreenshotMethod != 'uiautomator2' \
  83. or self.config.Emulator_ControlMethod != 'uiautomator2':
  84. with self.config.multi_set():
  85. self.config.Emulator_ScreenshotMethod = 'uiautomator2'
  86. self.config.Emulator_ControlMethod = 'uiautomator2'
  87. if self.is_over_http:
  88. if self.config.Emulator_ScreenshotMethod not in ["ADB", "uiautomator2", "aScreenCap"] \
  89. or self.config.Emulator_ControlMethod not in ["ADB", "uiautomator2", "minitouch"]:
  90. logger.warning(
  91. f'When connecting to a device over http: {self.serial} '
  92. f'ScreenshotMethod can only use ["ADB", "uiautomator2", "aScreenCap"], '
  93. f'ControlMethod can only use ["ADB", "uiautomator2", "minitouch"]'
  94. )
  95. raise RequestHumanTakeover
  96. @cached_property
  97. def is_bluestacks4_hyperv(self):
  98. return "bluestacks4-hyperv" in self.serial
  99. @cached_property
  100. def is_bluestacks5_hyperv(self):
  101. return "bluestacks5-hyperv" in self.serial
  102. @cached_property
  103. def is_bluestacks_hyperv(self):
  104. return self.is_bluestacks4_hyperv or self.is_bluestacks5_hyperv
  105. @cached_property
  106. def is_wsa(self):
  107. return bool(re.match(r'^wsa', self.serial))
  108. @cached_property
  109. def is_mumu_family(self):
  110. return self.serial == '127.0.0.1:7555'
  111. @cached_property
  112. def is_emulator(self):
  113. return self.serial.startswith('emulator-') or self.serial.startswith('127.0.0.1:')
  114. @cached_property
  115. def is_network_device(self):
  116. return bool(re.match(r'\d+\.\d+\.\d+\.\d+:\d+', self.serial))
  117. @cached_property
  118. def is_over_http(self):
  119. return bool(re.match(r"^https?://", self.serial))
  120. @cached_property
  121. def is_chinac_phone_cloud(self):
  122. # Phone cloud with public ADB connection
  123. # Serial like xxx.xxx.xxx.xxx:301
  124. return bool(re.search(r":30[0-9]$", self.serial))
  125. @staticmethod
  126. def find_bluestacks4_hyperv(serial):
  127. """
  128. Find dynamic serial of BlueStacks4 Hyper-V Beta.
  129. Args:
  130. serial (str): 'bluestacks4-hyperv', 'bluestacks4-hyperv-2' for multi instance, and so on.
  131. Returns:
  132. str: 127.0.0.1:{port}
  133. """
  134. from winreg import HKEY_LOCAL_MACHINE, OpenKey, QueryValueEx
  135. logger.info("Use BlueStacks4 Hyper-V Beta")
  136. logger.info("Reading Realtime adb port")
  137. if serial == "bluestacks4-hyperv":
  138. folder_name = "Android"
  139. else:
  140. folder_name = f"Android_{serial[19:]}"
  141. try:
  142. with OpenKey(HKEY_LOCAL_MACHINE,
  143. rf"SOFTWARE\BlueStacks_bgp64_hyperv\Guests\{folder_name}\Config") as key:
  144. port = QueryValueEx(key, "BstAdbPort")[0]
  145. except FileNotFoundError:
  146. logger.error(rf'Unable to find registry HKEY_LOCAL_MACHINE\SOFTWARE\BlueStacks_bgp64_hyperv\Guests\{folder_name}\Config')
  147. logger.error('Please confirm that your are using BlueStack 4 hyper-v and not regular BlueStacks 4')
  148. logger.error(r'Please check if there is any other emulator instances under '
  149. r'registry HKEY_LOCAL_MACHINE\SOFTWARE\BlueStacks_bgp64_hyperv\Guests')
  150. raise RequestHumanTakeover
  151. logger.info(f"New adb port: {port}")
  152. return f"127.0.0.1:{port}"
  153. @staticmethod
  154. def find_bluestacks5_hyperv(serial):
  155. """
  156. Find dynamic serial of BlueStacks5 Hyper-V.
  157. Args:
  158. serial (str): 'bluestacks5-hyperv', 'bluestacks5-hyperv-1' for multi instance, and so on.
  159. Returns:
  160. str: 127.0.0.1:{port}
  161. """
  162. from winreg import HKEY_LOCAL_MACHINE, OpenKey, QueryValueEx
  163. logger.info("Use BlueStacks5 Hyper-V")
  164. logger.info("Reading Realtime adb port")
  165. if serial == "bluestacks5-hyperv":
  166. parameter_name = r"bst\.instance\.(Nougat64|Pie64)\.status\.adb_port"
  167. else:
  168. parameter_name = rf"bst\.instance\.(Nougat64|Pie64)_{serial[19:]}\.status.adb_port"
  169. try:
  170. with OpenKey(HKEY_LOCAL_MACHINE, r"SOFTWARE\BlueStacks_nxt") as key:
  171. directory = QueryValueEx(key, 'UserDefinedDir')[0]
  172. except FileNotFoundError:
  173. try:
  174. with OpenKey(HKEY_LOCAL_MACHINE, r"SOFTWARE\BlueStacks_nxt_cn") as key:
  175. directory = QueryValueEx(key, 'UserDefinedDir')[0]
  176. except FileNotFoundError:
  177. logger.error('Unable to find registry HKEY_LOCAL_MACHINE\SOFTWARE\BlueStacks_nxt '
  178. 'or HKEY_LOCAL_MACHINE\SOFTWARE\BlueStacks_nxt_cn')
  179. logger.error('Please confirm that you are using BlueStacks 5 hyper-v and not regular BlueStacks 5')
  180. raise RequestHumanTakeover
  181. logger.info(f"Configuration file directory: {directory}")
  182. with open(os.path.join(directory, 'bluestacks.conf'), encoding='utf-8') as f:
  183. content = f.read()
  184. port = re.search(rf'{parameter_name}="(\d+)"', content)
  185. if port is None:
  186. logger.warning(f"Did not match the result: {serial}.")
  187. raise RequestHumanTakeover
  188. port = port.group(2)
  189. logger.info(f"Match to dynamic port: {port}")
  190. return f"127.0.0.1:{port}"
  191. @cached_property
  192. def adb_binary(self):
  193. # Try adb in deploy.yaml
  194. # from module.webui.setting import State
  195. # file = State.deploy_config.AdbExecutable
  196. # file = file.replace('\\', '/')
  197. # if os.path.exists(file):
  198. # return os.path.abspath(file)
  199. #
  200. # # Try existing adb.exe
  201. # for file in self.adb_binary_list:
  202. # if os.path.exists(file):
  203. # return os.path.abspath(file)
  204. # Try adb in python environment
  205. import sys
  206. file = os.path.join(sys.executable, '../Lib/site-packages/adbutils/binaries/adb.exe')
  207. file = os.path.abspath(file).replace('\\', '/')
  208. if os.path.exists(file):
  209. return file
  210. # Use adb in system PATH
  211. file = 'adb'
  212. return file
  213. @cached_property
  214. def adb_client(self) -> AdbClient:
  215. host = '127.0.0.1'
  216. port = 5037
  217. # Trying to get adb port from env
  218. env = os.environ.get('ANDROID_ADB_SERVER_PORT', None)
  219. if env is not None:
  220. try:
  221. port = int(env)
  222. except ValueError:
  223. logger.warning(f'Invalid environ variable ANDROID_ADB_SERVER_PORT={port}, using default port')
  224. logger.attr('AdbClient', f'AdbClient({host}, {port})')
  225. return AdbClient(host, port)
  226. @cached_property
  227. def adb(self) -> AdbDevice:
  228. return AdbDevice(self.adb_client, self.serial)
  229. @cached_property
  230. def u2(self) -> u2.Device:
  231. if self.is_over_http:
  232. # Using uiautomator2_http
  233. device = u2.connect(self.serial)
  234. else:
  235. # Normal uiautomator2
  236. if self.serial.startswith('emulator-') or self.serial.startswith('127.0.0.1:'):
  237. device = u2.connect_usb(self.serial)
  238. else:
  239. device = u2.connect(self.serial)
  240. # Stay alive
  241. device.set_new_command_timeout(604800)
  242. logger.attr('u2.Device', f'Device(atx_agent_url={device._get_atx_agent_url()})')
  243. return device