calabash-cucumber 0.9.169.pre2 → 0.9.169.pre5

data/lib/calabash-cucumber/rotation_helpers.rb

@@ -1,7 +1,11 @@
+require 'calabash-cucumber/utils/logging'
+
 module Calabash
   module Cucumber
     module RotationHelpers  #=> Connection, StatusBarHelpers
 
+      include Calabash::Cucumber::Logging
+
       def rotation_candidates
         %w(rotate_left_home_down rotate_left_home_left rotate_left_home_right rotate_left_home_up
            rotate_right_home_down rotate_right_home_left rotate_right_home_right rotate_right_home_up)
@@ -18,15 +22,15 @@ module Calabash
       def rotate_home_button_to(dir)
         dir_sym = dir.to_sym
         if dir_sym.eql?(:top)
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-            warn "converting '#{dir}' to ':up' - please adjust your code"
+          if full_console_logging?
+            calabash_warn "converting '#{dir}' to ':up' - please adjust your code"
           end
           dir_sym = :up
         end
 
         if dir_sym.eql?(:bottom)
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-            warn "converting '#{dir}' to ':down' - please adjust your code"
+          if full_console_logging?
+            calabash_warn "converting '#{dir}' to ':down' - please adjust your code"
           end
           dir_sym = :down
         end
@@ -46,7 +50,7 @@ module Calabash
         return res if res.eql? dir_sym
 
         rotation_candidates.each { |candidate|
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+          if full_console_logging?
             puts "try to rotate to '#{dir_sym}' using '#{candidate}'"
           end
           playback(candidate)
@@ -63,10 +67,10 @@ module Calabash
           return if res.eql? dir_sym
         }
 
-        if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-          warn "Could not rotate home button to '#{dir}'."
-          warn 'Is rotation enabled for this controller?'
-          warn "Will return 'down'"
+        if full_console_logging?
+          calabash_warn "Could not rotate home button to '#{dir}'."
+          calabash_warn 'Is rotation enabled for this controller?'
+          calabash_warn "Will return 'down'"
         end
         :down
       end
@@ -99,7 +103,7 @@ module Calabash
         end
 
         if rotate_cmd.nil?
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+          if full_console_logging?
             puts "Could not rotate device in direction '#{dir}' with orientation '#{current_orientation} - will do nothing"
           end
         else

data/lib/calabash-cucumber/status_bar_helpers.rb

@@ -1,12 +1,16 @@
+require 'calabash-cucumber/utils/logging'
+
 module Calabash
   module Cucumber
     module StatusBarHelpers #=> Map
 
+      include Calabash::Cucumber::Logging
+
       def device_orientation(force_down=false)
         res = map(nil, :orientation, :device).first
 
         if ['face up', 'face down'].include?(res)
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+          if full_console_logging?
             if force_down
               puts "WARN  found orientation '#{res}' - will rotate to force orientation to 'down'"
             end

data/lib/calabash-cucumber/uia.rb

@@ -2,11 +2,14 @@ require 'edn'
 require 'json'
 # required for ruby 1.8
 require 'enumerator'
+require 'calabash-cucumber/utils/logging'
 
 module Calabash
   module Cucumber
     module UIA
 
+      include Calabash::Cucumber::Logging
+
       def uia(command,options={})
         res = http({:method => :post, :path => 'uia'}, {:command => command}.merge(options))
         res = JSON.parse(res)
@@ -16,15 +19,6 @@ module Calabash
         res['results'].first
       end
 
-      def uia_tap_server(query, options={})
-        res = http({:method => :post, :path => 'uia-tap'}, {:query => query}.merge(options))
-        res = JSON.parse(res)
-        if res['outcome'] != 'SUCCESS'
-          raise "uia-tap action failed because: #{res['reason']}\n#{res['details']}"
-        end
-        res['results'].first
-      end
-
       def uia_query(*queryparts)
         #TODO escape '\n etc in query
         uia_handle_command(:query, queryparts)
@@ -201,7 +195,7 @@ module Calabash
           end
         end
         command = "#{js_cmd}.#{js_args.join('.')}"
-        if ENV['DEBUG'] == '1'
+        if debug_logging?
           puts 'Sending UIA command'
           puts command
         end
@@ -212,7 +206,7 @@ module Calabash
 
       def uia_handle_command(cmd, *query_args)
         command = uia_serialize_command(cmd, *query_args)
-        if ENV['DEBUG'] == '1'
+        if debug_logging?
           puts 'Sending UIA command'
           puts command
         end
@@ -270,7 +264,7 @@ module Calabash
       end
 
       def uia_result(s)
