browser_shooter 0.2.3 → 0.3.1

data/README.md

@@ -38,53 +38,103 @@ Create a YAML file like this:
 
     # myconfig.yml
     output_path: "/tmp/shoots"
-    logs_format: "csv"
-
-    scripts:
-      google:
-        name: "google"
-        # commands are WebDriver commands
-        # except 'shot' command which receive an optional param with the 'sufix' of the page screenshot png
-        # except 'pause' command which use a Ruby 'sleep' command to pause
-        # except 'click' command whith receive a 'css_selector' as a param, find the element and click on it
-        # except 'type' command whith receive two params: 'css_selector' ana a 'message', find the element and type the message on it
-        # except 'wait_for_element' command whith receive two params: 'css_selector', and a 'timeout' in seconds
-        commands: |
-          navigate.to "http://www.google.de"
-          shot before
-          type "input[name='q']", "beautiful houses"
-          click "input[name='btnG']"
-          pause 3
-          click "a.kls"
-          pause 3
-          shot after
+
+    tests:
+      google: |
+        navigate.to "http://www.google.de"
+        shot before
+        type "input[name='q']", "beautiful houses"
+        click "input[name='btnG']"
+        pause 3
+        click "a.kls"
+        pause 3
+        shot after
+
+      miniclip: |
+        navigate.to "http://www.miniclip.com/games/de/"
+        shot
 
     browsers:
       windows-firefox:
-        name: "windows-firefox"
         url: "http://127.0.0.1:4444/wd/hub"
-        browser: "firefox"
+        type: "firefox"
 
       windows-iexplore:
-        name: "windows-iexploreproxy"
         url: "http://127.0.0.1:4444/wd/hub"
