calabash-cucumber 0.19.2 → 0.20.0

data/lib/calabash-cucumber/launcher.rb

@@ -39,7 +39,9 @@ module Calabash
     class Launcher
 
       require "calabash-cucumber/device"
-      require "calabash-cucumber/actions/instruments_actions"
+      require "calabash-cucumber/automator/automator"
+      require "calabash-cucumber/automator/instruments"
+      require "calabash-cucumber/automator/device_agent"
       require "calabash-cucumber/usage_tracker"
       require "calabash-cucumber/dylibs"
       require "calabash-cucumber/environment"
@@ -58,10 +60,10 @@ module Calabash
       @@launcher = nil
 
       # @!visibility private
-      attr_accessor :run_loop
+      attr_reader :run_loop
 
       # @!visibility private
-      attr_accessor :actions
+      attr_reader :automator
 
       # @!visibility private
       attr_accessor :launch_args
@@ -76,15 +78,26 @@ module Calabash
 
       # @!visibility private
       def to_s
-        msg = ["#{self.class}"]
-        if self.run_loop
-          msg << "Log file: #{self.run_loop[:log_file]}"
+        class_name = "Launcher"
+
+        if !automator
+          "#<#{class_name}: not attached to an automator>"
         else
-          msg << "Not attached to instruments."
-          msg << "Start your app with `start_test_server_in_background`"
-          msg << "If your app is already running, try `console_attach`"
+          if automator.respond_to?(:name)
+            case automator.name
+              when :instruments
+                log_file =  automator.run_loop[:log_file]
+                "#<#{class_name}: UIAutomation/instruments - #{log_file}>"
+              when :device_agent
+                launcher_name = automator.client.cbx_launcher.name
+                "#<#{class_name}: DeviceAgent/#{launcher_name}>"
+              else
+                "#<#{class_name}: attached to #{automator.name}>"
+            end
+          else
+            "#<#{class_name}: attached to #{automator}>"
+          end
         end
-        msg.join("\n")
       end
 
       # @!visibility private
@@ -138,17 +151,11 @@ module Calabash
         @usage_tracker ||= Calabash::Cucumber::UsageTracker.new
       end
 
-      # @!visibility private
-      def actions
-        attach if @actions.nil?
-        @actions
-      end
-
       # @!visibility private
       # @see Calabash::Cucumber::Core#console_attach
       def self.attach
         l = launcher
-        return l if l && l.active?
+        return l if l && l.attached_to_automator?
         l.attach
       end
 
@@ -163,7 +170,19 @@ module Calabash
                            :http_connection_timeout => 10}
         merged_options = default_options.merge(options)
 
-        self.run_loop = RunLoop::HostCache.default.read
+        @run_loop = RunLoop::HostCache.default.read
+
+        if @run_loop[:automator] == :device_agent
+          # TODO Attach to DeviceAgent - run-loop supports this!
+          # TODO Rewrite UIA methods to raise in the context of UIA
+          raise RuntimeError, %Q[
+
+Cannot attach to DeviceAgent automator.
+
+This behavior is not implemented yet.
+
+]
+        end
 
         begin
           Calabash::Cucumber::HTTP.ensure_connectivity(merged_options)
@@ -188,19 +207,18 @@ Try `start_test_server_in_background`
           return false
         end
 
-        if self.run_loop[:pid]
-          self.actions = Calabash::Cucumber::InstrumentsActions.new
+        if run_loop[:pid]
+          @automator = Calabash::Cucumber::Automator::Instruments.new(run_loop)
         else
           RunLoop.log_warn(
 %Q[
 
 Connected to an app that was not launched by Calabash using instruments.
 
-Queries will work, but gestures will not.
+Queries will work, but gestures and other automator actions will not.
 
 ])
         end
-
         self
       end
 
@@ -208,19 +226,30 @@ Queries will work, but gestures will not.
       #
       # @return {Boolean} true if we're using instruments to launch
       def self.instruments?
-        l = launcher_if_used
-        return false unless l
-        l.instruments?
+        launcher = Launcher::launcher_if_used
+        if !launcher
+          false
+        else
+          launcher.instruments?
+        end
       end
 
       # @!visibility private
       def instruments?
-        !!(active? && run_loop[:pid])
+        attached_to_automator? &&
+          automator.name == :instruments
       end
 
+      # @!visibility private
+      def attached_to_automator?
+        automator != nil
+      end
+
+      # TODO remove in 0.21.0
       # @!visibility private
       def active?
