appium_instrumenter 0.1.0

data/lib/appium_instrumenter/environment.rb

@@ -0,0 +1,123 @@
+module Calabash
+  module Android
+    # @!visibility private
+    class Environment
+      # @!visibility private
+      class InvalidEnvironmentError < RuntimeError; end
+      # @!visibility private
+      class InvalidJavaSDKHome < RuntimeError; end
+
+    # @!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/appium_instrumenter/helpers.rb

@@ -0,0 +1,220 @@
+require "stringio"
+require 'zip'
+require 'tempfile'
+require 'escape'
+require 'rbconfig'
+require_relative 'utils'
+require_relative 'dependencies'
+require_relative 'environment'
+
+def package_name(app)
+  unless File.exist?(app)
+    raise "Application '#{app}' does not exist"
+  end
+
+  package_line = aapt_dump(app, "package").first
+  raise "'package' not found in aapt output" unless package_line
+  m = package_line.match(/name='([^']+)'/)
+  raise "Unexpected output from aapt: #{package_line}" unless m
+  m[1]
+end
+
+def main_activity(app)
+  unless File.exist?(app)
+    raise "Application '#{app}' does not exist"
+  end
+
+  begin
+    log("Trying to find launchable activity")
+    launchable_activity_line = aapt_dump(app, "launchable-activity").first
+    raise "'launchable-activity' not found in aapt output" unless launchable_activity_line
+    m = launchable_activity_line.match(/name='([^']+)'/)
+    raise "Unexpected output from aapt: #{launchable_activity_line}" unless m
+    log("Found launchable activity '#{m[1]}'")
+    m[1]
+  rescue => e
+    log("Could not find launchable activity, trying to parse raw AndroidManifest. #{e.message}")
+
+    manifest_data = `"#{Calabash::Android::Dependencies.aapt_path}" dump xmltree "#{app}" AndroidManifest.xml`
+    regex = /^\s*A:[\s*]android:name\(\w+\)\=\"android.intent.category.LAUNCHER\"/
+    lines = manifest_data.lines.collect(&:strip)
+    indicator_line = nil
+
+    lines.each_with_index do |line, index|
+      match = line.match(regex)
+
+      unless match.nil?
+        raise 'More than one launchable activity in AndroidManifest' unless indicator_line.nil?
+        indicator_line = index
+      end
+    end
+
+    raise 'No launchable activity found in AndroidManifest' unless indicator_line
+
+    intent_filter_found = false
+
+    (0..indicator_line).reverse_each do |index|
+      if intent_filter_found
+        match = lines[index].match(/\s*E:\s*activity-alias/)
+
+        raise 'Could not find target activity in activity alias' if match
+
+        match = lines[index].match(/^\s*A:\s*android:targetActivity\(\w*\)\=\"([^\"]+)/){$1}
+
+        if match
+          log("Found launchable activity '#{match}'")
+
+          return match
+        end
+      else
+        unless lines[index].match(/\s*E: intent-filter/).nil?
+          log("Read intent filter")
+          intent_filter_found = true
+        end
+      end
+    end
+
+    raise 'Could not find launchable activity'
+  end
+end
+
+def aapt_dump(app, key)
+  lines = `"#{Calabash::Android::Dependencies.aapt_path}" dump badging "#{app}"`.lines.collect(&:strip)
+  lines.select { |l| l.start_with?("#{key}:") }
+end
+
+def checksum(file_path)
+  require 'digest/md5'
+  Digest::MD5.file(file_path).hexdigest
+end
+
+def test_server_path(apk_file_path)
+  "test_servers/#{checksum(apk_file_path)}_#{Calabash::Android::VERSION}.apk"
+end
+
+def build_test_server_if_needed(app_path)
+  unless File.exist?(test_server_path(app_path))
+    if ARGV.include? "--no-build"
+      puts "No test server found for this combination of app and calabash version. Exiting!"
+      exit 1
+    else
+      puts "No test server found for this combination of app and calabash version. Recreating test server."
+      require 'calabash-android/operations'
+      require File.join(File.dirname(__FILE__), '..', '..', 'bin', 'calabash-android-build')
+      calabash_build(app_path)
+    end
+  end
+end
+
+def resign_apk(app_path)
+  Dir.mktmpdir do |tmp_dir|
+    log "Resign apk"
+    unsigned_path = File.join(tmp_dir, 'unsigned.apk')
+    unaligned_path = File.join(tmp_dir, 'unaligned.apk')
+    FileUtils.cp(app_path, unsigned_path)
+    unsign_apk(unsigned_path)
+    sign_apk(unsigned_path, unaligned_path)
+    zipalign_apk(unaligned_path, app_path)
+  end
+end
+
+def unsign_apk(path)
+  meta_files = `"#{Calabash::Android::Dependencies.aapt_path}" list "#{path}"`.lines.collect(&:strip).grep(/^META-INF\//)
+
+  signing_file_names = ['.mf', '.rsa', '.dsa', '.ec', '.sf']
+
+  files_to_remove = meta_files.select do |file|
+    # other will be:
+    # META-INF/foo/bar
+    #  other #=> bar
+    directory, file_name, other = file.split('/')
+
+    if other != nil || file_name.nil?
+      false
+    else
+      if signing_file_names.include?(File.extname(file_name).downcase)
+        true
+      end
+    end
+  end
+
+  if files_to_remove.empty?
+    log "App wasn't signed. Will not try to unsign it."
+  else
+    system("\"#{Calabash::Android::Dependencies.aapt_path}\" remove \"#{path}\" #{files_to_remove.join(" ")}")
+  end
+end
+
+def zipalign_apk(inpath, outpath)
+  cmd = %Q("#{Calabash::Android::Dependencies.zipalign_path}" -f 4 "#{inpath}" "#{outpath}")
+  log "Zipaligning using: #{cmd}"
+  system(cmd)
+end
+
+def sign_apk(app_path, dest_path)
+  java_keystore = JavaKeystore.get_keystores.first
+
+  if java_keystore.nil?
+    raise 'No keystores found. You can specify the keystore location and credentials using calabash-android setup'
+  end
+
+  java_keystore.sign_apk(app_path, dest_path)
+end
+
+def fingerprint_from_apk(app_path)
+  app_path = File.expand_path(app_path)
+  Dir.mktmpdir do |tmp_dir|
+    Dir.chdir(tmp_dir) do
+      FileUtils.cp(app_path, "app.apk")
+      FileUtils.mkdir("META-INF")
+
+      Calabash::Utils.with_silent_zip do
+        Zip::File.foreach("app.apk") do |z|
+          z.extract if /^META-INF\/\w+.(rsa|dsa)/i =~ z.name
+        end
+      end
+
+      signature_files = Dir["#{tmp_dir}/META-INF/*"]
+
+      log 'Signature files:'
+
+      signature_files.each do |signature_file|
+        log signature_file
+      end
+
+      raise "No signature files found in META-INF. Cannot proceed." if signature_files.empty?
+      raise "More than one signature file (DSA or RSA) found in META-INF. Cannot proceed." if signature_files.length > 1
+
+      cmd = "\"#{Calabash::Android::Dependencies.keytool_path}\" -v -printcert -J\"-Dfile.encoding=utf-8\" -file \"#{signature_files.first}\""
+      log cmd
+      fingerprints = `#{cmd}`
+      md5_fingerprint = extract_sha1_fingerprint(fingerprints)
+      log "SHA1 fingerprint for signing cert (#{app_path}): #{md5_fingerprint}"
+      md5_fingerprint
+    end
+  end
+end
+
+def extract_md5_fingerprint(fingerprints)
+  m = fingerprints.scan(/MD5.*((?:[a-fA-F\d]{2}:){15}[a-fA-F\d]{2})/).flatten
+  raise "No MD5 fingerprint found:\n #{fingerprints}" if m.empty?
+  m.first
+end
+
+def extract_sha1_fingerprint(fingerprints)
+  m = fingerprints.scan(/SHA1.*((?:[a-fA-F\d]{2}:){15}[a-fA-F\d]{2})/).flatten
+  raise "No SHA1 fingerprint found:\n #{fingerprints}" if m.empty?
+  m.first
+end
+
+def extract_signature_algorithm_name(fingerprints)
+  m = fingerprints.scan(/Signature algorithm name: (.*)/).flatten
+  raise "No signature algorithm names found:\n #{fingerprints}" if m.empty?
+  m.first
+end
+
+def log(message, error = false)
+  if error or ARGV.include? "-v" or ARGV.include? "--verbose" or ENV["DEBUG"] == "1"
+    $stdout.puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} - #{message}"
+  end
+end

data/lib/appium_instrumenter/java_keystore.rb

@@ -0,0 +1,125 @@
+require 'json'
+class JavaKeystore
+  attr_reader :errors, :location, :keystore_alias, :password, :fingerprint
+  attr_reader :signature_algorithm_name
+
+  def initialize(location, keystore_alias, password)
+    raise "No such keystore file '#{location}'" unless File.exists?(File.expand_path(location))
+    log "Reading keystore data from keystore file '#{File.expand_path(location)}'"
+
+    keystore_data = system_with_stdout_on_success(Calabash::Android::Dependencies.keytool_path, '-list', '-v', '-alias', keystore_alias, '-keystore', location, '-storepass', password, '-J"-Dfile.encoding=utf-8"', '-J"-Duser.language=en-US"')
+
+    if keystore_data.nil?
+      if keystore_alias.empty?
+        log "Could not obtain keystore data. Will try to extract alias automatically"
+
+        keystore_data = system_with_stdout_on_success(Calabash::Android::Dependencies.keytool_path, '-list', '-v', '-keystore', location, '-storepass', password, '-J"-Dfile.encoding=utf-8"', '-J"-Duser.language=en-US"')
+        aliases = keystore_data.scan(/Alias name\:\s*(.*)/).flatten
+
+        if aliases.length == 0
+          raise 'Could not extract alias automatically. Please specify alias using calabash-android setup'
+        elsif aliases.length > 1
+          raise 'Multiple aliases found in keystore. Please specify alias using calabash-android setup'
+        else
+          keystore_alias = aliases.first
+          log "Extracted keystore alias '#{keystore_alias}'. Continuing"
+
+          return initialize(location, keystore_alias, password)
+        end
+      else
+        error = "Could not list certificates in keystore. Probably because the password was incorrect."
+        @errors = [{:message => error}]
+        log error
+        raise error
+      end
+    end
+
+    @location = location
+    @keystore_alias = keystore_alias
+    @password = password
+    log "Key store data:"
+    log keystore_data
+    @fingerprint = extract_sha1_fingerprint(keystore_data)
+    @signature_algorithm_name = extract_signature_algorithm_name(keystore_data)
+    log "Fingerprint: #{fingerprint}"
+    log "Signature algorithm name: #{signature_algorithm_name}"
+  end
+
+  def sign_apk(apk_path, dest_path)
+    raise "Cannot sign with a miss configured keystore" if errors
+    raise "No such file: #{apk_path}" unless File.exists?(apk_path)
+
+    # E.g. MD5withRSA or MD5withRSAandMGF1
+    encryption = signature_algorithm_name.split('with')[1].split('and')[0]
+    signing_algorithm = "SHA1with#{encryption}"
+    digest_algorithm = 'SHA1'
+
+    log "Signing using the signature algorithm: '#{signing_algorithm}'"
+    log "Signing using the digest algorithm: '#{digest_algorithm}'"
+
+    unless system_with_stdout_on_success(Calabash::Android::Dependencies.jarsigner_path, '-sigfile', 'CERT', '-sigalg', signing_algorithm, '-digestalg', digest_algorithm, '-signedjar', dest_path, '-storepass', password, '-keystore',  location, apk_path, keystore_alias)
+      raise "Could not sign app: #{apk_path}"
+    end
+  end
+
+  def system_with_stdout_on_success(cmd, *args)
+    a = Escape.shell_command(args)
+    cmd = "\"#{cmd}\" #{a.gsub("'", '"')}"
+    log cmd
+    out = `#{cmd}`
+    if $?.exitstatus == 0
+      out
+    else
+      nil
+    end
+  end
+
+  def self.read_keystore_with_default_password_and_alias(path)
+    path = File.expand_path path
+
+    if File.exists? path
+      keystore = JavaKeystore.new(path, 'androiddebugkey', 'android')
+      if keystore.errors
+        log "Trying to "
+        nil
+      else
+        log "Unlocked keystore at #{path} - fingerprint: #{keystore.fingerprint}"
+        keystore
+      end
+    else
+      log "Trying to read keystore from: #{path} - no such file"
+      nil
+    end
+  end
+
+  def self.get_keystores
+    if keystore = keystore_from_settings
+      p "found calabash_settings file"
+      [ keystore ]
+    else
+      [
+        read_keystore_with_default_password_and_alias(File.join(ENV["HOME"], "/.android/debug.keystore")),
+        read_keystore_with_default_password_and_alias("debug.keystore"),
+        read_keystore_with_default_password_and_alias(File.join(ENV["HOME"], ".local/share/Xamarin/Mono\\ for\\ Android/debug.keystore")),
+        read_keystore_with_default_password_and_alias(File.join(ENV["HOME"], "AppData/Local/Xamarin/Mono for Android/debug.keystore")),
+      ].compact
+    end
+  end
+
+  def self.keystore_from_settings
+      keystore = JSON.parse(IO.read(".calabash_settings")) if File.exist? ".calabash_settings"
+      keystore = JSON.parse(IO.read("calabash_settings")) if File.exist? "calabash_settings"
+      return unless keystore
+      fail_if_key_missing(keystore, "keystore_location")
+      fail_if_key_missing(keystore, "keystore_password")
+      fail_if_key_missing(keystore, "keystore_alias")
+      keystore["keystore_location"] = File.expand_path(keystore["keystore_location"])
+      log("Keystore location specified in #{File.exist?(".calabash_settings") ? ".calabash_settings" : "calabash_settings"}.")
+      JavaKeystore.new(keystore["keystore_location"], keystore["keystore_alias"], keystore["keystore_password"])
+  end
+
+  def self.fail_if_key_missing(map, key)
+    raise "Found .calabash_settings but no #{key} defined." unless map[key]
+  end
+
+end