run_loop 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d73937dad7c29104b1ae37c879b16e44aff02db3
-  data.tar.gz: dda0b44e84dd217f63e2108912fb74b79049bd1b
+  metadata.gz: 11be3a1fe89681a24289e331b94823e23cf6ade9
+  data.tar.gz: 5e51d2d106452481ba15e63315ac26fb5798a0c6
 SHA512:
-  metadata.gz: 93c63c401d4307fe1accf494b4a6a32619d66043ded3c7c75ebc7ff9cacfdcc32f0fc23552309bd048212c4ca77c0421e8aab5be9b892a3e3ab8383442950db3
-  data.tar.gz: 5d23eda8b969944c6030affb7ff2dcd7da5a1ef357b4b5f6ce8ff9e92d7e169b9dfa0f001182bc0a95811c73fe4eba9b40149bbe00e4a2d0fe37e27b75a30c22
+  metadata.gz: 396eff04828c24cadfca702fc041a238b337c8310d65e1ebba5dfd8ba1a7a77dc7a3cee05a1e59966db913f7dbb3113ff8023a6c2bac609ede575c98b48c2f7e
+  data.tar.gz: 6c87504310686551a5bec02248b92bc24681b4bf62ae57286ba04f64e0dba3edbae7e1b804efdbeb9325e67e3be594cc2c8943fbcff8bb8405f693b973d5cfeb

data/lib/run_loop/core.rb

@@ -574,7 +574,13 @@ module RunLoop
 
     def self.default_tracetemplate(xctools=RunLoop::XCTools.new)
       templates = xctools.instruments :templates
-      if xctools.xcode_version_gte_6?
+      if xctools.xcode_version_gte_61?
+        templates.delete_if do |path|
+          not path =~ /\/Automation.tracetemplate/
+        end.delete_if do |path|
+          not path =~ /Xcode/
+        end.first.tr("\"", '').strip
+      elsif xctools.xcode_version_gte_6?
         templates.delete_if do |name|
           not name == 'Automation'
         end.first

data/lib/run_loop/instruments.rb

@@ -5,23 +5,123 @@ module RunLoop
   # @note All instruments commands are run in the context of `xcrun`.
   #
   # @todo Detect Instruments.app is running and pop an alert.
-  # @todo Needs tests.
   class Instruments
 
+    # Returns an Array of instruments process ids.
+    #
+    # @note The `block` parameter is included for legacy API and will be
+    #  deprecated.  Replace your existing calls with with .each or .map.  The
+    #  block argument makes this method hard to mock.
+    # @return [Array<Integer>] An array of instruments process ids.
+    def instruments_pids(&block)
+      pids = pids_from_ps_output
+      if block_given?
+        pids.each do |pid|
+          block.call(pid)
+        end
+      else
+        pids
+      end
+    end
+
+    # Are there any instruments processes running?
+    # @return [Boolean] True if there is are any instruments processes running.
+    def instruments_running?
+      instruments_pids.count > 0
+    end
+
+    # Send a kill signal to any running `instruments` processes.
+    #
+    # Only one instruments process can be running at any one time.
+    #
+    # @param [RunLoop::XCTools] xcode_tools The Xcode tools to use to determine
+    #  what version of Xcode is active.
+    def kill_instruments(xcode_tools = RunLoop::XCTools.new)
+      kill_signal = kill_signal xcode_tools
+      # It is difficult to test using a block.
+      instruments_pids.each do |pid|
+        begin
+          if ENV['DEBUG'] == '1'
+            puts "Sending '#{kill_signal}' to instruments process '#{pid}'"
+          end
+          Process.kill(kill_signal, pid.to_i)
+        rescue Exception => e
+          if ENV['DEBUG'] == '1'
+            puts "Could not kill process '#{pid.to_i}' - ignoring #{e}"
+          end
+        end
+
+        # Process.wait or `wait` here is pointless.  The pid may or may not be
+        # a child of this Process.
+        begin
+          if ENV['DEBUG'] == '1'
+            puts "Waiting for instruments '#{pid}' to terminate"
+          end
+          wait_for_process_to_terminate(pid, {:timeout => 2.0})
+        rescue Exception => e
+          if ENV['DEBUG'] == '1'
+            puts "Ignoring #{e.message}"
+          end
+        end
+      end
+    end
+
+    private
+
     # @!visibility private