-        not run_loop.nil?
+        RunLoop.deprecated("0.20.0", "replaced with attached_to_automator?")
+        attached_to_automator?
       end
 
       # A reference to the current launcher (instantiates a new one if needed).
@@ -336,10 +365,29 @@ Resetting physical devices is not supported.
         options[:xcode] = xcode || Calabash::Cucumber::Environment.xcode
         options[:inject_dylib] = detect_inject_dylib_option(launch_options)
 
-        self.launch_args = options
+        @launch_args = options
+
+        @run_loop = new_run_loop(options)
+        if @run_loop.is_a?(Hash)
+          @automator = Calabash::Cucumber::Automator::Instruments.new(@run_loop)
+        elsif @run_loop.is_a?(RunLoop::DeviceAgent::Client)
+          @automator = Calabash::Cucumber::Automator::DeviceAgent.new(@run_loop)
+        else
+          raise ArgumentError, %Q[
+
+Could not determine which automator to use based on the launch arguments:
+
+#{@launch_args.join("$-0")}
+
+RunLoop.run returned:
 
-        self.run_loop = new_run_loop(options)
-        self.actions= Calabash::Cucumber::InstrumentsActions.new
+#{@run_loop}
+
+]
+        end
+
+        Calabash::Cucumber::UIA.redefine_instance_methods_if_necessary(options[:xcode],
+                                                                       automator)
 
         if !options[:calabash_lite]
           Calabash::Cucumber::HTTP.ensure_connectivity
@@ -374,7 +422,23 @@ Resetting physical devices is not supported.
       # @!visibility private
       # TODO Should call calabash exit route to shutdown the server.
       def stop
-        RunLoop.stop(run_loop) if run_loop && run_loop[:pid]
+        return :no_automator if !automator
+
+        if !automator.respond_to?(:name)
+          RunLoop.log_warn("Unknown automator: #{automator}")
+          RunLoop.log_warn("Calabash does not know how to stop this automator")
+          return :unknown_automator
+        end
+
+        case automator.name
+          when :instruments, :device_agent
+            automator.stop
+            :stopped
+          else
+            RunLoop.log_warn("Unknown automator: #{automator}")
+            RunLoop.log_warn("Calabash does not know how to stop this automator")
+            :unknown_automator
+        end
       end
 
       # Should Calabash quit the app under test after a Scenario?
@@ -418,6 +482,7 @@ Resetting physical devices is not supported.
       end
 
       # @deprecated 0.19.0 - replaced with #quit_app_after_scenario?
+      # TODO remove in 0.20.0
       # @!visibility private
       def calabash_no_stop?
         # Not yet.  Save for 0.20.0.
