calabash-cucumber 0.16.4 → 0.17.0

data/lib/calabash-cucumber/dot_dir.rb

@@ -0,0 +1,18 @@
+module Calabash
+  module Cucumber
+    # A module for managing the ~/.calabash directory.
+    module DotDir
+      require "run_loop"
+
+      def self.directory
+        home = RunLoop::Environment.user_home_directory
+        dir = File.join(home, ".calabash")
+        if !File.exist?(dir)
+          FileUtils.mkdir_p(dir)
+        end
+        dir
+      end
+    end
+  end
+end
+

data/lib/calabash-cucumber/launch/simulator_launcher.rb

@@ -34,6 +34,10 @@ module Calabash
       # The file path to the default Xcode DerivedData directory.
       DERIVED_DATA = File.expand_path('~/Library/Developer/Xcode/DerivedData')
 
+      # @!visibility private]
+      # The file path to the default Xcode preferences plist.
+      XCODE_PREFS = File.expand_path('~/Library/Preferences/com.apple.dt.Xcode.plist')
+
       # @!visibility private
       # REGEX for finding application Info.plist.
       DEFAULT_DERIVED_DATA_INFO = File.expand_path("#{DERIVED_DATA}/*/info.plist")
@@ -161,6 +165,33 @@ module Calabash
         end
       end
 
+      # @!visibility private
+      # Returns the absolute build path to the project directory.
+      #
+      # @return [String] absolute path to the projects build directory
+      def build_output_dir_for_project
+        xcode_temp_prefs = File.join(project_dir, '.cal_xcode_prefs')
+        FileUtils.cp(XCODE_PREFS, xcode_temp_prefs)
+        `plutil -convert xml1 "#{xcode_temp_prefs}"`
+
+        plist = CFPropertyList::List.new(:file => xcode_temp_prefs)
+        hash = CFPropertyList.native_types(plist.value)
+
+        if hash.has_key?('IDESharedBuildFolderName')
+          build_folder_name = hash['IDESharedBuildFolderName']
+          output_dir = "#{DERIVED_DATA}/#{build_folder_name}/Products"
+        elsif hash.has_key?('IDECustomBuildProductsPath')
+          products_path = hash['IDECustomBuildProductsPath']
+          File.join(project_dir, products_path)
+        else
+          output_dir = derived_data_dir_for_project
+        end
+
+        FileUtils.rm(xcode_temp_prefs)
+
+        output_dir
+      end
+
       # @!visibility private
       # Returns the absolute path to the project directory.
       #
@@ -220,12 +251,13 @@ module Calabash
             puts('-'*37)
           end
         else
-          dd_dir = derived_data_dir_for_project
-          sim_dirs = Dir.glob(File.join(dd_dir, 'Build', 'Products', '*-iphonesimulator', '*.app'))
+          bo_dir = build_output_dir_for_project
+          sim_dirs = Dir.glob(File.join(bo_dir, '*-iphonesimulator', '*.app'))
+          
           if sim_dirs.empty?
             msg = ['Unable to auto detect APP_BUNDLE_PATH.']
             msg << 'Have you built your app for simulator?'
-            msg << "Searched dir: #{dd_dir}/Build/Products"
+            msg << "Searched dir: #{bo_dir}"
             msg << 'Please build your app from Xcode'
             msg << 'You should build the -cal target.'
             msg << ''

data/lib/calabash-cucumber/launcher.rb

@@ -8,6 +8,7 @@ require 'run_loop'
 require 'cfpropertylist'
 require 'calabash-cucumber/utils/logging'
 require 'calabash/dylibs'
+require "calabash-cucumber/usage_tracker"
 
 # Used to launch apps for testing in iOS Simulator or on iOS Devices.  By default
 # it uses Apple's `instruments` process to launch your app, but has legacy support
@@ -56,6 +57,7 @@ class Calabash::Cucumber::Launcher
   attr_accessor :launch_args
   attr_accessor :simulator_launcher
   attr_reader :xcode
+  attr_reader :usage_tracker
 
   # @!visibility private
   # Generated when calabash cannot launch the app.
@@ -81,6 +83,10 @@ class Calabash::Cucumber::Launcher
     @xcode ||= RunLoop::Xcode.new
   end
 
