calabash 1.9.9.pre3 → 2.0.0.prelegacy

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c93bdf73649617b8de5fe8e2e34fcf03a2f31f2e
-  data.tar.gz: 187f1e60ca6bf8005efa47ee03a9f6896c169599
+  metadata.gz: c9918df9dac58e62b8dd1f98df5e15bc1397e45c
+  data.tar.gz: da8b89437c9d0081fd3e95ea87f6f9fdb622a816
 SHA512:
-  metadata.gz: de02fd0467b70c2836fcca4859b803537365bf69ef6ae9c7f70f7f153ee877ecbaa1ec69a5941de2ba816874e9b9ad131af9b79642aef88c17a505d73df15af0
-  data.tar.gz: cd2a3b11e0ce8dcbc31236346f483440cfd61cdb00b12124ccf9c8922ee0373f5f940d2ea3e902308fca6f47c4bb8405816d5b9c238a2ac3c5ab6ad67e38c438
+  metadata.gz: dbf27f752dabd23e53ed70a7562314d6affe0cb14e770d46e97d1c59c4c5836f58c26cdb75cb23ebd38ce50a3e662e9aac7edb6a334dd764169d49d0f80ad0db
+  data.tar.gz: fd52b4f6b2d24111cf62d015a833d9eded491b5dd926fa72c114eaf7a2c83598865803e7ddaa960a164db0fd42115c786f862765c3039071ad2a8852c9bb6aee

data/README.md

@@ -6,18 +6,6 @@
 
 Automated Acceptance Testing for Mobile Apps
 
-## Initial workflow
-
-**TL;DR**
-
-```
-$ cd calabash
-$ ./copy_repos.sh
-$ ./changing_old_files.sh
-```
-
-Before Calabash is ready to be released, the old gems will exist outside version control. To make a change run the script `copy_repos.sh`. This will copy the Android and iOS repositories and extract them as files in the directory `old`. Then execute `changing_old_files.sh`. This script will move old files into their new directories. To make changes to "old files" e.g. move them, add your steps to `changing_old_files.sh` and execute it. To make code changes to old files, change them locally first to ensure they work. Then copy the change to the branch `united` on either iOS or Android. Commit the changes and push them upstream. `copy_repos.sh` will always download the newest files.
-
 ## Rake
 
 **TODO** Release instructions for Android and iOS.
@@ -27,8 +15,6 @@ $ rake -T
 rake android:build     # Build the Android test server
 rake build             # Build calabash-1.9.9.pre2.gem into the pkg directory
 rake ctags             # Generate ctags in ./git/tags
-rake cucumber:android  # Run Android cucumber tests
-rake cucumber:ios      # Run iOS cucumber tests
 rake install           # Build and install calabash-1.9.9.pre2.gem into system gems
 rake release           # Create tag v1.9.9.pre2 and build and push calabash-1.9.9.pre2.gem to Rubygems
 rake spec              # Run RSpec code examples
@@ -47,30 +33,21 @@ $ be rake spec # All tests.  Launches iOS Simulators, etc.
 $ be guard     # Run unit tests as you develop.
 ```
 
-### Cucumber iOS
+### Cucumber Android
+
+**NOTE** If you find you cannot launch on Android, be sure you run the
+`copy\_repos` and `changing\_old\_files.sh` script.
 
 ```
-$ cd cucumber/ios
 $ bundle update
