browser_shooter 0.3.1 → 0.3.3

data/README.md

@@ -49,6 +49,7 @@ Create a YAML file like this:
         click "a.kls"
         pause 3
         shot after
+        shot_system final_shot
 
       miniclip: |
         navigate.to "http://www.miniclip.com/games/de/"
@@ -58,10 +59,12 @@ Create a YAML file like this:
       windows-firefox:
         url: "http://127.0.0.1:4444/wd/hub"
         type: "firefox"
+        vm: "VirtualBox name"
 
       windows-iexplore:
         url: "http://127.0.0.1:4444/wd/hub"
         type: "ie"
+        vm: "VirtualBox name"
 
     suites:
       suite1:
@@ -86,6 +89,7 @@ Look in the [examples folder](https://github.com/fguillen/BrowserShooter/tree/ma
 Commands are WebDriver commands, except:
 
 * **shot** command which receive an optional param with the 'sufix' of the page screenshot png
+* **shot_system** equal to 'shot' but use the "VirtualBox" system command "VBoxManage" to make an screenshot of the OS screen.
 * **pause** command which use a Ruby 'sleep' command to pause
 * **click** command which receive a 'css_selector' as a param, find the element and click on it
 * **type** command which receive two params: 'css_selector' ana a 'message', find the element and type the message on it
@@ -97,6 +101,8 @@ You can define as much tests as you want. Every test is composed by a list of **
 
 All the available browsers with the **selenium server url** and the **selenium browser type**.
 
+Also if you are gonna use the _shot_system_ command you have to indicate the name of the VirtualBox machine in the **vm** attribute.
+
 ##### Suites section
 
 Groups of **tests** and **browsers** to be executed as one.
@@ -137,4 +143,8 @@ The logs will be stored in:
 
 ## Status
 
-Still in a _development_ state.. but is already **functional**.
+Still in a _development_ state.. but is already **functional**.
+
+## TODO
+
+Support _Parallels_ screenshots with `$ prlctl capture`.

data/examples/config0.yml

@@ -3,7 +3,8 @@ output_path: "~/browser_shoots"
 tests:
   google: |
     navigate.to "http://www.google.com"
-    shot
+    shot browser
+    shot_system system
 
   miniclip: |
     navigate.to "http://www.miniclip.com/games/de/"
@@ -13,10 +14,17 @@ browsers:
   ios-firefox:
     url: "http://127.0.0.1:4444/wd/hub"
     type: "firefox"
+    vm: "My VM"
 
   ios-chrome:
     url: "http://127.0.0.1:4444/wd/hub"
     type: "chrome"
+    vm: "My VM"
+
+  win-ie:
+    url: "http://192.168.2.102:4444/wd/hub"
+    type: "ie"
+    vm: "windows7"
 
 suites:
   suite1:
@@ -31,5 +39,5 @@ suites:
     tests:
       - google
     browsers:
-      - ios-chrome
+      - win-ie
 

data/examples/config1.yml

@@ -19,10 +19,12 @@ browsers:
   ios-firefox:
     url: "http://127.0.0.1:4444/wd/hub"
     type: "firefox"
+    vm: "myVM"
 
   ios-chrome:
     url: "http://127.0.0.1:4444/wd/hub"
     type: "chrome"
+    vm: "myVM"
 
 suites:
   suite1:

data/examples/config2.yml

@@ -29,18 +29,22 @@ browsers:
   osx-chrome:
     url: "http://127.0.0.1:4444/wd/hub"
     type: "chrome"
+    vm: "myVM"
 
   windows-chrome:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "chrome"
+    vm: "myVM"
 
   windows-firefox:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "firefox"
+    vm: "myVM"
 
   windows-ie:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "ie"
+    vm: "myVM"
 
 suites:
   suite1:

data/lib/browser_shooter/base.rb

@@ -49,6 +49,7 @@ module BrowserShooter
           BrowserShooter::Commander.script(
             test.commands,
             driver,
+            browser,
             output_path
           )
 

data/lib/browser_shooter/commander.rb

@@ -1,12 +1,13 @@
 module BrowserShooter::Commander
 
-  def self.script( commands, driver, output_path )
+  def self.script( commands, driver, browser, output_path )
     test_result =
       commands.map do |command|
         command_result =
           BrowserShooter::Commander.wrapper_execute(
             command.strip,
             driver,
+            browser,
             output_path
           )
 
@@ -20,7 +21,7 @@ module BrowserShooter::Commander
     test_result
   end
 
-  def self.execute( command, driver, output_path )
+  def self.execute( command, driver, browser, output_path )
     BrowserShooter::Logger.log "command: #{command}"
 
     if( command.split[0].strip == "shot" )
@@ -32,6 +33,16 @@ module BrowserShooter::Commander
         sufix
       )
 
