run_loop 2.1.3 → 2.1.4

data/lib/run_loop/device_agent/frameworks.rb

@@ -4,7 +4,7 @@ module RunLoop
   module DeviceAgent
     # @!visibility private
     class Frameworks
-      require "run_loop/shell"
+
       require "singleton"
       include Singleton
 
@@ -15,24 +15,23 @@ module RunLoop
           return true
         end
 
-        RunLoop.log_debug("Installing Frameworks to #{target}")
+        RunLoop.log_debug("Installing Frameworks to #{rootdir}")
 
         options = { :log_cmd => true }
 
         Dir.chdir(rootdir) do
           RunLoop.log_unix_cmd("cd #{rootdir}")
-          shell.exec(["unzip", File.basename(zip)], options)
+          shell.run_shell_command(["ditto", "-xk", File.basename(zip), "."], options)
         end
-
-        shell.exec(["cp", "-r", "#{frameworks}/*.framework", target], options)
-        shell.exec(["cp", "#{frameworks}/*LICENSE", target], options)
-        RunLoop.log_debug("Installed frameworks to #{target}")
+        RunLoop.log_debug("Installed frameworks to #{rootdir}")
       end
 
       private
 
       # @!visibility private
+      # TODO replace with include Shell
       def shell
+        require "run_loop/shell"
         Class.new do
           include RunLoop::Shell
           def to_s; "#<Frameworks Shell>"; end
@@ -40,11 +39,6 @@ module RunLoop
         end.new
       end
 
-      # @!visibility private
-      def target
-        @target ||= File.join(RunLoop::DotDir.directory, "Frameworks")
-      end
-
       # @!visibility private
       def frameworks
         @frameworks ||= File.join(rootdir, "Frameworks")
@@ -57,7 +51,7 @@ module RunLoop
 
       # @!visibility private
       def rootdir
-        @rootdir ||= File.expand_path(File.join(File.dirname(__FILE__), "frameworks"))
+        @rootdir ||= File.expand_path(File.join(File.dirname(__FILE__)))
       end
     end
   end

data/lib/run_loop/device_agent/{xctestctl.rb → ios_device_manager.rb}

@@ -5,10 +5,10 @@ module RunLoop
     # @!visibility private
     #
     # A wrapper around the test-control binary.
-    class XCTestctl < RunLoop::DeviceAgent::Launcher
+    class IOSDeviceManager < RunLoop::DeviceAgent::Launcher
 
       # @!visibility private
-      @@xctestctl = nil
+      @@ios_device_manager = nil
 
       # @!visibility private
       def self.device_agent_dir
@@ -16,32 +16,36 @@ module RunLoop
       end
 
       # @!visibility private
-      def self.xctestctl
-        @@xctestctl ||= lambda do
-          from_env = RunLoop::Environment.xctestctl
+      def self.ios_device_manager
+        @@ios_device_manager ||= begin
+          from_env = RunLoop::Environment.ios_device_manager
           if from_env
             if File.exist?(from_env)
-              RunLoop.log_debug("Using XCTESTCTL=#{from_env}")
+              RunLoop.log_debug("Using IOS_DEVICE_MANAGER=#{from_env}")
               from_env
             else
               raise RuntimeError, %Q[
-XCTESTCTL environment variable defined:
+IOS_DEVICE_MANAGER environment variable defined:
 
 #{from_env}
 
 but binary does not exist at that path.
-            ]
+]
             end
-
           else
-            File.join(self.device_agent_dir, "bin", "xctestctl")
+            File.join(self.device_agent_dir, "bin", "iOSDeviceManager")
           end
-        end.call
+        end
+      end
+
+      # @!visibility private
+      def name
+        :xctestctl
       end
 
       # @!visibility private
       def to_s
-        "#<Testctl: #{XCTestctl.xctestctl}>"
+        "#<iOSDeviceManager: #{IOSDeviceManager.ios_device_manager}>"
       end
 
       # @!visibility private
@@ -56,7 +60,7 @@ but binary does not exist at that path.
 
       # @!visibility private
       def self.log_file
-        path = File.join(Launcher.dot_dir, "xctestctl.log")
+        path = File.join(Launcher.dot_dir, "ios-device-manager.log")
         FileUtils.touch(path) if !File.exist?(path)
         path
       end
@@ -65,17 +69,27 @@ but binary does not exist at that path.
       def launch
         RunLoop::DeviceAgent::Frameworks.instance.install
 
+        # WIP: it is unclear what the behavior should be.
         if device.simulator?