-        if ENV['DEBUG'] == '1'
+        if debug_logging?
           puts 'Result'
           p s
         end

data/lib/calabash-cucumber/utils/logging.rb

@@ -0,0 +1,97 @@
+
+module Calabash
+  module Cucumber
+
+    # internal logging methods for calabash-ios gem
+    module Logging
+
+      # controls the the kind of information calabash logs
+      #
+      # this is considered one level above debug logging - maybe we should call
+      # the info log level.
+      #
+      # @return [Boolean] +true+ if the <tt>CALABASH_FULL_CONSOLE_OUTPUT</tt> is set to
+      #   '1'
+      def full_console_logging?
+        ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+      end
+
+      # controls whether or not calabash logs debug information
+      #
+      # @return [Boolean] +true+ if the <tt>DEBUG</tt> is set to '1'
+      def debug_logging?
+        ENV['DEBUG'] == '1'
+      end
+
+      # prints a blue/cyan warning message
+      # @param [String] msg the message to print
+      def calabash_warn(msg)
+        begin
+          warn "\033[34m\nWARN: #{msg}\033[0m"
+        rescue
+          warn "\nWARN: #{msg}"
+        end
+      end
+
+      # prints a green info message
+      # @param [String] msg the message to print
+      def calabash_info(msg)
+        begin
+          puts "\033[32m\nINFO: #{msg}\033[0m"
+        rescue
+          puts "\nINFO: #{msg}"
+        end
+      end
+
+      # controls printing of deprecation warnings
+      #
+      # to inhibit deprecation message set this to '1'
+      #
+      # inhibiting deprecation messages is not recommend
+      CALABASH_NO_DEPRECATION = ENV['CALABASH_NO_DEPRECATION'] || '0'
+
+      # returns +true+ if the <tt>CALABASH_NO_DEPRECATION</tt> variable is set
+      # to +1+
+      def no_deprecation_warnings?
+        ENV['CALABASH_NO_DEPRECATION'] == '1'
+      end
+
+      # prints a deprecated message that includes the line number
+      #
+      # if ENV['CALABASH_NO_DEPRECATION'] == '1' then this method is a nop
+      #
+      # @param [String] version indicates when the feature was deprecated
+      # @param [String] msg deprecation message (possibly suggesting alternatives)
+      # @param [Symbol] type { :warn | :pending } - :pending will raise a
+      #   cucumber pending exception
+      def _deprecated(version, msg, type)
+        allowed = [:pending, :warn]
+        unless allowed.include?(type)
+          raise "type '#{type}' must be on of '#{allowed}'"
+        end
+
+        unless no_deprecation_warnings?
+
+          if RUBY_VERSION < '2.0'
+            stack = Kernel.caller()[1..6].join("\n")
+          else
+            stack = Kernel.caller(0, 6)[1..-1].join("\n")
+          end
+
+          msg = "deprecated '#{version}' - '#{msg}'\n#{stack}"
+
+          if type.eql?(:pending)
+            pending(msg)
+          else
+            begin
+              warn "\033[34m\nWARN: #{msg}\033[0m"
+            rescue
+              warn "\nWARN: #{msg}"
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/calabash-cucumber/utils/plist_buddy.rb