+  def usage_tracker
+    @usage_tracker ||= Calabash::Cucumber::UsageTracker.new
+  end
+
   # @!visibility private
   def initialize
     @simulator_launcher = Calabash::Cucumber::SimulatorLauncher.new
@@ -147,12 +153,15 @@ class Calabash::Cucumber::Launcher
     self.run_loop = run_loop
     major = self.device.ios_major_version
     if major.to_i >= 7 && self.actions.is_a?(Calabash::Cucumber::PlaybackActions)
-      puts "\n\n WARNING \n\n"
-      puts 'Warning Trying to connect to simulator that was not launched by Calabash/instruments.'
-      puts 'To fix this you must let Calabash or instruments launch the app.'
-      puts 'Query will work, but gestures will not.'
-      puts "\n\n WARNING \n\n"
-      puts 'Please read: https://github.com/calabash/calabash-ios/wiki/A0-UIAutomation---instruments-problems'
+      puts  %Q{
+
+WARNING
+
+Connected to simulator that was not launched by Calabash.
+
+Queries will work, but gestures will not.
+
+}
     end
     self
   end
@@ -267,56 +276,24 @@ class Calabash::Cucumber::Launcher
   #  `:all` is passed, then the sandboxes for all sdks will be deleted.
   # @option opts [String] :path (nil) path to the application bundle
   def reset_app_sandbox(opts={})
+    calabash_warn(%Q{
+Starting in Calabash 0.17.0, this method does nothing.
 
-    if device_target?
-      calabash_warn("calling 'reset_app_sandbox' when targeting a device.")
-      return
-    end
-
-    default_opts = {:sdk => nil, :path => nil}
-    merged_opts = default_opts.merge opts
+You can still control whether or not your app's sandbox is
+reset between Scenarios using RESET_BETWEEN_SCENARIOS=1 or
+by passing :reset => true as a launch option.
 
-    sim_control = opts.fetch(:sim_control, RunLoop::SimControl.new)
-    xcode = sim_control.xcode
+options = {
+  :reset => true
+}
 
-    if sim_control.xcode_version_gte_6?
-      default_sim = RunLoop::Core.default_simulator(xcode)
-      name_or_udid = merged_opts[:udid] || ENV['DEVICE_TARGET'] || default_sim
+launcher.relaunch(options)
 
-      target_simulator = sim_control.simulators.find do |sim|
-        [name_or_udid == sim.instruments_identifier(xcode),
-         name_or_udid == sim.udid,
-         name_or_udid == sim.name].any?
-      end
+Please do not ignore this message.
 
-      if target_simulator.nil?
-        raise "Could not find a simulator that matches '#{name_or_udid}'"
-      end
-
-      sim_control.reset_sim_content_and_settings({:sim_udid => target_simulator.udid})
-    else
-      sdk ||= merged_opts[:sdk] || sdk_version || self.simulator_launcher.sdk_detector.latest_sdk_version
-      path ||= merged_opts[:path] || self.simulator_launcher.app_bundle_or_raise(app_path)
+Remove direct calls to reset_app_sandbox.
 
-      app = File.basename(path)
-
-      directories_for_sdk_prefix(sdk).each do |sdk_dir|
-        app_dir = File.expand_path("#{sdk_dir}/Applications")
-        next unless File.exists?(app_dir)
-
-        bundle = `find "#{app_dir}" -type d -depth 2 -name "#{app}" | head -n 1`
-
-        next if bundle.empty? # Assuming we're already clean
-
-        if debug_logging?
-          puts "Reset app state for #{bundle}"
-        end
-        sandbox = File.dirname(bundle)
-        ['Library', 'Documents', 'tmp'].each do |content_dir|
-          FileUtils.rm_rf(File.join(sandbox, content_dir))
-        end
-      end
-    end
+})
   end
 
   # Erases the contents and setting for every available simulator.
@@ -503,36 +480,27 @@ class Calabash::Cucumber::Launcher
     end
   end
 
-  # Launches your app on the connected device or simulator. Stops the app if it is already running.
-  # `relaunch` does a lot of error detection and handling to reliably start the app and test. Instruments (particularly the cli)
-  # has stability issues which we workaround by restarting the simulator process and checking that UIAutomation is correctly
-  # attaching.
+  # Launches your app on the connected device or simulator.
   #
