calabash-android 0.1.0 → 0.2.0.pre2

data/CHANGES.txt

@@ -1,3 +1,13 @@
+0.2.0.pre2:
+      A HTTP server has been introduced in the test server so that we no 
+      longer use socket for communication.
+
+0.2.0.pre1:
+      The concept of a Device has been introduced. It will handle all setup
+      and communication with physical devices or emulators.
+      The device class is needed because we want to interact with more than
+      one device at the same time from Calabash.
+
 0.1.0:
       Added support for testing Xamarin Mono for Android apps.
       Currently only Release builds are supported.

data/bin/calabash-android

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'fileutils'
+require 'calabash-android/helpers'
+
 
 require File.join(File.dirname(__FILE__), "calabash-android-helpers")
 require File.join(File.dirname(__FILE__), "calabash-android-generate")
@@ -14,6 +16,14 @@ require File.join(File.dirname(__FILE__), "calabash-android-submit")
 @source_dir = File.join(File.dirname(__FILE__), '..', 'features-skeleton')
 @script_dir = File.join(File.dirname(__FILE__), '..', 'scripts')
 
+def is_apk_file?(file_path)
+  file_path.end_with? ".apk" and File.exist? file_path
+end
+
+def relative_to_full_path(file_path)
+  File.expand_path(File.join(ENV["PWD"], file_path))
+end
+
 if (ARGV.length == 0)
   print_usage
   exit 0
@@ -23,10 +33,17 @@ if cmd == 'help'
   print_help
   exit 0
 elsif cmd == 'build'
-  calabash_build(ARGV)
+  puts "Please specify the app you want to test" if (ARGV.empty? or not is_apk_file?(ARGV.first))
+  while not ARGV.empty? and is_apk_file?(ARGV.first)
+    calabash_build(relative_to_full_path(ARGV.shift))
+  end
   exit 0
 elsif cmd == 'run'
-  calabash_run(ARGV)
+  if ARGV.empty? or not is_apk_file?(ARGV.first)
+    calabash_run(nil, ARGV)
+  else
+    calabash_run(ARGV.shift)
+  end
   exit 0
 elsif cmd == 'gen'
   calabash_scaffold

data/bin/calabash-android-build.rb

@@ -1,8 +1,10 @@
-def calabash_build(args)
-  run_setup_if_settings_does_not_exist
+def calabash_build(app)
 
-  @settings = JSON.parse(IO.read(".calabash_settings"))  
-    test_server_template_dir = File.join(File.dirname(__FILE__), '..', 'test-server')
+
+
+  keystore = read_keystore_info()
+
+  test_server_template_dir = File.join(File.dirname(__FILE__), '..', 'test-server')
   
   Dir.mktmpdir do |workspace_dir|
     
@@ -15,14 +17,14 @@ def calabash_build(args)
         ant_executable,
         "clean", 
         "package",
-        "-Dtested.package_name=#{@settings["package_name"]}",
-        "-Dtested.main_activity=#{@settings["activity_name"]}",
-        "-Dtested.project.apk=#{@settings["app_path"]}",
-        "-Dandroid.api.level=#{@settings["api_level"]}",
-        "-Dkey.store=#{@settings["keystore_location"]}",
-        "-Dkey.store.password=#{@settings["keystore_password"]}",
-        "-Dkey.alias=#{@settings["keystore_alias"]}",
-        "-Dkey.alias.password=#{@settings["keystore_alias_password"]}",
+        "-Dtested.package_name=#{package_name(app)}",
+        "-Dtested.main_activity=#{main_activity(app)}",
+        "-Dtested.project.apk=#{app}",
+        "-Dandroid.api.level=#{api_level}",
+        "-Dkey.store=#{keystore["keystore_location"]}",
+        "-Dkey.store.password=#{keystore["keystore_password"]}",
+        "-Dkey.alias=#{keystore["keystore_alias"]}",
+        "-Dkey.alias.password=#{keystore["keystore_alias_password"]}",
       ]
       STDOUT.sync = true
       IO.popen(args.join(" ")) do |io|
@@ -35,8 +37,22 @@ def calabash_build(args)
     }
 
     test_apk = File.join(@test_server_dir, "bin", "Test.apk")
