calabash-android 0.5.16.pre1 → 0.6.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bb7b1d479f70d02d21cb13ac79c342a4636d8a1
-  data.tar.gz: a0054f26ac58558e5a93060ec6ba07819a522e16
+  metadata.gz: 43b1239ae3480cd7c7d91486030874b98bcc2458
+  data.tar.gz: e2720beceab3b24e451368c257cd54833d7da0fb
 SHA512:
-  metadata.gz: 412afba1c956f1390cb7516125cbf4f56853bb0c153bd5c68215c70ba5d551e4a981f6899b380f7dc092532eb66c4c7f51ca6498591d627dcdc6010499d61017
-  data.tar.gz: ebb6d1a2a0cdd7d9837c9ce19d931d3a716adfd6ccf9a0977c1710d18fd3319f267b96b1ec81a481f73676271c3f943695298e99ae8fda3954ca76f7803ed69e
+  metadata.gz: 1e6a8884a4a0253a8767d3c3669a1ec5fa359bcf3f9465c0daebbe22e137e776f15092f241ae67638117f00c2041b82bb94968abe211c6d657a0866a48c7aeb4
+  data.tar.gz: 1bfdbf7c4372c89d75aabc9c0aecca14d805bc56750636b6817518dfcf5cfb73c19dcb973b2306e2de37118c4fb15a513aa251a625f39cfeab9a3a833621ad0d

data/bin/calabash-android-build.rb

@@ -31,12 +31,13 @@ def calabash_build(app)
   FileUtils.mkdir_p File.dirname(test_server_file_name) unless File.exist? File.dirname(test_server_file_name)
 
   unsigned_test_apk = File.join(File.dirname(__FILE__), '..', 'lib/calabash-android/lib/TestServer.apk')
+  test_server_manifest = File.join(File.dirname(__FILE__), '..', 'lib', 'calabash-android', 'lib', 'AndroidManifest.xml')
 
   android_platform = Env.android_platform_path
   Dir.mktmpdir do |workspace_dir|
     Dir.chdir(workspace_dir) do
       FileUtils.cp(unsigned_test_apk, "TestServer.apk")
-      FileUtils.cp(File.join(File.dirname(__FILE__), '..', 'test-server/AndroidManifest.xml'), "AndroidManifest.xml")
+      FileUtils.cp(test_server_manifest, "AndroidManifest.xml")
 
       unless system %Q{"#{RbConfig.ruby}" -pi.bak -e "gsub(/#targetPackage#/, '#{package_name(app)}')" AndroidManifest.xml}
         raise "Could not replace package name in manifest"

data/irbrc

@@ -54,3 +54,20 @@ end
 
 extend Calabash::Android::Operations
 
+
+def preferences
+  Calabash::Android::Preferences.new
+end
+
+def disable_usage_tracking
+  preferences.usage_tracking = "none"
+  puts "Calabash will not collect usage information."
+  "none"
+end
+
+def enable_usage_tracking(level="system_info")
+  preferences.usage_tracking = level
+  puts "Calabash will collect statistics using the '#{level}' rule."
+  level
+end
+

data/lib/calabash-android/dot_dir.rb

@@ -0,0 +1,17 @@
+module Calabash
+  module Android
+    # A module for managing the ~/.calabash directory.
+    module DotDir
+      def self.directory
+        home = Calabash::Android::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-android/environment.rb