-$ rake ensure_app  # Optional. See note below.
+$ rake android:build
+$ cd cucumber/android
+$ be calabash resign ../../spec/resources/android/xtc-android-sample.apk
+$ be calabash build ../../spec/resources/android/xtc-android-sample.apk
 $ be cucumber
 ```
 
-The rake task `ensure_app` checks the `cucumber/ios` directory for
-CalSmoke-cal.app. If it exists, it will do nothing.  If it does not exist,
-it will pull the latest sources from the CalSmoke repo, build the
-CalSmoke-cal.app from the master branch, and install it in the
-`cucumber/ios` directory.
-
-If you want to use a different CalSmoke-cal.app, drop it into `cucumber/ios`
-or call cucumber with `CAL\_APP` set.
-
-```
-$ CAL_APP=/path/to/your/CalSmoke-cal.app be cucumber
-```
-
-The rake task `ensure_ipa` does the same thing, but for the CalSmoke-cal.ipa.
+### Cucumber iOS
 
-Testing against physical devices requires that you have ideviceinstaller
-installed in /usr/local/bin/ideviceinstaller.
+See `cucumber/ios/README.md`.
 

data/bin/calabash

@@ -47,49 +47,58 @@ module Calabash
       def parse_arguments!
         argument = @arguments.shift
 
-        case argument
-          when '-v', '--verbose'
-            @options[:verbose] = true
-            Logger.log_levels += [:debug]
-            parse_arguments!
-          when '--platform'
-            platform = @arguments.shift.downcase
+        begin
+          case argument
+            when '-v', '--verbose'
+              @options[:verbose] = true
+              Logger.log_levels += [:debug]
+              parse_arguments!
+            when '--platform'
+              platform = @arguments.shift.downcase
 
-            fail("Invalid specified platform '#{platform}'") unless platform == 'android' || platform == 'ios'
+              fail("Invalid specified platform '#{platform}'") unless platform == 'android' || platform == 'ios'
 
-            set_platform!(platform.to_sym)
+              set_platform!(platform.to_sym)
 
-            parse_arguments!
-          when 'version'
-            puts Calabash::VERSION
-          when 'build'
-            parse_build_arguments!
-          when 'resign'
-            parse_resign_arguments!
-          when 'console'
-            parse_console_arguments!
-          when 'generate'
-            parse_generate_arguments!
-          when 'run'
-            parse_run_arguments!
-          when 'setup-keystore'
-            parse_setup_keystore_arguments!
-          when 'help'
-            argument = @arguments.shift
+              parse_arguments!
+            when 'version'
+              puts Calabash::VERSION
+            when 'build'
+              parse_build_arguments!
+            when 'resign'
+              parse_resign_arguments!
+            when 'console'
+              parse_console_arguments!
+            when 'generate'
+              parse_generate_arguments!
+            when 'run'
+              parse_run_arguments!
+            when 'setup-keystore'
+              parse_setup_keystore_arguments!
+            when 'help'
+              argument = @arguments.shift
 
-            if argument.nil?
-              print_usage
-            else
-              if key_for_command(argument)
-                print_usage_for(key_for_command(argument))
+              if argument.nil?
+                print_usage
               else
-                fail("No such command '#{argument}'")
+                if key_for_command(argument)
+                  print_usage_for(key_for_command(argument))
+                else
+                  fail("No such command '#{argument}'")
+                end
               end
-            end
-          when nil
-            print_usage
+            when nil
+              print_usage
+            else
+              fail("Invalid command #{argument}.\n  For help use 'calabash help'")
+          end
+        rescue => e
+          if Logger.log_levels.include?(:debug)
+            raise e
           else
-            fail("Invalid command #{argument}.\n  For help use 'calabash help'")
+            puts "#{Color.red(e.message)}"
+            exit 1
+          end
         end
       end
     end

data/lib/calabash.rb

@@ -25,6 +25,7 @@ module Calabash
   require 'calabash/text'
   require 'calabash/interactions'
   require 'calabash/defaults'
+  require 'calabash/legacy'
   require 'calabash/console_helpers'
 
 
@@ -45,22 +46,58 @@ module Calabash
 
   require 'calabash/page'
 
-  # Instantiate a page object.
+  # Instantiate a page object for the current platform.
+  #
+  # @note Your pages **must** be in the scope of either Android or IOS. See the
+  #  examples for details.
   #
   # @example
-  #  # android/pages/login_page.rb
-  #  class Android::LoginPage < Calabash::Page
+  #  # android/pages/my_page.rb
+  #  class Android::MyPage < Calabash::Page
   #    include Calabash::Android
   #
-  #    [...]
+  #    # [...]
   #  end
   #
   #  # step definition
-  #  Given([...]) do
+  #  Given(/[...]/) do
   #    # Calabash will determine your platform and pick the Android page.
-  #    page(LoginPage).method
+  #    page(MyPage).method
+  #  end
+  #
+  # @example
+  #  # This example shows page code sharing across iOS and Android
+  #  # Please see the sample 'shared-page-logic' for details.
+  #  # pages/abstract_login_page.rb
+  #  class AbstractLoginPage < Calabash::Page
+  #    def login(username, password)
+  #     enter_text_in(username_field, username)
+  #     # [...]
+  #    end
+  #
+  #    private
+  #
+  #    def username_field
+  #      abstract_method!
+  #    end
+  #  end
+  #
+  #  # pages/android_login_page.rb
+  #  class Android::LoginPage < SharedLoginPage
+  #    include Calabash::Android
+  #
+  #    private
+  #
+  #    def username_field
+  #      "* marked:'a_username'"
+  #    end
+  #
+  #    # [...]
   #  end
   #
+  #
+  # @see #android?
+  # @see #ios?
   # @param [Class] page_class The page to instantiate
   # @return [Calabash::Page] An instance of the page class
   def page(page_class)
@@ -76,12 +113,24 @@ module Calabash
       raise ArgumentError, "Expected a 'Class', got '#{page_class.class}'"
     end
 
-    page_name = page_class.name.split('::').last
+    page_name = page_class.name
+    full_page_name = "#{platform_module}::#{page_name}"
 
-    if platform_module.const_defined?(page_name, false)
+    if Calabash.is_defined?(full_page_name)
       page_class = platform_module.const_get(page_name, false)
 
       if page_class.is_a?(Class)
+        modules = page_class.included_modules.map(&:to_s)
+
+        unless modules.include?("Calabash::#{platform_module}")
+          raise "Page '#{page_class}' does not include Calabash::#{platform_module}"
+        end
+
+        if modules.include?('Calabash::Android') &&
+            modules.include?('Calabash::IOS')
+          raise "Page '#{page_class}' includes both Calabash::Android and Calabash::IOS"
+        end
+
         page = page_class.send(:new, self)
 
         if page.is_a?(Calabash::Page)
@@ -93,18 +142,26 @@ module Calabash
         raise "Page '#{page_class}' is not a class"
       end
     else
-      raise "No such page defined '#{platform_module}::#{page_name}'"
+      raise "No such page defined '#{full_page_name}'"
     end
   end
 
-  # Is the app under test running on Android?
+  # Is the device under test running Android?
+  #
+  # @return [Boolean] Returns true if
+  #  {Calabash::Defaults#default_device Calabash.default_device} is an instance
+  #  of {Calabash::Android::Device}.
   def android?
-    Android.const_defined?(:Device) && Device.default.is_a?(Android::Device)
+    Android.const_defined?(:Device, false) && Device.default.is_a?(Android::Device)
   end
 
-  # Is the app under test running on iOS?
+  # Is the device under test running iOS?
+  #
+  # @return [Boolean] Returns true if
+  #  {Calabash::Defaults#default_device Calabash.default_device} is an instance
+  #  of {Calabash::IOS::Device}.
   def ios?
-    IOS.const_defined?(:Device) && Device.default.is_a?(IOS::Device)
+    IOS.const_defined?(:Device, false) && Device.default.is_a?(IOS::Device)
   end
 
   # @!visibility private
@@ -159,6 +216,29 @@ module Calabash
     end
   end
 
+  # @!visibility private
+  def self.is_defined?(string, scope = Object)
+    constant, rest = string.split('::', 2)
+
+    begin
+      scope.const_defined?(constant.to_sym, false) &&
+          (!rest || is_defined?(rest, scope.const_get(constant, false)))
+    rescue NameError => _
+      false
+    end
+  end
+
+  # @!visibility private
+  def self.recursive_const_get(string, scope = Object)
+    constant, rest = string.split('::', 2)
+
+    if rest
+      recursive_const_get(rest, scope.const_get(constant.to_sym, false))
+    else
+      scope.const_get(constant.to_sym, false)
+    end
+  end
+
   # @!visibility private
   def self.on_cucumber_context(base)
     on_new_context(base)
@@ -172,6 +252,7 @@ module Calabash
       @@has_set_embedding_context
     end
 
+    # @!visibility private
     def self.new_embed_method(method)
       define_method(:embed) do |*args|
         method.call(*args)
@@ -180,6 +261,7 @@ module Calabash
       @@has_set_embedding_context = true
     end
 
+    # @!visibility private
     def embed(*_)
       Logger.warn 'Embed is not available in this context. Will not embed.'
     end
@@ -193,3 +275,45 @@ end
 unless Object.const_defined?(:IOS)
   Object.const_set(:IOS, Module.new)
 end
+
+if Calabash::Environment::DEBUG_CALLED_METHODS
+  $stdout.puts "#{Calabash::Color.red('Will print every Calabash method called!')}"
+  $stdout.puts "#{Calabash::Color.red('Warning: This might slow down your test drastically')}"
+  $stdout.puts "#{Calabash::Color.red('and is an experimental feature.')}"
+
+  calabash_file = Calabash.method(:extended).source_location.first
+  $__calabash_dir_name = File.dirname(calabash_file)
+
+  trace_func = lambda do |event, file, line, id, binding, classname|
+    if event == 'call'
+      if classname.to_s.split('::').first == 'Calabash'
+        binding_caller_locations = binding.eval('caller_locations')
+        files = binding_caller_locations[3..-1].map(&:path)
+
+        calabash_not_in_stacktrace = files.none? do |file|
+          file.start_with?($__calabash_dir_name) &&
+              File.basename(file) != 'page.rb'
+        end
+
+        if calabash_not_in_stacktrace
+          unless id == :included || id == :extended || id == :inherited
+            arguments = {}
+
+            binding.eval('local_variables').each do |variable|
+              arguments[variable] = binding.eval(variable.to_s)
+            end
+
+            # The arguments will be in order
+            if arguments.empty?
+              $stdout.puts "Calabash method called: #{id}"
+            else
+              $stdout.puts "Calabash method called: #{id}(#{arguments.values.map(&:inspect).join(', ')})"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  set_trace_func(trace_func)
+end

data/lib/calabash/android.rb

@@ -1,8 +1,11 @@
 module Calabash
   # Contains the Android implementations of the Calabash APIs.
   module Android
+    # @!visibility private
     TEST_SERVER_CODE_PATH = File.join(File.dirname(__FILE__), '..', '..', 'android', 'test-server')
+    # @!visibility private
     UNSIGNED_TEST_SERVER_APK = File.join(File.dirname(__FILE__), 'android', 'lib', 'TestServer.apk')
+    # @!visibility private
     ANDROID_MANIFEST_PATH = File.join(File.dirname(__FILE__), 'android', 'lib', 'AndroidManifest.xml')
 
     require 'calabash'
@@ -35,6 +38,8 @@ module Calabash
     require 'calabash/android/text'
     require 'calabash/android/console_helpers'
     require 'calabash/android/life_cycle'
+    require 'calabash/android/scroll'
+    require 'calabash/android/legacy'
 
     include Calabash::Android::Gestures
     include Calabash::Android::Interactions
@@ -42,6 +47,7 @@ module Calabash
     include Calabash::Android::Orientation
     include Calabash::Android::PhysicalButtons
     include Calabash::Android::Text
+    include Calabash::Android::Scroll
 
     # @!visibility private
     def self.binary_location(name, abi, using_pie)

data/lib/calabash/android/adb.rb

@@ -17,8 +17,10 @@ module Calabash
         end
       end
 
+      # @!visibility private
       PROCESS_WAIT_TIME = 10
 
+      # @!visibility private
       def self.open_pipe_with_timeout(timeout, *cmd, &block)
         begin
           i, o, e, t, pid = nil
@@ -52,6 +54,7 @@ module Calabash
         end
       end
 
+      # @!visibility private
       def self.open_adb_pipe(*cmd, **options, &block)
         timeout = options.fetch(:timeout, PROCESS_WAIT_TIME)
 
@@ -60,11 +63,23 @@ module Calabash
         end
       end
 
+      # @!visibility private
       DAEMON_STARTED_MESSAGE = "* daemon not running. starting it now on port 5037 *\n* daemon started successfully *\n"
 
       def self.command(*cmd, **args)
         Logger.debug("ADB Command: #{cmd.join(', ')}")
         Logger.debug("ADB input: #{args[:input]}")
+
+        cmd_s = "#{Environment.adb_path} #{cmd.join(' ')}"
+
+        Logger.debug("Going to execute: #{cmd_s}")
+        `#{cmd_s}`
+      end
+
+      # @!visibility private
+      def self.old_command(*cmd, **args)
+        Logger.debug("ADB Command: #{cmd.join(', ')}")
+        Logger.debug("ADB input: #{args[:input]}")
         stderr = nil
         stdout = nil
         exit_code = nil
@@ -121,10 +136,12 @@ module Calabash
 
       attr_reader :serial
 
+      # @!visibility private
       def initialize(serial)
         @serial = serial
       end
 
+      # @!visibility private
       def command(*argv, **args)
         cmd = argv.dup
 
@@ -135,9 +152,16 @@ module Calabash
         ADB.command(*cmd, args)
       end
 
+      # @!visibility private
+      def shell(shell_cmd, options={})
+        command('shell', shell_cmd)
+      end
+
+      # @!visibility private
       END_STRING = '__CAL_END__'
 
-      def shell(shell_cmd, options={})
+      # @!visibility private
+      def old_shell(shell_cmd, options={})
         if shell_cmd.nil? || shell_cmd.empty?
           raise ArgumentError, "Invalid shell command '#{shell_cmd}'"
         end