mobmanager 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aef04bb70e5ad38e7e6b0e61999d5e1cd20eff19
+  data.tar.gz: 44ec61ad4b32c6008c6f839261f1e29b1e258e69
+SHA512:
+  metadata.gz: 056abce902ace629d88e045c2022089e3791564cfe9151fa2ed671b9e3e38cd1889928da920b9e402c02304e781f2e4ab56e1b8f994a6b376e4374c5ef954e10
+  data.tar.gz: 1dab5c43178fafdea35829b211a14ec7de43265535623e5c6f45a1d269d84af2275b3b0d4a9fcec715a95c0175eb55da5b645e99f3bd5cf67a9a4cc00ffc21cd

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.idea/
+*.gem
+

data/README.md

@@ -0,0 +1,2 @@
+# MobManager
+Manages calls to the Appium server and provides methods to manage interaction with emulators, simulators and devices for Android and iOS

data/lib/mobmanager/mobile/appium/server/server.rb

@@ -0,0 +1,72 @@
+require_relative '../../../../mobmanager/mobile/os/os'
+
+module Mobile
+  module Appium
+    module Server
+      include OS
+
+      def start_appium_server
+        end_appium_server if node_running?
+        puts 'Starting Appium server...'
+
+        platform = ENV['PLATFORM']
+
+        if platform == 'android'
+          puts '-- Android Platform --'
+          if ENV['ANDROID_PHONE'] == 'emulator'
+            start_server
+          else
+            start_server ENV['DEVICE']
+          end
+        end
+
+        if platform == 'ios'
+          puts '-- IOS Platform --'
+          if ENV['IOS_PHONE'] == 'simulator'
+            start_server
+          else
+            start_server ENV['UIUD']
+          end
+        end
+
+        sleep 5
+        puts "Appium is listening...\n\n"
+      end
+
+      def end_appium_server
+        if node_running?
+          puts 'Terminating Appium server...'
+          if mac?
+            termination = system 'pkill node'
+          else
+            termination = system 'TASKKILL /F /IM node.exe'
+          end
+          return print_response(termination)
+        end
+        puts 'No Appium server found.'
+      end
+
+      def node_running?
+        if mac?
+          return true if %x[ps aux | grep -i node | grep -v grep | wc -l].to_i > 0
+        else
+          return true if %x[tasklist /FI "IMAGENAME eq node.exe"].to_s.include? 'node'
+        end
+        false
+      end
+
+      private
+      def print_response(success)
+        return puts "Appium server terminated successfully." if success
+        return puts "Appium server was not found." unless success
+        warn '[PANIC]: Something went wrong while terminating the appium server.'
+      end
+
+      def start_server(id=nil, log_level='--log-level error')
+        udid = "--udid #{id}" unless id.nil?
+        command = "appium #{udid} #{log_level}"
+        spawn command
+      end
+    end
+  end
+end

data/lib/mobmanager/mobile/os/os.rb

@@ -0,0 +1,18 @@
+module OS
+  def mac?
+    begin
+      os = %x[sw_vers -productName]
+    rescue Exception
+      os = nil
+    end
+    if os.nil?
+      return false if %x[ver].to_s.downcase.include? 'windows'
+    elsif os
+      return true if %[sw_vers -productName].to_s.downcase.include? 'mac'
+    else
+      fail '[PANIC:] Failed to determine OS.'
+      return false
+    end
+    true
+  end
+end

data/lib/mobmanager/mobile/platform/android/common.rb

@@ -0,0 +1,32 @@
+require_relative '../../../../mobmanager/mobile/platform/android/device'
+require_relative '../../../../mobmanager/mobile/platform/android/emulator'
+
+module Platform
+  module Android
+    module Common
+
+      include Platform::Android::Device
+      include Platform::Android::Emulator
+
+      def prepare_android_phone(settings = nil)
+        if ENV['ANDROID_PHONE'] == 'emulator'
+          if ENV['TARGET'] == 'sauce'
+            start_emulator(settings)
+          else
+            terminate_emulator
+            start_emulator
+            online = wait_for_emulator
+            retry_again unless online
+          end
+        else
+          start_android_device
+        end
+      end
+
+      def back_button
+        %x[adb shell input keyevent KEYCODE_BACK]
+      end
+
+    end
+  end
+end

