browser_shooter 0.3.9 → 0.3.11

data/lib/browser_shooter/argv_parser.rb

@@ -1,3 +1,4 @@
+# Parse all the _shell commands params_
 module BrowserShooter
   class ARGVParsers
     include Mixlib::CLI

data/lib/browser_shooter/base.rb

@@ -6,6 +6,7 @@ module BrowserShooter
       @opts = opts
     end
 
+    # Main method. Loads the configuration, filter the suites, runs the tests and exports the logs.
     def run
       BrowserShooter::Logger.verbose = opts[:verbose]
       BrowserShooter::Logger.log( "Starting script running with version #{BrowserShooter::VERSION}..." )
@@ -31,6 +32,7 @@ module BrowserShooter
       BrowserShooter::Logger.log( "BYE!" )
     end
 
+    # Runs a single test with all its _commands_ in an specific _browser_
     def self.run_test( suite, test, browser, config )
       BrowserShooter::Logger.log( "Executing #{suite.name} | #{test.name} | #{browser.name}", true )
       output_path = "#{config["output_path"]}/#{suite.name}/#{test.name}/#{browser.name}"

data/lib/browser_shooter/commander.rb

@@ -1,7 +1,15 @@
 module BrowserShooter::Commander
 
+  # Executes a test _script_ with all _its_ commands.
+  #
+  # Returns: the test result in this format:
+  #     {
+  #       :time => (the actual time),
+  #       :success => (true|false),
+  #       :command => (the actual command),
+  #       :message => (the command message or error message),
+  #     }
   def self.script( commands, driver, browser, output_path )
-
     command_executor =
       BrowserShooter::Commands::Base.new(
         driver,

data/lib/browser_shooter/configurator.rb

@@ -2,6 +2,7 @@ module BrowserShooter
   class Configurator
     attr_reader :suites
 
+    # Takes the digested command options and create and filter the models
     def initialize( opts )
       @config = BrowserShooter::Configurator.load_config( opts[:config_file] )
       models  = BrowserShooter::Configurator.build_models( @config )
@@ -10,45 +11,26 @@ module BrowserShooter
       BrowserShooter::Configurator.load_extensions( @config["extensions"] ) if @config["extensions"]
     end
 
+    # The hash version of the _config.yml_ is available here
     def [](value)
       @config[value]
     end
 
-    def self.filter_suites( models, opts )
-      suites = []
-
-      if( opts[:suite] )
-        suite  = models[:suites].select{ |e| e.name == opts[:suite] }.first
-        raise ArgumentError, "Not suite found '#{opts[:suite]}'" if suite.nil?
-
-        suites = [suite]
-
-      elsif( opts[:test] && opts[:browsers] )
-        test      = models[:tests].select{ |e| e.name == opts[:test] }.first
-        raise ArgumentError, "Not test found '#{opts[:test]}'" if test.nil?
-
-        browsers  = models[:browsers].select{ |e| opts[:browsers].include? e.name }
-        raise ArgumentError, "Not browsers found '#{opts[:browsers].join( "," )}'" if browsers.empty?
-
-        suite     = BrowserShooter::Models::Suite.new( "anonymous", [test], browsers )
-        suites    = [suite]
-
-      elsif( opts[:test] )
-        test      = models[:tests].select{ |e| e.name == opts[:test] }.first
-        raise ArgumentError, "Not test found '#{opts[:test]}'" if test.nil?
-
-        browsers  = models[:browsers]
-        suite     = BrowserShooter::Models::Suite.new( "anonymous", [test], browsers )
-        suites    = [suite]
+    # Load the _config.yml_ file and return it in a Hash format
+    def self.load_config( config_file_path )
+      config = {
+        "output_path" => "~/browser_shooter",
+        "timeout"    => 40
+      }
 
-      else
-        suites    = models[:suites]
+      config.merge! YAML.load_file( config_file_path )
 
-      end
+      config["output_path"] = setup_output_path( config["output_path"] )
 
-      suites
+      config
     end
 
+    # Creates the _tests_, _browsers_ and _suites_ arrays.
     def self.build_models( config )
       tests =
         config["tests"].map do |name, commands|
@@ -64,8 +46,8 @@ module BrowserShooter
 
       suites =
         config["suites"].map do |name, opts|
-          suite_tests    = tests.select{ |e| opts["tests"].include? e.name }
-          suite_browsers = browsers.select{ |e| opts["browsers"].include? e.name }
+          suite_tests    = BrowserShooter::Utils.find_by_names( tests, opts["tests"] )
+          suite_browsers = BrowserShooter::Utils.find_by_names( browsers, opts["browsers"] )
 
           BrowserShooter::Models::Suite.new( name, suite_tests, suite_browsers )
         end
@@ -77,21 +59,40 @@ module BrowserShooter
       }
     end
 
