wbench 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe21cd9138babb08ef23e967f76d921650ed1ebd
-  data.tar.gz: 9ee59b415dc1fd6e312404be238521f2c70d23d1
+  metadata.gz: 6dfb44fa9da6a36574ee13ee7b541a0beee68cbf
+  data.tar.gz: def12740e6a51ddf81d71d8479d1acb150d2fe17
 SHA512:
-  metadata.gz: b61abc703677f00323a93b684a22a31b32d4e0a327d858fb14e06cb52afa8d32777039a0a0198b38af494556baaaf2834a420047df2a0c7837e3ba2367ee09e7
-  data.tar.gz: 1700e343c31202744a33c45d68b8b2f15f3f64c3de4d0f7f4b8b56c98d881eeea855ab6790b1761f1ef490000cc95dbba41caa05503a312f3053e6d464d439ee
+  metadata.gz: 0ebecb25fe5ae425c7effb70ea8b7fc2c71a5fde0c0df1865664a81201ef997e1b9bbd0386745bcf3dc6654ee1195df267f15fef5e7d7e94bde9265cc9efac8a
+  data.tar.gz: b90b6da372c793a2a28db28f12341d6b5625b0161f2c661133afa3729e9482e2d5b6a83e26b181b90bbfdf88c020623143c76f56869e9f6c572b715e2ac255f8

data/README.md

@@ -20,7 +20,7 @@ You will need to install [Google Chrome](http://www.google.com/chrome) as well a
 You can install chromedriver (on OSX) with homebrew:
 
 ```bash
-brew install chromedriver
+$ brew install chromedriver
 ```
 
 Alternatively you can install firefox and use it with wbench. See [Running other browsers](#running-other-browsers) for more info.
@@ -32,7 +32,7 @@ Alternatively you can install firefox and use it with wbench. See [Running other
 Simply enter the URL of a website you want to benchmark. The site will be loaded in the Chrome browser 10 times.
 
 ```bash
-wbench https://www.desktoppr.co/
+$ wbench https://www.desktoppr.co/
 ```
 
 ![Example Usage Output](https://github.com/desktoppr/wbench/raw/master/example.png)
@@ -42,26 +42,33 @@ wbench https://www.desktoppr.co/
 Chrome is the default browser that is used. You can also use firefox by specifying it on the command line.
 
 ```bash
-wbench -b firefox https://www.desktoppr.co/
+$ wbench -b firefox https://www.desktoppr.co/
 ```
 
 ### Setting the user agent
 You can also pass the `-u/--user-agent` option to change the browsers user agent (This can be useful for mobile testing).
 
 ```bash
-wbench -u "Mozilla/5.0 (iPhone; U; ..." https://www.desktoppr.co/
+$ wbench -u "Mozilla/5.0 (iPhone; U; ..." https://www.desktoppr.co/
 ```
 
+### Server performance measuring
+
+Server response times will be reported if the application is a ruby/rack application that returns the `X-Runtime` http header. Without that header the server performance will not be able to be measured.
+
 ### Ruby API
 
 You can programatically run the benchmarks. Simply specify the URL and
 optionally the amount of runs.
 
-```bash
+Here is an example of running a benchmark in chrome looping around 3 times.
+
+```ruby
 
 require 'wbench'
 
-results = WBench::Benchmark.run('https://www.desktoppr.co/', :loops => 3, :browser => :chrome) # => WBench::Results
+benchmark = WBench::Benchmark.new('https://www.desktoppr.co/', :browser => :chrome)
+results   = benchmark.run(3) # => WBench::Results
 
 results.app_server # =>
   [25, 24, 24]
@@ -85,12 +92,37 @@ results.latency # =>
   "ssl.google-analytics.com"=>[497, 14, 14], "www.desktoppr.co"=>[191, 210, 203]}
 ```
 
+### Benchmarking authenticated pages
+
+Benchmarking authenticated pages is possible using the ruby API. The API
+provides direct access to the selenium session. The session allows us to visit
+a login page before our test page, for example:
+
+```ruby
+require 'wbench'
+
+benchmark = WBench::Benchmark.new('https://www.desktoppr.co/dashboard', :browser => :chrome)
+benchmark.before_each do
+  visit 'https://www.desktoppr.co/login'
+  fill_in 'Login', :with => 'mario'
+  fill_in 'Password', :with => 'super secret'
+  click_button 'Log In'
+end
+
+results = benchmark.run(3) # => WBench::Results
+```
+
+Please note that by visiting pages before each run, your browser may cache some
+assets. This means that when the benchmark is run against the authenticated
+page, some assets may be loaded from the cache, and the result may appear
+quicker than an uncahed visit.
+
 ### Gisting results
 
 You can install the [Github gist gem](https://github.com/defunkt/gist) and pipe in the results of wbench
 
-```
-gem install gist
+```bash
+$ gem install gist
 
-wbench http://www.google.com.au/ | gist -d "Google homepage"
+$ wbench http://www.google.com.au/ | gist -d "Google homepage"
 ```

data/lib/wbench/benchmark.rb

@@ -9,9 +9,14 @@ module WBench
       @browser = Browser.new(url, options)
     end
 
+    def before_each(&blk)
+      @before_each = blk
+    end
+
     def run(loops)
       Results.new(@url, loops).tap do |results|
         loops.times do
+          @browser.run(&@before_each)
           @browser.visit { results.add(app_server_results, browser_results, latency_results) }
         end
       end

data/lib/wbench/browser.rb

@@ -3,7 +3,6 @@ module WBench
     attr_accessor :url
 
     def initialize(url, options = {})
-
       Capybara.register_driver(CAPYBARA_DRIVER) do |app|
         http_client         = Selenium::WebDriver::Remote::Http::Default.new
         http_client.timeout = CAPYBARA_TIMEOUT
@@ -22,17 +21,6 @@ module WBench
 
     def visit
       session.visit(@url)
-      session.driver.browser.manage.add_cookie({:name => "__cfduid", :value => "d451147018e57384e0b9140acd81e7e651344316083", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "__utma", :value => "173654326.679005727.1344316084.1364896914.1364907827.314", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "__utmb", :value => "173654326.6.9.1364908479334", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "__utmc", :value => "173654326", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "__utmz", :value => "173654326.1364523542.301.35.utmcsr=t.co|utmccn=(referral)|utmcmd=referral|utmcct=/zIqI8VD5U9", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "_desktoppr_session", :value => "3219d6873f518346124e45aed28b3145", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "filter_preferences", :value => "", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "gs_u", :value => "1918212640:35447:133481:1352193418568", :path => "/", :secure => false})
-      session.driver.browser.manage.add_cookie({:name => "remember_user_token", :value => "BAhbB1sGaQdJIiIkMmEkMTAkR1ZLaDBxUk5oY0Q2YmxUWEpjTVJTdQY6BkVU--49ef55778ab2fc2f84b314289b7ea26d10222a40", :path => "/", :secure => false})
-      session.visit(@url)
-
       wait_for_page
       session.execute_script(wbench_javascript)
       yield if block_given?
@@ -43,6 +31,10 @@ module WBench
       session.evaluate_script(script)
     end
 
+    def run(&blk)
+      session.instance_eval(&blk) if block_given?
+    end
+
     private
 
     def add_selenium_args(options, arg)

data/lib/wbench/version.rb

@@ -1,3 +1,3 @@
 module WBench
-  VERSION = '0.3.6'
+  VERSION = '0.3.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wbench
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Mario Visic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Benchmark website loading times