Merge pull request #649 from calabash/feature/Device-simulator-paths-may-need-to-be-created

Device: ensure simulator plist paths exist

Author: jmoody

lib/run_loop/device.rb

@@ -275,79 +275,44 @@ def update_simulator_state
 
     # @!visibility private
     def simulator_root_dir
-      @simulator_root_dir ||= lambda {
-        return nil if physical_device?
-        File.join(CORE_SIMULATOR_DEVICE_DIR, udid)
-      }.call
+      return nil if physical_device?
+      @simulator_root_dir ||= File.join(CORE_SIMULATOR_DEVICE_DIR, udid)
     end
 
     # @!visibility private
     def simulator_accessibility_plist_path
-      @simulator_accessibility_plist_path ||= lambda {
-        return nil if physical_device?
-        File.join(simulator_root_dir, 'data/Library/Preferences/com.apple.Accessibility.plist')
-      }.call
+      return nil if physical_device?
+
+      directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
+      pbuddy.ensure_plist(directory, "com.apple.Accessibility.plist")
     end
 
     # @!visibility private
     def simulator_preferences_plist_path
       return nil if physical_device?
 
-
       directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
-
-      if !File.exist?(directory)
-        FileUtils.mkdir_p(directory)
-      end
-
-      plist = File.join(directory, "com.apple.Preferences.plist")
-
-      if !File.exist?(plist)
-        pbuddy.create_plist(plist)
-      end
-      plist
+      pbuddy.ensure_plist(directory, "com.apple.Preferences.plist")
     end
 
     # @!visibility private
     def simulator_log_file_path
-      @simulator_log_file_path ||= lambda {
-        return nil if physical_device?
-        File.join(CORE_SIMULATOR_LOGS_DIR, udid, 'system.log')
-      }.call
+      return nil if physical_device?
+      @simulator_log_file_path ||= File.join(CORE_SIMULATOR_LOGS_DIR, udid,
+                                             'system.log')
     end
 
     # @!visibility private
     def simulator_device_plist
-      @simulator_device_plist ||= lambda do
-        return nil if physical_device?
-        File.join(simulator_root_dir, 'device.plist')
-      end.call
+      return nil if physical_device?
+      pbuddy.ensure_plist(simulator_root_dir, "device.plist")
     end
 
     # @!visibility private
-    def simulator_global_preferences_path(timeout=10)
+    def simulator_global_preferences_path
       return nil if physical_device?
-
-      path = File.join(simulator_root_dir,
-                       "data/Library/Preferences/.GlobalPreferences.plist")
-
-      return path if File.exist?(path)
-
-      start = Time.now
-      while !File.exist?(path) && (start + timeout) < Time.now
-        sleep(1.0)
-      end
-
-      return path if File.exist?(path)
-
-      raise(RuntimeError, %Q[
-Timed out waiting for .GlobalPreferences.plist after #{Time.now - start} seconds.
-
-File does not exist at path:
-
-#{path}
-
-])
+      directory = File.join(simulator_root_dir, "data", "Library", "Preferences")
+      pbuddy.ensure_plist(directory, ".GlobalPreferences.plist")
     end
 
     # @!visibility private

lib/run_loop/plist_buddy.rb

@@ -1,3 +1,4 @@
+
 module RunLoop
   # A class for reading and writing property list values.
   #
@@ -6,6 +7,8 @@ module RunLoop
   # is problematic for our purposes.
   class PlistBuddy
 
+    require "fileutils"
+
     # Reads key from file and returns the result.
     # @param [String] key the key to inspect (may not be nil or empty)
     # @param [String] file the plist to read
@@ -85,6 +88,18 @@ def create_plist(path)
       path
     end
 
+    # Ensures a plist exists at path by creating necessary directories and
+    # creating an empty plist if none exists.
+    def ensure_plist(directory, name)
+      FileUtils.mkdir_p(directory) if !File.exist?(directory)
+
+      plist = File.join(directory, name)
+
+      create_plist(plist) if !File.exists?(plist)
+
+      plist
+    end
+
     private
 
     # returns the path to the PlistBuddy executable

lib/run_loop/simctl.rb

@@ -24,7 +24,7 @@ class Simctl
       "Shutdown" => 1,
       "Shutting Down" => 2,
       "Booted" => 3,
-      "Plist Missing" => -1
+      "Plist Missing Key" => -1
     }.freeze
 
     # @!visibility private
@@ -125,10 +125,11 @@ def app_container(device, bundle_id)
     # @!visibility private
     def simulator_state_as_int(device)
       plist = device.simulator_device_plist
-      if File.exist?(plist)
+
+      if pbuddy.plist_key_exists?("state", plist)
         pbuddy.plist_read("state", plist).to_i
       else