+    elsif( command.split[0].strip == "shot_system" )
+      sufix = command.split[1] ? command.split[1].strip : nil
+
+      BrowserShooter::Commander.shot_system(
+        driver,
+        browser,
+        output_path,
+        sufix
+      )
+
     elsif( command.split[0].strip == "pause" )
       BrowserShooter::Commander.pause( command.split[1].strip.to_i )
 
@@ -66,7 +77,7 @@ module BrowserShooter::Commander
     end
   end
 
-  def self.wrapper_execute( command, driver, output_path )
+  def self.wrapper_execute( command, driver, browser, output_path )
     result = {
       :time     => Time.now.to_i,
       :command  => command
@@ -77,6 +88,7 @@ module BrowserShooter::Commander
         BrowserShooter::Commander.execute(
           command,
           driver,
+          browser,
           output_path
         )
 
@@ -114,6 +126,24 @@ module BrowserShooter::Commander
     return shot_path
   end
 
+  def self.shot_system( driver, browser, output_path, sufix = nil )
+    sufix     = timestamp unless sufix
+    shot_path = "#{output_path}/shots/#{sufix}.png"
+
+    BrowserShooter::Logger.log "shooting system in '#{shot_path}'"
+
+    FileUtils.mkdir_p( File.dirname( shot_path ) )
+
+    command = "VBoxManage controlvm '#{browser.vm}' screenshotpng '#{shot_path}'"
+    success = Kernel.system( command )
+
+    if( !success )
+      raise SystemCallError, "Shoot system command [#{command}] returns error: '#{$?}'"
+    end
+
+    return shot_path
+  end
+
   def self.wait_for_element( driver, css_selector, timeout )
     wait = Selenium::WebDriver::Wait.new( :timeout => timeout )
 

data/lib/browser_shooter/configurator.rb

@@ -57,7 +57,7 @@ module BrowserShooter
 
       browsers =
         config["browsers"].map do |name, opts|
-          BrowserShooter::Models::Browser.new( name, opts["url"], opts["type"] )
+          BrowserShooter::Models::Browser.new( name, opts["url"], opts["type"], opts["vm"] )
         end
 
       suites =

data/lib/browser_shooter/models/browser.rb

@@ -1,6 +1,6 @@
 module BrowserShooter
   module Models
-    class Browser < Struct.new( :name, :url, :type )
+    class Browser < Struct.new( :name, :url, :type, :vm )
     end
   end
 end

data/lib/browser_shooter/version.rb

@@ -1,3 +1,3 @@
 module BrowserShooter
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

data/test/base_test.rb

@@ -34,7 +34,7 @@ class BaseTest < Test::Unit::TestCase
     BrowserShooter::Base.new( opts ).run
   end
 
-  def test_run_script
+  def test_run_test
     expected_opts = {
       :url                    => "url1",
       :desired_capabilities   => "type1".to_sym
@@ -43,7 +43,7 @@ class BaseTest < Test::Unit::TestCase
     driver = mock()
     driver.expects( :quit )
     Selenium::WebDriver.expects( :for ).with( :remote, expected_opts ).returns( driver )
-    BrowserShooter::Commander.expects( :script ).with( @test1.commands, driver, "output_path/suite1/test1/browser1" ).returns( "log1" )
+    BrowserShooter::Commander.expects( :script ).with( @test1.commands, driver, @browser1, "output_path/suite1/test1/browser1" ).returns( "log1" )
     BrowserShooter::LogExporter.expects( :export ).with( "log1", "output_path/suite1/test1/browser1/logs" )
 
     BrowserShooter::Base.run_test( @suite1, @test1, @browser1, "output_path" )

data/test/commander_test.rb

@@ -7,69 +7,129 @@ class CommanderTest < Test::Unit::TestCase
       "  command2 "
     ]
 
-    BrowserShooter::Commander.expects( :wrapper_execute ).with( "command1", "driver", "output_path" ).returns( "result1" )
-    BrowserShooter::Commander.expects( :wrapper_execute ).with( "command2", "driver", "output_path" ).returns( "result2" )
+    BrowserShooter::Commander.expects( :wrapper_execute ).with( "command1", "driver", "browser", "output_path" ).returns( "result1" )
+    BrowserShooter::Commander.expects( :wrapper_execute ).with( "command2", "driver", "browser", "output_path" ).returns( "result2" )
     BrowserShooter::Logger.expects( :command_result ).twice
     BrowserShooter::Logger.expects( :test_result )
 
-    result = BrowserShooter::Commander.script( commands, "driver", "output_path" )
+    result = BrowserShooter::Commander.script( commands, "driver", "browser", "output_path" )
 
     assert_equal( ["result1", "result2"], result )
   end
 
+  def test_wrapper_execute
+    BrowserShooter::Commander.expects( :execute ).with( "command", "driver", "browser", "output_path" ).returns( "message" )
+    result = BrowserShooter::Commander.wrapper_execute( "command", "driver", "browser", "output_path" )
+
+    assert_equal( "command", result[:command] )
+    assert_equal( false, result[:time].nil? )
+    assert_equal( true, result[:success] )
+    assert_equal( "message", result[:message] )
+  end
+
+  def test_wrapper_execute_when_error
+    BrowserShooter::Commander.expects( :execute ).with( "command", "driver", "browser", "output_path" ).raises( Exception.new( "error" ) )
+    result = BrowserShooter::Commander.wrapper_execute( "command", "driver", "browser", "output_path" )
+
+    assert_equal( "command", result[:command] )
+    assert_equal( false, result[:time].nil? )
+    assert_equal( false, result[:success] )
+    assert_equal( "error", result[:message] )
+  end
+
   def test_execute_when_shot_with_sufix
     BrowserShooter::Commander.expects( :shot ).with( "driver", "shoot-path", "sufix" )
-    BrowserShooter::Commander.execute( "shot sufix", "driver", "shoot-path" )
+    BrowserShooter::Commander.execute( "shot sufix", "driver", "browser", "shoot-path" )
   end
 
   def test_execute_when_shot_without_sufix
     BrowserShooter::Commander.expects( :shot ).with( "driver", "shoot-path", nil )
-    BrowserShooter::Commander.execute( "shot", "driver", "shoot-path" )
+    BrowserShooter::Commander.execute( "shot", "driver", "browser", "shoot-path" )
+  end
+
+  def test_execute_when_shot_system_with_sufix
+    BrowserShooter::Commander.expects( :shot_system ).with( "driver", "browser", "shoot-path", "sufix" )
+    BrowserShooter::Commander.execute( "shot_system sufix", "driver", "browser", "shoot-path" )
+  end
+
+  def test_execute_when_shot_system_without_sufix
+    BrowserShooter::Commander.expects( :shot_system ).with( "driver", "browser", "shoot-path", nil )
+    BrowserShooter::Commander.execute( "shot_system", "driver", "browser", "shoot-path" )
   end
 
   def test_execute_when_pause
     BrowserShooter::Commander.expects( :pause ).with( 10 )
-    BrowserShooter::Commander.execute( "pause 10", "driver", "shoot-path" )
+    BrowserShooter::Commander.execute( "pause 10", "driver", "browser", "shoot-path" )
   end
 
   def test_execute_when_wait_for_element
     BrowserShooter::Commander.expects( :wait_for_element ).with( "driver", "css_selector", 10 )
-    BrowserShooter::Commander.execute( "wait_for_element \"css_selector\", 10", "driver", nil )
+    BrowserShooter::Commander.execute( "wait_for_element \"css_selector\", 10", "driver", "browser", nil )
   end
 
   def test_execute_when_click
     BrowserShooter::Commander.expects( :click ).with( "driver", "css_selector" )
-    BrowserShooter::Commander.execute( "click \"css_selector\"", "driver", nil )
+    BrowserShooter::Commander.execute( "click \"css_selector\"", "driver", "browser", nil )
   end
 
   def test_execute_when_type
     BrowserShooter::Commander.expects( :type ).with( "driver", "css_selector", "message a b" )
-    BrowserShooter::Commander.execute( "type \"css_selector\", \"message a b\"", "driver", nil )
+    BrowserShooter::Commander.execute( "type \"css_selector\", \"message a b\"", "driver", "browser", nil )
   end
 
   def test_shot_with_sufix
-    in_tmpdir do |tmpdir|
-      driver      = mock()
-      output_path = tmpdir
+    driver = mock()
 
-      FileUtils.expects( :mkdir_p ).with( "#{output_path}/shots" )
-      driver.expects( :save_screenshot ).with( "#{output_path}/shots/sufix.png" )
+    FileUtils.expects( :mkdir_p ).with( "output_path/shots" )
+    driver.expects( :save_screenshot ).with( "output_path/shots/sufix.png" )
 
-      BrowserShooter::Commander.shot( driver, output_path, "sufix" )
-    end
+    BrowserShooter::Commander.shot( driver, "output_path", "sufix" )
   end
 
   def test_shot_without_sufix
     BrowserShooter::Commander.stubs( :timestamp ).returns( "timestamp" )
 
-    in_tmpdir do |tmpdir|
-      driver      = mock()
-      output_path = tmpdir
+    driver = mock()
+
+    FileUtils.expects( :mkdir_p ).with( "output_path/shots" )
+    driver.expects( :save_screenshot ).with( "output_path/shots/timestamp.png" )
+
+    BrowserShooter::Commander.shot( driver, "output_path", nil )
+  end
+
+  def test_shot_system_with_sufix
+    browser  = mock()
+    command  = "VBoxManage controlvm 'VMName' screenshotpng 'output_path/shots/sufix.png'"
+
+    browser.stubs( :vm ).returns( "VMName" )
+    FileUtils.expects( :mkdir_p ).with( "output_path/shots" )
+    Kernel.expects( :system ).with( command ).returns( true )
+
+    BrowserShooter::Commander.shot_system( "driver", browser, "output_path", "sufix" )
+  end
+
+  def test_shot_system_without_sufix
+    browser  = mock()
+    command  = "VBoxManage controlvm 'VMName' screenshotpng 'output_path/shots/timestamp.png'"
+
+    BrowserShooter::Commander.stubs( :timestamp ).returns( "timestamp" )
+    browser.stubs( :vm ).returns( "VMName" )
+    FileUtils.expects( :mkdir_p ).with( "output_path/shots" )
+    Kernel.expects( :system ).with( command ).returns( true )
+
+    BrowserShooter::Commander.shot_system( "driver", browser, "output_path" )
+  end
+
+  def test_shot_system_with_error
+    browser  = mock()
+    command  = "VBoxManage controlvm 'VMName' screenshotpng 'output_path/shots/sufix.png'"
 
-      FileUtils.expects( :mkdir_p ).with( "#{output_path}/shots" )
-      driver.expects( :save_screenshot ).with( "#{output_path}/shots/timestamp.png" )
+    browser.stubs( :vm ).returns( "VMName" )
+    FileUtils.expects( :mkdir_p ).with( "output_path/shots" )
+    Kernel.expects( :system ).with( command ).returns( false )
 
-      BrowserShooter::Commander.shot( driver, output_path, nil )
+    assert_raise( SystemCallError ) do
+      BrowserShooter::Commander.shot_system( "driver", browser, "output_path", "sufix" )
     end
   end
 

data/test/configurator_test.rb

@@ -29,6 +29,7 @@ class ConfiguratorTest < Test::Unit::TestCase
     assert_equal( "windows-firefox", models[:browsers].first.name )
     assert_equal( "http://10.211.55.4:4444/wd/hub", models[:browsers].first.url )
     assert_equal( "firefox", models[:browsers].first.type )
+    assert_equal( "vmName1", models[:browsers].first.vm )
 
     assert_equal( 2, models[:suites].size )
     assert_equal( "suite1", models[:suites].first.name )

data/test/fixtures/config.yml

@@ -17,14 +17,17 @@ browsers:
   windows-firefox:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "firefox"
+    vm: "vmName1"
 
   windows-iexplore:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "iexploreproxy"
+    vm: "vmName2"
 
   linux-firefox:
     url: "http://10.211.55.4:4444/wd/hub"
     type: "firefox"
+    vm: "vmName3"
 
 suites:
   suite1:

data/test/models/browser_test.rb

@@ -2,9 +2,10 @@ require_relative "../test_helper"
 
 class BrowserTest < Test::Unit::TestCase
   def test_initialize
-    browser = BrowserShooter::Models::Browser.new( "name", "url", "type")
+    browser = BrowserShooter::Models::Browser.new( "name", "url", "type", "vm_name")
     assert_equal( "name", browser.name )
     assert_equal( "url", browser.url )
     assert_equal( "type", browser.type )
+    assert_equal( "vm_name", browser.vm )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browser_shooter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-20 00:00:00.000000000Z
+date: 2012-03-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70234217808280 !ruby/object:Gem::Requirement
+  requirement: &70311807614080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.rc.6
   type: :development
   prerelease: false
-  version_requirements: *70234217808280
+  version_requirements: *70311807614080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70234217807780 !ruby/object:Gem::Requirement
+  requirement: &70311807613580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70234217807780
+  version_requirements: *70311807613580
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70234217807400 !ruby/object:Gem::Requirement
+  requirement: &70311807613200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70234217807400
+  version_requirements: *70311807613200
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &70234217837900 !ruby/object:Gem::Requirement
+  requirement: &70311807612740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70234217837900
+  version_requirements: *70311807612740
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
-  requirement: &70234217837480 !ruby/object:Gem::Requirement
+  requirement: &70311807612320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70234217837480
+  version_requirements: *70311807612320
 description: Selenium RC wraper to create browser screenshots
 email:
 - fguillen.mail@gmail.com