-    def self.load_config( config_file_path )
-      config = {
-        "output_path" => "~/browser_shooter",
-        "timeout"    => 40
-      }
+    # If special _filter_ options has been defined in the _command options_ the _suites_ are filtered
+    # to only play with the filtered ones.
+    def self.filter_suites( models, opts )
+      suites = []
 
-      config.merge! YAML.load_file( config_file_path )
+      if( opts[:suite] )
+        suite = BrowserShooter::Utils.find_by_name( models[:suites], opts[:suite] )
 
-      config["output_path"] = setup_output_path( config["output_path"] )
+        suites = [suite]
 
-      config
+      elsif( opts[:test] && opts[:browsers] )
+        test      = BrowserShooter::Utils.find_by_name( models[:tests], opts[:test] )
+        browsers  = BrowserShooter::Utils.find_by_names( models[:browsers], opts[:browsers] )
+        suite     = BrowserShooter::Models::Suite.new( "anonymous", [test], browsers )
+
+        suites = [suite]
+
+      elsif( opts[:test] )
+        test      = BrowserShooter::Utils.find_by_name( models[:tests], opts[:test] )
+        browsers  = models[:browsers]
+        suite     = BrowserShooter::Models::Suite.new( "anonymous", [test], browsers )
+
+        suites = [suite]
+
+      else
+        suites = models[:suites]
+
+      end
+
+      suites
     end
 
     def self.setup_output_path( output_path )
-      output_path = File.expand_path( "#{output_path}/#{timestamp}" )
+      output_path = File.expand_path( "#{output_path}/#{BrowserShooter::Utils.timestamp}" )
       BrowserShooter::Logger.log( "output_path: #{output_path}" )
 
       output_path
@@ -105,8 +106,5 @@ module BrowserShooter
       end
     end
 
-    def self.timestamp
-      Time.now.strftime("%Y%m%d%H%M%S")
-    end
   end
 end

data/lib/browser_shooter/utils.rb

@@ -1,7 +1,18 @@
 module BrowserShooter
   module Utils
     def self.timestamp
-      Time.now.to_i
+      Time.now.strftime( "%Y%m%d%H%M%S" )
+    end
+
+    def self.find_by_name( array, name )
+      element = array.select{ |e| e.name == name }.first
+      raise ArgumentError, "Not element found '#{name}'" if element.nil?
+
+      element
+    end
+
+    def self.find_by_names( array, names )
+      names.map { |name| find_by_name( array, name ) }
     end
   end
 end

data/lib/browser_shooter/version.rb

@@ -1,3 +1,3 @@
 module BrowserShooter
-  VERSION = "0.3.9"
+  VERSION = "0.3.11"
 end

data/test/configurator_test.rb

@@ -85,8 +85,29 @@ class ConfiguratorTest < Test::Unit::TestCase
     assert_equal( "windows-firefox", suites.first.browsers.first.name )
   end
 
+  def test_filter_suites_with_error
+    BrowserShooter::Configurator.stubs( :setup_output_path )
+    config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config.yml" )
+    models = BrowserShooter::Configurator.build_models( config )
+
+    opts = { :suite => "not_exists" }
+    assert_raise( ArgumentError ) do
+      BrowserShooter::Configurator.filter_suites( models, opts )
+    end
+
+    opts = { :test => "not_exists" }
+    assert_raise( ArgumentError ) do
+      BrowserShooter::Configurator.filter_suites( models, opts )
+    end
+
+    opts = { :test => "google", :browsers => ["not_exists"] }
+    assert_raise( ArgumentError ) do
+      BrowserShooter::Configurator.filter_suites( models, opts )
+    end
+  end
+
   def test_load_config
