Changeset 280882 in webkit

Timestamp:

Aug 10, 2021, 9:09:33 PM (5 years ago)

Author:

Jonathan Bedard

Message:

[webkitpy] Stop relying on device.plist for simulated device state
​https://bugs.webkit.org/show_bug.cgi?id=228974
<rdar://problem/81749547>

Reviewed by Stephanie Lewis.

• Scripts/webkitpy/xcode/simulated_device.py:

(SimulatedDeviceManager):
(SimulatedDeviceManager.populate_available_devices): Device state check is now shared between simulators.
(SimulatedDeviceManager._disambiguate_device_type): Only extract hardware family and type from candidate.
(SimulatedDevice.init): Device state check is now shared between simulators.
(SimulatedDevice.state): Use 'xcrun simctl list' instead of device.plist.

• Scripts/webkitpy/xcode/simulated_device_unittest.py:

(SimulatedDeviceTest.change_state_to): Deleted.
(SimulatedDeviceTest.test_swapping_devices): Deleted.

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/xcode/simulated_device.py (modified) (6 diffs)
• Scripts/webkitpy/xcode/simulated_device_unittest.py (modified) (1 diff)

trunk/Tools/ChangeLog

@@ +1 @@
+2021-08-10  Jonathan Bedard  <jbedard@apple.com>
+
+        [webkitpy] Stop relying on device.plist for simulated device state
+        https://bugs.webkit.org/show_bug.cgi?id=228974
+        <rdar://problem/81749547>
+
+        Reviewed by Stephanie Lewis.
+
+        * Scripts/webkitpy/xcode/simulated_device.py:
+        (SimulatedDeviceManager):
+        (SimulatedDeviceManager.populate_available_devices): Device state check is now shared between simulators.
+        (SimulatedDeviceManager._disambiguate_device_type): Only extract hardware family and type from candidate.
+        (SimulatedDevice.__init__): Device state check is now shared between simulators.
+        (SimulatedDevice.state): Use 'xcrun simctl list' instead of device.plist.
+        * Scripts/webkitpy/xcode/simulated_device_unittest.py:
+        (SimulatedDeviceTest.change_state_to): Deleted.
+        (SimulatedDeviceTest.test_swapping_devices): Deleted.
+
 2021-08-10  Cameron McCormack  <heycam@apple.com>
 

trunk/Tools/Scripts/webkitpy/xcode/simulated_device.py

@@ -81 +81 @@
     _device_identifier_to_name = {}
     _managing_simulator_app = False
+    _last_updated_state = 0
 
     @staticmethod
@@ -142 +143 @@
         SimulatedDeviceManager.AVAILABLE_RUNTIMES = SimulatedDeviceManager._create_runtimes(simctl_json['runtimes'])
 
+        SimulatedDeviceManager._last_updated_state = time.time()
         for runtime in SimulatedDeviceManager.AVAILABLE_RUNTIMES:
             # Needed for <rdar://problem/47122965>
@@ -160 +162 @@
                 # Update device state from simctl output.
                 device.platform_device._state = SimulatedDevice.NAME_FOR_STATE.index(device_json['state'].upper())
-                device.platform_device._last_updated_state = time.time()
         return
 
@@ -254 +255 @@
                 candidate = DeviceType.from_string(type_name)
                 if candidate == full_device_type:
-                    full_device_type = candidate
+                    full_device_type.hardware_family = candidate.hardware_family
+                    full_device_type.hardware_type = candidate.hardware_type
                     break
 
@@ -551 +553 @@
         self.build_version = build_version
         self._state = SimulatedDevice.DeviceState.SHUTTING_DOWN
-        self._last_updated_state = time.time()
 
         self.executive = host.executive
@@ -563 +564 @@
     def state(self, force_update=False):
         # Don't allow state to get stale
-        if not force_update and time.time() < self._last_updated_state + 1:
+        if not force_update and time.time() < SimulatedDeviceManager._last_updated_state + 10:
             return self._state
 
-        device_plist = self.filesystem.expanduser(self.filesystem.join(SimulatedDeviceManager.simulator_device_path, self.udid, 'device.plist'))
         try:
-            self._state = int(readPlist(self.filesystem.open_binary_file_for_reading(device_plist))['state'])
-        except IOError:
+            SimulatedDeviceManager._last_updated_state = time.time()
+            simctl_json = json.loads(self.executive.run_command([SimulatedDeviceManager.xcrun, 'simctl', 'list', '--json'], decode_output=False, return_stderr=False))
+            state_map = {}
+            for devices in simctl_json['devices'].values():
+                for device in devices:
+                    if device.get('udid') and device.get('state'):
+                        state_map[device.get('udid')] = device.get('state')
+            for device in SimulatedDeviceManager.AVAILABLE_DEVICES:
+                device.platform_device._state = SimulatedDevice.NAME_FOR_STATE.index(state_map.get(device.platform_device.udid, 'SHUTDOWN').upper())
+        except (ValueError, ScriptError):
+            _log.error("Failed to decode 'simctl list' json output")
             self._state = SimulatedDevice.DeviceState.SHUTTING_DOWN
 
-        self._last_updated_state = time.time()
         return self._state
 

trunk/Tools/Scripts/webkitpy/xcode/simulated_device_unittest.py

@@ -643 +643 @@
         self.assertEquals(runtime, None)
 
-    @staticmethod
-    def change_state_to(device, state):
-        assert isinstance(state, int)
-
-        # Reaching into device.plist to change device state. Note that this will not change the initial state of the device
-        # as determined from the .json output.
-        device_plist = device.filesystem.expanduser(device.filesystem.join(SimulatedDeviceManager.simulator_device_path, device.udid, 'device.plist'))
-        index_position = device.filesystem.files[device_plist].index(b'</integer>') - 1
-        device.filesystem.files[device_plist] = device.filesystem.files[device_plist][:index_position] + string_utils.encode(str(state)) + device.filesystem.files[device_plist][index_position + 1:]
-
-    def test_swapping_devices(self):
-        SimulatedDeviceTest.reset_simulated_device_manager()
-        host = SimulatedDeviceTest.mock_host_for_simctl()
-        SimulatedDeviceManager.available_devices(host)
-
-        # We won't test the creation and deletion of simulators, only managing existing sims
-        SimulatedDeviceTest.change_state_to(SimulatedDeviceManager.device_by_filter(lambda device: device.device_type == DeviceType.from_string('iPhone 8'), host)[0], SimulatedDevice.DeviceState.BOOTED)
-        SimulatedDeviceTest.change_state_to(SimulatedDeviceManager.device_by_filter(lambda device: device.device_type == DeviceType.from_string('iPhone X'), host)[0], SimulatedDevice.DeviceState.BOOTED)
-
-        SimulatedDeviceManager.initialize_devices(DeviceRequest(DeviceType.from_string('iPhone 8')), host=host)
-
-        self.assertEquals(1, len(SimulatedDeviceManager.INITIALIZED_DEVICES))
-        self.assertEquals('17104B4F-E77D-4019-98E6-621FE3CC3653', SimulatedDeviceManager.INITIALIZED_DEVICES[0].udid)
-        self.assertEquals(SimulatedDevice.DeviceState.BOOTED, SimulatedDeviceManager.INITIALIZED_DEVICES[0].platform_device.state())
-
-        # Now swap for the X
-        SimulatedDeviceTest.change_state_to(SimulatedDeviceManager.INITIALIZED_DEVICES[0], SimulatedDevice.DeviceState.SHUT_DOWN)
-        SimulatedDeviceManager.swap(SimulatedDeviceManager.INITIALIZED_DEVICES[0], DeviceRequest(DeviceType.from_string('iPhone X')), host)
-
-        self.assertEquals(1, len(SimulatedDeviceManager.INITIALIZED_DEVICES))
-        self.assertEquals('4E6E7393-C4E3-4323-AA8B-4A42A45AE7B8', SimulatedDeviceManager.INITIALIZED_DEVICES[0].udid)
-        self.assertEquals(SimulatedDevice.DeviceState.BOOTED,  SimulatedDeviceManager.INITIALIZED_DEVICES[0].platform_device.state())
-
-        SimulatedDeviceTest.change_state_to(SimulatedDeviceManager.INITIALIZED_DEVICES[0], SimulatedDevice.DeviceState.SHUT_DOWN)
-        SimulatedDeviceManager.tear_down(host)
-        self.assertIsNone(SimulatedDeviceManager.INITIALIZED_DEVICES)
-
     def test_no_state_files(self):
         SimulatedDeviceTest.reset_simulated_device_manager()