-  # Takes optional args to specify details of the launch (e.g. device or simulator, sdk version, target device, launch method...).
-  # @note an important part of relaunch behavior is controlled by environment variables, specified below
+  # `relaunch` does a lot of error detection and handling to reliably start the
+  # app and test. Instruments (particularly the cli) has stability issues which
+  # we workaround by restarting the simulator process and checking that
+  # UIAutomation is correctly attaching to your application.
   #
-  # The two most important environment variables are `DEVICE_TARGET` and `APP_BUNDLE_PATH`.
+  # Use the `args` parameter to to control:
   #
-  # - `DEVICE_TARGET` controls which device you're running on. To see the options run: `instruments -s devices`.
-  #   In addition you can specify `DEVICE_TARGET=device` to run on a (unique) usb-connected device.
-  # - `APP_BUNDLE_PATH` controls which `.app` bundle to launch in simulator (don't use for on-device testing, instead use `BUNDLE_ID`).
-  # - `BUNDLE_ID` used with `DEVICE_TARGET=device` to specify which app to launch on device
-  # - `DEBUG` - set to "1" to obtain debug info (typically used to debug launching, UIAutomation and other issues)
-  # - `DEBUG_HTTP` - set to "1" to show raw HTTP traffic
+  # * `:app` - which app to launch.
+  # * `:device_target` - simulator or device to target.
+  # * `:reset_app_sandbox - reset he app's data (sandbox) before testing
   #
+  # and many other behaviors.
   #
-  # @example Launching on iPad simulator with DEBUG settings
-  #   DEBUG_HTTP=1 DEVICE_TARGET="iPad - Simulator - iOS 7.1" DEBUG=1 APP_BUNDLE_PATH=FieldServiceiOS.app bundle exec calabash-ios console
-  # @param {Hash} args optional args to specify details of the launch (e.g. device or simulator, sdk version,
-  #   target device, launch method...).
-  # @option args {String} :app (detect the location of the bundle from project settings) app bundle path
-  # @option args {String} :bundle_id if launching on device, specify this or env `BUNDLE_ID` to be the bundle identifier
-  #   of the application to launch
-  # @option args {Hash} :privacy_settings preset privacy settings for the, e.g., `{:photos => {:allow => true}}`.
-  #    See {KNOWN_PRIVACY_SETTINGS}
+  # Many of these behaviors can be be controlled by environment variables. The
+  # most important environment variables are `APP`, `DEVICE_TARGET`, and
+  # `DEVICE_ENDPOINT`.
+  #
+  # @param {Hash} args optional arguments to control the how the app is launched
   def relaunch(args={})
-    #TODO stopping is currently broken, but this works anyway because instruments stop the process before relaunching
-    RunLoop.stop(run_loop) if run_loop
 
     # @todo Don't overwrite the _args_ parameter!
     args = default_launch_args.merge(args)
@@ -577,34 +545,11 @@ class Calabash::Cucumber::Launcher
 
     args[:device] ||= detect_device_from_args(args)
 
-    if simulator_target?(args) and args[:reset]
-      # attempt to find the sdk version from the :device_target
-      sdk = sdk_version_for_simulator_target(args)
-
-      # *** LEGACY SUPPORT ***
-      # If DEVICE_TARGET has not been set and is not a device UDID, then
-      # :device_target will be 'simulator'.  In that case, we cannot know what
-      # SDK version of the app sandbox we should reset.  The user _might_ give
-      # us a hint with SDK_VERSION, but we want to deprecate that variable ASAP.
-      #
-      # If passed a nil SDK arg, reset_app_sandbox will reset the _latest_ SDK.
-      # This is not good, because this is probably _not_ the SDK that should be
-      # reset.  Our only option is to reset every sandbox for all SDKs by
-      # passing :sdk => :all to reset_app_sandbox.
-      if sdk.nil? and args[:device_target] == 'simulator'
-        sdk = :all
-      end
-      reset_app_sandbox({:sdk => sdk,
-                         :path => args[:app],
-                         :udid => args[:udid],
-                         :sim_control => args[:sim_control]})
-    end
-
     if args[:privacy_settings]
       if simulator_target?(args)
         update_privacy_settings(args[:bundle_id], args[:privacy_settings])
       else