data/lib/mobmanager/mobile/platform/android/device.rb

@@ -0,0 +1,65 @@
+require_relative '../../../../mobmanager/mobile/os/os'
+
+module Platform
+  module Android
+    module Device
+
+      include OS
+
+      ANDROID_DEVICE ||= ENV['DEVICE']
+
+      def start_android_device
+        puts "Setting android device #{ANDROID_DEVICE}"
+        system 'adb start-server'
+        wait_for_android_device
+      end
+
+      def wait_for_android_device
+        max_wait = 5
+        counter = 0
+
+        found = false
+        while !found && counter <= max_wait
+          devices = %x[adb devices]
+          list = list_of_devices(devices)
+          begin
+            found = is_partial_string_in_array?(ANDROID_DEVICE, list)
+          rescue Exception => e
+            found = false
+          end
+          if found
+            return puts "Android device #{ANDROID_DEVICE} found."
+          end
+          counter += 1
+        end
+      end
+
+      def terminate_android_device
+        system 'adb kill-server'
+      end
+    end
+  end
+end
+
+#TODO - move to a helper module maybe adb?
+def list_of_devices(text)
+  devices = []
+  lines = text.split("\n")
+
+  lines.each do |ele|
+    if ele.include?("\t")
+      devices << ele.split("\t")
+    else
+      devices << ele
+    end
+  end
+
+  devices.flatten!
+end
+
+def is_partial_string_in_array?(part_of_string, in_array)
+  in_array.each do |element|
+    return true if part_of_string.include? element
+    false
+  end
+end

data/lib/mobmanager/mobile/platform/android/emulator.rb

@@ -0,0 +1,134 @@
+require_relative '../../../../mobmanager/mobile/os/os'
+require 'fileutils'
+
+module Platform
+  module Android
+    module Emulator
+
+      include OS
+
+      ANDROID_EMULATOR ||= ENV['DEVICE']
+      OFFLINE_CHECKS ||= 15
+
+      def start_emulator(settings = nil)
+        if ENV['TARGET'] == 'sauce'
+          caps = settings unless settings.nil?
+          caps = YAML.load_file(Dir.pwd + '/features/support/settings/android.yml') if settings.nil?
+          setup_for_android_sauce caps
+        else
+          spawn "emulator -avd #{ANDROID_EMULATOR} -no-audio"
+        end
+      end
+
+      def setup_for_android_sauce(settings)
+        sauce_user = %x[echo $SAUCE_USER].strip
+        sauce_key = %x[echo $SAUCE_KEY].strip
+        app_path = settings[:apk_path]
+        app = app_path.split('/').select{|item| item.include?('.apk')}.first
+        puts 'MobTest: Connecting to sauce server...'
+        system "curl https://#{sauce_user}:#{sauce_key}@saucelabs.com/rest/v1/users/#{sauce_user}"
+        puts 'MobTest: Sending apk to sauce storage'
+        system 'curl -u '+"#{sauce_user}:#{sauce_key}"+' -X POST "https://saucelabs.com/rest/v1/storage/'+sauce_user+'/'+app+'?overwrite=true" -H "Content-Type: application/octet-stream" --data-binary @'+app_path
+
+      end
+
+      # Wait until emulator is online
+      def wait_for_emulator
+        online = false
+        iterations = 0
+        while online == false && iterations < OFFLINE_CHECKS
+          iterations += 1
+          sleep 3
+          puts 'Emulator is offline...'
+          list_of_devices = %x[adb devices].to_s
+          if list_of_devices.include? 'emulator'
+            if list_of_devices.include? 'offline'
+              online = false
+            else
+              puts "Emulator is online...\n\n"
+              online = true
+            end
+          end
+        end
+
+        online
+      end
+
+      def retry_again
+        puts 'Something went wrong while getting the AVD. Retrying now...'
+        delete_locked_files
+        terminate_emulator
+        system 'adb kill-server'
+        system 'adb start-server'
+        start_emulator
+        online = wait_for_emulator
+        unless online
+          fail 'Something went wrong while getting the AVD. Verify the selected AVD exists.'
+        end
+      end
+
+      def terminate_emulator
+        if emulator_running?
+          puts 'Terminating Android emulator...'
+          if mac?
+            termination = system 'pkill -9 emulator'
+          else
+            termination = system 'TASKKILL /F /IM emulator-x86.exe'
+            cleanup_after_emulator
+          end
+          print_termination_response(termination)
+        end
+      end
+
+      def cleanup_after_emulator
+        if mac?
+          #remove /private/temp/android-<username>
+          path = '/private/tmp'
+          files = Dir["#{path}/**"]
+          files.each do |file|
+            if File.directory(file)
+              FileUtils.remove_dir(file) if ((file.include? 'android-'))
+            end
+          end
+        else
+          # Delete temp files from AppData/Local/Temp/AndroidEmulator
+          user_profile = %x[echo %USERPROFILE%].to_s.chomp!
+          Dir.glob(user_profile.gsub("\\", '/')+ '//AppData//Local//Temp//AndroidEmulator//*.tmp').each { |f| File.delete(f) }
+        end
+      end
+
+      def emulator_running?
+        if mac?
+          if %x[ps aux | grep -i emulator | grep -v grep | wc -l].to_i > 0
+            return true
+          end
+        else
+          if %x[tasklist /FI "IMAGENAME eq emulator-x86.exe"].to_s.include? 'emulator'
+            return true
+          end
+        end
+        false
+      end
+
+      private
+      def print_termination_response(success)
+        if success
+          puts 'Android emulator terminated successfully.'
+        elsif !success
+          puts 'Android emulator was not found.'
+        else
+          warn '[PANIC]: Something went wrong while terminating the Android emulator.'
+        end
+      end
+
+      def delete_locked_files
+        # Delete lock files from ./.android/avd
+        path = "#{Dir.home}/.android/avd"
+        locks = Dir["#{path}/**/*.lock"]
+        locks.each do |file|
+          File.delete(file)
+        end
+      end
+    end
+  end
+end

