automate-standard-baseline 0.0.4 → 0.0.5

data/lib/automate-standard-baseline/helpers.rb

@@ -0,0 +1,228 @@
+require 'rubygems'
+require "securerandom"
+require 'rexml/document'
+require 'rexml/xpath'
+require 'tempfile'
+require "uri"
+require "net/http"
+require 'fileutils'
+
+include REXML
+
+def default_timeout_val
+    300
+end
+
+def logger
+	@logger ||= Logger.new(STDOUT)
+end
+
+def set_env(device_id,id)
+   ENV["ADB_DEVICE_ARG"]="#{device_id}"
+   ENV["ADB_DEVICE_INDEX"]="#{id}"
+end
+
+def log(message)
+    logger.info message
+end
+
+
+def pull_out_apk(device_serial, package_name, to_path = nil)
+    out_path = File.expand_path(to_path) if to_path
+    out_path ||= File.expand_path("#{package_name}.apk")
+    
+    if File.exists?(out_path)
+        new_name = "#{out_path}.#{Time.now.strftime('%Y%m%d%H%M%S%s%S')}"  
+        puts %Q{rename #{out_path} to #{new_name} since it already exists.}
+        File.rename(out_path, new_name)
+    end
+
+    for num in ['2', '1', '3']
+        begin
+            cmd = %Q{ #{adb_cmd(device_serial)} pull /data/app/#{package_name}-#{num}.apk #{out_path} }
+            exec_command(cmd, 120)
+        rescue
+        end
+
+        if File.exists?(out_path)
+            break
+        end
+    end
+
+    raise %Q{Failed to pull out the package "#{}"} unless File.exists?(out_path)
+    out_path
+end
+
+def mkdirs(path)
+    if(!File.directory?(path))
+        if(!mkdirs(File.dirname(path)))
+            return false;
+        end
+        Dir.mkdir(path)
+    end
+
+    return true
+end
+
+
+def get_available_devices
+  # grep the connected devices
+  cmd = "#{adb_cmd} devices | ruby -nae 'puts $F[0] if $F[1] =~ /device/'" 
+    devices = exec_command(cmd, 10).output
+  devices = devices.split /\s+/
+
+  if devices.length > 0
+    logger.info {
+      msg = "\nAvailable devices\n"
+      for i in 0...devices.length
+        msg += "#{devices[i]}\n"
+      end
+
+      msg
+    }
+  end
+
+  devices
+end
+
+# pull out all /sdcard/*.pcap to logs/
+def pull_out_tcpdump(devices)
+    dest_dir = "/sdcard/"
+    devices.each do |d|
+        cmd = "#{adb_cmd(d)} shell su -c ls #{dest_dir} | grep pcap" 
+        tcpdump_files = exec_command(cmd, 10).output.strip
+        tcpdump_files.each_line do |f|
+            Dir.mkdir('logs') unless Dir.exists?('logs')
+
+            cmd = "#{adb_cmd(d)} pull #{File.join(dest_dir, f)} logs/#{d}_#{f}"
+            logger.info(cmd)
+            exec_command(cmd, 120)
+            cmd = "#{adb_cmd(d)} shell su -c rm #{File.join(dest_dir, f)}"
+            logger.info(cmd)
+            exec_command(cmd, 10)
+        end
+    end
+end
+
+
+def download_file(url, saved_path = nil)
+  uri = URI.parse(url)
+  path = (!uri.query or uri.query.blank?) ? uri.path : uri.path+"?"+uri.query
+  unless saved_path
+    saved_path = 'oc_apks'
+    Dir.mkdir(saved_path) unless Dir.exists?(saved_path)
+    saved_path = "#{saved_path}/#{uri.path[uri.path.rindex("/") + 1, uri.path.length]}"
+  end
+  saved_path = File.expand_path(saved_path)
+  puts "Download file by url #{url}; saved_path: #{saved_path}"
+  f = File.new(saved_path, "wb")
+  begin
+  print "Downloading\n"
+  i = 0
+  Net::HTTP.start(uri.host, uri.port) do |http|
+    http.request_get(path) do |resp|
+      resp.read_body do |segment|
+        f.write(segment)
+        i = i + 1
+        if (i % 80 == 0)
+          print "\n"
+        else 
+          print "."
+        end
+      end
+    end
+  end
+  ensure
+    f.close()
+  end
+  print "\n"
+  return saved_path
+end
+
+
+def package_name(app)
+  require 'rexml/document'
+  require 'rexml/xpath'
+
+  manifest = Document.new(manifest(app))
+  manifest.root.attributes['package']
+end
+
+def manifest(app)
+  cmd = %Q{java -jar "#{File.dirname(__FILE__)}/manifest_extractor.jar" "#{app}"}
+  puts "exec #{cmd}"
+  exec_command(cmd, default_timeout_val).output
+end
+
+class ExecResult
+  attr_accessor :output, :is_success, :status_code
+
+  def initialize(output, is_success, status_code)
+    @output = output
+    @is_success = is_success
+    @status_code = status_code
+  end
+end
+
+## Add timeout mechanism here to avoid external command executing the whole
+## program.
+def exec_command(cmd, time_out = nil)
+  rd, wr = IO.pipe
+  pid = spawn(cmd, [:out, :err] => wr)
+
+  begin
+      unless time_out
+        Process.waitpid(pid)
+        status_code = $?.exitstatus
+      else 
+        begin
+          Timeout.timeout(time_out) do
+            Process.waitpid(pid)
+            status_code = $?.exitstatus
+          end
+        rescue Timeout::Error => e
+          puts 'Timeout::Error'
+          puts "kill"
+          Process.kill("KILL", pid) rescue nil
+          status_code = -99999
+
+          backtrace = e.backtrace || []
+          new_error = Timeout::Error.new("Failed to execute command #{cmd} due to it spent too much time than expected time: #{time_out}s")
+          new_error.set_backtrace(backtrace + [e.message])
+
+          raise new_error
+        end
+      end
+  ensure
+      wr.close
+      output = rd.read
+      rd.close
+  end
+
+  ExecResult.new(output, status_code == 0, status_code)
+end
+
+
+
+def is_windows?
+  require 'rbconfig'
+  (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+end
+
+def adb_cmd(device_serial = nil)
+  if is_windows?
+    %Q("#{ENV["ANDROID_HOME"]}\\platform-tools\\adb.exe" #{_device_args(device_serial)}) 
+  else
+    %Q("#{ENV["ANDROID_HOME"]}/platform-tools/adb" #{_device_args(device_serial)})
+  end
+end
+
+def _device_args(device_serial = nil)
+  if ENV["ADB_DEVICE_ARG"]
+    "-s #{ENV["ADB_DEVICE_ARG"]}"
+  elsif device_serial
+    " -s #{device_serial} "
+  else
+    ""
+  end
+end

data/lib/automate-standard-baseline/operations.rb

@@ -0,0 +1,238 @@
+require 'net/http'
+require 'open-uri'
+require 'rubygems'
+require 'timeout'
+require 'retriable'
+require 'yaml'
+require 'uri'
+require File.join(File.dirname(__FILE__), "helpers")
+
+
+module Seven module ASB
+
+OC_GA_PROCESSES = ['occ', 'ochttpd', 'ocdnsd', 'ocshttpd', 'octcpd']
+
+module Operations
+
+  @@default_device = nil
+
+  @@default_time_out = 300 # 5 minutes
+  
+  def default_device
+    unless @@default_device
+      puts "create a default device"
+      @@default_device = Device.new(self, ENV['ADB_DEVICE_ARG'],ENV['ADB_DEVICE_INDEX'])
+    end
+    @@default_device
+  end
+
+
+  def install_or_dump_oc_client(path, reinstall = true)
+    
+    
+    if reinstall
+        uri = URI.parse(path)
+        if uri.scheme == 'http' or uri.scheme == 'https'
+            install_and_start_oc_client_by_url(path)
+        else
+            install_and_start_oc_client(path)
+        end
+    else
+        #log "Only dump the OC info but not re-install OC client."
+        #oc_info = dump_oc_info(path, "logs/device-#{ENV['ADB_DEVICE_ARG']}-oc-info.yml") 
+        #log "OC Info: #{oc_info}"
+    end
+  end
+
+  def reset_data()
+      # install the oc client apk
+    default_device.device_reset_data()
+      
+  end
+
+  def install_and_start_oc_client_by_url(url, saved_path = nil)
+    default_device.reinstall_oc_client_by_url(url, saved_path)
+  end
+
+  def install_and_start_oc_client(oc_apk_path)
+    default_device.reinstall_oc_client(oc_apk_path)
+  end 
+
+  def uninstall_oc_client(package_name)
+    default_device.uninstall_oc_client(package_name)
+  end
+
+  def start_oc_client()
+    default_device.start_oc_client()
+  end
+
+  def stop_oc_client(package_name)
+    default_device.stop_oc_client(package_name)
+  end
+
+ 
+
+  ###
+
+  class Device
+
+    def make_default_device
+      @cucumber_world.default_device = self
+    end
+
+    def initialize(cucumber_world, serial, index)
+      @cucumber_world = cucumber_world
+      @serial = serial
+      @index = index
+      log "ADB_DEVICE_INDEX; #{ENV['ADB_DEVICE_INDEX']}"
+      if @index
+        @index = Integer(@index) * 100 
+      else
+        @index = 0
+      end
+      log "device_index; #{@index}"
+	  @apps = Hash.new
+	 
+    end
+
+    
+    def uninstall_oc_client(package_name)
+      # uninstall the oc client apk
+      log "Uninstall oc client"
+      cmd = "#{adb_command} uninstall #{package_name}"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      log result.is_success
+      
+      stop_oc_client(package_name)
+
+      # remove /data/misc/openchannel
+      cmd = "#{adb_command} shell su -c rm -r /data/misc/openchannel"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      log result.is_success
+
+      cmd = "#{adb_command} shell su -c rm -r /sdcard/OpenChannel"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      log result.is_success
+
+      log "Uninstall oc client finished"
+    end
+
+    def start_oc_client()
+      log "Starting oc client...."
+      cmd = "#{adb_command} shell am startservice -a com.seven.asimov.ocengine.OCENGINESERVICE"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      raise "Can not start oc by am startservice" unless result.is_success
+ 
+      # check if oc is running
+      retriable :tries => 5, :interval => 30 do
+        cmd = "#{adb_command} shell su -c ps"
+        log cmd
+        result = exec_command(cmd, @@default_time_out)
+        for oc_process in OC_GA_PROCESSES
+          raise "OC client is not running" unless result.output.include?(oc_process)
+        end
+      end
+      
+      # check iptables is modified
+      retriable :tries => 3, :interval => 30 do
+        cmd = "#{adb_command} shell su -c iptables -t nat -nvL"
+        log cmd
+        result = exec_command(cmd, @@default_time_out)
+        raise "iptables is not modified" unless result.output.include?('redir ports 65002')
+      end
+      puts "oc client is started."  
+    end
+
+    def stop_oc_client(package_name)
+      log "Stopping oc client...."
+      cmd = "#{adb_command} shell am force-stop #{package_name}"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      log result.is_success
+      raise "Can not stop oc by am force-stop" unless result.is_success
+      
+      # kill oc client processes
+      for oc_process in OC_GA_PROCESSES
+        cmd = "#{adb_command} shell su -c cat /data/misc/openchannel/pids/#{oc_process}"
+        log cmd
+        result = exec_command(cmd, @@default_time_out).output.strip
+        log result
+        cmd = "#{adb_command} shell su -c kill -9 #{result}"
+        log cmd
+        result = exec_command(cmd, @@default_time_out)
+        log result.is_success
+      end
+
+      # flush iptables
+      cmd = "#{adb_command} shell su -c iptables -t nat -F"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      log result.is_success
+    end
+
+    def install_and_start_oc_client(oc_apk_path)
+      # install the oc client apk
+      log "Install oc client"
+      cmd = "#{adb_command} install -r #{oc_apk_path}"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      raise "Can not install oc client" unless result.is_success
+      start_oc_client()
+
+      #oc_info = dump_oc_info(oc_apk_path, "logs/device-#{ENV['ADB_DEVICE_ARG']}-oc-info.yml") 
+      #log "oc_info: #{oc_info}"
+      log "Install and start oc client finished."
+    end
+
+    def device_reset_data()
+      # install the oc client apk
+      log "Reset Data Usage/Mobile data (off/on)"
+      cmd = "#{adb_command} shell svc data disable && #{adb_command} shell svc data enable"
+      log cmd
+      result = exec_command(cmd, @@default_time_out)
+      raise "Can not reset data" unless result.is_success
+     
+      log "Reset data usage done."
+    end
+
+    def reinstall_oc_client(oc_apk_path)
+	  oc_pkg_name = package_name(oc_apk_path)
+      uninstall_oc_client(oc_pkg_name)
+      install_and_start_oc_client(oc_apk_path)
+    end
+
+    def reinstall_oc_client_by_url(url, saved_path = nil)
+      if saved_path
+        saved_path = File.expand_path(saved_path)
+      end
+      saved_path = download_file(url, saved_path)
+      reinstall_oc_client(saved_path)
+    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
+
+  end
+
+end
+
+
+end end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automate-standard-baseline
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable
-  requirement: &14319260 !ruby/object:Gem::Requirement
+  requirement: &19215380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14319260
+  version_requirements: *19215380
 - !ruby/object:Gem::Dependency
   name: sys-proctable
-  requirement: &14318700 !ruby/object:Gem::Requirement
+  requirement: &19214360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14318700
+  version_requirements: *19214360
 description: auomated standard baseline test
 email: rfu@seven.com
 executables:
@@ -41,6 +41,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/automate-standard-baseline/manifest_extractor.jar
+- lib/automate-standard-baseline/operations.rb
+- lib/automate-standard-baseline/helpers.rb
 - bin/automate-standard-baseline
 - bin/abs-stop
 homepage: http://rubygems.org/gems/automate-standard-baseline