connection_attr.py 10 KB

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