calabash 1.2.1 → 1.9.9.pre1

data/lib/calabash/android/build.rb

@@ -0,0 +1,12 @@
+module Calabash
+  module Android
+    module Build
+      require 'calabash/android/build/application'
+      require 'calabash/android/build/build_error'
+      require 'calabash/android/build/builder'
+      require 'calabash/android/build/java_keystore'
+      require 'calabash/android/build/resigner'
+      require 'calabash/android/build/test_server'
+    end
+  end
+end

data/lib/calabash/android/build/application.rb

@@ -0,0 +1,13 @@
+module Calabash
+  module Android
+    # @!visibility private
+    module Build
+      # @!visibility private
+      class Application < Android::Application
+        def initialize(application_path, options = {})
+          super(application_path, nil, options)
+        end
+      end
+    end
+  end
+end

data/lib/calabash/android/build/build_error.rb

@@ -0,0 +1,11 @@
+module Calabash
+  module Android
+    # @!visibility private
+    module Build
+      # @!visibility private
+      class BuildError < RuntimeError
+
+      end
+    end
+  end
+end

data/lib/calabash/android/build/builder.rb

@@ -0,0 +1,119 @@
+require 'zip'
+
+module Calabash
+  module Android
+    module Build
+      # @!visibility private
+      class Builder
+        def initialize(application_path, options={})
+          @application_path = application_path
+
+          if options[:logger]
+            @logger = options[:logger] || Logger.new
+          else
+            @logger = Logger.new
+            @logger.default_log_level = :info
+          end
+        end
+
+        def build
+          apk_fingerprint = fingerprint_from_apk
+          @logger.log "#{@application_path} was signed with a certificate with fingerprint #{apk_fingerprint}", :debug
+
+          keystores = JavaKeystore.get_keystores
+          if keystores.empty?
+            @logger.log "No default keystores found."
+            @logger.log "Please create one or run calabash setup-keystore to configure calabash to use an existing keystore."
+
+            raise BuildError.new('No keystores found')
+          end
+          keystore = keystores.find { |k| k.fingerprint == apk_fingerprint}
+
+          unless keystore
+            @logger.log "#{@application_path} is not signed with any of the available keystores."
+            @logger.log "Tried the following keystores:"
+            keystores.each do |k|
+              @logger.log k.location
+            end
+            @logger.log ""
+            @logger.log "You can resign the app with #{keystores.first.location} by running:
+      calabash resign #{@application_path}"
+
+            @logger.log ""
+            @logger.log "Notice that resigning an app might break some functionality."
+            @logger.log "Getting a copy of the certificate used when the app was build will in general be more reliable."
+
+            raise BuildError.new("#{@application_path} is not signed with any of the available keystores")
+          end
+
+          application = Calabash::Application.from_path(@application_path)
+
+          test_server_file_name = TestServer.new(@application_path).path
+          FileUtils.mkdir_p File.dirname(test_server_file_name) unless File.exist? File.dirname(test_server_file_name)
+
+          Dir.mktmpdir do |workspace_dir|
+            Dir.chdir(workspace_dir) do
+              FileUtils.cp(UNSIGNED_TEST_SERVER_APK, "TestServer.apk")
+              FileUtils.cp(ANDROID_MANIFEST_PATH, "AndroidManifest.xml")
+
+              contents = File.read('AndroidManifest.xml')
+              contents.gsub!(/#targetPackage#/, application.identifier)
+              contents.gsub!(/#testPackage#/, "#{application.identifier}.test")
+
+              File.open('AndroidManifest.xml_tmp', 'w') {|file| file.write(contents)}
+              FileUtils.mv('AndroidManifest.xml_tmp', 'AndroidManifest.xml')
+
+              unless system %Q{"#{Environment.aapt_path}" package -M AndroidManifest.xml  -I "#{Environment.android_jar_path}" -F dummy.apk}
+                raise "Could not create dummy.apk"
+              end
+
+              Zip::File.new("dummy.apk").extract("AndroidManifest.xml","customAndroidManifest.xml")
+              Zip::File.open("TestServer.apk") do |zip_file|
+                zip_file.add("AndroidManifest.xml", "customAndroidManifest.xml")
+              end
+            end
+            keystore.sign_apk("#{workspace_dir}/TestServer.apk", test_server_file_name)
+            begin
+
+            rescue => e
+              @logger.log e, :debug
+              raise BuildError.new("Could not sign test server")
+            end
+          end
+          @logger.log "Done signing the test server. Moved it to #{test_server_file_name}"
+        end
+
+        def fingerprint_from_apk
+          application_path = File.expand_path(@application_path)
+
+          Dir.mktmpdir do |tmp_dir|
+            Dir.chdir(tmp_dir) do
+              FileUtils.cp(application_path, "app.apk")
+              FileUtils.mkdir("META-INF")
+              Zip::File.foreach("app.apk") do |z|
+                z.extract if /^META-INF\/\w+.(rsa|dsa)/i =~ z.name
+              end
+              signature_files = Dir["#{tmp_dir}/META-INF/*"]
+
+              Logger.debug 'Signature files:'
+
+              signature_files.each do |signature_file|
+                Logger.debug 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::Environment.keytool_path} -v -printcert -J\"-Dfile.encoding=utf-8\" -file \"#{signature_files.first}\""
+              Logger.debug cmd
+              fingerprints = `#{cmd}`
+              md5_fingerprint = JavaKeystore.extract_md5_fingerprint(fingerprints)
+              Logger.debug "MD5 fingerprint for signing cert (#{application_path}): #{md5_fingerprint}"
+              md5_fingerprint
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/calabash/android/build/java_keystore.rb

@@ -0,0 +1,177 @@
+require 'escape'
+
+module Calabash
+  module Android
+    module Build
+      class JavaKeystore
+        CALABASH_KEYSTORE_SETTINGS_FILENAME = 'calabash_keystore_settings.json'
+
+        attr_reader :errors, :location, :keystore_alias, :store_password
+        attr_reader :key_password, :fingerprint, :signature_algorithm_name
+
+        def initialize(location, keystore_alias, store_password, key_password, options={})
+          @logger = options[:logger] || Calabash::Logger.new
+
+          raise "No such keystore file '#{location}'" unless File.exists?(File.expand_path(location))
+
+          if key_password.nil? || key_password.empty?
+            key_password = store_password.dup
+          end
+
+          @logger.log "Reading keystore data from keystore file '#{File.expand_path(location)}'", :debug
+
+          keystore_data = system_with_stdout_on_success(Environment.keytool_path, '-list', '-v', '-alias', keystore_alias, '-keystore', location, '-storepass', store_password, '-keypass', key_password, '-J"-Dfile.encoding=utf-8"')
+
+          if keystore_data.nil?
+            if keystore_alias.empty?
+              @logger.log "Could not obtain keystore data. Will try to extract alias automatically", :debug
+
+              keystore_data = system_with_stdout_on_success(Environment.keytool_path, '-list', '-v', '-keystore', location, '-storepass', store_password, '-keypass', key_password, '-J"-Dfile.encoding=utf-8"')
+
+              if keystore_data.nil?
+                error = 'Could not read keystore alias. Probably because the credentials were incorrect.'
+                @errors = [{message: error}]
+                @logger.log error, :error
+                raise error
+              end
+
+              aliases = keystore_data.scan(/Alias name\:\s*(.*)/).flatten
+
+              if aliases.length == 0
+                raise 'Could not extract alias automatically. Please specify alias using calabash setup-keystore'
+              elsif aliases.length > 1
+                raise 'Multiple aliases found in keystore. Please specify alias using calabash setup-keystore'
+              else
+                keystore_alias = aliases.first
+                @logger.log "Extracted keystore alias '#{keystore_alias}'. Continuing", :debug
+
+                return initialize(location, keystore_alias, store_password, key_password)
+              end
+            else
+              error = "Could not list certificates in keystore. Probably because the credentials were incorrect."
+              @errors = [{:message => error}]
+              @logger.log error, :error
+              raise error
+            end
+          end
+
+          @location = location
+          @keystore_alias = keystore_alias
+          @store_password = store_password
+          @key_password = key_password
+          @logger.log "Key store data:", :debug
+          @logger.log keystore_data, :debug
+          @fingerprint = JavaKeystore.extract_md5_fingerprint(keystore_data)
+          @signature_algorithm_name = JavaKeystore.extract_signature_algorithm_name(keystore_data)
+          @logger.log "Fingerprint: #{fingerprint}", :debug
+          @logger.log "Signature algorithm name: #{signature_algorithm_name}", :debug
+        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'
+
+          Logger.info "Signing using the signature algorithm: '#{signing_algorithm}'"
+          Logger.info "Signing using the digest algorithm: '#{digest_algorithm}'"
+
+          unless system_with_stdout_on_success(Environment.jarsigner_path, '-sigfile', 'CERT', '-sigalg', signing_algorithm, '-digestalg', digest_algorithm, '-signedjar', dest_path, '-storepass', store_password, '-keypass', key_password, '-keystore',  location, apk_path, keystore_alias)
+            Logger.error 'Could not sign the application. The keystore credentials are most like incorrect'
+            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("'", '"')}"
+          @logger.log cmd, :debug
+          out = `#{cmd}`
+          if $?.exitstatus == 0
+            out
+          else
+            nil
+          end
+        end
+
+        def fail_wrong_info
+          raise "Could not read keystore with the given credentials. Please ensure "
+        end
+
+        def self.read_keystore_with_default_password_and_alias(path)
+          path = File.expand_path path
+
+          if File.exists? path
+            keystore = nil
+
+            begin
+              keystore = JavaKeystore.new(path, 'androiddebugkey', 'android', 'android')
+            rescue => _
+              Logger.debug "Trying to read keystore from: #{path} - got error"
+              return nil
+            end
+
+            if keystore.errors
+              Logger.debug "Got errors #{keystore.errors}"
+              nil
+            else
+              Logger.debug "Unlocked keystore at #{path} - fingerprint: #{keystore.fingerprint}"
+              keystore
+            end
+          else
+            Logger.debug "Trying to read keystore from: #{path} - no such file"
+            nil
+          end
+        end
+
+        def self.get_keystores
+          if keystore = keystore_from_settings
+            [ 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
+          if File.exist?(CALABASH_KEYSTORE_SETTINGS_FILENAME)
+            Logger.info "Reading keystore information specified in #{CALABASH_KEYSTORE_SETTINGS_FILENAME}"
+
+            begin
+              keystore = JSON.parse(IO.read(CALABASH_KEYSTORE_SETTINGS_FILENAME))
+            rescue JSON::ParserError => e
+              Logger.error('Could not parse keystore settings. Please run calabash setup-keystore again')
+
+              raise e
+            end
+
+            JavaKeystore.new(keystore["keystore_location"], keystore["keystore_alias"], keystore["keystore_store_password"], keystore["keystore_key_password"])
+          end
+        end
+
+        def self.fail_if_key_missing(map, key)
+          raise "Found #{CALABASH_KEYSTORE_SETTINGS_FILENAME} but no #{key} defined." unless map[key]
+        end
+
+        def self.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 self.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
+      end
+    end
+  end
+end

data/lib/calabash/android/build/resigner.rb

@@ -0,0 +1,56 @@
+module Calabash
+  module Android
+    module Build
+      # @!visibility private
+      class Resigner
+        def initialize(application_path, options={})
+          @application_path = application_path
+
+          if options[:logger]
+            @logger = options[:logger] || Logger.new
+          else
+            @logger = Logger.new
+            @logger.default_log_level = :info
+          end
+        end
+
+        def resign!
+          Dir.mktmpdir do |tmp_dir|
+            @logger.log 'Resigning apk', :debug
+            unsigned_path = File.join(tmp_dir, 'unsigned.apk')
+            unaligned_path = File.join(tmp_dir, 'unaligned.apk')
+            FileUtils.cp(@application_path, unsigned_path)
+            unsign(unsigned_path)
+            sign(unsigned_path, unaligned_path)
+            zipalign(unaligned_path, @application_path)
+          end
+        end
+
+        def unsign(unsigned_path)
+          files_to_remove = `"#{Environment.aapt_path}" list "#{unsigned_path}"`.lines.collect(&:strip).grep(/^META-INF\//)
+          if files_to_remove.empty?
+            @logger.log "App wasn't signed. Will not try to unsign it.", :debug
+          else
+            system("\"#{Environment.aapt_path}\" remove \"#{unsigned_path}\" #{files_to_remove.join(" ")}")
+          end
+        end
+
+        def zipalign(unaligned_path, app_path)
+          cmd = %Q("#{Environment.zipalign_path}" -f 4 "#{unaligned_path}" "#{app_path}")
+          @logger.log "Zipaligning using: #{cmd}", :debug
+          system(cmd)
+        end
+
+        def sign(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 setup-keystore'
+          end
+
+          java_keystore.sign_apk(app_path, dest_path)
+        end
+      end
+    end
+  end
+end

data/lib/calabash/android/build/test_server.rb

@@ -0,0 +1,27 @@
+module Calabash
+  module Android
+    module Build
+      # @!visibility private
+      class TestServer
+        def initialize(application_path)
+          @application_path = application_path
+        end
+
+        def path
+          File.expand_path("test_servers/#{checksum(@application_path)}_#{VERSION}.apk")
+        end
+
+        def exists?
+          File.exists?(path)
+        end
+
+        private
+
+        def checksum(file_path)
+          require 'digest/md5'
+          Digest::MD5.file(file_path).hexdigest
+        end
+      end
+    end
+  end
+end

data/lib/calabash/android/console_helpers.rb

@@ -0,0 +1,44 @@
+module Calabash
+  module ConsoleHelpers
+    def self.render(data, indentation)
+      if visible?(data)
+        type = data['type']
+        simple_name = type.split('.').last.split('$').last
+
+        str_type = if data['type'] == 'dom'
+                     "#{Color.yellow("[")}#{simple_name}:#{Color.yellow("#{data['nodeName']}]")} "
+                   else
+                     Color.yellow("[#{simple_name}] ")
+                   end
+
+        text = nil
+
+        if data['value']
+          unless data['value'].empty?
+            if data['value'].length > 45
+              text = "#{data['value'][0,45]}[...]"
+            else
+              text = data['value']
+            end
+
+            newline_index = text.index("\n")
+
+            unless newline_index.nil?
+              text = "#{text[0,newline_index]}[...]"
+            end
+          end
+        end
+
+        str_id = data['id'] ? "[id:#{Color.blue(data['id'])}] " : ''
+        str_label = data['label'] ? "[contentDescription:#{Color.green(data['label'])}] " : ''
+        str_text = text ? "[text:#{Color.magenta(text)}] " : ''
+        output("#{str_type}#{str_id}#{str_label}#{str_text}", indentation)
+        output("\n", indentation)
+      end
+    end
+
+    def self.visible?(data)
+      data['visible'] || data['children'].map{|child| visible?(child)}.any?
+    end
+  end
+end