-    BrowserShooter::Configurator.expects( :timestamp ).returns( "timestamp" )
+    BrowserShooter::Utils.expects( :timestamp ).returns( "timestamp" )
 
     config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config_simple.yml" )
 
@@ -97,7 +118,7 @@ class ConfiguratorTest < Test::Unit::TestCase
   end
 
   def test_load_config_with_defaults
-    BrowserShooter::Configurator.expects( :timestamp ).returns( "timestamp" )
+    BrowserShooter::Utils.expects( :timestamp ).returns( "timestamp" )
 
     config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config_empty.yml" )
 
@@ -110,4 +131,22 @@ class ConfiguratorTest < Test::Unit::TestCase
     Kernel.expects( :require ).with( File.expand_path( "extension2.rb" ) )
     BrowserShooter::Configurator.load_extensions( ["extension1.rb", "extension2.rb"] )
   end
+
+  def test_suite_tests_in_order
+    BrowserShooter::Configurator.stubs( :setup_output_path )
+    config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config_in_order.yml" )
+    models = BrowserShooter::Configurator.build_models( config )
+
+    assert_equal( 2, models[:suites].first.tests.size )
+    assert_equal( "test2", models[:suites].first.tests.first.name )
+  end
+
+  def test_suite_browsers_in_order
+    BrowserShooter::Configurator.stubs( :setup_output_path )
+    config = BrowserShooter::Configurator.load_config( "#{FIXTURES}/config_in_order.yml" )
+    models = BrowserShooter::Configurator.build_models( config )
+
+    assert_equal( 2, models[:suites].first.browsers.size )
+    assert_equal( "browser2", models[:suites].first.browsers.first.name )
+  end
 end

data/test/fixtures/config_in_order.yml

@@ -0,0 +1,21 @@
+tests:
+  test1: commands
+  test2: commands
+
+browsers:
+  browser1:
+    url: "http://10.211.55.4:4444/wd/hub"
+    type: "firefox"
+
+  browser2:
+    url: "http://10.211.55.4:4444/wd/hub"
+    type: "iexploreproxy"
+
+suites:
+  suite1:
+    tests:
+      - test2
+      - test1
+    browsers:
+      - browser2
+      - browser1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browser_shooter
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000Z
+date: 2012-04-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70301246657780 !ruby/object:Gem::Requirement
+  requirement: &70295546959160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.rc.6
   type: :development
   prerelease: false
-  version_requirements: *70301246657780
+  version_requirements: *70295546959160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70301246657280 !ruby/object:Gem::Requirement
+  requirement: &70295546958660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70301246657280
+  version_requirements: *70295546958660
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70301246656900 !ruby/object:Gem::Requirement
+  requirement: &70295546958280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301246656900
+  version_requirements: *70295546958280
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &70301246656440 !ruby/object:Gem::Requirement
+  requirement: &70295546957820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301246656440
+  version_requirements: *70295546957820
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
-  requirement: &70301246656020 !ruby/object:Gem::Requirement
+  requirement: &70295546957400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301246656020
+  version_requirements: *70295546957400
 description: Selenium RC wraper to create browser screenshots
 email:
 - fguillen.mail@gmail.com
@@ -111,6 +111,7 @@ files:
 - test/configurator_test.rb
 - test/fixtures/config.yml
 - test/fixtures/config_empty.yml
+- test/fixtures/config_in_order.yml
 - test/fixtures/config_simple.yml
 - test/fixtures/logs/log.csv
 - test/fixtures/screenshot.base64
@@ -153,6 +154,7 @@ test_files:
 - test/configurator_test.rb
 - test/fixtures/config.yml
 - test/fixtures/config_empty.yml
+- test/fixtures/config_in_order.yml
 - test/fixtures/config_simple.yml
 - test/fixtures/logs/log.csv
 - test/fixtures/screenshot.base64