-    FileUtils.cp(test_apk, File.join(@support_dir, "Test.apk"))
-    puts "Done building the test server. Moved it to features/support/Test.apk"
+    test_server_file_name = "#{checksum(app)}.apk"
+    FileUtils.cp(test_apk, File.join(@support_dir, test_server_file_name))
+    puts "Done building the test server. Moved it to features/support/#{test_server_file_name}"
+  end
+end
+
+def read_keystore_info
+  if File.exist? ".calabash_settings"
+    JSON.parse(IO.read(".calabash_settings"))
+  else
+    {
+    "keystore_location" => "#{ENV["HOME"]}/.android/debug.keystore",
+    "keystore_password" => "android",
+    "keystore_alias" => "androiddebugkey",
+    "keystore_alias_password" => "android"
+    }
   end
 end
 

data/bin/calabash-android-generate.rb

@@ -2,7 +2,6 @@
 def calabash_scaffold
   if File.exists?(@features_dir)
     puts "A features directory already exists. Stopping..."
-    #puts "Run calabash-android update for update instructions."
     exit 1
   end
   msg("Question") do

data/bin/calabash-android-helpers.rb

@@ -43,25 +43,10 @@ def print_help
   print_usage
 end
 
-
 def is_json?(str)
   str[0..0] == '{'
 end
 
-def run_build_if_test_server_does_not_exist
-  unless File.exists?(File.join(@support_dir, "Test.apk"))
-    puts "Could not find the test server"
-    puts "Should I run calabash-android build for you?"
-    puts "Please answer yes (y) or no (n)"
-    if ['yes', 'y'].include? STDIN.gets.chomp
-      calabash_build([])
-    else
-      puts "Please run: calabash-android build"
-      exit 1
-    end
-  end
-end
-
 def run_setup_if_settings_does_not_exist
   unless File.exists?(".calabash_settings")
     puts "Could not find .calabash_settings."

data/bin/calabash-android-run.rb

@@ -1,5 +1,4 @@
-def calabash_run(args)
-  run_build_if_test_server_does_not_exist
+def calabash_run(app_path)
 
   old_runner = "android.test.InstrumentationTestRunner"
   new_rummer = "sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner"
@@ -13,14 +12,17 @@ def calabash_run(args)
     exit
   end
 
-  settings = JSON.parse(IO.read(".calabash_settings"))
-  
-  env ="PACKAGE_NAME=#{settings["package_name"]} "\
-        "TEST_PACKAGE_NAME=#{settings["package_name"]}.test "\
-        "APP_PATH=#{settings["app_path"]} "\
-        "TEST_APP_PATH=features/support/Test.apk "\
-        "TEST_SERVER_PORT=34777"
-      
+  if app_path
+    test_server_path = "features/support/#{checksum(app_path)}.apk"
+    env = "PACKAGE_NAME=#{package_name(app_path)} "\
+          "TEST_PACKAGE_NAME=#{package_name(test_server_path)} "\
+          "APP_PATH=#{app_path} "\
+          "TEST_APP_PATH=#{test_server_path} "\
+          "TEST_SERVER_PORT=34777"
+  else
+    env = ""
+  end
+
   STDOUT.sync = true
   cmd = "cucumber -c #{ARGV.join(" ")} #{env}"
   puts cmd

data/features-skeleton/support/app_installation_hooks.rb

@@ -8,8 +8,9 @@ Before do |scenario|
   feature_name = scenario.feature.name
   if FeatureNameMemory.feature_name != feature_name
     log "Is first scenario - reinstalling apps"
-    uninstall_apps
+    uninstall_app(ENV["TEST_APP_PATH"])
     install_app(ENV["TEST_APP_PATH"])
+    uninstall_app(ENV["APP_PATH"])
     install_app(ENV["APP_PATH"])
     FeatureNameMemory.feature_name = feature_name
 	end

data/features-skeleton/support/app_life_cycle_hooks.rb

@@ -3,26 +3,5 @@ require 'calabash-android/management/adb'
 Before do |scenario|
 
   return if scenario.failed? #No need to start the server is anything before this has failed.