-        #Not supported on device
+        # Not supported on device
         puts 'Warning: :privacy_settings not supported on device'
       end
     end
@@ -649,6 +594,8 @@ class Calabash::Cucumber::Launcher
         check_server_gem_compatibility
       end
     end
+
+    usage_tracker.post_usage_async
   end
 
   # @!visibility private
@@ -1083,7 +1030,7 @@ class Calabash::Cucumber::Launcher
       msgs = [
             'The server version is not compatible with gem version.',
             'Please update your server.',
-            'https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-version',
+            'https://github.com/calabash/calabash-ios/wiki/Updating-your-Calabash-iOS-version',
             "       gem version: '#{gem_version}'",
             "min server version: '#{min_server_version}'",
             "    server version: '#{server_version}'"]

data/lib/calabash-cucumber/logging.rb

@@ -0,0 +1,79 @@
+module Calabash
+  module Cucumber
+    require "run_loop"
+
+    # These methods are not part of the API.
+    #
+    # They may change at any time.
+
+    # !@visibility private
+    # blue
+    def self.log_warn(msg)
+      puts self.blue(" WARN: #{msg}") if msg
+    end
+
+    # !@visibility private
+    # magenta
+    def self.log_debug(msg)
+      if RunLoop::Environment.debug?
+        puts self.magenta("DEBUG: #{msg}") if msg
+      end
+    end
+
+    # !@visibility private
+    # green
+    def self.log_info(msg)
+      puts self.green(" INFO: #{msg}") if msg
+    end
+
+    # !@visibility private
+    # red
+    def self.log_error(msg)
+      puts self.red("ERROR: #{msg}") if msg
+    end
+
+    private
+
+    # @!visibility private
+    def self.windows_env?
+      RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
+    end
+
+    # @!visibility private
+    def self.colorize(string, color)
+      if self.windows_env?
+        string
+      elsif RunLoop::Environment.xtc?
+        string
+      else
+        "\033[#{color}m#{string}\033[0m"
+      end
+    end
+
+    # @!visibility private
+    def self.red(string)
+      colorize(string, 31)
+    end
+
+    # @!visibility private
+    def self.blue(string)
+      colorize(string, 34)
+    end
+
+    # @!visibility private
+    def self.magenta(string)
+      colorize(string, 35)
+    end
+
+    # @!visibility private
+    def self.cyan(string)
+      colorize(string, 36)
+    end
+
+    # @!visibility private
+    def self.green(string)
+      colorize(string, 32)
+    end
+  end
+end
+

data/lib/calabash-cucumber/playback_helpers.rb

@@ -75,7 +75,7 @@ module Calabash
           Most likely you have updated your calabash-cucumber client
           but not your server. Please follow closely:
 
-https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-version
+https://github.com/calabash/calabash-ios/wiki/Updating-your-Calabash-iOS-version
 
           If you are running version 0.9.120+ then please report this message as a bug.
 EOF
@@ -194,7 +194,7 @@ EOF
           Most likely you have updated your calabash-cucumber client
           but not your server. Please follow closely:
 
-https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-version
+https://github.com/calabash/calabash-ios/wiki/Updating-your-Calabash-iOS-version
 
           If you are running version 0.9.120+ then please report this message as a bug.
 EOF

data/lib/calabash-cucumber/store/preferences.rb

