frank-pivotal 1.2.3.pre.1

data/lib/frank-pivotal/frankifier.rb

@@ -0,0 +1,153 @@
+require 'pathname'
+require 'xcodeproj'
+
+class Frankifier
+  include Thor::Shell
+
+  def self.frankify! root_dir, options = {}
+    me = new(root_dir, options)
+    me.frankify!
+    me
+  end
+
+  def initialize( root_dir, options = {} )
+    @root = Pathname.new( root_dir )
+    @target_build_configuration = options[:build_config]
+    @target_selection = options[:target]
+    load_xcode_proj_option(options[:project])
+  end
+
+  def frankify!
+    decide_on_project if @project.nil?
+    decide_on_target
+    report_project_and_target
+
+    check_target_build_configuration_is_valid!
+
+    say ''
+    project_changed |= add_linker_flag
+
+    say ''
+    project_changed |= add_library_search_path
+
+    if project_changed
+      save_changes
+    end
+  end
+
+  private
+  def load_xcode_proj_option(xcodeproj)
+    if xcodeproj
+      unless File.exists?(xcodeproj)
+        raise "Project file '#{xcodeproj}' does not exist. Please specify the relative path."
+      end
+
+      @xcodeproj_path = Pathname.new(xcodeproj)
+      @project = Xcodeproj::Project.open(@xcodeproj_path)
+    end
+  end
+
+  def decide_on_project
+    projects = Pathname.glob( @root+'*.xcodeproj' )
+    xcodeproj = case projects.size
+    when 0
+      raise "There are no .xcodeproj files in this directory. Please move to your root project directory and try again."
+    when 1
+      projects.first
+    else
+      choice = ask_menu(
+        "I found more than one .xcodeproj. Which is the main app project that you wish to Frankify?",
+        projects.map(&:basename)
+      )
+      projects[choice]
+    end
+
+    @xcodeproj_path = xcodeproj
+    @project = Xcodeproj::Project.open(xcodeproj)
+  end
+
+  def decide_on_target
+    targets = @project.targets
+    @target = targets.find { |item| item.name.eql?(@target_selection) } if @target_selection
+    return @target if @target
+    @target = case targets.size
+    when 0
+      raise "Sorry, this project appears to contain no targets. Nothing I can do here."
+    when 1
+      targets.first
+    else
+      choice = ask_menu(
+        "I found more than one target in this project. Which is the main app target that you wish to Frankify?",
+        targets.map(&:name)
+      )
+      targets.to_a[choice]
+    end
+  end
+
+  def report_project_and_target
+    puts "Frankifying target [#{@target.name}] in project #{@xcodeproj_path.basename}"
+  end
+
+  def add_linker_flag
+    add_frank_entry_to_build_setting( 'OTHER_LDFLAGS', 'FRANK_LDFLAGS' )
+  end
+
+  def add_library_search_path
+    add_frank_entry_to_build_setting( 'LIBRARY_SEARCH_PATHS', 'FRANK_LIBRARY_SEARCH_PATHS' )
+  end
+
+  def add_frank_entry_to_build_setting( build_setting, entry_to_add )
+    setting_array = Array( build_settings_to_edit[build_setting] )
+
+    if setting_array.find{ |flag| flag.start_with? "$(FRANK_" }
+      say "It appears that your '#{@target_build_configuration}' configuration's #{build_setting} build setting already include some FRANK setup. Namely: #{setting_array.inspect}. I won't change anything here."
+      return false
+    end
+
+    say "Adding $(inherited) and $(#{entry_to_add}) to your '#{@target_build_configuration}' configuration's #{build_setting} build setting ..."
+    setting_array.unshift "$(inherited)"
+    setting_array << "$(#{entry_to_add})"
+    setting_array.uniq! # mainly to avoid duplicate $(inherited) entries
+    say "... #{build_setting} is now: #{setting_array.inspect}"
+
+    build_settings_to_edit[build_setting] = setting_array
+    true
+  end
+
+  def check_target_build_configuration_is_valid!
+    unless @target.build_configuration_list.build_settings(@target_build_configuration)
+      say %Q|I'm trying to Frankify the '#{@target_build_configuration}' build configuration, but I don't see it that build configuration in your XCode target. Here's a list of the build configurations I see:|
+      @target.build_configuration_list.build_configurations.each do |bc|
+        say "  '#{bc.name}'"
+      end
+      say ''
+      say %Q|Please specify one of those build configurations using the --build_configuration flag|
+      exit
+    end
+
+  end
+
+  def build_settings_to_edit
+    @_build_settings_to_edit ||= @target.build_configuration_list.build_settings(@target_build_configuration)
+  end
+
+  def save_changes
+    @project.save
+  end
+
+  # TODO: send this as a pull request to thor
+  def ask_menu message, options
+    option_lines = options.each_with_index.map{ |o,i| "#{i+1}: #{o}" }
+    full_message = ([message,'']+option_lines+[">"]).join("\n")
+
+    allowed_range = (1..options.length)
+    valid_choice = nil
+    until valid_choice
+      choice = ask(full_message).to_i
+      valid_choice = choice if allowed_range.include?(choice)
+      say("You must choose an option between #{allowed_range.first} and #{allowed_range.last}") unless valid_choice
+    end
+    valid_choice-1
+  end
+
+end