data/lib/mobmanager/mobile/platform/ios/common.rb

@@ -0,0 +1,21 @@
+require_relative '../../../../mobmanager/mobile/platform/ios/device'
+require_relative '../../../../mobmanager/mobile/platform/ios/simulator'
+
+module Platform
+  module IOS
+    module Common
+      include Platform::IOS::Device
+      include Platform::IOS::Simulator
+
+      def prepare_ios_phone(settings = nil)
+        if ENV['IOS_PHONE'] == 'simulator'
+          terminate_simulator
+          start_simulator(settings)
+        else
+          start_ios_device
+        end
+      end
+
+    end
+  end
+end

data/lib/mobmanager/mobile/platform/ios/device.rb

@@ -0,0 +1,13 @@
+require_relative '../../../../mobmanager/mobile/os/os'
+
+module Platform
+  module IOS
+    module Device
+
+      def start_ios_device
+        #TODO
+        puts "start_ios_device place holder"
+      end
+    end
+  end
+end

data/lib/mobmanager/mobile/platform/ios/simulator.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+require_relative '../../../../mobmanager/mobile/os/os'
+
+module Platform
+  module IOS
+    module Simulator
+
+      include OS
+
+      def start_simulator(settings = nil)
+        caps = settings unless settings.nil?
+        caps = YAML.load_file(Dir.pwd + '/features/support/settings/ios.yml') if settings.nil?
+
+        unless caps[:workspace_path].nil?
+          build_ios_app(caps)
+        end
+
+        if ENV['TARGET'] == 'sauce'
+          setup_for_sauce(caps)
+        end
+      end
+
+      def build_ios_app(settings)
+        puts 'Building ios app with xcodebuild tool...'
+        puts 'MobTest: Building ios app with xcodebuild tool...'
+        #TODO - Add to PATH?
+        puts "ENV['IOS_DERIVED_DATA_PATH'] #{ENV['IOS_DERIVED_DATA_PATH']}"
+        fail("MobTest: Failed to determine app_path. Please check your ios.yml settings") if settings[:app_path].nil?
+        app = settings[:app_path].split('/').select{|element| element.include?'.app'}.first
+        system "xcodebuild -workspace #{settings[:workspace_path]} -scheme \"#{app.gsub('.app', '')}\" -configuration Debug -sdk \"#{settings['sim_sdk']}\" -derivedDataPath \"~/\""
+      end
+
+      def setup_for_sauce(settings)
+        sauce_user = %x[echo $SAUCE_USER].strip
+        sauce_key = %x[echo $SAUCE_KEY].strip
+        app_path = settings[:app_path]
+        zipped_app_path = app_path.gsub('.app','.zip')
+        app = app_path.split('/').select{|item| item.include?('.app')}.first.gsub('.app','')
+        puts 'MobTest: Connecting to sauce server...'
+        system "curl https://#{sauce_user}:#{sauce_key}@saucelabs.com/rest/v1/users/#{sauce_user}"
+        puts 'MobTest: Zipping iOS app'
+        system "zip -r #{zipped_app_path} #{app_path}/"
+        zipped_app_path = zipped_app_path.gsub('~',Dir.home)
+        puts 'MobTest: Sending zipped app to sauce storage'
+        system 'curl -u '+"#{sauce_user}:#{sauce_key}"+' -X POST "https://saucelabs.com/rest/v1/storage/'+sauce_user+'/'+app+'.zip?overwrite=true" -H "Content-Type: application/octet-stream" --data-binary @'+zipped_app_path
+      end
+
+      def terminate_simulator
+        spawn 'killall "iOS Simulator"'
+        spawn 'killall -9 instruments'
+      end
+
+      def close_and_clean_simulator
+        terminate_simulator
+        remove_sim_temp_files
+      end
+
+      def remove_sim_temp_files
+        if mac?
+          #remove ios related files from /private/temp/
+          path = '/private/tmp'
+          files = Dir["#{path}/**"]
+          files.each do |file|
+            if File.directory?(file)
+              FileUtils.remove_dir(file) if ((file.include? 'com.apple.') || (file.include? 'appium-instruments'))
+            end
+          end
+        else
+          # TODO - research in Windows OS
+        end
+      end
+    end
+  end
+end