@@ -0,0 +1,223 @@
+module Calabash
+  module Cucumber
+
+    require "fileutils"
+    require "securerandom"
+
+    # Users preferences persisted across runs:
+    #
+    # ~/.calabash/preferences/preferences.json
+    class Preferences
+
+      def initialize
+        dot_dir = Calabash::Cucumber::DotDir.directory
+        @path = File.join(dot_dir, "preferences", "preferences.json")
+      end
+
+      def to_s
+        puts "Preferences:"
+        ap read
+      end
+
+      def inspect
+        to_s
+      end
+
+      # !@visibility private
+      def usage_tracking
+        preferences = read
+
+        unless valid_user_tracking_value?(preferences[:usage_tracking])
+          log_defaults_reset
+          preferences[:usage_tracking] = defaults[:usage_tracking]
+          write(preferences)
+        end
+
+        preferences[:usage_tracking]
+      end
+
+      # !@visibility private
+      def usage_tracking=(value)
+        if !valid_user_tracking_value?(value)
+          raise ArgumentError,
+            "Expected '#{value}' to be one of #{VALID_USAGE_TRACKING_VALUES.join(", ")}"
+        end
+
+        preferences = read
+        preferences[:usage_tracking] = value
+        write(preferences)
+      end
+
+      # !@visibility private
+      def user_id
+        preferences = read
+
+        unless valid_user_id?(preferences[:user_id])
+          preferences[:user_id] = SecureRandom.uuid
+          write(preferences)
+        end
+
+        preferences[:user_id]
+      end
+
+      # !@visibility private
+      def user_id=(value)
+        if !valid_user_id?(value)
+          raise ArgumentError,
+            "Expected '#{value}' to not be nil and not an empty string"
+        end
+
+        preferences = read
+        preferences[:user_id] = value
+        write(preferences)
+      end
+
+      private
+
+      # @!visibility private
+      def valid_user_tracking_value?(value)
+        VALID_USAGE_TRACKING_VALUES.include?(value)
+      end
+
+      # @!visibility private
+      def valid_user_id?(value)
+        !value.nil? && value != "" && value.is_a?(String)
+      end
+
+      # @!visibility private
+      #
+      # The preferences version
+      VERSION = "1.0"
+
+      # @!visibility private
+      #
+      # Ordered by permissiveness left to right ascending.
+      #
+      # "system_info" implies that "events" are also allowed.
+      VALID_USAGE_TRACKING_VALUES = ["none", "events", "system_info"]
+
+      # @!visibility private
+      def version
+        read[:version]
+      end
+
+      # @!visibility private
+      attr_reader :path
+
+      # @!visibility private
+      def ensure_preferences_dir
+        dir = File.dirname(@path)
+        unless File.exist?(dir)
+          FileUtils.mkdir_p(dir)
+        end
+      end
+
+      # @!visibility private
+      def defaults
+        {
+          :version => VERSION,
+          :usage_tracking => "system_info",
+          :user_id => SecureRandom.uuid
+        }
+      end
+
+      # @!visibility private
+      def write(hash)
+        if hash.nil?
+          raise ArgumentError, "Hash to write cannot be nil"
+        end
+
+        if !hash.is_a?(Hash)
+          raise ArgumentError, "Expected a Hash argument"
+        end
+
+        if hash.count == 0
+          raise ArgumentError, "Hash to write cannot be empty"
+        end
+
+        string = generate_json(hash)
+
+        ensure_preferences_dir
+
+        File.open(path, "w:UTF-8") do |file|
+          file.write(string)
+        end
+
+        true
+      end
+
+      # @!visibility private
+      def generate_json(hash)
+        begin
+          JSON.pretty_generate(hash)
+        rescue TypeError, JSON::UnparserError => e
+          write_to_log(
+%Q{Error generating JSON from:
+ hash: #{hash}
+error: #{e}
+})
+          log_defaults_reset
+
+          # Will always generate valid JSON
+          generate_json(defaults)
+        end
+      end
+
+      # @!visibility private
+      def read
+        if File.exist?(path)
+
+          string = File.read(path).force_encoding("UTF-8")
+
+          parse_json(string)
+        else
+          hash = defaults
+          write(hash)
+          hash
+        end
+      end
+
+      # @!visibility private
+      def parse_json(string)
+        begin
+          JSON.parse(string, {:symbolize_names => true})
+        rescue TypeError, JSON::ParserError => e
+          write_to_log(
+%Q{Error parsing JSON from:
+string: #{string}
+ error: #{e}
+})
+          log_defaults_reset
+
+          hash = defaults
+          write(hash)
+          hash
+        end
+      end
+
+      # @!visibility private
+      def write_to_log(error_message)
+        # TODO write to a log file?
+      end
+
+      # @!visibility private
+      def log_defaults_reset
+        Calabash::Cucumber.log_warn(
+%q{An error occurred while accessing your user preferences.
+
+We have reset the preferences to the default settings.
+
+If this happens on a regular basis, please create a GitHub issue.
+
+Your preferences control various Calabash behaviors.  In particular, they tell
+us how much usage information you are willing to share.  If you have previously
+turned off usage tracking, you will need to disable it again using the command
+line tools or the irb.
+
+We do not recommend that edit the preferences file by hand.
+})
+      end
+    end
+  end
+end
+