@@ -427,6 +492,7 @@ Resetting physical devices is not supported.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def calabash_no_launch?
         RunLoop.log_warn(%Q[
 Calabash::Cucumber::Launcher #calabash_no_launch? and support for the NO_LAUNCH
@@ -438,6 +504,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement.
+      # TODO remove in 0.20.0
       def default_uia_strategy(launch_args, sim_control, instruments)
         RunLoop::deprecated("0.19.0", "This method has been removed.")
         :host
@@ -445,6 +512,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def detect_connected_device?
         RunLoop.deprecated("0.19.0", "No replacement")
         false
@@ -452,6 +520,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def default_launch_args
         RunLoop.deprecated("0.19.0", "No replacement")
         {}
@@ -459,6 +528,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def discover_device_target(launch_args)
         RunLoop.deprecated("0.19.0", "No replacement")
         nil
@@ -466,6 +536,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def app_path
         RunLoop.deprecated("0.19.0", "No replacement")
         nil
@@ -473,6 +544,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def xcode
         RunLoop.deprecated("0.19.0", "Use Calabash::Cucumber::Environment.xcode")
         Calabash::Cucumber::Environment.xcode
@@ -480,6 +552,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def ensure_connectivity
         RunLoop.deprecated("0.19.0", "No replacement")
         Calabash::Cucumber::HTTP.ensure_connectivity
@@ -491,12 +564,14 @@ true.  Please remove this method call from your hooks.
       # #relaunch will now send ":on_launch" to the Cucumber World if:
       # * the Launcher is part of the World (it is not by default).
       # * Cucumber responds to :on_launch.
+      # TODO remove in 0.20.0
       def calabash_notify(_)
         false
       end
 
       # @!visibility private
       # @deprecated 0.19.0  - no replacement.
+      # TODO remove in 0.20.0
       def server_version_from_server
         RunLoop.deprecated("0.19.0", "No replacement")
         server_version
@@ -504,6 +579,7 @@ true.  Please remove this method call from your hooks.
 
       # @!visibility private
       # @deprecated 0.19.0 - no replacement
+      # TODO remove in 0.20.0
       def server_version_from_bundle(app_bundle_path)
         RunLoop.deprecated("0.19.0", "No replacement")
         options = {:app => app_bundle_path }

data/lib/calabash-cucumber/log_tailer.rb

@@ -0,0 +1,46 @@
+
+module Calabash
+  module Cucumber
+    # @!visibility private
+    class LogTailer
+
+      # @!visibility private
+      def self.tail_in_terminal(path)
+        if !File.exist?(path)
+          raise RuntimeError, %Q[
+Cannot tail a file that does not exist:
+
+#{path}
+
+]
+        end
+
+        term_part = %Q[xcrun osascript -e 'tell application "Terminal" to do script]
+        tail_part = %Q["tail -n 10000 -F #{path} | grep -v \\"Default: \\\\*\\""']
+        cmd = "#{term_part} #{tail_part}"
+
+        if !LogTailer.run_command(cmd)
+          raise RuntimeError, %Q[
+Could not tail file:
+
+#{path}
+
+with command:
+
+#{cmd}
+
+]
+        end
+
+        true
+      end
+
+      private
+
+      # @!visibility private
+      def self.run_command(cmd)
+        system(cmd)
+      end
+    end
+  end
+end

data/lib/calabash-cucumber/map.rb

@@ -27,7 +27,7 @@ module Calabash
       # If `method_name` maps to no LPOperation, then it is treated a selector
       # and is performed on any view that matches `query`.
       #
-      # @examples
+      # @example
       #
       #   # Calls 'text' on any visible UITextField, because :text is not a defined operation.
       #   > map("textField", :text)
@@ -55,6 +55,12 @@ module Calabash
       #
       # @todo Calabash LPOperations should return 'views touched' in JSON format
       def self.map(query, method_name, *method_args)
+        require "calabash-cucumber/launcher"
+        launcher = Calabash::Cucumber::Launcher.launcher_if_used
+        if launcher && launcher.automator && launcher.automator.name == :device_agent
+          launcher.automator.client.send(:_dismiss_springboard_alerts)
+        end
+
         self.raw_map(query, method_name, *method_args)['results']
       end
 

data/lib/calabash-cucumber/rotation_helpers.rb

@@ -1,108 +1,11 @@
 module Calabash
   module Cucumber
 
-    # Provides methods for rotating a device in a direction or to a particular
-    # orientation.
+    # @!visibility private
     module RotationHelpers
 
-      require "run_loop"
-
-      # Rotates the home button to a position relative to the status bar.
-      #
-      # @example portrait
-      #  rotate_home_button_to :down
-      #
-      # @example upside down
-      #  rotate_home_button_to :up
-      #
-      # @example landscape with left home button AKA: _right_ landscape
-      #  rotate_home_button_to :left
-      #
-      # @example landscape with right home button AKA: _left_ landscape
-      #  rotate_home_button_to :right
-      #
-      # @note Refer to Apple's documentation for clarification about left vs.
-      #  right landscape orientations.
-      #
-      # @note For legacy support the `dir` argument can be a String or Symbol.
-      #  Please update your code to pass a Symbol.
-      #
-      # @note For legacy support `:top` and `top` are synonyms for `:up`.
-      #  Please update your code to pass `:up`.
-      #
-      # @note For legacy support `:bottom` and `bottom` are synonyms for `:down`.
-      #  Please update your code to pass `:down`.
-      #
-      # @note This method generates verbose messages when full console logging
-      #  is enabled.  See {Calabash::Cucumber::Logging#full_console_logging?}.
-      #
-      # @param [Symbol] direction The position of the home button after the rotation.
-      #  Can be one of `{:down | :left | :right | :up }`.
-      #
-      # @note A rotation will only occur if your view controller and application
-      #  support the target orientation.
-      #
-      # @return [Symbol] The position of the home button relative to the status
-      #  bar when all rotations have been completed.
-      def rotate_home_button_to(direction)
-
-        begin
-          as_symbol = ensure_valid_rotate_home_to_arg(direction)
-        rescue ArgumentError => e
-          raise ArgumentError, e.message
-        end
-
-        current_orientation = status_bar_orientation.to_sym
-
-        return current_orientation if current_orientation == as_symbol
-
-        rotate_to_uia_orientation(as_symbol)
-        recalibrate_after_rotation
-        status_bar_orientation.to_sym
-      end
-
-      # Rotates the device in the direction indicated by `direction`.
-      #
-      # @example rotate left
-      #  rotate :left
-      #
-      # @example rotate right
-      #  rotate :right
-      #
-      # @param [Symbol] direction The direction to rotate. Can be :left or :right.
-      #
-      # @return [Symbol] The position of the home button relative to the status
-      #   bar after the rotation.  Will be one of `{:down | :left | :right | :up }`.
-      # @raise [ArgumentError] If direction is not :left or :right.
-      def rotate(direction)
-
-        as_symbol = direction.to_sym
-
-        if as_symbol != :left && as_symbol != :right
-          raise ArgumentError,
-                "Expected '#{direction}' to be :left or :right"
-        end
-
-        current_orientation = status_bar_orientation.to_sym
-
-        result = rotate_with_uia(as_symbol, current_orientation)
-
-        recalibrate_after_rotation
-
-        ap result if RunLoop::Environment.debug?
-
-        status_bar_orientation
-      end
-
-      private
-
-      # @! visibility private
-      def recalibrate_after_rotation
-        uia_query :window
-      end
-
       # @! visibility private
-      def ensure_valid_rotate_home_to_arg(arg)
+      def expect_valid_rotate_home_to_arg(arg)
         coerced = arg.to_sym
 
         if coerced == :top
@@ -119,62 +22,44 @@ module Calabash
         coerced
       end
 
-      # @! visibility private
-      UIA_DEVICE_ORIENTATION = {
-            :portrait => 1,
-            :upside_down => 2,
-            :landscape_left => 3,
-            :landscape_right => 4
-      }.freeze
-
-      # @! visibility private
-      def rotate_to_uia_orientation(orientation)
-        case orientation
-          when :down then key = :portrait
-          when :up then key = :upside_down
-          when :left then key = :landscape_right
-          when :right then key = :landscape_left
-          else
-            raise ArgumentError,
-                  "Expected '#{orientation}' to be :left, :right, :up, or :down"
-        end
-        value = UIA_DEVICE_ORIENTATION[key]
-        cmd = "UIATarget.localTarget().setDeviceOrientation(#{value})"
-        uia(cmd)
-      end
-
-      # @! visibility private
-      def rotate_with_uia(direction, current_orientation)
-        key = uia_orientation_key(direction, current_orientation)
-        value = UIA_DEVICE_ORIENTATION[key]
-        cmd = "UIATarget.localTarget().setDeviceOrientation(#{value})"
-        uia(cmd)
+      # @!visibility private
+      def orientation_for_key(key)
+        DEVICE_ORIENTATION[key]
       end
 
       # @! visibility private
-      def uia_orientation_key(direction, current_orientation)
-
+      #
+      # It is important to remember that the current orientation is the
+      # position of the home button:
+      #
+      # :up => home button on the top => upside_down
+      # :bottom => home button on the bottom => portrait
+      # :left => home button on the left => landscape_right
+      # :right => home button on the right => landscape_left
+      #
+      # Notice how :left and :right are mapped.
+      def orientation_key(direction, current_orientation)
         key = nil
         case direction
           when :left then
             if current_orientation == :down
-              key = :landscape_right
+              key = :landscape_left
             elsif current_orientation == :right
-              key = :portrait
-            elsif current_orientation == :left
               key = :upside_down
+            elsif current_orientation == :left
+              key = :portrait
             elsif current_orientation == :up
-              key = :landscape_left
+              key = :landscape_right
             end
           when :right then
             if current_orientation == :down
-              key = :landscape_left
+              key = :landscape_right
             elsif current_orientation == :right
-              key = :upside_down
-            elsif current_orientation == :left
               key = :portrait
+            elsif current_orientation == :left
+              key = :upside_down
             elsif current_orientation == :up
-              key = :landscape_right
+              key = :landscape_left
             end
           else
             raise ArgumentError,
@@ -182,6 +67,29 @@ module Calabash
         end
         key
       end
+
+      private
+
+      # @! visibility private
+      #
+      # It is important to remember that the current orientation is the
+      # position of the home button:
+      #
+      # :up => home button on the top => upside_down
+      # :bottom => home button on the bottom => portrait
+      # :left => home button on the left => landscape_right
+      # :right => home button on the right => landscape_left
+      #
+      # Notice how :left and :right are mapped to their logical opposite.
+      # @!visibility private
+      # @! visibility private
+      DEVICE_ORIENTATION = {
+        :portrait => 1,
+        :upside_down => 2,
+        :landscape_left => 3, # Home button on the right
+        :landscape_right => 4 # Home button on the left
+      }.freeze
+
     end
   end
 end