gondola 1.1.6 → 1.1.7

data/README.markdown

@@ -0,0 +1,85 @@
+# Gondola
+
+Gondola is a ruby gem which aims to bridge the gap between two very prominent, open source, quality assurance tools, Selenium IDE and Sauce Labs.
+Many quality assurance professionals who don't have the necessary technical skills to write Selenium webdriver-based unit tests prefer to do their
+web regression testing using solely the Selenium IDE and then exporting those test cases by some means to Sauce Labs' system.
+
+Gondola offers an easier and more convenient system for dispatching tests written in Selenium IDE to a Sauce Labs account. Gondola transforms the html
+that Selenium IDE produces by default and ships it to Sauce Labs across a number of browsers in parallel. Test suites and projects can be easily organized
+with simple file directory structures.
+
+Beyond the console application that comes with the gem, Gondola offers a small API for integrating Gondola's features into custom web apps. This allows
+a user to bring Gondola's simplicity into an existing testing suite or a new web application. Specifically, we have a plan to write a sample Gondola web
+app to demonstrate its power.  
+
+## Installation
+
+    $ gem install gondola
+
+NOTE: You may run into problems if rubygems' executable path is not in your `$PATH` environment variable. See rubygems' documentation
+for more details.
+
+## Usage
+
+Gondola offers a simplistic command line application for quickly debugging tests written in the Selenium IDE. Gondola also offers a short and sweet API for
+integrating Gondola's features into any other application.
+
+### Getting started
+
+    $ gondola help
+
+Will get you started with the basic commands available. The most used and main function of gondola is the `run` command.
+
+    $ gondola run [options] [tests]
+
+The available `[options]` are:
+
+* `-s` or `--super_parallel`: This activates "super\_parallel" mode which will not only execute all browsers in parallel but also all the
+  test cases. This mode is experimental and may slow down Sauce Labs considerably. Use at your own risk.
+* `-r` or `--recursive`: This activates recursive search mode. When you supply Gondola with a directory containing tests, using this option will
+  enable sub directory searching.
+
+The `[tests]` attribute refers to a list of test cases or test suites:
+
+* Test cases can either be in HTML format (Selenium IDE saves) or in ruby format which is just a bunch of commands that you would like to execute. 
+  * NOTE: The ruby test case feature is under construction and should not be used at the moment.
+* Test suites are directories that contain many test cases.
+
+### Integrating with an existing product
+
+    require 'rubygems'
+    require 'gondola'
+
+    browsers = [
+        {:os => "Windows 2003", :browser => "firefox", :browser_version => "3.6"},
+        {:os => "Windows 2003", :browser => "iexplore", :browser_version => "8" },
+    ]
+
+    runner = Gondola::TestRunner.new
+    runner.add_test "example.html"
+    runner.run({:base_url => "http://www.google.com", :browsers => browsers})
+
+The above code does several things:
+
+* `runner.add_test "example.html"` adds the test case "example.html" to the list of tests that this runner will execute when you tell it to
+* `runner.run(opts={})` runs all the tests that you've added with the options specified. The list of available options is long and a work in progress
+  with the rest of the documentation.
+
+The end result here is that the test case that you have written with Selenium IDE, "example.html", is converted to ruby on the fly and then sent
+to Sauce Labs with two browser settings in parallel.
+
+## Contributing to gondola
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Agora Games. See LICENSE.txt for
+further details.
+

data/bin/gondola

@@ -45,18 +45,19 @@ class RunCommand < CmdParse::Command
   # Function that is executed when a user issues a run command
   def execute(args)
     if args.length < 1
-      puts run.usage
+      puts usage
       exit 1
     end
-    test = args[0]
     # Can either provide directory or file
-    if File.exists?(test)
-      runner = Gondola::TestRunner.new
-      runner.add_test(test)
-      runner.run(@opts)
-    else
-      puts "Could not find file \"#{test}\""
+    runner = Gondola::TestRunner.new
+    args.each do |t| 
+      if File.exists? t
+        runner.add_test t
+      else
+        puts "Could not find \"#{t}\""
+      end
     end
+    runner.run(@opts)
   end
 end
 cmd.add_command(RunCommand.new)

