browser_shooter 0.0.5 → 0.1.1

data/examples/config4.yml

@@ -7,20 +7,30 @@ scripts:
     commands: |
       open "/test/browser_shooter/lightbox_bareplayer.html"
       window_maximize
+      shot_system
       pause 5
       alert
       click "link=Show video"
       pause 5
+      shot_system
       select_frame "_sp_wiframe"
       run_script "$f().play()"
       wait_for_element "css=span.enabled", :timeout_in_seconds => 15
+      shot_system
       click "css=span.enabled"
-      pause 5
+      pause 8
+      shot_system
       alert
 
 browsers:
-  windows-firefox:
+  osx-firefox:
     name: "osx-firefox"
     host: 127.0.0.1
     port: 4444
-    browser: "*firefox"
+    browser: "*firefox"
+
+  windows-firefox:
+    name: "windows-explorer"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*iexploreproxy"

data/lib/browser_shooter/commander.rb

@@ -1,6 +1,6 @@
 class BrowserShooter
   module Commander
-    def self.execute( command, client, output_path )
+    def self.execute( command, client, shots_path )
       BrowserShooter::Logger.log "command: #{command}"
 
       if( command.split[0].strip == "shot" )
@@ -8,7 +8,7 @@ class BrowserShooter
 
         BrowserShooter::Commander.shot(
           client,
-          output_path,
+          shots_path,
           sufix
         )
 
@@ -17,7 +17,7 @@ class BrowserShooter
 
         BrowserShooter::Commander.shot_system(
           client,
-          output_path,
+          shots_path,
           sufix
         )
 
@@ -30,7 +30,7 @@ class BrowserShooter
       end
     end
 