-          cbxapp = RunLoop::App.new(runner.runner)
-
-          # quits the simulator
-          sim = CoreSimulator.new(device, cbxapp)
-          sim.install
+          # Simulator cannot be running for this version.
+          CoreSimulator.quit_simulator
+
+          # TODO: run-loop is responsible for detecting an outdated CBX-Runner
+          # application and installing a new one.  However, iOSDeviceManager
+          # fails if simulator is already running.
+
+          # cbxapp = RunLoop::App.new(runner.runner)
+          #
+          # # quits the simulator
+          # sim = CoreSimulator.new(device, cbxapp)
+          # sim.install
+          # sim.launch_simulator
         end
 
-        cmd = RunLoop::DeviceAgent::XCTestctl.xctestctl
+        cmd = RunLoop::DeviceAgent::IOSDeviceManager.ios_device_manager
 
-        args = ["-r", runner.runner,
+        args = ["start_test",
+                "-r", runner.runner,
                 "-t", runner.tester,
                 "-d", device.udid]
 
@@ -84,14 +98,14 @@ but binary does not exist at that path.
           args << RunLoop::Environment.codesign_identity
         end
 
-        log_file = XCTestctl.log_file
+        log_file = IOSDeviceManager.log_file
         FileUtils.rm_rf(log_file)
         FileUtils.touch(log_file)
 
         options = {:out => log_file, :err => log_file}
         RunLoop.log_unix_cmd("#{cmd} #{args.join(" ")} >& #{log_file}")
 
-        # Gotta keep the xctestctl process alive or the connection
+        # Gotta keep the ios_device_manager process alive or the connection
         # to testmanagerd will fail.
         pid = Process.spawn(cmd, *args, options)
         Process.detach(pid)
@@ -105,5 +119,3 @@ but binary does not exist at that path.
     end
   end
 end
-
-

data/lib/run_loop/device_agent/launcher.rb

@@ -29,6 +29,14 @@ XCUITest is only available for iOS >= 9.0
         end
       end
 
+      # @!visibility private
+      # The name of this launcher. Must be a symbol (keyword).  This value will
+      # be used for the key :cbx_launcher in the RunLoop::Cache so Calabash
+      # iOS can attach and reattach to an XCUITest instance.
+      def name
+        abstract_method!
+      end
+
       # @!visibility private
       #
       # Does whatever it takes to launch the CBX-Runner on the device.

data/lib/run_loop/device_agent/xcodebuild.rb

@@ -24,6 +24,11 @@ module RunLoop
         to_s
       end
 
+      # @!visibility private
+      def name
+        :xcodebuild
+      end
+
       # @!visibility private
       def launch
         workspace

data/lib/run_loop/dnssd.rb

@@ -0,0 +1,148 @@
+module RunLoop
+
+  # @!visibility private
+  # This class is a work in progress.
+  #
+  # At the moment, it is only useful for debugging the bonjour
+  # server that is started by DeviceAgent.
+  class DNSSD
+
+    # @!visibility private
+    def self.factory(json)
+      array = JSON.parse(json, {:symbolize_names => true})
+      array.map do |dns|
+        RunLoop::DNSSD.new(dns[:service],
+                           dns[:ip],
+                           dns[:port],
+                           dns[:txt])
+      end
+    end
+
+    # @!visibility private
+    attr_reader :service
+
+    # @!visibility private
+    attr_reader :ip
+
+    # @!visibility private
+    attr_reader :port
+
+    # @!visibility private
+    attr_reader :txt
+
+    # @!visibility private
+    def initialize(service, ip, port, txt)
+      @service = service
+      @ip = ip
+      @port = port
+      @txt = txt
+    end
+
+    # @!visibility private
+    def url
+      @url ||= "http://#{ip}:#{port}"
+    end
+
+    # @!visibility private
+    def to_s
+      "#<#{service}: #{url} TXT: #{txt}"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
+    # @!visibility private
+    def ==(other)
+      service == other.service
+    end
+
+    DEVICE_AGENT = "_calabus._tcp"
+
+    def self.wait_for_new_device_agent(old, options={})
+      new = self.wait_for_device_agents(options)
+      new.find do |new_dns|
+        !old.include?(new_dns)
+      end
+    end
+
+    def self.wait_for_device_agents(options={})
+      default_opts = {
+        :timeout => 0.1,
+        :retries => 150,
+        :interval => 0.1
+      }
+
+      merged_opts = default_opts.merge(options)
+      timeout = merged_opts[:timeout]
+      retries = merged_opts[:retries]
+      interval = merged_opts[:interval]
+
+      start_time = Time.now
+
+      retries.times do |try|
+        time_diff = start_time + timeout - Time.now
+
+        if time_diff <= 0
+          elapsed = Time.now - start_time
+          RunLoop.log_debug("Timed out waiting after #{elapsed} seconds for DeviceAgents")
+          return []
+        end
+
+        agents = self.device_agents(timeout)
+
+        if !agents.empty?
+          elapsed = Time.now - start_time
+          RunLoop.log_debug("Found #{agents.count} DeviceAgents after #{elapsed} seconds")
+          return agents
+        end
+
+        sleep(interval)
+      end
+      []
+    end
+
+    def self.device_agents(timeout)
+      services = []
+      addresses = []
+      self.browse(DEVICE_AGENT, timeout) do |reply|
+        if reply.flags.add?
+          services << reply
+        end
+        next if reply.flags.more_coming?
+
+        services.each do |service|
+          resolved = service.resolve
+          addr = Socket.getaddrinfo(resolved.target, nil, Socket::AF_INET)
+          addr.each do |address|
+            match = addresses.find do |dns|
+              dns.service == service.name
+            end
+
+            if !match
+              dns = RunLoop::DNSSD.new(service.name,
+                                       addr[0][2],
+                                       resolved.port,
+                                       resolved.text_record)
+              addresses << dns
+            end
+          end
+        end
+      end
+      addresses
+    end
+
+    def self.browse(type, timeout)
+      domain = nil
+      flags = 0
+      interface = ::DNSSD::InterfaceAny
+      service = ::DNSSD::Service.browse(type, domain, flags, interface)
+      service.each(timeout) { |r| yield r }
+    ensure
+      service.stop if service
+    end
+
+  end
+end
+

data/lib/run_loop/dot_dir.rb

@@ -54,7 +54,7 @@ module RunLoop::DotDir
 
     RunLoop.log_debug("Deleted #{oldest_first.count} previous results in #{elapsed} seconds")
   rescue StandardError => e
-    RunLoop.log_error("While rotating previous results, encounterd: #{e}")
+    RunLoop.log_error("While rotating previous results, encountered: #{e}")
   end
 
   private

data/lib/run_loop/dylib_injector.rb

@@ -70,7 +70,7 @@ module RunLoop
       hash = nil
       success = false
       begin
-        hash = xcrun.exec(["lldb", "--no-lldbinit", "--source", script_path], options)
+        hash = xcrun.run_command_in_context(["lldb", "--no-lldbinit", "--source", script_path], options)
         pid = hash[:pid]
         exit_status = hash[:exit_status]
         success = exit_status == 0

data/lib/run_loop/encoding.rb

@@ -2,6 +2,23 @@
 module RunLoop
   module Encoding
 
+    # Removes diacritic markers from string.
+    #
+    # The ruby Encoding tools cannot perform this action, they can only change
+    # convert one encodign to another by substituting characters.
+    #
+    # In ruby 1.9.3 we would have used Iconv, but that does not exist in 2.0.
+    #
+    # The Encoding::Convert in 2.0 does not work on string with UTF-16 characters.
+    def transliterate(string)
+      require "i18n"
+      locales = I18n.available_locales
+      if !locales.include?(:en)
+        I18n.available_locales = locales + [:en]
+      end
+      I18n.transliterate(string)
+    end
+
     # Raised when a string cannot be coerced to UTF8
     class UTF8Error < RuntimeError; end
 

data/lib/run_loop/environment.rb

@@ -186,13 +186,13 @@ module RunLoop
       end
     end
 
-    # Returns the value of XCTESTCTL
+    # Returns the value of IOS_DEVICE_MANAGER
     #
-    # Use this to specify a non-default xctestctl binary.
+    # Use this to specify a non-default ios_device_manager binary.
     #
-    # The default xctestctl binary is bundled with this gem.
-    def self.xctestctl
-      value = ENV["XCTESTCTL"]
+    # The default ios_device_manager binary is bundled with this gem.
+    def self.ios_device_manager
+      value = ENV["IOS_DEVICE_MANAGER"]
       if !value || value == ""
         nil
       else
@@ -228,6 +228,16 @@ module RunLoop
       end
     end
 
+    # Returns the value of DEVICE_ENDPOINT
+    def self.device_agent_url
+      value = ENV["DEVICE_AGENT_URL"]
+      if value.nil? || value == ""
+        nil
+      else
+        value
+      end
+    end
+
     # Returns true if running in Jenkins CI
     #
     # Checks the value of JENKINS_HOME

data/lib/run_loop/instruments.rb

@@ -193,7 +193,7 @@ module RunLoop
     def templates
       @instruments_templates ||= lambda do
         args = ['instruments', '-s', 'templates']
-        hash = xcrun.exec(args, log_cmd: true)
+        hash = xcrun.run_command_in_context(args, log_cmd: true)
         hash[:out].chomp.split("\n").map do |elm|
           stripped = elm.strip.tr('"', '')
           if stripped == '' || stripped == 'Known Templates:'
@@ -269,7 +269,7 @@ module RunLoop
     def fetch_devices
       @device_hash ||= lambda do
         args = ['instruments', '-s', 'devices']
-        xcrun.exec(args, log_cmd: true)
+        xcrun.run_command_in_context(args, log_cmd: true)
       end.call
     end