@@ -0,0 +1,178 @@
+require 'calabash-cucumber/utils/logging'
+
+module Calabash
+  module Cucumber
+
+    include Calabash::Cucumber::Logging
+
+    # module for reading and writing property list values
+    module PlistBuddy
+
+      # 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
+      # @param [Hash] opts options for controlling execution
+      # @option opts [Boolean] :verbose (false) controls log level
+      # @return [nil] if +key+ does not exist
+      # @return [String] if the +key+ exists then the value of +key+ (error)
+      # @raise [ArgumentError] if nil or empty +key+
+      def plist_read(key, file, opts={})
+        if key.nil? or key.length == 0
+          raise(ArgumentError, "key '#{key}' must not be nil or empty")
+        end
+        cmd = build_plist_cmd(:print, {:key => key}, file)
+        res = execute_plist_cmd(cmd, opts)
+        if res == "Print: Entry, \":#{key}\", Does Not Exist"
+          nil
+        else
+          res
+        end
+      end
+
+      # checks if the key exists in plist
+      # @param [String] key the key to inspect (may not be nil or empty)
+      # @param [String] file the plist to read
+      # @param [Hash] opts options for controlling execution
+      # @option opts [Boolean] :verbose (false) controls log level
+      # @return [Boolean] true iff the +key+ exists in plist +file+
+      def plist_key_exists?(key, file, opts={})
+        plist_read(key, file, opts) != nil
+
+      end
+
+      # replaces or creates the +value+ of +key+ in the +file+
+      #
+      # @param [String] key the key to set (may not be nil or empty)
+      # @param [String] type the plist type (used only when adding a value)
+      # @param [String] value the new value
+      # @param [String] file the plist to read
+      # @param [Hash] opts options for controlling execution
+      # @option opts [Boolean] :verbose (false) controls log level
+      # @return [Boolean] true iff the operation was successful
+      # @raise [ArgumentError] if nil or empty +key+
+      def plist_set(key, type, value, file, opts={})
+        default_opts = {:verbose => false}
+        merged = default_opts.merge(opts)
+
+        if key.nil? or key.length == 0
+          raise(ArgumentError, "key '#{key}' must not be nil or empty")
+        end
+
+        cmd_args = {:key => key,
+                    :type => type,
+                    :value => value}
+
+        if plist_key_exists?(key, file, merged)
+          cmd = build_plist_cmd(:set, cmd_args, file)
+        else
+          cmd = build_plist_cmd(:add, cmd_args, file)
+        end
+
+        res = execute_plist_cmd(cmd, merged)
+        res == ''
+      end
+
+      @private
+
+      # returns the path to the PlistBuddy executable
+      # @return [String] path to PlistBuddy
+      def plist_buddy
+        '/usr/libexec/PlistBuddy'
+      end
+
+      # executes +cmd+ as a shell command and returns the result
+      #
+      # @param [String] cmd shell command to execute
+      # @param [Hash] opts options for controlling execution
+      # @option opts [Boolean] :verbose (false) controls log level
+      # @return [Boolean] if command was successful
+      # @return [String] if :print'ing result, the value of the key
+      # @return [String] if there is an error, the output from stderr
+      def execute_plist_cmd(cmd, opts={})
+        default_opts = {:verbose => false}
+        merged = default_opts.merge(opts)
+
+        calabash_info(cmd) if merged[:verbose]
+
+        res = nil
+        # noinspection RubyUnusedLocalVariable
+        Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+          err = stderr.read
+          std = stdout.read
+          if not err.nil? and err != ''
+            res = err.chomp
+          else
+            res = std.chomp
+          end
+        end
+        res
+      end
+
+      # composes a PlistBuddy command that can be executed as a shell command
+      #
+      # @param [Symbol] type should be one of [:print, :set, :add]
+      #
+      # @param [Hash] args_hash arguments used to construct plist command
+      # @option args_hash [String] :key (required) the plist key
+      # @option args_hash [String] :value (required for :set and :add) the new value
+      # @option args_hash [String] :type (required for :add) the new type of the value
+      #
+      # @param [String] file the plist file to interact with (must exist)
+      #
+      # @raise [RuntimeError] if +file+ does not exist
+      # @raise [ArgumentError] when invalid +type+ is passed
+      # @raise [ArgumentError] when +args_hash+ does not include required key/value pairs
+      #
+      # @return [String] a shell-ready PlistBuddy command
+      def build_plist_cmd(type, args_hash, file)
+
+        unless File.exist?(File.expand_path(file))
+          raise(RuntimeError, "plist '#{file}' does not exist - could not read")
+        end
+
+        case type
+          when :add
+            value_type = args_hash[:type]
+            unless value_type
+              raise(ArgumentError, ':value_type is a required key for :add command')
+            end
+            allowed_value_types = ['string', 'bool', 'real', 'integer']
+            unless allowed_value_types.include?(value_type)
+              raise(ArgumentError, "expected '#{value_type}' to be one of '#{allowed_value_types}'")
+            end
+            value = args_hash[:value]
+            unless value
+              raise(ArgumentError, ':value is a required key for :add command')
+            end
+            key = args_hash[:key]
+            unless key
+              raise(ArgumentError, ':key is a required key for :add command')
+            end
+            cmd_part = "\"Add :#{key} #{value_type} #{value}\""
+          when :print
+            key = args_hash[:key]
+            unless key
+              raise(ArgumentError, ':key is a required key for :print command')
+            end
+            cmd_part = "\"Print :#{key}\""
+          when :set
+            value = args_hash[:value]
+            unless value
+              raise(ArgumentError, ':value is a required key for :set command')
+            end
+            key = args_hash[:key]
+            unless key
+              raise(ArgumentError, ':key is a required key for :set command')
+            end
+            cmd_part = "\"Set :#{key} #{value}\""
+          else
+            cmds = [:add, :print, :set]
+            raise(ArgumentError, "expected '#{type}' to be one of '#{cmds}'")
+        end
+
+        "#{plist_buddy} -c #{cmd_part} \"#{file}\""
+      end
+
+    end
+  end
+end