-    #  $ ps x -o pid,command | grep -v grep | grep instruments
-    #   98081 sh -c xcrun instruments -w "43be3f89d9587e9468c24672777ff6241bd91124" < args >
-    #   98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
+    # When run from calabash, expect this:
+    #
+    # ```
+    # $ ps x -o pid,command | grep -v grep | grep instruments
+    # 98081 sh -c xcrun instruments -w "43be3f89d9587e9468c24672777ff6241bd91124" < args >
+    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
+    # ```
+    # When run from run-loop (via rspec), expect this:
+    #
+    # ```
+    # $ ps x -o pid,command | grep -v grep | grep instruments
+    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
     FIND_PIDS_CMD = 'ps x -o pid,comm | grep -v grep | grep instruments'
 
-    def grep_for_instruments_pids
-      ps_output = `#{FIND_PIDS_CMD}`.strip
+    # @!visibility private
+    #
+    # Executes `ps_cmd` to find instruments processes and returns the result.
+    #
+    # @param [String] ps_cmd The Unix ps command to execute to find instruments
+    #  processes.
+    # @return [String] A ps-style list of process details.  The details returned
+    #  are controlled by the `ps_cmd`.
+    def ps_for_instruments(ps_cmd=FIND_PIDS_CMD)
+      `#{ps_cmd}`.strip
+    end
+
+    # @!visibility private
+    # Is the process described an instruments process?
+    #
+    # @param [String] ps_details Details about a process as returned by `ps`
+    # @return [Boolean] True if the details describe an instruments process.
+    def is_instruments_process?(ps_details)
+      return false if ps_details.nil?
+      (ps_details[/\/usr\/bin\/instruments/, 0] or
+            ps_details[/sh -c xcrun instruments/, 0]) != nil
+    end
+
+    # @!visibility private
+    # Extracts an Array of integer process ids from the output of executing
+    # the Unix `ps_cmd`.
+    #
+    # @param [String] ps_cmd The Unix `ps` command used to find instruments
+    #  processes.
+    # @return [Array<Integer>] An array of integer pids for instruments
+    #  processes.  Returns an empty list if no instruments process are found.
+    def pids_from_ps_output(ps_cmd=FIND_PIDS_CMD)
+      ps_output = ps_for_instruments(ps_cmd)
       lines = ps_output.lines("\n").map { |line| line.strip }
       lines.map do |line|
         tokens = line.strip.split(' ').map { |token| token.strip }
         pid = tokens.fetch(0, nil)
-        process = tokens.fetch(1, nil)
-        if process and process[/\/usr\/bin\/instruments/, 0]
+        process_description = tokens[1..-1].join(' ')
+        if is_instruments_process? process_description
           pid.to_i
         else
           nil
@@ -29,28 +129,60 @@ module RunLoop
       end.compact
     end
 
-    def instruments_pids(&block)
-      pids = grep_for_instruments_pids
-      if block_given?
-        pids.each do |pid|
-          block.call(pid)
-        end
-      else
-        pids
-      end    # MobileGestaltHelper[909] <Error>: libMobileGestalt MobileGestalt.c:273: server_access_check denied access to question UniqueDeviceID for pid 796

+    # @!visibility private
+    # The kill signal should be sent to instruments.
+    #
+    # When testing against iOS 8, sending -9 or 'TERM' causes the ScriptAgent
+    # process on the device to emit the following error until the device is
+    # rebooted.
+    #
+    # ```
+    # MobileGestaltHelper[909] <Error>: libMobileGestalt MobileGestalt.c:273: server_access_check denied access to question UniqueDeviceID for pid 796

+    # ScriptAgent[796] <Error>: libMobileGestalt MobileGestaltSupport.m:170: pid 796 (ScriptAgent) does not have sandbox access for re6Zb+zwFKJNlkQTUeT+/w and IS NOT appropriately entitled
+    # ScriptAgent[703] <Error>: libMobileGestalt MobileGestalt.c:534: no access to UniqueDeviceID (see <rdar://problem/11744455>)
+    # ```
+    #
+    # @see https://github.com/calabash/run_loop/issues/34
+    #
+    # @param [RunLoop::XCTools] xcode_tools The Xcode tools to use to determine
+    #  what version of Xcode is active.
+    # @return [String] Either 'QUIT' or 'TERM', depending on the Xcode
+    #  version.
+    def kill_signal(xcode_tools = RunLoop::XCTools.new)
+      xcode_tools.xcode_version_gte_6? ? 'QUIT' : 'TERM'
     end
 