-    def self.wrapper_execute( command, client, output_path )
+    def self.wrapper_execute( command, client, shots_path )
       result = {
         :time     => Time.now.to_i,
         :command  => command
@@ -41,7 +41,7 @@ class BrowserShooter
           BrowserShooter::Commander.execute(
             command,
             client,
-            output_path
+            shots_path
           )
 
         result.merge!(
@@ -61,8 +61,8 @@ class BrowserShooter
     end
 
     def self.shot( client, path, sufix = nil )
-      sufix = "_#{sufix}" unless sufix.nil?
-      path  = "#{path}#{sufix}.png"
+      sufix = timestamp unless sufix
+      path  = "#{path}_#{sufix}.png"
 
       BrowserShooter::Logger.log "shooting in '#{path}'"
 
@@ -73,9 +73,9 @@ class BrowserShooter
       return path
     end
 
-    def self.shot_system( client, path, sufix = nil )
-      sufix = "_#{sufix}" unless sufix.nil?
-      path  = "#{path}#{sufix}.system.png"
+    def self.shot_system( client, path, sufix = timestamp )
+      sufix = timestamp unless sufix
+      path  = "#{path}_#{sufix}.system.png"
 
       BrowserShooter::Logger.log "shooting system in '#{path}'"
 
@@ -92,5 +92,9 @@ class BrowserShooter
 
       return "#{seconds} later..."
     end
+
+    def self.timestamp
+      Time.now.to_i
+    end
   end
 end

data/lib/browser_shooter/driver.rb

@@ -1,6 +1,6 @@
 class BrowserShooter
   module Driver
-    def self.run_script_on_browser(script, browser, output_path)
+    def self.run_script_on_browser(script, browser, shots_path)
       client = nil
 
       begin
@@ -22,7 +22,7 @@ class BrowserShooter
             BrowserShooter::Commander.wrapper_execute(
               command.strip,
               client,
-              "#{output_path}/#{script["name"]}_#{browser["name"]}"
+              "#{shots_path}/#{script["name"]}_#{browser["name"]}"
             )
           end
 

data/lib/browser_shooter/log_exporter.rb

@@ -1,17 +1,17 @@
 class BrowserShooter
   module LogExporter
-    def self.export( path, logs, format )
+    def self.export( logs, path, format )
       BrowserShooter::Logger.log "Exporting '#{format}' logs to #{path}"
-      send(:"export_to_#{format}", path, logs )
+      send(:"export_to_#{format}", logs, path )
     end
 
-    def self.export_to_json( path, logs )
-      File.open( "#{path}.json", "w" ) do |f|
+    def self.export_to_json( logs, path )
+      File.open( "#{path}/logs.json", "w" ) do |f|
         f.write JSON.pretty_generate( logs )
       end
     end
 
-    def self.export_to_csv( path, logs )
+    def self.export_to_csv( logs, path )
       logs.each do |script_name, results|
         _path = File.expand_path "#{path}/#{script_name}.csv"
 

data/lib/browser_shooter/version.rb

@@ -1,3 +1,3 @@
 class BrowserShooter
-  VERSION = "0.0.5"
+  VERSION = "0.1.1"
 end

data/lib/browser_shooter.rb

@@ -26,11 +26,11 @@ class BrowserShooter
     config["scripts"].each_value do |script|
       config["browsers"].each_value do |browser|
         logs["#{script["name"]}_#{browser["name"]}"] =
-          BrowserShooter::Driver.run_script_on_browser(script, browser, config["output_path"])
+          BrowserShooter::Driver.run_script_on_browser(script, browser, "#{config["output_path"]}/shots")
       end
     end
 
-    BrowserShooter::LogExporter.export( "#{config["output_path"]}/logs", logs, config["logs_format"] )
+    BrowserShooter::LogExporter.export( logs, "#{config["output_path"]}/logs", config["logs_format"] )
 
     BrowserShooter::Logger.log "... script running ended."
     BrowserShooter::Logger.log "shots are in: #{config["output_path"]}/shots"

data/test/browser_shooter_test.rb

@@ -9,14 +9,14 @@ class BrowserScreenshotTest < Test::Unit::TestCase
     config_file_path = "#{FIXTURES}/config_simple.yml"
     BrowserShooter::Configurator.expects( :load_config ).with( config_file_path ).returns( YAML.load_file( config_file_path ) )
 
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-one", "/shoots-path" )
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-two", "/shoots-path" )
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-three", "/shoots-path" )
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-one", "/shoots-path" )
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-two", "/shoots-path" )
-    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-three", "/shoots-path" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-one", "/output_path/shots" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-two", "/output_path/shots" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-one", "browser-three", "/output_path/shots" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-one", "/output_path/shots" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-two", "/output_path/shots" )
+    BrowserShooter::Driver.expects( :run_script_on_browser).with( "script-two", "browser-three", "/output_path/shots" )
 
-    BrowserShooter::Util.expects( :export_logs_to_csv )
+    BrowserShooter::LogExporter.expects( :export_to_csv )
 
     BrowserShooter.new( config_file_path ).run
   end

data/test/commander_test.rb

@@ -41,6 +41,8 @@ class CommanderTest < Test::Unit::TestCase
   end
 
   def test_shot_without_sufix
+    BrowserShooter::Commander.stubs( :timestamp ).returns( "timestamp" )
+
     in_tmpdir do |tmpdir|
       client = stub( :capture_entire_page_screenshot_to_string => read_fixture( "screenshot.base64" ) )
       path = "#{tmpdir}/myfile"
@@ -49,7 +51,7 @@ class CommanderTest < Test::Unit::TestCase
 
       assert_equal(
        Digest::MD5.hexdigest( Base64.decode64( read_fixture( "screenshot.base64" ) ) ),
-       Digest::MD5.hexdigest( File.read( "#{path}.png" ) )
+       Digest::MD5.hexdigest( File.read( "#{path}_timestamp.png" ) )
       )
     end
   end
@@ -69,6 +71,8 @@ class CommanderTest < Test::Unit::TestCase
   end
 
   def test_shot_system_without_sufix
+    BrowserShooter::Commander.stubs( :timestamp ).returns( "timestamp" )
+
     in_tmpdir do |tmpdir|
       client = stub( :capture_screenshot_to_string => read_fixture( "screenshot.base64" ) )
       path = "#{tmpdir}/myfile"
@@ -77,7 +81,7 @@ class CommanderTest < Test::Unit::TestCase
 
       assert_equal(
        Digest::MD5.hexdigest( Base64.decode64( read_fixture( "screenshot.base64" ) ) ),
-       Digest::MD5.hexdigest( File.read( "#{path}.system.png" ) )
+       Digest::MD5.hexdigest( File.read( "#{path}_timestamp.system.png" ) )
       )
     end
   end

data/test/configurator_test.rb

@@ -3,13 +3,13 @@ require_relative "test_helper"
 class ConfiguratorTest < Test::Unit::TestCase
   def test_load_config
     BrowserShooter::Configurator.expects( :timestamp ).returns( "timestamp" )
-    FileUtils.expects( :mkdir_p ).with( "/shoots-path/timestamp" )
-    FileUtils.expects( :mkdir ).with( "/shoots-path/timestamp/shots" )
-    FileUtils.expects( :mkdir ).with( "/shoots-path/timestamp/logs" )
+    FileUtils.expects( :mkdir_p ).with( "/output_path/timestamp" )
+    FileUtils.expects( :mkdir ).with( "/output_path/timestamp/shots" )
+    FileUtils.expects( :mkdir ).with( "/output_path/timestamp/logs" )
 
     config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config_simple.yml" )
 
-    assert_equal( "/shoots-path/timestamp", config["output_path"] )
+    assert_equal( "/output_path/timestamp", config["output_path"] )
     assert_equal( "script-one", config["scripts"]["script-one"] )
     assert_equal( "browser-one", config["browsers"]["browser-one"] )
   end

data/test/fixtures/config.yml

@@ -1,4 +1,4 @@
-output_path: "/tmp/shoots"
+output_path: "/tmp/output"
 
 scripts:
   google:

data/test/fixtures/config_simple.yml

@@ -1,4 +1,4 @@
-output_path: "/shoots-path"
+output_path: "/output_path"
 logs_format: "csv"
 
 scripts:

data/test/fixtures/logs/logs.json

@@ -0,0 +1,24 @@
+{
+  "script1": [
+    {
+      "time": "the time 1",
+      "success": true,
+      "command": "the command 1",
+      "message": "the message 1"
+    },
+    {
+      "time": "the time 2",
+      "success": false,
+      "command": "the command 2",
+      "message": "the message 2"
+    }
+  ],
+  "script2": [
+    {
+      "time": "the time 3",
+      "success": true,
+      "command": "the command 3",
+      "message": "the message 3"
+    }
+  ]
+}

data/test/fixtures/logs/script1.csv

@@ -0,0 +1,3 @@
+time | success | command | message
+the time 1 | true | the command 1 | the message 1
+the time 2 | false | the command 2 | the message 2

data/test/fixtures/logs/script2.csv

@@ -0,0 +1,2 @@
+time | success | command | message
+the time 3 | true | the command 3 | the message 3

data/test/log_exporter_test.rb

@@ -0,0 +1,62 @@
+require_relative "test_helper"
+
+class LogExporterTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @logs = {
+      "script1" => [
+        {
+          :time     => "the time 1",
+          :success  => true,
+          :command  => "the command 1",
+          :message  => "the message 1"
+        },
+        {
+          :time     => "the time 2",
+          :success  => false,
+          :command  => "the command 2",
+          :message  => "the message 2"
+        }
+      ],
+      "script2" => [
+        {
+          :time     => "the time 3",
+          :success  => true,
+          :command  => "the command 3",
+          :message  => "the message 3"
+        }
+      ]
+    }
+  end
+
+  def test_export_should_call_sub_methods
+    BrowserShooter::LogExporter.expects( :"export_to_format" ).with( "logs", "path" )
+    BrowserShooter::LogExporter.export( "logs", "path", "format" )
+  end
+
+  def test_export_to_json
+    in_tmpdir do |path|
+      BrowserShooter::LogExporter.export_to_json( @logs, path )
+      result = File.read( "#{path}/logs.json" )
+
+      # File.open( "#{FIXTURES}/logs/logs.json", "w" ) { |f| f.write result }
+
+      assert_equal( read_fixture( "logs/logs.json" ), result )
+    end
+  end
+
+  def test_export_to_csv
+    in_tmpdir do |path|
+      BrowserShooter::LogExporter.export_to_csv( @logs, path )
+      result1 = File.read( "#{path}/script1.csv" )
+      result2 = File.read( "#{path}/script2.csv" )
+
+      # File.open( "#{FIXTURES}/logs/script1.csv", "w" ) { |f| f.write result1 }
+      # File.open( "#{FIXTURES}/logs/script2.csv", "w" ) { |f| f.write result2 }
+
+      assert_equal( read_fixture( "logs/script1.csv" ), result1 )
+      assert_equal( read_fixture( "logs/script2.csv" ), result2 )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browser_shooter
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70249375547000 !ruby/object:Gem::Requirement
+  requirement: &70305037223240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.rc.6
   type: :development
   prerelease: false
-  version_requirements: *70249375547000
+  version_requirements: *70305037223240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70249375546500 !ruby/object:Gem::Requirement
+  requirement: &70305037222740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70249375546500
+  version_requirements: *70305037222740
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70249375546120 !ruby/object:Gem::Requirement
+  requirement: &70305037222360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70249375546120
+  version_requirements: *70305037222360
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &70249375545660 !ruby/object:Gem::Requirement
+  requirement: &70305037221900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249375545660
+  version_requirements: *70305037221900
 - !ruby/object:Gem::Dependency
   name: selenium
-  requirement: &70249375545240 !ruby/object:Gem::Requirement
+  requirement: &70305037221480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249375545240
+  version_requirements: *70305037221480
 - !ruby/object:Gem::Dependency
   name: selenium-client
-  requirement: &70249375544820 !ruby/object:Gem::Requirement
+  requirement: &70305037221060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249375544820
+  version_requirements: *70305037221060
 description: Selenium RC wraper to create browser screenshots
 email:
 - fguillen.mail@gmail.com
@@ -97,7 +97,6 @@ files:
 - examples/config2.yml
 - examples/config3.yml
 - examples/config4.yml
-- examples/config5.yml
 - lib/browser_shooter.rb
 - lib/browser_shooter/commander.rb
 - lib/browser_shooter/configurator.rb
@@ -111,7 +110,11 @@ files:
 - test/driver_test.rb
 - test/fixtures/config.yml
 - test/fixtures/config_simple.yml
+- test/fixtures/logs/logs.json
+- test/fixtures/logs/script1.csv
+- test/fixtures/logs/script2.csv
 - test/fixtures/screenshot.base64
+- test/log_exporter_test.rb
 - test/test_helper.rb
 homepage: https://github.com/fguillen/BrowserShooter
 licenses: []
@@ -144,5 +147,9 @@ test_files:
 - test/driver_test.rb
 - test/fixtures/config.yml
 - test/fixtures/config_simple.yml
+- test/fixtures/logs/logs.json
+- test/fixtures/logs/script1.csv
+- test/fixtures/logs/script2.csv
 - test/fixtures/screenshot.base64
+- test/log_exporter_test.rb
 - test/test_helper.rb

data/examples/config5.yml

@@ -1,18 +0,0 @@
-output_path: "~/browser_shooter"
-
-scripts:
-  lightbox:
-    name: "lightbox"
-    url: "http://localhost:3000"
-    commands: |
-      open "/test/browser_shooter/lightbox_bareplayer.html"
-      window_maximize
-      shot
-
-
-browsers:
-  windows-firefox:
-    name: "osx-firefox"
-    host: 127.0.0.1
-    port: 4444
-    browser: "*firefox"