@@ -0,0 +1,120 @@
+module Calabash
+  module Android
+
+    # @!visibility private
+    class Environment
+
+    # @!visibility private
+      # Returns true if running on Windows
+      def self.windows?
+        RbConfig::CONFIG['host_os'][/mswin|mingw|cygwin/, 0] != nil
+      end
+
+    # @!visibility private
+      # Returns the user home directory
+      def self.user_home_directory
+        if self.xtc?
+          home = File.join("./", "tmp", "home")
+          FileUtils.mkdir_p(home)
+          home
+        else
+          if self.windows?
+            # http://stackoverflow.com/questions/4190930/cross-platform-means-of-getting-users-home-directory-in-ruby
+            home = ENV["HOME"] || ENV["USERPROFILE"]
+          else
+            require "etc"
+            home = Etc.getpwuid.dir
+          end
+
+          unless File.exist?(home)
+            home = File.join("./", "tmp", "home")
+            FileUtils.mkdir_p(home)
+          end
+
+          home
+        end
+      end
+
+      # @!visibility private
+      # Returns true if debugging is enabled.
+      def self.debug?
+        ENV['DEBUG'] == '1' ||
+          ARGV.include?("-v") ||
+          ARGV.include?("--verbose")
+      end
+
+      # @!visibility private
+      # Returns true if we are running on the XTC
+      def self.xtc?
+        ENV['XAMARIN_TEST_CLOUD'] == '1'
+      end
+
+      # @!visibility private
+      # Returns true if running in Jenkins CI
+      #
+      # Checks the value of JENKINS_HOME
+      def self.jenkins?
+        value = ENV["JENKINS_HOME"]
+        !!value && value != ''
+      end
+
+      # @!visibility private
+      # Returns true if running in Travis CI
+      #
+      # Checks the value of TRAVIS
+      def self.travis?
+        value = ENV["TRAVIS"]
+        !!value && value != ''
+      end
+
+      # @!visibility private
+      # Returns true if running in Circle CI
+      #
+      # Checks the value of CIRCLECI
+      def self.circle_ci?
+        value = ENV["CIRCLECI"]
+        !!value && value != ''
+      end
+
+      # @!visibility private
+      # Returns true if running in Teamcity
+      #
+      # Checks the value of TEAMCITY_PROJECT_NAME
+      def self.teamcity?
+        value = ENV["TEAMCITY_PROJECT_NAME"]
+        !!value && value != ''
+      end
+
+      # @!visibility private
+      # Returns true if running in Teamcity
+      #
+      # Checks the value of GITLAB_CI
+      def self.gitlab?
+        value = ENV["GITLAB_CI"]
+        !!value && value != ''
+      end
+
+      # @!visibility private
+      # Returns true if running in a CI environment
+      def self.ci?
+        [
+          self.ci_var_defined?,
+          self.travis?,
+          self.jenkins?,
+          self.circle_ci?,
+          self.teamcity?,
+          self.gitlab?
+        ].any?
+      end
+
+      private
+
+      # !@visibility private
+      def self.ci_var_defined?
+        value = ENV["CI"]
+        !!value && value != ''
+      end
+    end
+  end
+end
+

data/lib/calabash-android/logging.rb

@@ -0,0 +1,120 @@
+module Calabash
+  module Android
+    module Logging
+      require "fileutils"
+
+      # 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 Calabash::Android::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
+
+      # !@visibility private
+      def self.log_to_file(message)
+        timestamp = self.timestamp
+
+        begin
+          File.open(self.calabash_log_file, "a:UTF-8") do |file|
+            message.split($-0).each do |line|
+              file.write("#{timestamp} #{line}#{$-0}")
+            end
+          end
+        rescue => e
+          message =
+%Q{Could not write:
+
+#{message}
+
+to calabash.log because:
+
+#{e}
+}
+          self.log_debug(message)
+        end
+      end
+
+      private
+
+      # @!visibility private
+      def self.colorize(string, color)
+        if Calabash::Android::Environment.windows?
+          string
+        elsif Calabash::Android::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
+
+      # @!visibility private
+      def self.timestamp
+        Time.now.strftime("%Y-%m-%d_%H-%M-%S")
+      end
+
+      # @!visibility private
+      def self.logs_directory
+        path = File.join(Calabash::Android::DotDir.directory, "logs")
+        FileUtils.mkdir_p(path)
+        path
+      end
+
+      # @!visibility private
+      def self.calabash_log_file
+        path = File.join(self.logs_directory, "calabash.log")
+        if !File.exist?(path)
+          FileUtils.touch(path)
+        end
+        path
+      end
+    end
+  end
+end

data/lib/calabash-android/operations.rb

@@ -15,6 +15,11 @@ require 'calabash-android/drag_helpers'
 require 'calabash-android/wait_helpers'
 require 'calabash-android/version'
 require 'calabash-android/env'
+require 'calabash-android/environment'
+require 'calabash-android/dot_dir'
+require 'calabash-android/logging'
+require 'calabash-android/store/preferences'
+require 'calabash-android/usage_tracker'
 require 'retriable'
 require 'cucumber'
 require 'date'
