run_loop 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2231305525deb7ff8eef39cab42f66a592e0618d
-  data.tar.gz: e02a550f4dfd50652a406e75ec7f8b5075393c7b
+  metadata.gz: 0a05a75fc51c334a7120e7d0930c4cb673302138
+  data.tar.gz: 17cd820907c0d174cc81ad7ff02f9a3b172198d9
 SHA512:
-  metadata.gz: f2e693f21f81754350213e4e331d5c400639d59ce135b1c63419f1e6cc585bbdf1af916b09f49ae83bee725b5b6b62ff911a9bfc26541d1ebffc23eb0e1598f4
-  data.tar.gz: 11c87e9d511a1e1ece647b493a24c604c0916d50f302166d80dbc126d92aa70b42eb1c7078ae90beaa0e1354c62c8b93d03cf59d08dbb4b8c75e5735bdf49615
+  metadata.gz: 198b2bd5e060074724dca694de25d4121ca42d7fca592118713798dff2374703c087f74c196b48a7d179babccabbc47e6cf6720452e19cbff85571227012cd90
+  data.tar.gz: 87e39e777923cb401a38a165654180ca5d9e5809e86f3fa3f17c591fc16246b4b3c501855f8f444074e625ec6b5beae23a3e9223c8e557442f6ce66d1411f8ed

data/bin/run-loop

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'run_loop/cli/cli'
+require 'run_loop/cli/errors'
+require 'run_loop/environment'
+
+begin
+  RunLoop::CLI::Tool.start
+  exit 0
+rescue RunLoop::CLI::ValidationError, Thor::RequiredArgumentMissingError, Thor::UndefinedCommandError => e
+  puts e.message
+  exit 64
+rescue Thor::Error => e
+  puts e.message
+  if RunLoop::Environment.debug?
+    puts e.backtrace.join("\n") if e.backtrace
+    p e.class
+  end
+  exit 70
+end

data/lib/run_loop.rb

@@ -15,7 +15,8 @@ require 'run_loop/device'
 require 'run_loop/instruments'
 require 'run_loop/lipo'
 require 'run_loop/host_cache'
-require 'run_loop/monkey_patch'
+require 'run_loop/patches/awesome_print'
+require 'run_loop/patches/retriable'
 require 'run_loop/simctl/bridge'
 
 module RunLoop

data/lib/run_loop/cli/cli.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require 'run_loop'
+require 'run_loop/cli/errors'
+require 'run_loop/cli/instruments'
+
+trap 'SIGINT' do
+  puts 'Trapped SIGINT - exiting'
+  exit 10
+end
+
+module RunLoop
+
+  module CLI
+
+    class Tool < Thor
+      include Thor::Actions
+
+      def self.exit_on_failure?
+        true
+      end
+
+      desc 'version', 'Prints version of the run_loop gem'
+      def version
+        puts RunLoop::VERSION
+      end
+
+      desc 'instruments', "Interact with Xcode's command-line instruments"
+      subcommand 'instruments', RunLoop::CLI::Instruments
+
+    end
+  end
+end

data/lib/run_loop/cli/errors.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+module RunLoop
+  module CLI
+    class ValidationError < Thor::InvocationError
+    end
+
+    class NotImplementedError < Thor::InvocationError
+    end
+  end
+end

data/lib/run_loop/cli/instruments.rb

