flaky 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40c7fce2c960f2266e8f7e3f7931c875974b4b54
-  data.tar.gz: c5e46bb2dbe776f720707543915ca8609f8d0afe
+  metadata.gz: 0f9ff093338f06bfed3fa22d003f989fab204700
+  data.tar.gz: 688ede60f2d512a8178c2ab01afddb582c80e598
 SHA512:
-  metadata.gz: 9a0ad60c9f831be58811fb5d4d50e330c319ce76a3161c974621825cee3a69cb3fb8409069e265101116f30e7ced90ffe2c6737f30c7124d728cbd865fe313e8
-  data.tar.gz: 6b437e86dc50c10d7ebf755040aa72a62517d99a840d961b3a74516e96b7dc6933d290c9808db841521b698a0259cf4eec591782dd139fda6e790012fe0410ea
+  metadata.gz: 6267bde8b466674dcc2fa27d37012a24de5b243a19c29c0f66f87096ba8429cb1378132a83d963722e5ba9c1ccc9dce71fc830fb615b532e80ea335235f64301
+  data.tar.gz: f12d59ff098bb2bacf1fc13c8cfbd6766e8acdd0936dc35375a1677f6cd61631aac41a9dd48329121dbbe0ec221cf0e05ab2a38462e73dad35e41cc04e8b0c8c

data/lib/flaky/appium.rb

@@ -19,7 +19,8 @@ module Flaky
   #noinspection RubyResolve
   class Appium
     include POSIX::Spawn
-    attr_reader :ready, :pid, :in, :out, :err, :log, :tail
+    # logcat is read & stopped by run.execute
+    attr_reader :ready, :pid, :in, :out, :err, :log, :tail, :logcat
     @@thread = nil
 
     def self.remove_ios_apps
@@ -46,17 +47,29 @@ module Flaky
       Process::waitpid(_pid) if _pid
     end
 
-    def initialize
+    # android: true to activate Android mode
+    def initialize opts={}
       @ready = false
       @pid, @in, @out, @err = nil
       @log = ''
       @tail = nil
+      @android = opts.fetch(:android, false)
+      if @android
+        @droid = Flaky::Android.new
+        @logcat = Flaky::Logcat.new
+      end
     end
 
     def start
       @log = ''
       self.stop # stop existing process
-      self.class.remove_ios_apps
+
+      if @android
+        @droid.reset
+        @logcat.start
+      else
+         self.class.remove_ios_apps
+      end
 
       @@thread.exit if @@thread
       @@thread = Thread.new do
@@ -102,6 +115,10 @@ module Flaky
       self.class.kill_all 'node'
     end
 
+    def end_all_instruments
+      self.class.kill_all 'instruments'
+    end
+
     # Invoked inside a thread by `self.go`
     def launch
       @log = ''
@@ -109,9 +126,9 @@ module Flaky
       @ready = false
       appium_home = ENV['APPIUM_HOME']
       raise "ENV['APPIUM_HOME'] must be set!" if appium_home.nil? || appium_home.empty?
-      contains_appium = File.exists?(File.join(ENV['APPIUM_HOME'], 'server.js'))
-      raise "Appium home `#{appium_home}` doesn't contain server.js!" unless contains_appium
-      cmd = %Q(cd "#{appium_home}"; node server.js)
+      contains_appium = File.exists?(File.join(ENV['APPIUM_HOME'], 'bin', 'appium.js'))
+      raise "Appium home `#{appium_home}` doesn't contain bin/appium.js!" unless contains_appium
+      cmd = %Q(cd "#{appium_home}"; node .)
       @pid, @in, @out, @err = popen4 cmd
       @in.close
       self # used to chain `launch.wait`
@@ -122,11 +139,11 @@ module Flaky
       # https://github.com/tmm1/pygments.rb/blob/master/lib/pygments/popen.rb
       begin
         Process.kill 'KILL', @pid
-        Process.waitpid @pid
       rescue
       end unless @pid.nil?
       @pid = nil
       self.end_all_nodes
+      self.end_all_instruments unless @android
 
       @tail.stop if @tail
     end