@@ -702,6 +707,11 @@ module Calabash module Android
         end
 
         log("Client and server versions match (client: #{client_version}, server: #{server_version}). Proceeding...")
+
+        # What is Calabash tracking? Read this post for information
+        # No private data (like ip addresses) are collected
+        # https://github.com/calabash/calabash-android/issues/655
+        Calabash::Android::UsageTracker.new.post_usage_async
       end
 
       def shutdown_test_server
@@ -912,6 +922,8 @@ module Calabash module Android
     end
 
     def press_user_action_button(action_name=nil)
+      wait_for_keyboard
+
       if action_name.nil?
         perform_action("press_user_action_button")
       else

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

@@ -0,0 +1,211 @@
+module Calabash
+  module Android
+
+    require "awesome_print"
+    require "json"
+    require "fileutils"
+    require "securerandom"
+
+    # Users preferences persisted across runs:
+    #
+    # ~/.calabash/preferences/preferences.json
+    class Preferences
+      def initialize
+        dot_dir = Calabash::Android::DotDir.directory
+        @path = File.join(dot_dir, "preferences", "preferences.json")
+      end
+
+      def to_s
+        $stdout.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 => _
+
+          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 => _
+
+          log_defaults_reset
+
+          hash = defaults
+          write(hash)
+          hash
+        end
+      end
+
+      # @!visibility private
+      def log_defaults_reset
+        $stderr.puts(
+%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
+

data/lib/calabash-android/text_helpers.rb

@@ -12,6 +12,7 @@ module Calabash
       end
 
       def keyboard_enter_text(text, options = {})
+        wait_for_keyboard
         perform_action('keyboard_enter_text', text)
       end
 
@@ -19,36 +20,62 @@ module Calabash
         keyboard_enter_text(character[0,1], options)
       end
 
+      # Appends `text` into the first view matching `uiquery`.
       def enter_text(uiquery, text, options = {})
         tap_when_element_exists(uiquery, options)
         sleep 0.5
+        set_selection(-1, -1)
         keyboard_enter_text(text, options)
       end
 
       def clear_text_in(query_string, options={})
-        unless query_string.nil?
-          touch(query_string, options)
-          sleep 0.5
-        end
-
+        touch(query_string, options)
+        sleep 0.5
         clear_text(options)
       end
 
+      # Clears the text of the currently focused view.
       def clear_text(options={})
-        if options.is_a?(String)
-          puts "Warning: The method clear_text now clears the text in the currently focused view. Use clear_text_in instead"
-          puts "Notice that clear_text_in only clears the text of the first element matching the given query, not all."
-          puts "Use query(query, setText: '') to replicate the old behaviour"
+        set_selection(-1, -1)
+        perform_action("delete_surrounding_text", -1, 0)
+      end
+
+      def escape_quotes(str)
+        str.gsub("'", "\\\\'")
+      end
 
-          clear_text_in(options)
+      # Sets the selection of the currently focused view.
+      #
+      # @param [Integer] selection_start The start of the selection, can be
+      #  negative to begin counting from the end of the string.
+      # @param [Integer] selection_end The end of the selection, can be
+      #  negative to begin counting from the end of the string.
+      def set_selection(selection_start, selection_end)
+        perform_action("set_selection", selection_start, selection_end)
+      end
+
+      def keyboard_visible?
+        input_method = `#{default_device.adb_command} shell dumpsys input_method`.force_encoding('UTF-8')
+        shown = input_method.each_line.grep(/mInputShown\s*=\s*(.*)/){$1}.first.chomp
+
+        if shown == "true"
+          true
+        elsif shown == "false"
+          false
         else
-          perform_action('clear_text')
+          raise "Could not detect keyboard visibility. '#{shown}'"
         end
       end
 
-      def escape_quotes(str)
-        str.gsub("'", "\\\\'")
+      def wait_for_keyboard(opt={})
+        params = opt.clone
+        params[:timeout_message] ||= "Timed out waiting for the keyboard to appear"
+        params[:timeout] ||= 5
+
+        wait_for(params) do
+          keyboard_visible?
+        end
       end
     end
   end
-end
+end