data/lib/frank-pivotal/gateway.rb

@@ -0,0 +1,135 @@
+require 'net/http'
+require 'uri'
+
+module Frank module Cucumber
+
+class Gateway
+  DEFAULT_BASE_URL = "http://localhost:37265/"
+
+  def initialize( base_url = nil )
+    @base_url = URI.parse( (base_url || DEFAULT_BASE_URL).to_s )
+  end
+
+  def ping
+    send_get('')
+    return true
+  rescue FrankNetworkError
+    return false
+  end
+
+  class << self
+    def build_operation_map( method_sig, method_args )
+      num_args_according_to_method_sig = method_sig.count(':')
+
+      if num_args_according_to_method_sig != method_args.count
+        raise <<-EOS
+          
+          The method you've specified - #{method_sig} - wants #{num_args_according_to_method_sig} arguments, but you've supplied #{method_args.count} arguments.
+
+        EOS
+      end
+
+      if num_args_according_to_method_sig > 0 && !method_sig.end_with?(':')
+        raise <<-EOS
+
+          The method signature you've specified - #{method_sig} - is invalid. Objective C method signatures which take parameters must end with a :
+
+        EOS
+      end
+
+      {
+        :method_name => method_sig,
+        :arguments => method_args,
+      }
+    end
+
+    def evaluate_frankly_response( json, req_desc )
+      res = JSON.parse( json )
+      if res['outcome'] != 'SUCCESS'
+        raise "#{req_desc} failed because: #{res['reason']}\n#{res['details']}"
+      end
+
+      res['results']
+    end
+  end
+
+  #taken from Ian Dee's Encumber
+  def send_post( verb, command )
+    command = command.to_json unless command.is_a? String
+
+    url = frank_url_for( verb )
+    req = Net::HTTP::Post.new url.path
+    req.body = command
+
+    make_http_request( url, req )
+  end
+
+  def send_get( verb )
+    url = frank_url_for( verb )
+    req = Net::HTTP::Get.new url.path
+    make_http_request( url, req )
+  end
+  
+  private
+
+  def frank_url_for( verb )
+    url = @base_url.clone
+    url.path = '/'+verb
+    url
+  end
+
+  def make_http_request( url, req )
+    http = Net::HTTP.new(url.host, url.port)
+
+    begin
+      res = http.start do |sess|
+        sess.request req
+      end
+
+      res.body
+    rescue Errno::ECONNREFUSED
+      raise FrankNetworkError 
+    rescue EOFError
+      raise FrankNetworkError
+    end
+  end
+
+end
+
+
+class FrankNetworkError < RuntimeError
+  OVERLY_VERBOSE_YET_HELPFUL_ERROR_MESSAGE = <<EOS
+  
+
+*********************************************
+Oh dear. Your app fell over and can't get up.
+*********************************************
+
+
+We just encountered an error while trying to talk to the Frank server embedded 
+within the app under test. This usually means that the app has just crashed, 
+either while carrying out the current step or while finishing up the previous 
+step.
+
+Here are some things you could do next:
+
+- Take a look at the app's logs to see why it crashed. You can view the logs 
+  in Console.app (a search for 'Frankified' will usually find your frankified 
+  app's output).
+
+- Launch your frankified app in the XCode debugger and then run this scenario 
+  again. You'll get lots of helpful output from XCode. Don't forget to do 
+  something to prevent cucumber from automatically re-launching your app when 
+  you run the scenario by hand. If you don't prevent the relaunch then you 
+  won't still be in the XCode debugger when the crash happens.
+
+  
+
+EOS
+
+  def initialize
+    super OVERLY_VERBOSE_YET_HELPFUL_ERROR_MESSAGE
+  end
+end
+
+end end

data/lib/frank-pivotal/gesture_helper.rb

@@ -0,0 +1,99 @@
+module Frank
+	module Cucumber
+		module GestureHelper
+
+			# Touch and hold the selector for a given duration
+			#
+			# @param [String] selector a view selector.
+			# @param [Number] duration the duration of the touch, the default is 1.
+			#
+			# @return [Array<Boolean>] an array indicating for each view which matched the selector whether it was touched or not.
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could be touched
+			def tap_and_hold( selector, duration = 1 )
+				touch_successes = frankly_map( selector, "touchAndHold:", duration )
+				raise "Could not find anything matching [#{selector}] to long touch" if touch_successes.empty?
+			    raise "Some views could not be long touched (probably because they are not within the current viewport)" if touch_successes.include?(false)
+			end
+
+			# Touch and hold the selector at a specific point for a given duration
+			#
+			# @param [String] selector a view selector.
+			# @param [Number] duration the duration of the touch, the default is 1.
+			# @param [Number] x the x-coordinate to touch
+			# @param [Number] y the y-coordinate to touch
+			#
+			# @return [Array<Boolean>] an array indicating for each view which matched the selector whether it was touched or not.
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could be touched
+			def tap_and_hold_point( selector, x, y, duration = 1 )
+				touch_successes = frankly_map( selector, "touchAndHold:x:y:", duration, x, y )
+				raise "Could not find anything matching [#{selector}] to long touch" if touch_successes.empty?
+			    raise "Some views could not be long touched (probably because they are not within the current viewport)" if touch_successes.include?(false)
+			end
+
+			# Double tap the selector
+			#
+			# @param [String] selector a view selector.
+			#
+			# @return [Array<Boolean>] an array indicating for each view which matched the selector whether it was touched or not.
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could be touched
+			def double_tap( selector )
+				touch_successes = frankly_map( selector, "doubleTap"  )
+				raise "Could not find anything matching [#{selector}] to double tap" if touch_successes.empty?
+			    raise "Some views could not be double tap (probably because they are not within the current viewport)" if touch_successes.include?(false)
+			end
+
+			# Double tap the selector at a specific point
+			#
+			# @param [String] selector a view selector.
+			# @param [Number] x the x-coordinate to touch
+			# @param [Number] y the y-coordinate to touch
+			#
+			# @return [Array<Boolean>] an array indicating for each view which matched the selector whether it was touched or not.
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could be touched
+			def double_tap_point( selector, x, y )
+				touch_successes = frankly_map( selector, "doubleTapx:y:", x, y )
+				raise "Could not find anything matching [#{selector}] to double tap" if touch_successes.empty?
+			    raise "Some views could not be double tap (probably because they are not within the current viewport)" if touch_successes.include?(false)
+			end
+			
+			# Drag the slider thumb to required value, taking the specified time
+			#
+			# @param [String] selector A view selector
+			# @param [Number] value The value up to which the slider should be dragged
+			# @param [Number] duration The time interval that the drag should take
+			#
+			#  @return [Array<Boolean>] an array indicating for each view which matched the selector if the value was acceptable or not
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could have their thumbs dragged
+			def drag_thumb_in_slider( selector, value, duration )
+				touch_successes = frankly_map( selector, "FEX_dragThumbToValue:withDuration:", value, duration)
+				raise "Could not find anything matching [#{selector}] to have its thumb dragged" if touch_successes.empty?
+			    raise "Some views could not had their thumbs dragged (are they even UISLiders?)" if touch_successes.include?(false)
+			end
+			
+			# Drag the slider thumb to required value
+			#
+			# @param [String] selector A view selector
+			# @param [Number] value The value up to which the slider should be dragged
+			#
+			#  @return [Array<Boolean>] an array indicating for each view which matched the selector if the value was acceptable or not
+			#
+			# @raise an expection if no views matched the selector
+			# @raise an expection if no views which matched the selector could have their thumbs dragged
+			def drag_thumb_in_slider_with_default_duration( selector, value )
+				touch_successes = frankly_map( selector, "FEX_dragThumbToValue:", value )
+				raise "Could not find anything matching [#{selector}] to have its thumb dragged" if touch_successes.empty?
+			    raise "Some views could not had their thumbs dragged (are they even UISLiders?)" if touch_successes.include?(false)
+			end
+		end
+	end
+end

data/lib/frank-pivotal/host_scripting.rb

@@ -0,0 +1,102 @@
+require 'frank-cucumber/frank_localize'
+
+module Frank module Cucumber
+
+module HostScripting
+
+  def start_recording
+    %x{osascript<<APPLESCRIPT
+	tell application "QuickTime Player"
+	set sr to new screen recording
+	  tell sr to start
+	end tell
+  APPLESCRIPT}
+
+  end
+
+  def stop_recording
+    %x{osascript<<APPLESCRIPT
+	tell application "QuickTime Player"
+	  set sr to (document 1)
+	  tell sr to stop
+	end tell
+  APPLESCRIPT}
+  end
+
+  def quit_simulator
+    %x{osascript<<APPLESCRIPT-
+      application id "com.apple.iphonesimulator" quit
+    APPLESCRIPT}
+  end
+
+  def quit_double_simulator
+    %x{osascript<<APPLESCRIPT
+      activate application id "com.apple.iphonesimulator"
+      tell application "System Events"
+        set process_name_list to name of (application processes where bundle identifier is "com.apple.iphonesimulator")
+	    set process_name to first item of process_name_list
+        tell process process_name
+          if (value of static text 1 of window 1) is "#{Localize.t(:only_one_simulator)}" then
+            click button 1 of window 1
+          end if
+        end tell
+      end tell
+    }
+  end
+
+def simulator_reset_data
+  %x{osascript<<APPLESCRIPT
+activate application id "com.apple.iphonesimulator"
+tell application "System Events"
+  set process_name_list to name of (application processes where bundle identifier is "com.apple.iphonesimulator")
+  set process_name to first item of process_name_list
+  click menu item 5 of menu 1 of menu bar item 2 of menu bar 1 of process process_name
+  delay 0.5
+  click button "#{Localize.t(:iphone_simulator_reset)}" of window 1 of process process_name
+end tell
+  APPLESCRIPT}
+end
+
+  #Note this needs to have "Enable access for assistive devices"
+  #chcked in the Universal Access system preferences
+  def simulator_hardware_menu_press( menu_label )
+    %x{osascript -s o <<APPLESCRIPT
+activate application id "com.apple.iphonesimulator"
+tell application "System Events"
+  set process_name_list to name of (application processes where bundle identifier is "com.apple.iphonesimulator")
+	set process_name to first item of process_name_list
+	click menu item "#{menu_label}" of menu "#{Localize.t(:hardware)}" of menu bar 1 of process process_name
+end tell
+  APPLESCRIPT}
+  end
+
+  def press_home_on_simulator
+    simulator_hardware_menu_press Localize.t(:home)
+  end
+
+  def rotate_simulator_left
+    simulator_hardware_menu_press Localize.t(:rotate_left)
+  end
+
+  def rotate_simulator_right
+    simulator_hardware_menu_press Localize.t(:rotate_right)
+  end
+
+  def shake_simulator
+    simulator_hardware_menu_press Localize.t(:shake_gesture)
+  end
+
+  def simulate_memory_warning
+    simulator_hardware_menu_press Localize.t(:simulate_memory_warning)
+  end
+
+  def toggle_call_status_bar
+    simulator_hardware_menu_press Localize.t(:toggle_call_status_bar)
+  end
+
+  def simulate_hardware_keyboard
+    simulator_hardware_menu_press Localize.t(:simulate_hardware_keyboard)
+  end
+end
+
+end end

data/lib/frank-pivotal/keyboard_helper.rb

@@ -0,0 +1,69 @@
+module Frank
+module Cucumber
+
+module KeyboardHelper
+  # Ask Frank to press a sequence of keys on the iOS keyboard.
+  #
+  # @note The keyboard must be fully visible on the device before calling this method.
+  #
+  # The "/b" control character is interpreted as a request to press the 'Delete' key.
+  #
+  # An implicit return is appended to the key sequence, unless you explicitly specify otherwise by setting the :append_return option to false.
+  #
+  # @example
+  #   # press the X, -, Y, and z keys on the
+  #   # iOS keyboard, then press return
+  #   type_into_keyboard("X-Yz")
+  #
+  #   # press the 1, 2, and 3 keys on the
+  #   # iOS keyboard, but don't press return afterwards
+  #   type_into_keyboard("123", :append_return => false)
+  #
+  #   # press the 1, 2, and 3 keys on the
+  #   # iOS keyboard, but don't press return afterwards
+  #   type_into_keyboard("123", :append_return => false)
+  #
+  #   # press Delete twice, then type "foo"
+  #   type_into_keyboard("\b\bfoo")
+  #
+  def type_into_keyboard(text_to_type, options = {})
+    options = {
+      :append_return => true
+    }.merge(options)
+
+    if( options[:append_return] )
+      text_to_type = text_to_type+"\n" unless text_to_type.end_with?("\n")
+    end
+    res = frank_server.send_post(
+      'type_into_keyboard',
+      :text_to_type => text_to_type
+    )
+    Frank::Cucumber::Gateway.evaluate_frankly_response( res, "typing the following into the keyboard '#{text_to_type}'" )
+  end
+
+  # Type a keyboard shortcut (Mac only)
+  #
+  # This function takes as arguments either a single string, or an array of strings, with
+  # each string representing a different key to press. Modifier keys are represented by
+  # the strings "command", "shift", "option", and "control".
+  #
+  # For example, to sent a keyboard shortcut to quit the app, you would call
+  #
+  # type shortcut "command", "q"
+  def type_shortcut(*args)
+    if args[0].kind_of?(Array)
+      return type_shortcut(*args)
+    else
+      key = args.pop
+
+      res = frank_server.send_post(
+        'type_into_keyboard',
+        :text_to_type => key,
+        :modifiers => args
+      )
+
+      Frank::Cucumber::Gateway.evaluate_frankly_response(res, "typing the following shortcut into the keyboard '#{key}' with modifiers #{args}")
+    end
+  end
+end
+end end

data/lib/frank-pivotal/launcher.rb

@@ -0,0 +1,118 @@
+require 'sim_launcher'
+require 'frank-cucumber/app_bundle_locator'
+require 'frank-cucumber/frank_helper'
+
+module Frank module Cucumber
+
+module Launcher
+    include Frank::Cucumber::FrankHelper
+
+  attr_accessor :application_path, :sdk, :version
+
+  def simulator_client
+    @simulator_client ||= SimLauncher::Client.new(@application_path, @sdk, @version)
+  end
+
+  def simulator_direct_client
+    @simulator_direct_client ||= SimLauncher::DirectClient.new(@application_path, @sdk, @version)
+  end
+
+  def enforce(app_path, locator = Frank::Cucumber::AppBundleLocator.new)
+    if app_path.nil?
+      message = "APP_BUNDLE_PATH is not set. \n\nPlease set APP_BUNDLE_PATH (either an environment variable, or the ruby constant in support/env.rb) to the path of your Frankified target's iOS app bundle."
+      possible_app_bundles = locator.guess_possible_app_bundles_for_dir( Dir.pwd )
+      if possible_app_bundles && !possible_app_bundles.empty?
+        message << "\n\nBased on your current directory, you probably want to use one of the following paths for your APP_BUNDLE_PATH:\n"
+        message << possible_app_bundles.join("\n")
+      end
+      raise "\n\n"+("="*80)+"\n"+message+"\n"+("="*80)+"\n\n"
+    end
+
+    if app_path_problem = SimLauncher.check_app_path(app_path)
+      raise "\n\n"+("="*80)+"\n"+app_path_problem+"\n"+("="*80)+"\n\n"
+    end
+  end
+
+  def launch_app(app_path, sdk = nil, version = 'iphone', wait_for_launch = true)
+    @application_path = app_path
+    @sdk = sdk
+    @version = version
+
+    if path_is_mac_app(@application_path)
+      launch_mac_app(wait_for_launch)
+    else
+      enforce(app_path)
+      launch_ios_app(wait_for_launch)
+    end
+  end
+
+  def launch_ios_app(wait_for_launch = true)
+    # kill the app if it's already running, just in case this helps
+    # reduce simulator flakiness when relaunching the app. Use a timeout of 5 seconds to
+    # prevent us hanging around for ages waiting for the ping to fail if the app isn't running
+    begin
+      Timeout::timeout(5) { press_home_on_simulator if frankly_ping }
+    rescue Timeout::Error
+    end
+
+    if( ENV['USE_SIM_LAUNCHER_SERVER'] )
+      simulator = simulator_client
+    else
+      simulator = simulator_direct_client
+    end
+
+    num_timeouts = 0
+    begin
+      simulator.relaunch
+
+      if wait_for_launch
+        wait_for_frank_to_come_up
+      end
+    rescue Timeout::Error
+      num_timeouts += 1
+      puts "Encountered #{num_timeouts} timeouts while launching the app."
+      if num_timeouts > 3
+        raise "Encountered #{num_timeouts} timeouts in a row while trying to launch the app."
+      end
+      quit_double_simulator
+      retry
+    end
+
+  end
+
+  def path_is_mac_app (app_dir)
+    return File.exists? File.join( app_dir, "Contents", "MacOS" )
+  end
+
+
+  def launch_mac_app(wait_for_launch = true)
+    `open "#{@application_path}"`
+
+    if wait_for_launch
+      wait_for_frank_to_come_up
+    end
+  end
+
+  def quit_mac_app_if_running
+    pid = `ps -ax | grep "#{@app_path}" | grep -v grep`
+
+    if pid != ""
+      pid = pid.strip.split[0]
+      `kill #{pid}`
+    end
+
+    Timeout::timeout(60) {
+      while pid != ""
+        pid = `ps -ax | grep "#{@app_path}" | grep -v grep`
+      end
+    }
+
+  end
+
+  def relaunch_mac_app
+    self.quit_if_running
+    self.launch
+  end
+
+end
+end end