browser_shooter 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp
+.rvmrc
+shoots/

data/.rvmrc.example

@@ -0,0 +1,2 @@
+rvm use 1.9.2@browser_shooter
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# BrowserShooter
+
+Combined with Selenium RC this gem allows to program Selenium scripts combined with ScreenShots.
+
+## Use it
+
+### Setup the servers
+
+1. Set up your VirtualMachines with your target SO and browsers installed. Java SE is also needed.
+2. Download the last version of [Selenium Server](http://seleniumhq.org/download/) (AKA Selenium Remote Control).
+3. Go to the console and start the Selenium Server:
+
+    java -jar <your selenium server file>.jar
+
+Repeat this steps in every VM.
+
+### Config your BrowserShooter script
+
+Create a YAML file like this:
+
+shoots_path: "/tmp/shoots"
+
+scripts:
+  google:
+    name: "google"
+    url: "http://www.google.de"
+    # commands are Selenium commands
+    # except 'shot' command wich receive an optional param with the 'sufix' of the screenshot png
+    # except 'pause' command wich use a Ruby 'sleep' command to pause
+    commands: |
+      open "/"
+      window_maximize
+      shot before
+      type "id=lst-ib", "fernando guillen"
+      click "name=btnG", wait_for :page
+      pause 3
+      shot after
+
+browsers:
+  windows-firefox:
+    name: "windows-firefox"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*firefox"
+
+  windows-iexplore:
+    name: "windows-iexploreproxy"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*iexploreproxy"
+
+Look in the `examples` folder for more complete examples.
+
+
+### Run the BrowserShooter script
+
+    $ browser_shooter ./my/config.yml
+
+The screenshots will be stored in:
+
+    <shoots_path>/<time_stamp>/<script_name>_<browser_name>[_<sufix>].png
+
+## Status
+
+Still in a _discovery_ state.. no tests.
+
+But is functional a can be usefull in no-production environments.

data/Rakefile

@@ -0,0 +1,17 @@
+# require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << '.'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/bin/browser_shooter

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Use:
+#     browser_shooter /path/to/config.yml
+
+begin
+  require '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
+
+BrowserShooter.new( ARGV[0] ).run

data/browser_shoter.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "browser_shooter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "browser_shooter"
+  s.version     = BrowserShooter::VERSION
+  s.authors     = ["Fernando Guillen"]
+  s.email       = ["fguillen.mail@gmail.com"]
+  s.homepage    = "https://github.com/fguillen/BrowserShooter"
+  s.summary     = "Selenium RC wraper to create browser screenshots"
+  s.description = "Selenium RC wraper to create browser screenshots"
+
+  s.rubyforge_project = "browser_shooter"
+
+  s.add_development_dependency "bundler",   ">= 1.0.0.rc.6"
+  s.add_development_dependency "rake",      "0.9.2.2"
+  s.add_dependency "selenium-webdriver"
+  s.add_dependency "selenium"
+  s.add_dependency "selenium-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/examples/config1.yml

@@ -0,0 +1,55 @@
+shoots_path: "~/browser_shoots"
+
+scripts:
+  google:
+    name: "google"
+    url: "http://www.google.de"
+    commands: |
+      open "/"
+      window_maximize
+      shot before
+      type "id=lst-ib", "fernando guillen"
+      click "name=btnG", wait_for :page
+      pause 3
+      shot after
+
+
+  miniclip:
+    name: "miniclip"
+    url: "http://www.miniclip.com/games/de/"
+    commands: |
+      open "/"
+      window_maximize
+      shot
+
+  brandengage:
+    name: "brandengage"
+    url: "http://staging.iframe.sponsorpay.com"
+    commands: |
+      open "/test/brandengage.html"
+      window_maximize
+      click "link=be_1372_dedicated"
+      pause 5
+      get_alert
+      click "link=sp.showVideo();"
+      pause 5
+      shot
+
+browsers:
+  windows-firefox:
+    name: "windows-firefox"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*firefox"
+
+  windows-iexplore:
+    name: "windows-iexploreproxy"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*iexploreproxy"
+
+  linux-firefox:
+    name: "linux-firefox"
+    host: 10.211.55.5
+    port: 4444
+    browser: "*firefox"

data/examples/config2.yml

@@ -0,0 +1,28 @@
+shoots_path: "~/browser_shoots"
+
+scripts:
+  brandengage:
+    name: "brandengage"
+    url: "http://staging.iframe.sponsorpay.com"
+    commands: |
+      open "/test/brandengage.html"
+      window_maximize
+      click "link=be_1372_dedicated"
+      pause 5
+      get_alert
+      click "link=sp.showVideo();"
+      pause 5
+      shot
+
+browsers:
+  windows-firefox:
+    name: "windows-firefox"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*firefox"
+
+  windows-iexplore:
+    name: "windows-iexploreproxy"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*iexploreproxy"

data/lib/browser_shooter/commander.rb

@@ -0,0 +1,40 @@
+class BrowserShooter
+  module Commander
+    def self.execute( command, client, shoot_path )
+      BrowserShooter::Logger.log "command: #{command}"
+
+      if( command.split[0].strip == "shot" )
+        sufix = command.split[1] ? command.split[1].strip : nil
+
+        BrowserShooter::Commander.shot(
+          client,
+          shoot_path,
+          sufix
+        )
+
+      elsif( command.split[0].strip == "pause" )
+        BrowserShooter::Commander.pause( command.split[1].strip.to_i )
+
+      else
+        eval "client.#{command}"
+
+      end
+    end
+
+    def self.shot( client, path, sufix = nil )
+      sufix = "_#{sufix}" unless sufix.nil?
+      path  = "#{path}#{sufix}.png"
+
+      BrowserShooter::Logger.log "shooting in '#{path}'"
+
+      File.open( path, "wb" ) do |f|
+        f.write( Base64.decode64( client.capture_entire_page_screenshot_to_string( "" ) ) )
+      end
+    end
+
+    def self.pause( seconds )
+      BrowserShooter::Logger.log "pausing #{seconds} seconds"
+      sleep seconds
+    end
+  end
+end

data/lib/browser_shooter/driver.rb

@@ -0,0 +1,38 @@
+class BrowserShooter
+  module Driver
+    def self.run_script_on_browser(script, browser, shoots_path)
+      BrowserShooter::Logger.log "Runing script '#{script["name"]}' with url '#{script["url"]}' in browser '#{browser["name"]}'"
+
+      client = nil
+
+      begin
+        client =
+          Selenium::Client::Driver.new(
+            :host     => browser["host"],
+            :port     => browser["port"],
+            :browser  => browser["browser"],
+            :url      => script["url"],
+            :timeout_in_seconds => 20
+          )
+
+        client.start_new_browser_session
+
+        script["commands"].lines.each do |command|
+          BrowserShooter::Commander.execute(
+            command,
+            client,
+            "#{shoots_path}/#{script["name"]}_#{browser["name"]}"
+          )
+        end
+
+      rescue Exception => e
+        BrowserShooter::Logger.log "ERROR: #{e.message}"
+        # puts e.backtrace
+
+      ensure
+        client.close_current_browser_session if client
+
+      end
+    end
+  end
+end

data/lib/browser_shooter/logger.rb

@@ -0,0 +1,7 @@
+class BrowserShooter
+  module Logger
+    def self.log( message )
+      puts "[BrowserShooter #{Time.now.strftime( "%F %T" )}] #{message}"
+    end
+  end
+end

data/lib/browser_shooter/version.rb

@@ -0,0 +1,3 @@
+class BrowserShooter
+  VERSION = "0.0.1"
+end

data/lib/browser_shooter.rb

@@ -0,0 +1,42 @@
+require_relative "./browser_shooter/version"
+require_relative "./browser_shooter/logger"
+require_relative "./browser_shooter/driver"
+require_relative "./browser_shooter/commander"
+
+require "selenium-webdriver"
+require "selenium-client"
+require "yaml"
+
+class BrowserShooter
+  attr_reader :config
+
+  def initialize( config_file_path )
+    @config = load_config( config_file_path )
+  end
+
+  def load_config( config_file_path )
+    config = YAML.load_file( config_file_path )
+    config = set_up_shoots_path( config )
+
+    config
+  end
+
+  def run
+    config["scripts"].each_value do |script|
+      config["browsers"].each_value do |browser|
+        BrowserShooter::Driver.run_script_on_browser(script, browser, config["shoots_path"])
+      end
+    end
+  end
+
+  def set_up_shoots_path( config )
+    config["shoots_path"] = File.expand_path( "#{config["shoots_path"]}/#{Time.now.strftime("%Y%m%d%H%M%S")}" )
+    BrowserShooter::Logger.log( "shoots_path: #{config["shoots_path"]}" )
+
+    FileUtils.mkdir_p( config["shoots_path"] )
+
+    config
+  end
+
+end
+

data/test/browser_shooter_test.rb

@@ -0,0 +1,7 @@
+require_relative "test_helper"
+
+class BrowserScreenshotTest < Test::Unit::TestCase
+  def test_run
+    BrowserShooter.new( "#{FIXTURES}/config.yml" ).run
+  end
+end

data/test/fixtures/config.yml

@@ -0,0 +1,55 @@
+shoots_path: "/tmp/shoots"
+
+scripts:
+  google:
+    name: "google"
+    url: "http://www.google.de"
+    commands: |
+      open "/"
+      window_maximize
+      shot before
+      type "id=lst-ib", "fernando guillen"
+      click "name=btnG", wait_for :page
+      pause 3
+      shot after
+
+
+  miniclip:
+    name: "miniclip"
+    url: "http://www.miniclip.com/games/de/"
+    commands: |
+      open "/"
+      window_maximize
+      shot
+
+  brandengage:
+    name: "brandengage"
+    url: "http://staging.iframe.sponsorpay.com"
+    commands: |
+      open "/test/brandengage.html"
+      window_maximize
+      click "link=be_1372_dedicated"
+      pause 5
+      get_alert
+      click "link=sp.showVideo();"
+      pause 5
+      shot
+
+browsers:
+  windows-firefox:
+    name: "windows-firefox"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*firefox"
+
+  windows-iexplore:
+    name: "windows-iexploreproxy"
+    host: 10.211.55.4
+    port: 4444
+    browser: "*iexploreproxy"
+
+  linux-firefox:
+    name: "linux-firefox"
+    host: 10.211.55.5
+    port: 4444
+    browser: "*firefox"

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "test/unit"
+require_relative "../lib/browser_shooter"
+
+FIXTURES = File.expand_path( "#{File.dirname(__FILE__)}/fixtures" )

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: browser_shooter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Fernando Guillen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 6
+        version: 1.0.0.rc.6
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: selenium-webdriver
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: selenium
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: selenium-client
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Selenium RC wraper to create browser screenshots
+email: 
+- fguillen.mail@gmail.com
+executables: 
+- browser_shooter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc.example
+- Gemfile
+- README.md
+- Rakefile
+- bin/browser_shooter
+- browser_shoter.gemspec
+- examples/config1.yml
+- examples/config2.yml
+- lib/browser_shooter.rb
+- lib/browser_shooter/commander.rb
+- lib/browser_shooter/driver.rb
+- lib/browser_shooter/logger.rb
+- lib/browser_shooter/version.rb
+- test/browser_shooter_test.rb
+- test/fixtures/config.yml
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/fguillen/BrowserShooter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: browser_shooter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Selenium RC wraper to create browser screenshots
+test_files: 
+- test/browser_shooter_test.rb
+- test/fixtures/config.yml
+- test/test_helper.rb