platform_base.py 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  1. import sys
  2. import typing as t
  3. from pydantic import BaseModel
  4. from module.base.decorator import cached_property, del_cached_property
  5. from module.base.utils import SelectedGrids
  6. # from module.device.connection import Connection
  7. from module.device.method.utils import get_serial_pair
  8. from module.device.platform2.emulator_base import EmulatorInstanceBase, EmulatorManagerBase, remove_duplicated_path
  9. from module.logger import logger
  10. class EmulatorInfo(BaseModel):
  11. emulator: str = ''
  12. name: str = ''
  13. path: str = ''
  14. # For APIs of chinac.com, a phone cloud platform.
  15. # access_key: SecretStr = ''
  16. # secret: SecretStr = ''
  17. class PlatformBase(EmulatorManagerBase):
  18. """
  19. Base interface of a platform, platform can be various operating system or phone clouds.
  20. For each `Platform` class, the following APIs must be implemented.
  21. - all_emulators()
  22. - all_emulator_instances()
  23. - emulator_start()
  24. - emulator_stop()
  25. """
  26. def emulator_start(self):
  27. """
  28. Start a emulator, until startup completed.
  29. - Retry is required.
  30. - Using bored sleep to wait startup is forbidden.
  31. """
  32. logger.info(f'Current platform {sys.platform} does not support emulator_start, skip')
  33. def emulator_stop(self):
  34. """
  35. Stop a emulator.
  36. """
  37. logger.info(f'Current platform {sys.platform} does not support emulator_stop, skip')
  38. @cached_property
  39. def config_interface(self) -> dict:
  40. result = {'emulator': 'auto',
  41. 'name': '',
  42. 'path': '',
  43. 'serial': '127.0.0.1:16384'}
  44. if hasattr(self, 'config'):
  45. result = {
  46. 'emulator': self.config.script.device.emulatorinfo_type,
  47. 'name': self.config.script.device.emulatorinfo_name,
  48. 'path': self.config.script.device.emulatorinfo_path,
  49. 'serial': self.config.script.device.serial
  50. }
  51. return result
  52. def _config_save_new(self, emulator: str, name: str, path: str):
  53. if hasattr(self, 'config'):
  54. self.config.script.device.emulatorinfo_type = emulator
  55. self.config.script.device.emulatorinfo_name = name
  56. self.config.script.device.emulatorinfo_path = path
  57. self.config.save()
  58. @cached_property
  59. def emulator_info(self) -> EmulatorInfo:
  60. emulator = self.config_interface['emulator']
  61. if emulator == 'auto':
  62. emulator = ''
  63. def parse_info(value):
  64. if isinstance(value, str):
  65. value = value.strip().replace('\n', '')
  66. if value in ['None', 'False', 'True']:
  67. value = ''
  68. return value
  69. else:
  70. return ''
  71. name = parse_info(self.config_interface['name'])
  72. path = parse_info(self.config_interface['path'])
  73. return EmulatorInfo(
  74. emulator=emulator,
  75. name=name,
  76. path=path,
  77. )
  78. @cached_property
  79. def emulator_instance(self) -> t.Optional[EmulatorInstanceBase]:
  80. """
  81. Returns:
  82. EmulatorInstanceBase: Emulator instance or None
  83. """
  84. data = self.emulator_info
  85. old_info = dict(
  86. emulator=data.emulator,
  87. path=data.path,
  88. name=data.name,
  89. )
  90. # Redirect emulator-5554 to 127.0.0.1:5555
  91. serial = self.config_interface['serial']
  92. port_serial, _ = get_serial_pair(serial)
  93. if port_serial is not None:
  94. serial = port_serial
  95. instance = self.find_emulator_instance(
  96. serial=serial,
  97. name=data.name,
  98. path=data.path,
  99. emulator=data.emulator,
  100. )
  101. # Write complete emulator data
  102. if instance is not None:
  103. new_info = dict(
  104. emulator=instance.type,
  105. path=instance.path,
  106. name=instance.name,
  107. )
  108. if new_info != old_info:
  109. self._config_save_new(emulator=instance.type, name=instance.name, path=instance.path)
  110. del_cached_property(self, 'emulator_info')
  111. return instance
  112. def find_emulator_instance(
  113. self,
  114. serial: str,
  115. name: str = None,
  116. path: str = None,
  117. emulator: str = None
  118. ) -> t.Optional[EmulatorInstanceBase]:
  119. """
  120. Args:
  121. serial: Serial like "127.0.0.1:5555"
  122. name: Instance name like "Nougat64"
  123. path: Emulator install path like "C:/Program Files/BlueStacks_nxt/HD-Player.exe"
  124. emulator: Emulator type defined in Emulator class, like "BlueStacks5"
  125. Returns:
  126. EmulatorInstance: Emulator instance or None if no instances not found.
  127. """
  128. logger.hr('Find emulator instance', level=2)
  129. instances = SelectedGrids(self.all_emulator_instances)
  130. for instance in instances:
  131. logger.info(instance)
  132. search_args = dict(serial=serial)
  133. # Search by serial
  134. select = instances.select(**search_args)
  135. if select.count == 0:
  136. logger.warning(f'No emulator instance with {search_args}, serial invalid')
  137. return None
  138. if select.count == 1:
  139. instance = select[0]
  140. logger.hr('Emulator instance', level=2)
  141. logger.info(f'Found emulator instance: {instance}')
  142. return instance
  143. # Multiple instances in given serial, search by name
  144. if name:
  145. search_args['name'] = name
  146. select = instances.select(**search_args)
  147. if select.count == 0:
  148. logger.warning(f'No emulator instances with {search_args}, name invalid')
  149. search_args.pop('name')
  150. elif select.count == 1:
  151. instance = select[0]
  152. logger.hr('Emulator instance', level=2)
  153. logger.info(f'Found emulator instance: {instance}')
  154. return instance
  155. # Multiple instances in given serial and name, search by path
  156. if path:
  157. search_args['path'] = path
  158. select = instances.select(**search_args)
  159. if select.count == 0:
  160. logger.warning(f'No emulator instances with {search_args}, path invalid')
  161. search_args.pop('path')
  162. elif select.count == 1:
  163. instance = select[0]
  164. logger.hr('Emulator instance', level=2)
  165. logger.info(f'Found emulator instance: {instance}')
  166. return instance
  167. # Multiple instances in given serial, name and path, search by emulator
  168. if emulator:
  169. search_args['type'] = emulator
  170. select = instances.select(**search_args)
  171. if select.count == 0:
  172. logger.warning(f'No emulator instances with {search_args}, type invalid')
  173. search_args.pop('type')
  174. elif select.count == 1:
  175. instance = select[0]
  176. logger.hr('Emulator instance', level=2)
  177. logger.info(f'Found emulator instance: {instance}')
  178. return instance
  179. # Still too many instances, search from running emulators
  180. running = remove_duplicated_path(list(self.iter_running_emulator()))
  181. logger.info('Running emulators')
  182. for exe in running:
  183. logger.info(exe)
  184. if len(running) == 1:
  185. logger.info('Only one running emulator')
  186. # Same as searching path
  187. search_args['path'] = running[0]
  188. select = instances.select(**search_args)
  189. if select.count == 0:
  190. logger.warning(f'No emulator instances with {search_args}, path invalid')
  191. search_args.pop('path')
  192. elif select.count == 1:
  193. instance = select[0]
  194. logger.hr('Emulator instance', level=2)
  195. logger.info(f'Found emulator instance: {instance}')
  196. return instance
  197. # Still too many instances
  198. logger.warning(f'Found multiple emulator instances with {search_args}')
  199. return None