data/lib/flaky/logcat.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+# log = Flaky::Logcat.new
+# log.start; log.stop
+module Flaky
+  class Logcat
+    attr_reader :pid, :in, :out, :err
+    @@thread = nil
+    @@data = nil
+
+    # Start the logcat process and capture the output
+    def start
+      # make sure the adb devices command doesn't error.
+      while (!POSIX::Spawn::Child.new('adb kill-server; adb devices').err.empty?)
+        sleep 0.5
+      end
+
+      cmd = 'adb logcat'
+      @pid, @in, @@out, @err = POSIX::Spawn::popen4 cmd
+      @in.close
+      @data = ''
+
+      @@thread.exit if @@thread
+      @@thread = Thread.new do
+        # out.read blocks until the process ends
+        @@data = @@out.read
+      end
+    end
+
+    # Stop and return the data
+    def stop
+      begin
+        [@in, @out, @err].each { |io| io.close unless io.nil? || io.closed? }
+        Process.kill 'KILL', @pid
+        Process.waitpid @pid
+      rescue
+      end
+
+      @@data
+    end
+  end
+end

data/lib/flaky/reset_android.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+module Flaky
+
+  # Flaky::Android.new.reset
+  class Android
+    def initialize
+      apk_path = ENV['APK_PATH']
+      raise 'Environment variable APK_PATH must be set' if apk_path.nil? ||
+          apk_path.empty? || File.extname(apk_path).downcase != '.apk'
+      @md5 = Digest::MD5.file(apk_path).hexdigest
+      @apk = apk_path
+
+      app_package = ENV['APP_PACKAGE']
+      raise 'Environment variable APP_PACKAGE must be set' if app_package.nil? ||
+          app_package.empty?
+      @package = app_package
+    end
+
+    def _remove_old_apks
+      list_apks = POSIX::Spawn::Child.new 'adb shell "ls /data/local/tmp/*.apk"'
+      raise "list_apks errored with: #{list_apks.err}" unless list_apks.err.empty?
+
+      apk_on_device = false
+      remove_apks = ''
+      list_apks.out.split(/\r?\n/).each do |path|
+        if path.include?(@md5)
+          apk_on_device = true
+        else
+          remove_apks += ' rm \\"' + path + '\\";'
+        end
+      end
+
+      # must return if there are no apks to remove
+      return if remove_apks.empty?
+
+      remove_apks = 'adb shell "' + remove_apks + '"'
+      remove_apks = POSIX::Spawn::Child.new remove_apks
+      raise "remove_apks errored with: #{remove_apks.err}" unless remove_apks.err.empty?
+    end
+
+    def _push_apk
+      # dir must exist before pushing
+      POSIX::Spawn::Child.new 'adb shell "mkdir /data/local/tmp/"'
+      push_apk = POSIX::Spawn::Child.new %Q(adb push "#{@apk}" "/data/local/tmp/#{@md5}.apk")
+      raise "push_apk errored with: #{push_apk.err}" unless push_apk.err.empty?
+    end
+
+    def _reinstall_apk
+      POSIX::Spawn::Child.new %Q(adb shell "am force-stop #{@package}")
+      apk_uninstall = POSIX::Spawn::Child.new "adb uninstall #{@package}"
+      raise "apk_uninstall errored with: #{apk_uninstall.err}" unless apk_uninstall.err.empty?
+      apk_install = POSIX::Spawn::Child.new "adb shell pm install /data/local/tmp/#{@md5}.apk"
+      raise "apk_install errored with: #{apk_install.err}" unless apk_install.err.empty?
+    end
+
+    def reset
+      apk_on_device = _remove_old_apks
+      _push_apk unless apk_on_device
+      _reinstall_apk
+    end
+  end
+end

data/lib/flaky/run/all_tests.rb

@@ -24,7 +24,7 @@ module Flaky
 
       count.times do
         appium.start
-        run_cmd = "cd #{current_dir}; rake ios['#{name}']"
+        run_cmd = "cd #{current_dir}; rake #{os.downcase}['#{name}']"
         passed = flaky.execute run_cmd: run_cmd, test_name: test_name, appium: appium
         break if passed # move onto the next test after one successful run
       end

data/lib/flaky/run/one_test.rb

@@ -31,7 +31,7 @@ module Flaky
 
     count.times do
       appium.start
-      run_cmd = "cd #{current_dir}; rake ios['#{name}']"
+      run_cmd = "cd #{current_dir}; rake #{os.downcase}['#{name}']"
       flaky.execute run_cmd: run_cmd, test_name: test_name, appium: appium
     end
 

data/lib/flaky/run.rb

@@ -14,6 +14,17 @@ module Flaky
     end
   end
 