-        SIM_STATES["Plist Missing"]
+        SIM_STATES["Plist Missing Key"]
       end
     end
 

spec/lib/device_spec.rb

@@ -231,83 +231,103 @@
     end
   end
 
-  describe 'simulator files' do
-    let (:physical) {  RunLoop::Device.new('name',
-                                           '7.1.2',
-                                           '30c4b52a41d0f6c64a44bd01ff2966f03105de1e') }
-    let (:simulator) { RunLoop::Device.new('iPhone 5s',
-                                           '7.1.2',
-                                           '77DA3AC3-EB3E-4B24-B899-4A20E315C318', 'Shutdown') }
-    describe '#simulator_root_dir' do
-      it 'is nil if physical device' do
-        expect(physical.simulator_root_dir).to be_falsey
+  context "simulator files" do
+    let(:physical) do
+      RunLoop::Device.new("name", "7.1.2",
+                          "30c4b52a41d0f6c64a44bd01ff2966f03105de1e")
+    end
+
+    let (:simulator) do
+      RunLoop::Device.new("iPhone 5s", "7.1.2",
+                          "77DA3AC3-EB3E-4B24-B899-4A20E315C318", "Shutdown")
+    end
+
+    context "#simulator_root_dir" do
+      it "returns nil when physical device" do
+        expect(physical.simulator_root_dir).to be == nil
       end
 