@@ -0,0 +1,150 @@
+require 'thor'
+require 'run_loop'
+require 'run_loop/cli/errors'
+
+module RunLoop
+  module CLI
+    class Instruments < Thor
+
+      attr_accessor :signal
+
+      desc 'instruments quit', 'Send a kill signal to all instruments processes.'
+
+      method_option 'signal',
+                    :desc => 'The kill signal to send.',
+                    :aliases => '-s',
+                    :required => false,
+                    :default => 'TERM',
+                    :type => :string
+
+      method_option 'debug',
+                    :desc => 'Enable debug logging.',
+                    :aliases => '-v',
+                    :required => false,
+                    :default => false,
+                    :type => :boolean
+
+
+      def quit
+        signal = options[:signal]
+        ENV['DEBUG'] = '1' if options[:debug]
+        instruments = RunLoop::Instruments.new
+        instruments.instruments_pids.each do |pid|
+          terminator = RunLoop::ProcessTerminator.new(pid, signal, 'instruments')
+          unless terminator.kill_process
+            terminator = RunLoop::ProcessTerminator.new(pid, 'KILL', 'instruments')
+            terminator.kill_process
+          end
+        end
+      end
+
+
+      desc 'instruments launch [--app | [--ipa | --bundle-id]] [OPTIONS]', 'Launch an app with instruments.'
+
+# This is the description we want, but Thor doesn't handle newlines well(?).
+# long_desc <<EOF
+# # Launch App.app on a simulator.
+# $ be run-loop instruments launch --app /path/to/App.app
+#
+# # Launch App.ipa on a device; bundle id will be extracted.
+# $ be run-loop instruments launch --ipa /path/to/App.ipa
+#
+# # Launch the app with bundle id on a device.
+# $ be run-loop instruments launch --bundle-id com.example.MyApp-cal
+#
+# You can pass arguments to application as a comma separated list.
+# --args -NSShowNonLocalizedStrings,YES,-AppleLanguages,(de)
+# --args -com.apple.CoreData.SQLDebug,3'
+# EOF
+
+      method_option 'device',
+                    :desc => 'The device UDID or simulator identifier.',
+                    :aliases => '-d',
+                    :required => false,
+                    :type => :string
+
+      method_option 'app',
+                    :desc => 'Path to a .app bundle to launch on simulator.',
+                    :aliases => '-a',
+                    :required => false,
+                    :type => :string
+
+      method_option 'bundle-id',
+                    :desc => 'Bundle id of app to launch on device.',
+                    :aliases => '-b',
+                    :required => false,
+                    :type => :string
+
+      method_option 'template',
+                    :desc => 'Path to an automation template.',
+                    :aliases => '-t',
+                    :required => false,
+                    :type => :string
+
+      method_option 'args',
+                    :desc => 'Arguments to pass to the app.',
+                    :required => false,
+                    :type => :string
+
+      method_option 'debug',
+                    :desc => 'Enable debug logging.',
+                    :aliases => '-v',
+                    :required => false,
+                    :default => false,
+                    :type => :boolean
+
+      def launch
+        launch_options = {
+              :args => parse_app_launch_args(options),
+              :udid => detect_device_udid_from_options(options),
+              :bundle_dir_or_bundle_id => detect_bundle_id_or_bundle_path(options)
+        }
+        run_loop = RunLoop.run(launch_options)
+        puts JSON.generate(run_loop)
+      end
+
+      no_commands do
+        def parse_app_launch_args(options)
+          args = options[:args]
+          if args.nil?
+            []
+          else
+            args.split(',')
+          end
+        end
+
+        def detect_bundle_id_or_bundle_path(options)
+          app = options[:app]
+          ipa = options[:ipa]
+          bundle_id = options[:bundle_id]
+
+          if app && ipa
+            raise RunLoop::CLI::ValidationError,
+                  "--app #{app} and --ipa #{ipa} are mutually exclusive arguments.  Pass one or the other, not both."
+          end
+
+          if app && bundle_id
+            raise RunLoop::CLI::ValidationError,
+                  "--app #{app} and --bundle-id #{bundle_id} are mutually exclusive arguments. Pass one or the other, not both."
+          end
+
+          if ipa && bundle_id
+            raise RunLoop::CLI::ValidationError,
+                  "--ipa #{ipa} and --bundle-id #{bundle_id} are mutually exclusive arguments. Pass one or the other, not both."
+          end
+          app || bundle_id
+        end
+
+        def detect_device_udid_from_options(options)
+          device = options[:device]
+          app = options[:app]
+          if app && !device
+            RunLoop::Core.default_simulator
+          else
+            device
+          end
+        end
+      end
+    end
+  end
+end

data/lib/run_loop/core.rb

@@ -177,8 +177,13 @@ module RunLoop
         file.puts code
       end
 