data/lib/calabash-cucumber/utils/simulator_accessibility.rb

@@ -0,0 +1,250 @@
+require 'calabash-cucumber/utils/xctools'
+require 'calabash-cucumber/utils/plist_buddy'
+require 'sim_launcher'
+
+module Calabash
+  module Cucumber
+
+    # methods for checking and setting simulator accessibility
+    module SimulatorAccessibility
+
+      include Calabash::Cucumber::XcodeTools
+      include Calabash::Cucumber::PlistBuddy
+
+      # quits the iOS Simulator
+      #
+      # ATM there can only be only simulator open at a time, so simply doing
+      # what the sim_launcher gem does:
+      #
+      #    def quit_simulator
+      #      `echo 'application "iPhone Simulator" quit' | osascript`
+      #    end
+      #
+      # works.  I am not sure if we will ever be able to launch more than one
+      # simulator, but in case we can, this method will quit the simulator
+      # that is indicated by +xcode-select+ or +DEVELOPER_DIR+.
+      def quit_simulator
+        dev_dir = xcode_developer_dir
+        system "/usr/bin/osascript -e 'tell application \"#{dev_dir}/Platforms/iPhoneSimulator.platform/Developer/Applications/iPhone Simulator.app\" to quit'"
+      end
+
+      # launches the iOS Simulator indicated by +xcode-select+ or +DEVELOPER_DIR+
+      def launch_simulator
+        dev_dir = xcode_developer_dir
+        system "open -a \"#{dev_dir}/Platforms/iPhoneSimulator.platform/Developer/Applications/iPhone Simulator.app\""
+      end
+
+      # resets the simulator content and settings.  it is analogous to touching
+      # the menu item.
+      #
+      # it works by deleting the following directories:
+      #
+      # * ~/Library/Application Support/iPhone Simulator/Library
+      # * ~/Library/Application Support/iPhone Simulator/Library/<sdk>[-64]
+      #
+      # and relaunching the iOS Simulator which will recreate the Library
+      # directory and the latest SDK directory.
+      def reset_simulator_content_and_settings
+        quit_simulator
+        sim_lib_path = File.join(simulator_app_support_dir(), 'Library')
+        FileUtils.rm_rf(sim_lib_path)
+        simulator_support_sdk_dirs.each do |dir|
+          FileUtils.rm_rf(dir)
+        end
+
+        launch_simulator
+
+        # this is tricky because we need to wait for the simulator to recreate
+        # the directories.  specifically, we need the Accessibility plist to be
+        # exist so subsequent calabash launches will be able to enable
+        # accessibility.
+        #
+        # the directories take ~3.0 - ~5.0 to create.
+        counter = 0
+        loop do
+          break if counter == 80
+          dirs = simulator_support_sdk_dirs
+          if dirs.count == 0
+            sleep(0.2)
+          else
+            break if dirs.all? { |dir|
+              plist = File.expand_path("#{dir}/Library/Preferences/com.apple.Accessibility.plist")
+              File.exists?(plist)
+            }
+            sleep(0.2)
+          end
+          counter = counter + 1
+        end
+      end
+
+      # enables accessibility on any existing iOS Simulator by adjusting the
+      # simulator's Library/Preferences/com.apple.Accessibility.plist contents.
+      #
+      # a simulator 'exists' if has an Application Support directory. for
+      # example, the 6.1, 7.0.3-64, and 7.1 simulators exist if the following
+      # directories are present:
+      #
+      #     ~/Library/Application Support/iPhone Simulator/Library/6.1
+      #     ~/Library/Application Support/iPhone Simulator/Library/7.0.3-64
+      #     ~/Library/Application Support/iPhone Simulator/Library/7.1
+      #
+      # this method also hides the AXInspector.
+      # @param [Hash] opts controls the behavior of the method
+      # @option opts [Boolean] :verbose controls logging output
+      # @return [Boolean] true iff enabling accessibility worked on all sdk
+      #  directories
+      def enable_accessibility_on_simulators(opts={})
+        results =  simulator_support_sdk_dirs.map do |dir|
+          enable_accessibility_in_sdk_dir(dir, opts)
+        end
+        results.all? { |elm| elm }
+      end
+
+      @private
+
+      # enables accessibility on the simulator indicated by
+      # +sim_app_support_sdk_dir+.
+      #
+      # WARNING:  this will quit the simulator
+      #
+      #   path = '~/Library/Application Support/iPhone Simulator/Library/6.1'
+      #   enable_accessibility_in_sdk_dir(path)
+      #
+      # this method also hides the AXInspector.
+      #
+      # if the Library/Preferences/com.apple.Accessibility.plist does not exist,
+      # this method returns false.
+      #
+      # @see enable_accessibility_on_simulators for the public API.
+      #
+      # @param [String] sim_app_support_sdk_dir the directory where the
+      #   Library/Preferences/com.apple.Accessibility.plist can be found.
+      #
+      # @param [Hash] opts controls the behavior of the method
+      # @option opts [Boolean] :verbose controls logging output
+      # @return [Boolean] iff the plist exists and the plist was successfully
+      #   updated.
+      def enable_accessibility_in_sdk_dir(sim_app_support_sdk_dir, opts={})
+        default_opts = {:verbose => false}
+        merged = default_opts.merge(opts)
+
+        plist_path = File.expand_path("#{sim_app_support_sdk_dir}/Library/Preferences/com.apple.Accessibility.plist")
+
+        verbose = merged[:verbose]
+
+        sdk = File.basename(sim_app_support_sdk_dir)
+        msgs = ["cannot enable accessibility for #{sdk} SDK"]
+        unless File.exists?(plist_path)
+          if verbose
+            msgs << "expected plist to exist at #{plist_path}"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        quit_simulator
+
+        hash = accessibility_properties_hash()
+
+        unless plist_set(hash[:access_enabled], 'bool', 'true', plist_path)
+          if verbose
+            msgs << "could not set '#{hash[:access_enabled]}' to YES"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        unless plist_set(hash[:app_access_enabled], 'bool', 'true', plist_path)
+          if verbose
+            msgs << "could not set '#{hash[:app_access_enabled]}' to YES"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        unless plist_set(hash[:automation_enabled], 'bool', 'true', plist_path)
+          if verbose
+            msgs << "could not set '#{hash[:automation_enabled]}' to YES"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        unless plist_set(hash[:inspector_showing], 'bool', 'false', plist_path)
+          if verbose
+            msgs << "could not set '#{hash[:inspector_showing]}' to NO"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        unless plist_set(hash[:inspector_full_size], 'bool', 'false', plist_path)
+          if verbose
+            msgs << "could not set '#{hash[:inspector_full_size]}' to NO"
+            calabash_warn(msgs.join("\n"))
+          end
+          return false
+        end
+
+        res = plist_set(hash[:inspector_frame], 'string', '{{270, -13}, {276, 166}}', plist_path)
+        unless res
+          if verbose
+            msgs << "could not set '#{hash[:inspector_frame]}'"
+            calabash_warn(msgs.join("\n"))
+          end
+        end
+        res
+      end
+
+
+      # a hash table of the accessibility properties that control whether or not
+      # accessibility is enabled and whether the AXInspector is visible.
+      # @return [Hash] table of accessibility properties found in the
+      #  Library/Preferences/com.apple.Accessibility.plist
+      def accessibility_properties_hash
+        {
+              # this is required
+              :access_enabled => 'AccessibilityEnabled',
+              # i _think_ this is legacy
+              :app_access_enabled => 'ApplicationAccessibilityEnabled',
+
+              # i don't know what this does
+              :automation_enabled => 'AutomationEnabled',
+
+              # determines if the Accessibility Inspector is showing
+              :inspector_showing => 'AXInspectorEnabled',
+              # controls if the Accessibility Inspector is expanded or not expanded
+              :inspector_full_size => 'AXInspector.enabled',
+              # controls the frame of the Accessibility Inspector
+              # this is a 'string' => {{0, 0}, {276, 166}}
+              :inspector_frame => 'AXInspector.frame'
+        }
+      end
+
+      # the absolute path the the iPhone Simulator Application Support directory
+      # @return [String] absolute path
+      def simulator_app_support_dir
+        File.expand_path('~/Library/Application Support/iPhone Simulator')
+      end
+
+      # returns a list of absolute paths the existing simulator directories.
+      #
+      # a simulator 'exists' if has an Application Support directory. for
+      # example, the 6.1, 7.0.3-64, and 7.1 simulators exist if the following
+      # directories are present:
+      #
+      #     ~/Library/Application Support/iPhone Simulator/Library/6.1
+      #     ~/Library/Application Support/iPhone Simulator/Library/7.0.3-64
+      #     ~/Library/Application Support/iPhone Simulator/Library/7.1
+      #
+      # @return[Array<String>] a list of absolute paths to simulator directories
+      def simulator_support_sdk_dirs
+        sim_app_support_path = simulator_app_support_dir()
+        Dir.glob("#{sim_app_support_path}/*").select { |path|
+          path =~ /(\d)\.(\d)\.?(\d)?(-64)?/
+        }
+      end
+
+    end
+  end
+end