-        browser: "*iexploreproxy"
+        type: "ie"
+
+    suites:
+      suite1:
+        tests:
+          - google
+          - miniclip
+        browsers:
+          - ios-firefox
+          - ios-chrome
+
+      suite2:
+        tests:
+          - google
+        browsers:
+          - ios-chrome
+
 
 Look in the [examples folder](https://github.com/fguillen/BrowserShooter/tree/master/examples) for more complete examples.
 
+##### Tests section
+
+Commands are WebDriver commands, except:
+
+* **shot** command which receive an optional param with the 'sufix' of the page screenshot png
+* **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
+* **wait_for_element** command which receive two params: 'css_selector', and a 'timeout' in seconds
+
+You can define as much tests as you want. Every test is composed by a list of **one line** commands.
+
+##### Browsers section
+
+All the available browsers with the **selenium server url** and the **selenium browser type**.
+
+##### Suites section
+
+Groups of **tests** and **browsers** to be executed as one.
+
 
 #### Run the BrowserShooter script
 
-    $ browser_shooter ./my/config.yml
+##### The simple way
+
+    $ browser_shooter --config ./my/config.yml
+
+##### Choosing a suite
+
+    $ browser_shooter --config ./my/config.yml -s --suite suite1
+
+##### Choosing a test
+
+    $ browser_shooter --config ./my/config.yml -s --test google
+
+##### Choosing a test an a list of browsers
+
+    $ browser_shooter --config ./my/config.yml -s --test google --browsers windows-firefox,windows-iexplore
+
+##### Check all the options
+
+    $ browser_shooter --help
+
+
+#### The output paths
 
 The screenshots will be stored in:
 
-    /<output_path>/<time_stamp>/shots
+    /<output_path>/<time_stamp>/<suite_name>/<test_name>/<browser_name>/shots
 
 The logs will be stored in:
 
-    /<output_path>/<time_stamp>/logs
+    /<output_path>/<time_stamp>/<suite_name>/<test_name>/<browser_name>/logs
 
 ## Status
 
-Still in a _discovery_ state.. but is already **functional**.
+Still in a _development_ state.. but is already **functional**.

data/Rakefile

@@ -12,6 +12,6 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.libs << '.'
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end

data/bin/browser_shooter

@@ -1,18 +1,14 @@
 #!/usr/bin/env ruby
 
-# Use:
-#     browser_shooter /path/to/config.yml
-
 begin
   require 'browser_shooter'
+  # require_relative "../lib/browser_shooter"
 rescue LoadError
   require 'rubygems'
   require 'browser_shooter'
 end
 
-if ( ARGV.size != 1 )
-  BrowserShooter::Logger.log "use: $ browser_shooter <config_file_path>"
-  exit 1
-end
+argv_parser = BrowserShooter::ARGVParsers.new
+argv_parser.parse_options( ARGV )
 
-BrowserShooter.new( ARGV[0] ).run
+BrowserShooter::Base.new( argv_parser.config ).run

data/browser_shoter.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha"
 
   s.add_dependency "selenium-webdriver"
-  s.add_dependency "selenium"
-  s.add_dependency "selenium-client"
+  s.add_dependency "mixlib-cli"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/examples/config0.yml

@@ -0,0 +1,35 @@
+output_path: "~/browser_shoots"
+
+tests:
+  google: |
+    navigate.to "http://www.google.com"
+    shot
+
+  miniclip: |
+    navigate.to "http://www.miniclip.com/games/de/"
+    shot
+
+browsers:
+  ios-firefox:
+    url: "http://127.0.0.1:4444/wd/hub"
+    type: "firefox"
+
+  ios-chrome:
+    url: "http://127.0.0.1:4444/wd/hub"
+    type: "chrome"
+
+suites:
+  suite1:
+    tests:
+      - google
+      - miniclip
+    browsers:
+      - ios-firefox
+      - ios-chrome
+
+  suite2:
+    tests:
+      - google
+    browsers:
+      - ios-chrome
+

data/examples/config1.yml

@@ -1,31 +1,34 @@
 output_path: "~/browser_shoots"
 
-scripts:
-  google:
-    name: "google"
-    commands: |
-      navigate.to "http://www.google.de"
-      shot before
-      type "input[name='q']", "beautiful houses"
-      click "input[name='btnG']"
-      pause 3
-      click "a.kls"
-      pause 3
-      shot after
+tests:
+  google: |
+    navigate.to "http://www.google.de"
+    shot before
+    type "input[name='q']", "beautiful houses"
+    click "input[name='btnG']"
+    pause 3
+    click "a.kls"
+    pause 3
+    shot after
 
-  miniclip:
-    name: "miniclip"
-    commands: |
-      navigate.to "http://www.miniclip.com/games/de/"
-      shot
+  miniclip: |
+    navigate.to "http://www.miniclip.com/games/de/"
+    shot
 
 browsers:
   ios-firefox:
-    name: "ios-firefox"
     url: "http://127.0.0.1:4444/wd/hub"
-    browser: "firefox"
+    type: "firefox"
 
   ios-chrome:
-    name: "ios-chrome"
     url: "http://127.0.0.1:4444/wd/hub"
-    browser: "chrome"
+    type: "chrome"
+
+suites:
+  suite1:
+    tests:
+      - google
+      - miniclip
+    browsers:
+      - ios-firefox
+      - ios-chrome

data/examples/config2.yml

@@ -1,34 +1,54 @@
 output_path: "~/browser_shooter"
 
-scripts:
-  lightbox:
-    name: "lightbox"
-    commands: |
-      navigate.to "http://192.168.70.76:3000/test/browser_shooter/lightbox_bareplayer.html"
-      shot 01_first
-      pause 5
-      switch_to.alert.accept
-      click "a"
-      pause 5
-      shot 02_video
-      switch_to.frame "_sp_wiframe"
-      execute_script "$f().play()"
-      pause 3
-      shot 03_video_start
-      wait_for_element "span.enabled", 40
-      shot 04_green_button
-      click "span.enabled"
-      pause 8
-      switch_to.alert.accept
-      shot 05_spinner
-      switch_to.default_content
-      click "#sp_close_x"
-      switch_to.alert.accept
-      pause 4
-      shot 06_hidden
+tests:
+  lightbox: |
+    navigate.to "http://192.168.70.70/test/browser_shooter/lightbox_bareplayer.html"
+    shot 01_first
+    pause 5
+    switch_to.alert.accept
+    click "a"
+    pause 5
+    shot 02_video
+    switch_to.frame "_sp_wiframe"
+    execute_script "$f().play()"
+    pause 3
+    shot 03_video_start
+    wait_for_element "span.enabled", 40
+    shot 04_green_button
+    click "span.enabled"
+    pause 8
+    switch_to.alert.accept
+    shot 05_spinner
+    switch_to.default_content
+    click "#sp_close_x"
+    switch_to.alert.accept
+    pause 4
+    shot 06_hidden
 
 browsers:
   osx-chrome:
-    name: "osx-chrome"
     url: "http://127.0.0.1:4444/wd/hub"
-    browser: "chrome"
+    type: "chrome"
+
+  windows-chrome:
+    url: "http://10.211.55.4:4444/wd/hub"
+    type: "chrome"
+
+  windows-firefox:
+    url: "http://10.211.55.4:4444/wd/hub"
+    type: "firefox"
+
+  windows-ie:
+    url: "http://10.211.55.4:4444/wd/hub"
+    type: "ie"
+
+suites:
+  suite1:
+    tests:
+      - lightbox
+    browsers:
+      - osx-crhome
+      - windows-chrome
+      - windows-firefox
+      - windows-ie
+

data/lib/browser_shooter.rb

@@ -1,41 +1,17 @@
+require "selenium-webdriver"
+require "mixlib/cli"
+require "yaml"
+require "json"
+
+require_relative "./browser_shooter/base"
+require_relative "./browser_shooter/models/suite"
+require_relative "./browser_shooter/models/test"
+require_relative "./browser_shooter/models/browser"
 require_relative "./browser_shooter/version"
 require_relative "./browser_shooter/configurator"
 require_relative "./browser_shooter/logger"
-require_relative "./browser_shooter/driver"
 require_relative "./browser_shooter/commander"
 require_relative "./browser_shooter/log_exporter"
+require_relative "./browser_shooter/argv_parser"
 
-require "selenium-webdriver"
-require "selenium-client"
-require "yaml"
-require "json"
-
-class BrowserShooter
-  attr_reader :config_file_path
-
-  def initialize( config_file_path )
-    @config_file_path = config_file_path
-  end
-
-  def run
-    BrowserShooter::Logger.log "Starting script running with version #{BrowserShooter::VERSION}..."
-
-    config  = BrowserShooter::Configurator.load_config( config_file_path )
-    logs    = {}
-
-    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"]}/shots")
-      end
-    end
-
-    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"
-    BrowserShooter::Logger.log "logs are in: #{config["output_path"]}/logs"
-    BrowserShooter::Logger.log "BYE!"
-  end
-end
 