-      # Compute udid and bundle_dir / bundle_id from options and target depending on Xcode version
-      udid, bundle_dir_or_bundle_id = self.udid_and_bundle_for_launcher(device_target, options, sim_control)
+      udid = options[:udid]
+      bundle_dir_or_bundle_id = options[:bundle_dir_or_bundle_id]
+
+      if !(udid && bundle_dir_or_bundle_id)
+        # Compute udid and bundle_dir / bundle_id from options and target depending on Xcode version
+        udid, bundle_dir_or_bundle_id = self.udid_and_bundle_for_launcher(device_target, options, sim_control)
+      end
 
       args = options.fetch(:args, [])
 

data/lib/run_loop/dylib_injector.rb

@@ -79,7 +79,10 @@ module RunLoop
     end
 
     def retriable_inject_dylib(options={})
-      merged_options = RETRIABLE_OPTIONS.merge(options)
+      default_options = {:tries => 3,
+                         :interval => 10,
+                         :timeout => 10}
+      merged_options = default_options.merge(options)
 
       debug_logging = RunLoop::Environment.debug?
 
@@ -89,37 +92,25 @@ module RunLoop
           if elapsed_time && next_interval
             puts "LLDB: attempt #{try} failed in '#{elapsed_time}'; will retry in '#{next_interval}'"
           else
-            puts "LLDB: attempt #{try} failed; will retry in '#{merged_options[:interval]}'"
+            puts "LLDB: attempt #{try} failed; will retry in #{merged_options[:interval]}"
           end
         end
         RunLoop::LLDB.kill_lldb_processes
         RunLoop::ProcessWaiter.new('lldb').wait_for_none
       end
 
-      # For some reason, :timeout does not work here - the lldb process can
-      # hang indefinitely.  Seems to work when
-      Retriable.retriable({:tries => merged_options[:retries],
-                           # Retriable 2.0
-                           :interval => merged_options[:interval],
-                           :base_interval => merged_options[:interval],
-                           :on_retry => on_retry}) do
-        #unless inject_dylib_with_timeout merged_options[:timeout]
+      tries = merged_options[:tries]
+      interval = merged_options[:interval]
+      retry_opts = RunLoop::RetryOpts.tries_and_interval(tries, interval, {:on_retry => on_retry})
+
+      # For some reason, :timeout does not work here;
+      # the lldb process can hang indefinitely.
+      Retriable.retriable(retry_opts) do
         unless inject_dylib_with_timeout merged_options[:timeout]
           raise RuntimeError, "Could not inject dylib"
         end
       end
       true
     end
-
-    private
-
-    RETRIABLE_OPTIONS =
-          {
-                :retries => 3,
-                :timeout => 10,
-                # Retriable 2.0 replaces :interval with :base_interval
-                :interval => 2,
-                :base_interval => 2
-          }
   end
 end

data/lib/run_loop/environment.rb

@@ -39,7 +39,12 @@ module RunLoop
 
     # Returns the value of BUNDLE_ID
     def self.bundle_id
-      ENV['BUNDLE_ID']
+      value = ENV['BUNDLE_ID']
+      if !value || value == ''
+        nil
+      else
+        value
+      end
     end
 
     # Returns to the path to the app bundle (simulator builds).
@@ -48,7 +53,12 @@ module RunLoop
     #
     # Use of APP_BUNDLE_PATH is deprecated and will be removed.
     def self.path_to_app_bundle
-      ENV['APP_BUNDLE_PATH'] || ENV['APP']
+      value = ENV['APP_BUNDLE_PATH'] || ENV['APP']
+      if !value || value == ''
+        nil
+      else
+        value
+      end
     end
 
     # Returns the value of DEVELOPER_DIR
@@ -56,7 +66,12 @@ module RunLoop
     # @note Never call this directly.  Always create an XCTool instance
     #   and allow it to derive the path to the Xcode toolchain.
     def self.developer_dir
-      ENV['DEVELOPER_DIR']
+      value = ENV['DEVELOPER_DIR']
+      if !value || value == ''
+        nil
+      else
+        value
+      end
     end
   end
 end

data/lib/run_loop/host_cache.rb

@@ -24,7 +24,7 @@ module RunLoop
     # @return [String] Expanded path to the default cache directory.
     def self.default_directory
       uid = RunLoop::Environment.uid