-    def instruments_running?
-      instruments_pids.count > 0
-    end
+    # @!visibility private
+    # Wait for Unix process with id `pid` to terminate.
+    #
+    # @param [Integer] pid The id of the process we are waiting on.
+    # @param [Hash] options Values to control the behavior of this method.
+    # @option options [Float] :timeout (2.0) How long to wait for the process to
+    #  terminate.
+    # @option options [Float] :interval (0.1) The polling interval.
+    # @option options [Boolean] :raise_on_no_terminate (false) Should an error
+    #  be raised if process does not terminate.
+    # @raise [RuntimeError] If process does not terminate and
+    #  options[:raise_on_no_terminate] is truthy.
+    def wait_for_process_to_terminate(pid, options={})
+      default_opts = {:timeout => 2.0,
+                      :interval => 0.1,
+                      :raise_on_no_terminate => false}
+      merged_opts = default_opts.merge(options)
 
-    def kill_instruments(xcode_tools = RunLoop::XCTools.new)
-      kill_signal = xcode_tools.xcode_version_gte_6? ? 'QUIT' : 'TERM'
-      instruments_pids do |pid|
-        if ENV['DEBUG'] == '1'
-          puts "Sending '#{kill_signal}' to instruments process '#{pid}'"
-        end
-        Process.kill(kill_signal, pid.to_i)
+      cmd = "ps #{pid} -o pid | grep #{pid}"
+      poll_until = Time.now + merged_opts[:timeout]
+      delay = merged_opts[:interval]
+      has_terminated = false
+      while Time.now < poll_until
+        has_terminated = `#{cmd}`.strip == ''
+        break if has_terminated
+        sleep delay
+      end
+
+      if merged_opts[:raise_on_no_terminate] and not has_terminated
+        details = `ps -p #{pid} -o pid,comm | grep #{pid}`.strip
+        raise RuntimeError, "Waited #{merged_opts[:timeout]} s for process '#{details}' to terminate"
       end
     end
   end

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 
   # A model of a software release version that can be used to compare two versions.
   #

data/lib/run_loop/xctools.rb

@@ -15,6 +15,14 @@ module RunLoop
   # @todo Refactor instruments related code to instruments class.
   class XCTools
 
+    # Returns a version instance for `Xcode 6.0`; used to check for the
+    # availability of features and paths to various items on the filesystem.
+    #
+    # @return [RunLoop::Version] 6.0
+    def v61
+      @xc61 ||= RunLoop::Version.new('6.1')
+    end
+
     # Returns a version instance for `Xcode 6.0`; used to check for the
     # availability of features and paths to various items on the filesystem.
     #
@@ -39,6 +47,13 @@ module RunLoop
       @xc50 ||= RunLoop::Version.new('5.0')
     end
 
+    # Are we running Xcode 6.1 or above?
+    #
+    # @return [Boolean] `true` if the current Xcode version is >= 6.1
+    def xcode_version_gte_61?
+      @xcode_gte_61 ||= xcode_version >= v61
+    end
+
     # Are we running Xcode 6 or above?
     #
     # @return [Boolean] `true` if the current Xcode version is >= 6.0