-      it 'is non nil if a simulator' do
-        expect(simulator.simulator_root_dir[/#{simulator.udid}/,0]).to be_truthy
+      it "returns path to Library/Developer/CoreSimulator/<UDID>" do
+        expect(simulator.simulator_root_dir[/#{simulator.udid}/]).to be_truthy
       end
     end
 
-    describe '#simulator_accessibility_plist_path' do
-      it 'is nil if physical device' do
-        expect(physical.simulator_accessibility_plist_path).to be_falsey
+    context "#simulator_log_file_path" do
+      it "returns nil when physical device" do
+        expect(physical.simulator_log_file_path).to be == nil
       end
 
-      it 'is non nil if a simulator' do
-        expect(simulator.simulator_accessibility_plist_path[/#{simulator.udid}/,0]).to be_truthy
-        expect(simulator.simulator_accessibility_plist_path[/com.apple.Accessibility.plist/,0]).to be_truthy
+      it "returns path to Library/Logs/CoreSimulator/<UDID>/system.log" do
+        actual = simulator.simulator_log_file_path
+        expect(actual[/#{simulator.udid}/]).to be_truthy
+        expect(actual[/system.log/]).to be_truthy
       end
     end
 
-    describe "#simulator_preferences_plist_path" do
-      it "returns nil if physical device" do
-        expect(physical.simulator_preferences_plist_path).to be_falsey
+    context "simulator plists" do
+      let(:root_dir) do
+        File.join(Resources.shared.local_tmp_dir, "CoreSimulator", "Devices",
+                  simulator.udid)
       end
 
-      context "simulator" do
-        let(:root_dir) { File.join(Resources.shared.local_tmp_dir) }
-        let(:directory) { File.join(root_dir, "data", "Library", "Preferences") }
-        let(:plist) { File.join(directory, "com.apple.Preferences.plist") }
-        let(:template) { Resources.shared.plist_with_software_keyboard(true) }
+      before do
+        FileUtils.rm_rf(root_dir)
+        FileUtils.mkdir_p(root_dir)
+      end
 
-        before do
-          FileUtils.rm_rf(directory)
-          FileUtils.mkdir_p(directory)
+      context "#simulator_accessibility_plist_path" do
+        it "returns nil when physical device" do
+          expect(physical.simulator_accessibility_plist_path).to be == nil
+        end
+
+        it "returns path to Accessibility.plist when device is a simulator" do
           expect(simulator).to receive(:simulator_root_dir).and_return(root_dir)
+
+          actual = simulator.simulator_accessibility_plist_path
+
+          expect(actual[/com.apple.Accessibility.plist/]).to be_truthy
         end
+      end
 
-        it "returns path to plist" do
-          FileUtils.cp(template, plist)
-          expect(simulator.simulator_preferences_plist_path).to be == plist
+      context "#simulator_preferences_plist_path" do
+        it "returns nil if physical device" do
+          expect(physical.simulator_preferences_plist_path).to be == nil
         end
 
-        it "returns path to plist; creates file if necessary" do
-          expect(File.exist?(plist)).to be_falsey
-          expect(simulator.simulator_preferences_plist_path).to be == plist
-          expect(File.exist?(plist)).to be_truthy
+        it "returns path to Preference.plist when device is a simulator" do
+          expect(simulator).to receive(:simulator_root_dir).and_return(root_dir)
+
+          actual = simulator.simulator_preferences_plist_path
+
+          expect(actual[/com.apple.Preferences.plist/]).to be_truthy
         end
       end
-    end
 
-    describe '#simulator_log_file_path' do
-      it 'is nil if physical device' do
-        expect(physical.simulator_log_file_path).to be_falsey
-      end
+      context "#simulator_device_plist" do
+        it "returns nil physical device" do
+          expect(physical.simulator_device_plist).to be == nil
+        end
 
-      it 'is non nil if a simulator' do
-        expect(simulator.simulator_log_file_path[/#{simulator.udid}/,0]).to be_truthy
-        expect(simulator.simulator_log_file_path[/system.log/,0]).to be_truthy
-      end
-    end
+        it "returns path to device.plist when device is a simulator" do
+          expect(simulator).to receive(:simulator_root_dir).and_return(root_dir)
 
-    describe '#simulator_device_plist' do
-      it 'is nil if a physical device' do
-        expect(physical.simulator_device_plist).to be_falsey
+          actual = simulator.simulator_device_plist
+          expect(actual[/device.plist/]).to be_truthy
+        end
       end
 
-      it 'is non-nil for simulators' do
-        actual = simulator.simulator_device_plist
-        expect(actual[/#{simulator.udid}\/device.plist/, 0]).to be_truthy
+      context "#simulator_global_preferences_path" do
+        it "returns nil for physical devices" do
+          expect(physical.simulator_global_preferences_path).to be == nil
+        end
+
+        it "returns path to the .GlobalPreferences.plist when simulator" do
+          expect(simulator).to receive(:simulator_root_dir).and_return(root_dir)
+
+          actual = simulator.simulator_global_preferences_path
+
+          expect(actual[/.GlobalPreferences.plist/]).to be_truthy
+        end
       end
     end
 
@@ -340,33 +360,6 @@
        expect(actual).to be_truthy
       end
     end
-
-    describe "#simulator_global_preferences_path" do
-      it "returns nil for physical devices" do
-        expect(physical.simulator_global_preferences_path).to be_falsey
-      end
-
-      it "raises an error after waiting for the plist to exist" do
-        path = File.join(simulator.simulator_root_dir,
-                         "data/Library/Preferences/.GlobalPreferences.plist")
-        expect(File).to receive(:exist?).with(path).at_least(:twice).and_return(false)
-
-        expect do
-          simulator.simulator_global_preferences_path(0.05)
-        end.to raise_error(RuntimeError,
-                           /Timed out waiting for .GlobalPreferences.plist/)
-      end
-
-      it "returns the path to the global plist" do
-        simulator = Resources.shared.default_simulator
-
-        actual = simulator.simulator_global_preferences_path
-
-        expect(actual[/.GlobalPreferences.plist/]).to be_truthy
-        expect(actual[/#{simulator.udid}/]).to be_truthy
-        expect(File.exist?(actual)).to be_truthy
-      end
-    end
   end
 
   describe "#simulator_languages" do

spec/lib/plist_buddy_spec.rb

@@ -16,6 +16,42 @@
     expect(File.open(path).read).not_to be == ''
   end
 
+  context "#ensure_plist" do
+    let(:base_dir) { File.join(Resources.shared.local_tmp_dir, "PlistBuddy") }
+    let(:directory) { File.join(base_dir, "A", "B") }
+    let(:name) { "com.example.MyApp.plist" }
+    let(:plist) { File.join(directory, name) }
+
+    before do
+      FileUtils.rm_rf(base_dir)
+      FileUtils.mkdir_p(base_dir)
+    end
+
+    it "returns a path to an existing plist" do
+      FileUtils.mkdir_p(directory)
+      FileUtils.touch(plist)
+
+      expect(FileUtils).not_to receive(:mkdir_p).with(directory)
+      expect(pbuddy).not_to receive(:create_plist)
+      expect(pbuddy.ensure_plist(directory, name)).to be == plist
+    end
+
+    it "returns a path to an empty plist if one does not already exist" do
+      FileUtils.mkdir_p(directory)
+
+      expect(FileUtils).not_to receive(:mkdir_p).with(directory)
+      expect(pbuddy).to receive(:create_plist).with(plist)
+      expect(pbuddy.ensure_plist(directory, name)).to be == plist
+    end
+
+    it "returns a path to an empty plist after creating any necessary directories" do
+      expect(FileUtils).to receive(:mkdir_p).with(directory)
+      expect(pbuddy).to receive(:create_plist).with(plist)
+
+      expect(pbuddy.ensure_plist(directory, name)).to be == plist
+    end
+  end
+
   describe '#build_plist_cmd' do
     describe 'raises errors' do
       it 'if file does not exist' do