-  cmd = "#{adb_command} shell am instrument -w -e class sh.calaba.instrumentationbackend.InstrumentationBackend #{ENV['TEST_PACKAGE_NAME']}/sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner"
-  log "Starting test server using:"
-  log cmd
-  if is_windows?
-    system(%Q(start /MIN cmd /C #{cmd}))
-  else
-    `#{cmd} 1>&2 &`
-  end
-  
-  sleep 2
-  begin
-    connect_to_test_server
-    log "Connection established"
-  rescue Exception => e
-    log "Exception:#{e.backtrace}"
-  end
-end
-
-
-
-After do |scenario| 
-  disconnect_from_test_server
+  start_test_server_in_background
 end

data/lib/calabash-android/helpers.rb

@@ -0,0 +1,54 @@
+require 'rexml/document'
+require 'rexml/xpath'
+
+include REXML
+
+def package_name(app)
+  require 'rexml/document'
+  require 'rexml/xpath'
+
+  manifest = Document.new(manifest(app))
+  manifest.root.attributes['package']
+end
+  
+def main_activity(app)
+  manifest = Document.new(manifest(app))
+  main_activity = manifest.elements["//action[@name='android.intent.action.MAIN']/../.."].attributes['name']
+  #Handle situation where main activity is on the form '.class_name'
+  if main_activity.start_with? "."
+    main_activity = package_name(app) + main_activity
+  elsif not main_activity.include? "." #This is undocumentet behaviour but Android seems to accept shorthand naming that does not start with '.'
+    main_activity = "#{package_name(app)}.#{main_activity}"
+  end
+  main_activity
+end
+
+def api_level
+  api_levels = Dir["#{ENV["ANDROID_HOME"]}/platforms/android-*"].collect{|platform| platform.split("-").last.to_i}.sort
+  if api_levels.empty?
+    raise "Android SDK not found. Please install one of more using #{ENV["ANDROID_HOME"]}/tools/android"
+  end
+
+  api_levels = api_levels.find_all {|l| l > 7}
+  if api_levels.empty?
+    raise "Android SDK above 7 not found. Please install one of more using #{ENV["ANDROID_HOME"]}/tools/android"
+  end
+  api_levels.first
+end
+
+def manifest(app)
+  require 'tmpdir'
+  dir = Dir.mktmpdir
+  FileUtils.cp(app, File.join(dir, "app.apk"))
+
+  system "unzip -d #{dir} #{app} AndroidManifest.xml"
+
+  `java -jar #{File.dirname(__FILE__)}/lib/AXMLPrinter2.jar #{dir}/AndroidManifest.xml`
+end
+
+def checksum(file_path)
+  require 'digest/md5'
+  Digest::MD5.hexdigest(File.read(file_path))
+end
+
+

data/lib/calabash-android/management/adb.rb

@@ -1,11 +0,0 @@
-def adb_command
-  if is_windows?
-    %Q("#{ENV["ANDROID_HOME"]}\\platform-tools\\adb.exe" #{ENV["ADB_DEVICE_ARG"]})
-  else
-    %Q(#{ENV["ANDROID_HOME"]}/platform-tools/adb #{ENV["ADB_DEVICE_ARG"]})
-  end
-end
-
-def is_windows?
-   ENV["OS"] == "Windows_NT"
-end

data/lib/calabash-android/operations.rb

@@ -1,8 +1,10 @@
 require 'json'
+require 'net/http'
 require 'rubygems'
 require 'json'
 require 'socket'
 require 'timeout'
+require 'calabash-android/helpers'
 
 
 module Calabash module Android
@@ -15,19 +17,7 @@ module Operations
   end
 
   def take_screenshot
-    path = ENV["SCREENSHOT_PATH_PREFIX"] || "results"
-    FileUtils.mkdir_p path unless File.exist? path
-    filename_prefix = FeatureNameMemory.feature_name.gsub(/\s+/, '_').downcase
-    begin
-      Timeout.timeout(30) do
-        file_name = "#{path}/#{filename_prefix}_#{StepCounter.step_line}.png"
-        log "Taking screenshoot to #{file_name} from device: #{ENV['ADB_DEVICE_ARG']}"
-        system("java -jar #{File.dirname(__FILE__)}/lib/screenShotTaker.jar #{file_name} #{ENV['ADB_DEVICE_ARG']}")
-        log "Screenshot stored in: #{file_name}"
-      end
-    rescue Timeout::Error
-      raise Exception, "take_screenshot timed out"
-    end
+    Device.default_device.take_screenshot
   end
 
   def macro(txt)
@@ -39,31 +29,23 @@ module Operations
   end
 
   def performAction(action, *arguments)
-    log "Action: #{action} - Params: #{arguments.join(', ')}"
+    Device.default_device.perform_action(action, *arguments)
+  end
 
-    action = {"command" => action, "arguments" => arguments}
+  def install_app(app_path)
+    Device.default_device.install_app(app_path)
+  end
 
-    Timeout.timeout(300) do
-      begin
-        @@client.send(action.to_json + "\n", 0) #force_encoding('UTF-8') seems to be missing from JRuby
-        result = @@client.readline
-      rescue Exception => e
-        log "Error communicating with test server: #{e}"
-        raise e
-      end
-      log "Result:'" + result.strip + "'"
-      raise "Empty result from TestServer" if result.chomp.empty?
-      result = JSON.parse(result)
-      if not result["success"] then
-        take_screenshot
-        raise result["message"].to_s
-      end
-      return result
-    end
-  rescue Timeout::Error
-    raise Exception, "Step timed out"
+  def uninstall_apps
+    Device.default_device.uninstall_app(ENV["TEST_PACKAGE_NAME"])
+    Device.default_device.uninstall_app(ENV["PACKAGE_NAME"])
   end
 
+  def start_test_server_in_background
+    Device.default_device.start_test_server_in_background()
+  end
+
+
   def wait_for(timeout, &block)
     begin
       Timeout::timeout(timeout) do
@@ -93,16 +75,6 @@ module Operations
     raise "Not yet implemented."
   end
 
-
-  ##adb
-  def adb_command
-    if is_windows?
-      %Q("#{ENV["ANDROID_HOME"]}\\platform-tools\\adb.exe" #{ENV["ADB_DEVICE_ARG"]})
-    else
-      %Q(#{ENV["ANDROID_HOME"]}/platform-tools/adb #{ENV["ADB_DEVICE_ARG"]})
-    end
-  end
-
   def is_windows?
      ENV["OS"] == "Windows_NT"
   end
@@ -110,41 +82,179 @@ module Operations
 
   ### app life cycle
   def connect_to_test_server
-    log `#{adb_command} forward tcp:#{ENV["TEST_SERVER_PORT"]} tcp:7101`
-
-    end_time = Time.now + 60
-    begin
-      Timeout.timeout(10) do
-        @@client = TCPSocket.open('127.0.0.1',ENV["TEST_SERVER_PORT"])
-        @@client.send("Ping!\n",0)
-        log "Got '#{@@client.readline.strip}' from testserver"
-      end
-    rescue Exception => e
-      log "Got exception:#{e}. Retrying!"
-      sleep(1)
-      retry unless Time.now > end_time
-    end
+    puts "Explicit calls to connect_to_test_server should be removed."
+    puts "Please take a look in your hooks file for calls to this methods."
+    puts "(Hooks are stored in features/support)"
   end
 
   def disconnect_from_test_server
-    log "Closing connection to test"
-    @@client.close
+    puts "Explicit calls to disconnect_from_test_server should be removed."
+    puts "Please take a look in your hooks file for calls to this methods."
+    puts "(Hooks are stored in features/support)"
   end
 
+  class Device
+    @@default_device = nil
 
+    def self.default_device
+      unless @@default_device
+        @@default_device = Device.new(ENV["ADB_DEVICE_ARG"], ENV["TEST_SERVER_PORT"], ENV["APP_PATH"], ENV["TEST_APP_PATH"])
+      end
+      @@default_device
+    end
+
+    def make_default_device
+      @@default_device = self
+    end
 
-  ##location
-  def set_gps_coordinates_from_location(location)
-    require 'geocoder'
-    results = Geocoder.search(location)
-    raise Exception, "Got no results for #{location}" if results.empty?
+    def initialize(serial, server_port, app_path, test_server_path)
+      @serial = serial
+      @server_port = server_port
+      @app_path = app_path
+      @test_server_path = test_server_path
 
-    best_result = results.first
-    set_gps_coordinates(best_result.latitude, best_result.longitude)
-  end
+      puts "#{adb_command} forward tcp:b#{server_port} tcp:7102"
+      log `#{adb_command} forward tcp:#{server_port} tcp:7102`
+=begin
+      begin
+        Timeout::timeout(15) do
+          puts http("/ping")           
+        end
+      rescue Timeout::Error
+        msg = "Unable to make connection to Calabash Test Server at http://127.0.0.1:#{@server_port}/\n"
+        msg << "Please check the logcat output for more info about what happened\n"
+        raise msg
+      end
+=end
+    end
+
+    def reinstall_apps()
+      uninstall_app(package_name(@app_path))
+      install_app(@app_path)
+      uninstall_app(package_name(@test_server_path))
+      install_app(@test_server_path)
+    end
+
+    def install_app(app_path)
+      cmd = "#{adb_command} install #{app_path}"
+      log "Installing: #{app_path}"
+      result = `#{cmd}`
+      if result.include? "Success"
+        log "Success"
+      else
+        log "#Failure"
+        log "'#{cmd}' said:"
+        log result.strip
+        raise "Could not install app #{app_path}: #{result.strip}"
+      end
+    end
 
-  def set_gps_coordinates(latitude, longitude)
-    performAction('set_gps_coordinates', latitude, longitude)
+    def uninstall_app(package_name)
+      log "Uninstalling: #{package_name}"
+      log `#{adb_command} uninstall #{package_name}`
+    end
+
+    def perform_action(action, *arguments)
+      log "Action: #{action} - Params: #{arguments.join(', ')}"
+
+      params = {"command" => action, "arguments" => arguments}
+
+      Timeout.timeout(300) do
+        begin
+          result = http("/", params)
+        rescue Exception => e
+          log "Error communicating with test server: #{e}"
+          raise e
+        end
+        log "Result:'" + result.strip + "'"
+        raise "Empty result from TestServer" if result.chomp.empty?
+        result = JSON.parse(result)
+        if not result["success"] then
+          take_screenshot
+          raise result["message"].to_s
+        end
+        return result
+      end
+    rescue Timeout::Error
+      raise Exception, "Step timed out"
+    end
+
+    def http(path, data = {})
+      begin
+        http = Net::HTTP.new "127.0.0.1", @server_port
+        resp, data = http.post(path, "command=#{data.to_json}", {})
+        data
+      rescue EOFError
+        sleep 0.5
+        retry
+      end
+    end
+
+    def take_screenshot
+      path = ENV["SCREENSHOT_PATH_PREFIX"] || "results"
+      FileUtils.mkdir_p path unless File.exist? path
+      filename_prefix = FeatureNameMemory.feature_name.gsub(/\s+/, '_').downcase
+      begin
+        Timeout.timeout(30) do
+          file_name = "#{path}/#{filename_prefix}_#{StepCounter.step_line}.png"
+          log "Taking screenshoot to #{file_name} from device: #{@serial}"
+          system("java -jar #{File.dirname(__FILE__)}/lib/screenShotTaker.jar #{file_name} #{device_args}")
+          log "Screenshot stored in: #{file_name}"
+        end
+      rescue Timeout::Error
+        raise Exception, "take_screenshot timed out"
+      end
+    end
+
+    def adb_command
+      if is_windows?
+        %Q("#{ENV["ANDROID_HOME"]}\\platform-tools\\adb.exe" #{device_args})
+      else
+        %Q(#{ENV["ANDROID_HOME"]}/platform-tools/adb #{device_args})
+      end
+    end
+
+    def device_args
+      if @serial
+        "-s #{@serial}"
+      else
+        ""
+      end
+    end
+
+    def is_windows?
+      ENV["OS"] == "Windows_NT"
+    end
+
+    def start_test_server_in_background
+      test_server_package = package_name(@test_server_path)
+      cmd = "#{adb_command} shell am instrument -w -e class sh.calaba.instrumentationbackend.InstrumentationBackend #{test_server_package}/sh.calaba.instrumentationbackend.CalabashInstrumentationTestRunner"
+      log "Starting test server using:"
+      log cmd
+      if is_windows?
+        system(%Q(start /MIN cmd /C #{cmd}))
+      else
+        `#{cmd} 1>&2 &`
+      end
+    end
+
+    def log(message)
+      $stdout.puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} - #{message}" if (ARGV.include? "-v" or ARGV.include? "--verbose")
+    end
+
+    ##location
+    def set_gps_coordinates_from_location(location)
+      require 'geocoder'
+      results = Geocoder.search(location)
+      raise Exception, "Got no results for #{location}" if results.empty?
+
+      best_result = results.first
+      set_gps_coordinates(best_result.latitude, best_result.longitude)
+    end
+
+    def set_gps_coordinates(latitude, longitude)
+      perform_action('set_gps_coordinates', latitude, longitude)
+    end
   end
 
 
@@ -167,7 +277,6 @@ module Operations
     query(q).map {|e| e['html']}
   end
 
-
   def set_text(uiquery, txt)
     raise "Currently queries are only supported for webviews" unless uiquery.start_with? "webView"