@@ -142,7 +157,16 @@ module RunLoop
         when :templates
           @instruments_templates ||= lambda {
             cmd = "#{instruments} -s templates"
-            if self.xcode_version >= self.v60
+            if self.xcode_version >= self.v61
+              Open3.popen3(cmd) do |_, stdout, stderr, _|
+                stderr_filter.call(stderr)
+                stdout.read.chomp.split("\n").map do |line|
+                  line.strip.tr('"', '')
+                end.delete_if do |path|
+                  not path =~ /tracetemplate/
+                end
+              end
+            elsif self.xcode_version >= self.v60
               Open3.popen3(cmd) do |_, stdout, stderr, _|
                 stderr_filter.call(stderr)
                 stdout.read.chomp.split("\n").map { |elm| elm.strip.tr('"', '') }

metadata

@@ -1,195 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: run_loop
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: retriable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.3.1
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 description: calabash-cucumber drives tests for native iOS apps. RunLoop provides
@@ -212,7 +212,6 @@ files:
 - lib/run_loop/sim_control.rb
 - lib/run_loop/version.rb
 - lib/run_loop/xctools.rb
-- scripts/calabash-uia-min.js
 - scripts/calabash.lldb.erb
 - scripts/calabash_script_uia.js
 - scripts/json2-min.js
@@ -233,12 +232,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -248,4 +247,3 @@ signing_key:
 specification_version: 4
 summary: Tools related to running Calabash iOS tests
 test_files: []
-has_rdoc: 

data/scripts/calabash-uia-min.js

@@ -1,7 +0,0 @@
-(function(){function m(){return h.frontMostApp()}function r(){return m().mainWindow()}function s(){return m().windows().toArray()}function n(){return m().keyboard()}function l(a,c){this.reason=a;this.a=c||"";this.message=this.toString()}function k(a){return!a||a instanceof UIAElementNil}function t(a,c){var b=c||[],e,d;if(k(a))return b;e=a.elements();for(var f=0,g=e.length;f<g;f+=1)d=e[f],b.push(d),t(d,b);return b}function q(a,c){for(var b=0,e=c.length;b<e;b+=1)a.push(c[b])}function u(a,c){var b=[];
-if(k(c))return b;c instanceof this[a]&&b.push(c);for(var e=c.elements(),d=0,f=e.length;d<f;d+=1)q(b,u(a,e[d]));return b}function x(a,c){var b=null;if(a instanceof Array){if(3===a.length){var e=a[0],b=a[1],d=a[2];if("string"==typeof d)if(-1==d.indexOf("'"))d="'"+d+"'";else if(-1==d.indexOf('"'))d='"'+d+'"';else throw new l("Escaping for filters not supported yet.");b=c.withPredicate(e+" "+b+" "+d);return!k(b)}return!1}for(e in a)if(a.hasOwnProperty(e))if(b=a[e],"marked"==e){if(c.name()!=b&&c.label()!=
-b&&(!c.value||c.value!=b))return!1}else if(b=c.withValueForKey(b,e),k(b))return!1;return!0}function v(a,c){if(c(a))return a;var b,e;if(k(a))return null;b=a.elements();for(var d=0,f=b.length;d<f;d+=1)if(e=b[d],v(e,c))return e;return null}function w(a){h.delay(a);return h}var g={},h=UIATarget.localTarget();h.setTimeout(0);l.prototype=error();l.prototype.toString=function(){var a="UIAutomationError[reason="+this.reason;0<this.a.length&&(a+=", details="+this.a);return a+"]"};g.sleep=w;g.query=function(a,
-c){if(!c)return g.query(a,s());c instanceof UIAElement&&(c=[c]);var b=c,e=null,d=null,f=[],p,h,k,l;p=0;for(k=a.length;p<k;p+=1){e=a[p];h=0;for(l=b.length;h<l;h+=1)d=b[h],"string"===typeof e?"*"===e||"view"==e||"UIAElement"===e?q(f,t(d,[d])):q(f,u(e,d)):x(e,d)&&f.push(d);b=f;f=[]}return b};g.keyboard_visible=function(){return!k(n())};g.keyboard_enter_text=function(a,c){if(!g.keyboard_visible())throw new l("Keyboard not visible");c=c||{};if(c.unsafe)return n().typeString(a),!0;var b=v(r(),function(a){return 1==
-a.hasKeyboardFocus()});if(k(b))return n().typeString(a),!0;var e=c.initial_text||"",d=new Date,f=c.timeout||60,h=n();do try{return h.typeString(a),!0}catch(m){UIALogger.logMessage("keyboard_enter_text failed: "+m),UIALogger.logMessage("keyboard_enter_text retrying with restore to: "+e),b.setValue(e)}while(!(new Date-d>=1E3*f));throw new l("Unable to enter text","text: "+a+" failed after retrying for "+f);};g.deactivate=function(a){h.deactivateAppForDuration(a)};g.tap_offset=function(a,c,b){b=b||{};
-return b.unsafe?function(){return c.apply(this,arguments)}:function(){var e=new Date,d=b.timeout||60,f=b.frequency||.1;do try{return c.apply(this,arguments)}catch(g){UIALogger.logMessage(a+"Error: "+g+". Arguments: "+arguments[0]+", "+arguments[1]),w(f)}while(!(new Date-e>=1E3*d));throw new l(a,"Arguments: "+arguments[0]+", "+arguments[1]);}}("tap_offset failed",function(a,c){h.tapWithOptions(a,c||{})},{timeout:60,frequency:.5});this.target=h;this.uia=g;g.app=m;g.window=r;g.windows=s;g.keyboard=n;
-g.alert=function(){return m().alert()}})();