+  class LogArtifact
+    def initialize opts={}
+      @result_dir = opts.fetch :result_dir, ''
+      @pass_str   = opts.fetch :pass_str, ''
+    end
+
+    def name str
+      File.join @result_dir, @pass_str, str
+    end
+  end
+
   class Run
     include Flaky::Color
     attr_reader :tests, :result_dir, :result_file
@@ -102,24 +113,25 @@ module Flaky
       postfix = "#{runs}_#{test_name}_" + postfix
       postfix = '0' + postfix if runs <= 9
 
-      log_name = "#{postfix}.html"
-      log_name = File.join result_dir, pass_str, log_name
-      Flaky.write log_name, log
 
-      log_name = "#{postfix}.server.log.txt"
-      log_name = File.join result_dir, pass_str, log_name
+      log_file = LogArtifact.new result_dir: result_dir, pass_str: pass_str
+
+      # html Ruby test log
+      Flaky.write log_file.name("#{postfix}.html"), log
 
-      File.open(log_name, 'w') do |f|
+      # iOS simulator system log
+      File.open(log_file.name("#{postfix}.server.log.txt"), 'w') do |f|
         f.write appium.tail.out.readpartial(999_999_999)
       end
 
-      appium_log_name = File.join result_dir, pass_str, "#{postfix}.appium.html"
-      Flaky.write appium_log_name, appium.log
+      # adb logcat log
+      logcat = appium.logcat ? appium.logcat.stop : nil
+      File.open(log_file.name("#{postfix}.logcat.txt"), 'w') do |f|
+        f.write logcat
+      end if logcat
 
-      # save uncolored version
-      # File.open(appium_log_name + '.nocolor.txt', 'w') do |f|
-      #  f.write appium.log
-      # end
+      # appium server log
+      Flaky.write log_file.name("#{postfix}.appium.html"), appium.log
 
       passed
     end

data/lib/flaky.rb

@@ -6,10 +6,11 @@ require 'rubygems' # gem requires
 require 'chronic_duration'
 require 'escape_utils'
 require 'posix/spawn' # http://rubygems.org/gems/posix-spawn
+require 'digest/md5'
 
 module Flaky
-  VERSION = '0.0.7' unless defined? ::Flaky::VERSION
-  DATE = '2013-10-11' unless defined? ::Flaky::DATE
+  VERSION = '0.0.8' unless defined? ::Flaky::VERSION
+  DATE = '2013-10-17' unless defined? ::Flaky::DATE
 
   # https://github.com/appium/ruby_lib/blob/0e203d76610abd519ba9d2fe9c14b50c94df5bbd/lib/appium_lib.rb#L24
   def self.add_to_path file, path=false

data/readme.md

@@ -4,6 +4,9 @@ Run Appium iOS tests to measure flakiness.
 
 - `gem install flaky`
 - `flake 3 ios[nop]` - Run the iOS test named nop 3 times.
+- `flake 3 ios` - Run all the iOS tests up to 3 times.
+If a test passes then it moves onto the next test.
+If a test fails 3 times then it moves onto the next test.
 
 Results are stored in `/tmp/flaky`
 

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v0.0.7 2013-10-11
+
+- [26bc5cc](https://github.com/appium/flaky/commit/26bc5cc6b43e3de7398e6d9e8c9bb615353020eb) Release 0.0.7
+- [9e854aa](https://github.com/appium/flaky/commit/9e854aae8c4b7eb64afc79c3f8716944ea9667ad) Add all tests run option
+- [153119a](https://github.com/appium/flaky/commit/153119a59ba6b8c1d4c2f6d6311aa87f73b1a635) Add link to appium in the readme
+
+
 #### v0.0.6 2013-10-03
 
 - [86d8137](https://github.com/appium/flaky/commit/86d8137e3f1f348be8ee76e42bea0de36280d5a5) Release 0.0.6

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: flaky
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - code@bootstraponline.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic_duration
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: escape_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
 description: Measure flaky Ruby Appium tests.
@@ -81,6 +81,8 @@ files:
 - lib/flaky.rb
 - lib/flaky/appium.rb
 - lib/flaky/log.rb
+- lib/flaky/logcat.rb
+- lib/flaky/reset_android.rb
 - lib/flaky/run.rb
 - lib/flaky/run/all_tests.rb
 - lib/flaky/run/one_test.rb
@@ -100,17 +102,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Measure flaky Ruby Appium tests