data/gondola.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gondola}
-  s.version = "1.1.6"
+  s.version = "1.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Perry"]
-  s.date = %q{2011-03-10}
+  s.date = %q{2011-03-16}
   s.default_executable = %q{gondola}
   s.description = %q{
     Gondola is Ruby command line utility and as well as a library  which helps
@@ -21,14 +21,14 @@ Gem::Specification.new do |s|
   s.executables = ["gondola"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "bin/gondola",
     "examples/config.yml",
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/perrym5/gondola}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.0}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{Ruby command line utility and library for integrating the Selenium IDE more tightly with Sauce Labs' Ondemand services}
   s.test_files = [
     "test/helper.rb",

data/lib/gondola/tester.rb

@@ -7,9 +7,6 @@ module Gondola
   class Tester
     attr_reader :cmd_num, :sel, :converter, :job_id
 
-    class AssertionFailed < StandardError
-    end
-
     def initialize(sel, converter)
       @sel = sel
       @converter = converter
@@ -21,9 +18,12 @@ module Gondola
       @job_id = @sel.session_id
       begin
         eval(@converter.ruby)
-      rescue AssertionFailed 
+      rescue => e
+        $stderr.puts e.message + " - stopping test."
+      rescue Selenium::Client::CommandError
+      ensure
+        @sel.stop()
       end
-      @sel.stop()
     end
 
     def cmd_inc
@@ -32,25 +32,25 @@ module Gondola
 
     def assert(expr)
       unless verify(expr)
-        raise AssertionFailed
+        raise "Assertion Failed"
       end
     end
 
     def assert_not(expr)
       unless verifyNot(expr)
-        raise AssertionFailed
+        raise "Assertion Failed"
       end
     end
 
     def assert_eq(eq, expr)
       unless verify(eq, expr)
-        raise AssertionFailed
+        raise "Assertion Failed"
       end
     end
 
     def assert_not_eq(eq, expr)
       unless verifyNot(eq, expr)
-        raise AssertionFailed
+        raise "Assertion Failed"
       end
     end
 

data/lib/gondola/testrunner.rb

@@ -7,77 +7,60 @@ require 'gondola'
 
 module Gondola
   class TestRunner
-    attr_accessor :tests
+    attr_reader :tests
 
     def initialize
       @tests = []
     end
 
+    # Function to add a test to the member array of
+    # tests for this test run
     def add_test(file)
       @tests.push(file)
     end
 
+    # Function to run all tests that have been added
+    #   - opts: hash which can be used to override the
+    #           configuration from yml files
     def run(opts = {})
+      # Cannot run tests if there are none
       if @tests.empty?
         puts "No tests to run"
       end
+      # TODO: Need to implement a super-parallel ability( dangerous )
       if opts[:super_parallel] == true
         puts "Work in progress, please run again without the super parallel flag"
       else
+        # Iterate over all tests and dispatch each to Sauce Labs
         @tests.each do |test|
           if File.directory? test
-            Dir.chdir(test)
-            prepend = ""
-            if opts[:recursive] == true
-              prepend = "**/"
-            end
-            files = Dir.glob(prepend + "*.html")
-            files.concat(Dir.glob(prepend + "*.rb"))
-            files.each do |file|
-              conf = configure(File.expand_path(File.dirname(file)))
-              run_test(file, conf)
+            Dir.chdir(test) do
+              prepend = ""
+              if opts[:recursive] == true
+                prepend = "**/"
+              end
+              files = Dir.glob(prepend + "*.html")
+              files.concat(Dir.glob(prepend + "*.rb"))
+              files.each do |file|
+                converter,global,browsers = aggregate_data(file, opts)
+                run_test(converter, global, browsers)
+              end
             end
           else
-            conf = configure(File.expand_path(File.dirname(test)))
-            run_test(test, conf)
+            file = File.basename(test)
+            Dir.chdir(File.dirname(test)) do
+                converter,global,browsers = aggregate_data(file, opts)
+                run_test(converter, global, browsers)
+            end
           end
         end
       end
     end
 
     private
-    # Function to configure sauce labs' gem with proper api information
-    # as well as populate the configuration for the specific test being run
-    def configure(file)
-      # Load possible paths for the api information (Sauce already does this to some extent
-      # but more paths were required for this gem)
-      conf = {}
-      apiPaths = [
-        File.expand_path(File.join(file, "ondemand.yml")),
-        File.expand_path(File.join(file, "../ondemand.yml")),
-      ]
-      apiPaths.each do |path|
-        if File.exists?(path)
-          conf = YAML.load_file(path)
-          break
-        end
-      end          
-
-      # Load possible paths for the configuration information
-      configPaths = [
-        File.expand_path(File.join(file, "../config.yml")),
-        File.expand_path(File.join(file, "config.yml")),
-      ]
-      configPaths.each do |path|
-        if File.exists?(path)
-          conf.merge! YAML.load_file(path)
-        end
-      end          
-      return conf
-    end
-
-    # Function to run and parallelize the given test on the given browsers
-    def run_test(file, conf)
+    # Function to collect configuration data from various
+    # sources so that the test can run properly
+    def aggregate_data(file, opts)
       # Initialize a converter object based on filetype
       converter = nil
       if File.extname(file) == '.html'
@@ -85,6 +68,10 @@ module Gondola
       elsif File.extname(file) == '.rb'
         converter = Gondola::LegacyConverter.new(file)
       end
+      # Load file config data
+      conf = config_from_file(file)
+      # Merge in user-supplied data
+      conf.merge! opts
       # Set global information
       global = {}
       global[:job_name] = converter.name
@@ -93,18 +80,57 @@ module Gondola
       end
       global.merge! conf.reject { |k,v| !([:username, :access_key].include?(k)) }
       global[:browser_url] = conf[:base_url]
+
+      return [converter, global, conf[:browsers]]
+    end
+
+    # Function to read any config files which contain data for this
+    # test case or suite
+    def config_from_file(file, api=true, data=true)
+      # If the given test is just a file then start your search in
+      # its parent directory
+      unless File.directory? file
+        return config_from_file(File.dirname(file))
+      end
+      # Load any config files in the current directory only if
+      # a config hasn't already been found
+      conf = {}
+      Dir.chdir(file) do
+        if api
+          if File.exists? "ondemand.yml"
+            conf.merge! YAML.load_file("ondemand.yml")
+            api = false
+          end
+        end
+        if data
+          if File.exists? "config.yml"
+            conf.merge! YAML.load_file("config.yml")
+            data = false
+          end
+        end
+      end
+      # Recurse through the parent directories and merge the
+      # current configuration
+      unless file == File.dirname(file)
+        return config_from_file(File.dirname(file), api, data).merge(conf)
+      end
+      return conf
+    end
+
+    # Function to run and parallelize the given test on the given browsers
+    def run_test(converter, global, browsers)
       # Spawn n threads
-      Parallel.map(conf[:browsers], :in_threads => conf[:browsers].size)do |browser|
-        # Add global information to this configuration
-        browser.merge! global
+      Parallel.map(browsers, :in_threads => browsers.size) do |request|
+        # Add global information to this request
+        request.merge! global
         # Request a new selenium object from Sauce
-        selenium = Sauce::Selenium.new(browser)
+        selenium = Sauce::Selenium.new(request)
         # Begin test using a tester object
         tester = Gondola::Tester.new(selenium, converter)
-        browser_string = "#{browser[:os]} #{browser[:browser]} #{browser[:browser_version]}"
-        puts "Starting test case \"#{file}\" with: #{browser_string}"
+        browser_string = "#{request[:os]} #{request[:browser]} #{request[:browser_version]}"
+        puts "Starting test case \"#{converter.name}\" with: #{browser_string}"
         tester.begin
-        puts "#{file} finished - Sauce Job ID: #{tester.job_id}"
+        puts "#{converter.name} finished - Sauce Job ID: #{tester.job_id}"
       end
       puts
     end

data/lib/gondola/version.rb

@@ -1,3 +1,3 @@
 module Gondola
-    VERSION = "1.1.6"
+    VERSION = "1.1.7"
 end

metadata

@@ -2,7 +2,7 @@
 name: gondola
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors: 
 - Matthew Perry
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-10 00:00:00 -05:00
+date: 2011-03-16 00:00:00 -04:00
 default_executable: gondola
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,13 +76,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - bin/gondola
 - examples/config.yml
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 351993709
+      hash: 1003150642294150752
       segments: 
       - 0
       version: "0"
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Ruby command line utility and library for integrating the Selenium IDE more tightly with Sauce Labs' Ondemand services

data/README.rdoc

@@ -1,19 +0,0 @@
-= gondola
-
-WORK IN PROGRESS
-
-== Contributing to gondola
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Agora Games. See LICENSE.txt for
-further details.
-