-      File.expand_path("/tmp/com.xamarin.calabash.run-loop/host-cache/#{uid}")
+      File.expand_path("/tmp/com.xamarin.calabash.run-loop_host-cache_#{uid}")
     end
 
     # The default cache.

data/lib/run_loop/patches/retriable.rb

@@ -0,0 +1,24 @@
+require 'retriable'
+
+module RunLoop
+  # A class to bridge the gap between retriable 1.x and 2.0.
+  class RetryOpts
+    def self.tries_and_interval(tries, interval, other_retry_options={})
+      retriable_version = RunLoop::Version.new(Retriable::VERSION)
+
+      if other_retry_options[:tries]
+        raise RuntimeError, ':tries is not a valid key for other_retry_options'
+      elsif other_retry_options[:interval]
+        raise RuntimeError, ':interval is not a valid key for other_retry_options'
+      elsif other_retry_options[:intervals]
+        raise RuntimeError, ':intervals is not a valid key for other_retry_options'
+      end
+
+      if retriable_version >= RunLoop::Version.new('2.0.0')
+        other_retry_options.merge({:intervals => Array.new(tries, interval)})
+      else
+        other_retry_options.merge({:tries => tries, :interval => interval})
+      end
+    end
+  end
+end

data/lib/run_loop/version.rb

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

data/lib/run_loop/xctools.rb

@@ -70,7 +70,6 @@ module RunLoop
       @xcode_gte_63 ||= xcode_version >= v63
     end
 
-
     # Are we running Xcode 6.2 or above?
     #
     # @return [Boolean] `true` if the current Xcode version is >= 6.2
@@ -139,7 +138,7 @@ module RunLoop
     # @return [Boolean] True if the Xcode version is beta.
     def xcode_is_beta?
       @xcode_is_beta ||= lambda {
-        (xcode_developer_dir =~ /Xcode-Beta.app/) != nil
+        (xcode_developer_dir =~ /Xcode-[Bb]eta.app/) != nil
       }.call
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: run_loop
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.0
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -33,7 +33,7 @@ dependencies:
         version: 1.3.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 1.3.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: luffa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +228,22 @@ dependencies:
   name: stub_env
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -226,17 +272,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: calabash-cucumber drives tests for native iOS apps. RunLoop provides
-  a number of tools associated with running Calabash tests.
+description: 
 email:
 - karl.krukow@xamarin.com
-executables: []
+executables:
+- run-loop
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- bin/run-loop
 - lib/run_loop.rb
 - lib/run_loop/app.rb
+- lib/run_loop/cli/cli.rb
+- lib/run_loop/cli/errors.rb
+- lib/run_loop/cli/instruments.rb
 - lib/run_loop/core.rb
 - lib/run_loop/device.rb
 - lib/run_loop/dylib_injector.rb
@@ -247,7 +297,8 @@ files:
 - lib/run_loop/lipo.rb
 - lib/run_loop/lldb.rb
 - lib/run_loop/logging.rb
-- lib/run_loop/monkey_patch.rb
+- lib/run_loop/patches/awesome_print.rb
+- lib/run_loop/patches/retriable.rb
 - lib/run_loop/plist_buddy.rb
 - lib/run_loop/process_terminator.rb
 - lib/run_loop/process_waiter.rb
@@ -255,7 +306,6 @@ files:
 - lib/run_loop/simctl/bridge.rb
 - lib/run_loop/version.rb
 - lib/run_loop/xctools.rb
-- scripts/calabash.lldb.erb
 - scripts/calabash_script_uia.js
 - scripts/json2-min.js
 - scripts/json2.js
@@ -290,6 +340,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Tools related to running Calabash iOS tests
+summary: The bridge between Calabash iOS and Xcode command-line tools like instruments
+  and simctl.
 test_files: []
 has_rdoc: 

data/scripts/calabash.lldb.erb

@@ -1,4 +0,0 @@
-process attach -n '<%= cf_bundle_executable %>'
-expr (void*)dlopen("<%= dylib_path_for_target %>", 0x2)
-detach
-exit