data/lib/mobmanager/version.rb

@@ -0,0 +1,3 @@
+module Mobmanager
+  VERSION = "0.0.2"
+end

data/lib/mobmanager.rb

@@ -0,0 +1,9 @@
+require 'mobmanager/version'
+require 'mobmanager/mobile/appium/server/server'
+require 'mobmanager/mobile/os/os'
+require 'mobmanager/mobile/platform/android/common'
+require 'mobmanager/mobile/platform/android/device'
+require 'mobmanager/mobile/platform/android/emulator'
+require 'mobmanager/mobile/platform/ios/common'
+require 'mobmanager/mobile/platform/ios/device'
+require 'mobmanager/mobile/platform/ios/simulator'

data/mobmanager.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mobmanager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mobmanager"
+  spec.version       = Mobmanager::VERSION
+  spec.authors       = ['Milton Davalos']
+  spec.email         = ['miltondavalos@gmail.com']
+  spec.summary       = %q{Provides methods to manage Appium server}
+  spec.description   = %q{Provides methods to start/end Appium server and management of apps in Android and iOS}
+  spec.homepage      = 'https://github.com/miltondavalos/MobManager'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'require_all'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: mobmanager
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Milton Davalos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides methods to start/end Appium server and management of apps in
+  Android and iOS
+email:
+- miltondavalos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/mobmanager.rb
+- lib/mobmanager/mobile/appium/server/server.rb
+- lib/mobmanager/mobile/os/os.rb
+- lib/mobmanager/mobile/platform/android/common.rb
+- lib/mobmanager/mobile/platform/android/device.rb
+- lib/mobmanager/mobile/platform/android/emulator.rb
+- lib/mobmanager/mobile/platform/ios/common.rb
+- lib/mobmanager/mobile/platform/ios/device.rb
+- lib/mobmanager/mobile/platform/ios/simulator.rb
+- lib/mobmanager/version.rb
+- mobmanager.gemspec
+homepage: https://github.com/miltondavalos/MobManager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Provides methods to manage Appium server
+test_files: []