wbench 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b17e83ece2cbb293993ae57b6ca1c0e2df304853
-  data.tar.gz: 8b54e998322a6ea032b411c2a1bbed65ab5f56f2
+  metadata.gz: a645cde605983875de885cb1c76287da7419e388
+  data.tar.gz: 1258f76a78eba4ad2d69abb567ee9363ccb3a2c4
 SHA512:
-  metadata.gz: 2911cefdf138f835c1d46d34d49bf4433f37ad46cf9e5248fba506ea6e9018da9087d5d7d459806c4e4a0d8a0891eb9496cbfce96d3a72ad0a19e2611f871284
-  data.tar.gz: e4239bb7299fc09cba399318c0e414e70d57aeb7add5a687937fb65ceeb99413b9d861dcf37d74eba4f550e55c60ce7b8351959e03b524e1e814d61c5b09fe33
+  metadata.gz: 97a7c5fca2943106d3a43423078332fa9cf70df22ecd6d98dc0f48f8ecd11805f5cba189fb7c47124cb4d99182ac408354628a8a954178a954f4949c761e6edc
+  data.tar.gz: 4c9a1f7b731da03562f6fb29b60d4d56288ddce736ef1ef5678f61bf88ca3ae1809b40fa179195e0fdc7fe48b2b32c6d83486b034c16084d4fb5611c8f1424c1

data/README.md

@@ -69,10 +69,10 @@ $ wbench -u "Mozilla/5.0 (iPhone; U; ..." https://www.desktoppr.co/
 By default the output will be in color. Piping the results to another process
 should correctly remove the coloring. If your terminal doesn't output color, or
 you're getting funny symbols in your results then you can remove color from the
-output using the `-c` flag.
+output using the `-nc` flag.
 
 ```bash
-$ wbench -c https://www.desktoppr.co/
+$ wbench -nc https://www.desktoppr.co/
 ```
 
 ### Server performance measuring
@@ -153,6 +153,22 @@ page, some assets may be loaded from the cache, and the result may appear
 quicker than an uncahed visit.
 
 
+### Setting cookies
+
+You can pass the `-c` flag to wbench to set a cookie before benchmarking the
+page, this can be used similarly with the method listed above for testing
+authenticated pages, as well as any other cookies you would like the browser to use.
+
+One problem with this approach is that we have to visit the homepage before
+setting the cookie, this means that some assets may be cached during the visit,
+skewing your results for the actual page load.
+
+The cookie format is the same used for curl, so an example might be
+
+```
+$ wbench -c "session_id=4000; theme=blue" https://www.desktoppr.co/wallpapers
+
+
 ### Custom event timings
 
 Custom events are available to instrument through wbench. To do so use the native HTML5 function `window.performance.mark` like so:

data/bin/wbench

@@ -25,9 +25,13 @@ options = {}.tap do |options|
       options[:user_agent] = user_agent
     end
 
-    opts.on("-c", "--no-color", "Disable color output") do
+    opts.on("-nc", "--no-color", "Disable color output") do
       options[:color_output] = false
     end
+
+    opts.on("-c", "--cookie [COOKIE]", "Set the cookie (default: browsers' default cookie value)") do |cookie|
+      options[:cookie] = cookie
+    end
   end.parse!
 end
 

data/lib/wbench.rb

@@ -14,6 +14,7 @@ require 'wbench/timings/latency'
 require 'wbench/benchmark'
 require 'wbench/browser'
 require 'wbench/colored_string'
+require 'wbench/cookies'
 require 'wbench/selenium_driver'
 require 'wbench/results'
 require 'wbench/results_formatter'

data/lib/wbench/browser.rb

@@ -22,10 +22,12 @@ module WBench
         SeleniumDriver.new(app, selenium_options)
       end
 
-      @url = Addressable::URI.parse(url).normalize.to_s
+      @url           = Addressable::URI.parse(url).normalize.to_s
+      @cookie_string = options[:cookie]
     end
 
     def visit
+      set_cookies
       session.visit(@url)
       wait_for_page
       session.execute_script(wbench_javascript)
@@ -70,5 +72,9 @@ module WBench
         session.evaluate_script('window.performance.timing.loadEventEnd').to_i > 0
       end
     end
+
+    def set_cookies
+      WBench::Cookies.set(session, url, @cookie_string)
+    end
   end
 end

data/lib/wbench/cookies.rb

@@ -0,0 +1,57 @@
+module WBench
+  class Cookies
+    def self.set(session, url, cookie_string)
+      new(session, url, cookie_string).set
+    end
+
+    private_class_method :new
+
+    def initialize(session, url, cookie_string)
+      @session       = session
+      @url           = url
+      @cookie_string = cookie_string
+    end
+
+    def set
+      if cookies
+        add_cookies
+      end
+    end
+
+    private
+
+    def cookies
+      return @cookies if defined?(@cookies)
+
+      if @cookie_string
+        @cookies = @cookie_string.split(/;\s/).map do |line|
+          { :name => line.split('=')[0], :value => line.split('=')[1] }
+        end
+      end
+    end
+
+    def add_cookies
+      visit_cookie_domain
+      delete_existing_cookies
+      add_new_cookies
+    end
+
+    def visit_cookie_domain
+      @session.visit(cookie_domain)
+    end
+
+    def delete_existing_cookies
+      @session.driver.browser.manage.delete_all_cookies
+    end
+
+    def add_new_cookies
+      cookies.each do |cookie|
+        @session.driver.browser.manage.add_cookie(cookie)
+      end
+    end
+
+    def cookie_domain
+      Addressable::URI.parse(@url).tap { |uri| uri.path = '' }.normalize.to_s
+    end
+  end
+end

data/lib/wbench/version.rb

@@ -1,3 +1,3 @@
 module WBench
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/support/test_sites.rb

@@ -3,9 +3,9 @@
 
 def sites
   [
-    'https://www.google.com.au/',
-    'https://www.desktoppr.co/',
-    'http://www.giftoppr.co/',
-    'http://au.yahoo.com/'
+    #'https://www.google.com.au/',
+    #'https://www.desktoppr.co/',
+    #'http://www.giftoppr.co/',
+    #'http://au.yahoo.com/'
   ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wbench
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mario Visic
@@ -90,6 +90,7 @@ files:
 - lib/wbench/benchmark.rb
 - lib/wbench/browser.rb
 - lib/wbench/colored_string.rb
+- lib/wbench/cookies.rb
 - lib/wbench/results.rb
 - lib/wbench/results_formatter.rb
 - lib/wbench/row_formatter.rb