data/lib/browser_shooter/argv_parser.rb

@@ -0,0 +1,54 @@
+module BrowserShooter
+  class ARGVParsers
+    include Mixlib::CLI
+
+    option(
+      :config_file,
+      :short        => "-c CONFIG",
+      :long         => "--config CONFIG",
+      :required     => true,
+      :description  => "The configuration file to use"
+    )
+
+    option(
+      :suite,
+      :short        => "-s SUITE",
+      :long         => "--suite SUITE",
+      :description  => "The name of the suite to execute",
+    )
+
+    option(
+      :test,
+      :short        => "-t TEST",
+      :long         => "--test TEST",
+      :description  => "The name of the test to execute",
+    )
+
+    option(
+      :browsers,
+      :short        => "-b BROWSERS",
+      :long         => "--browsers BROWSERS",
+      :description  => "The name of the browsers to execute, separated by comas",
+      :proc         => Proc.new { |browsers| browsers.split(",") }
+    )
+
+    option(
+      :verbose,
+      :short        => "-v",
+      :long         => "--verbose",
+      :description  => "More verbose output",
+      :boolean      => true
+    )
+
+    option(
+      :help,
+      :short        => "-h",
+      :long         => "--help",
+      :description  => "Show this message",
+      :on           => :tail,
+      :boolean      => true,
+      :show_options => true,
+      :exit         => 0
+    )
+  end
+end