bauxite 0.6.5 → 0.6.6

data/lib/bauxite/application.rb

@@ -53,6 +53,10 @@ module Bauxite
 	#     Number of seconds to wait before issuing a timeout error. This
 	#     timeout applies only to Selectors. 
 	#
+	# [-o, \--open_timeout SECONDS]
+	#     Number of seconds to wait before issuing a timeout error. This
+	#     timeout applies only to page loading times (i.e. Net::HTTP).
+	#
 	# [-d, \--debug]
 	#     If an error occurs, break into the debug console. This mode is very
 	#     useful to try different selector combinations and debug
@@ -84,6 +88,8 @@ module Bauxite
 	#    To see a complete list of the available loggers execute:
 	#        bauxite -h
 	#
+	#    Note that multiple instances of this option can be specified.
+	#
 	# [-L, \--logger-option OPTION]
 	#    A <tt>name=value</tt> pair of options that are directly forwarded to
 	#    the logger. This option argument can appear multiple times in the
@@ -106,12 +112,34 @@ module Bauxite
 	#    To see a complete list of the available selectors execute:
 	#        bauxite -h
 	#
+	# [-c, \--capture]
+	#    If the test fails, capture a screenshot in the +output+ directory.
+	#    See the \--output option below.
+	#
+	# [\--csv-summary FILE]
+	#    Output a single-line CSV summary ideal to feed into the Plot Jenkins
+	#    plugin. If +FILE+ is not specified, defaults to +summary.csv+
+	#
+	# [\--output DIR]
+	#    Output directory for generated artifacts. Defaults to the current
+	#    working directory.
+	#
 	# [-u, \--url URL]
 	#    This option is an alias of:
 	#        -p remote -P url=URL
 	#    If +URL+ is not present <tt>http://localhost:4444/wd/hub</tt> will be
 	#    assumed.
 	#
+	# [\--jenkins DIR]
+	#    Configures default options for Jenkins integration. This option is an
+	#    alias of:
+	#         -p remote -P url=http://localhost:4444/wd/hub -l echo -l html
+	#         -L html_package=true -c --csv-summary
+	#         --output DIR
+	#    Note that any of the options above can be overridden by specifying the
+	#    option after the <tt>--jenkins</tt> option. For example:
+	#         --jenkins -u selenium.my-organization.com:4445
+	#
 	# [-e, \--extension DIR]
 	#    Loads every Ruby file (*.rb) inside +DIR+ (and subdirectories). This
 	#    option can be used to load custom Bauxite extensions (e.g. Actions, 
@@ -147,7 +175,7 @@ module Bauxite
 	class Application
 		def self.start #:nodoc:
 			options = {
-				:logger       => (ENV['TERM'] == 'xterm') ?  'xterm' : 'terminal',
+				:logger       => [],
 				:verbose      => false,
 				:break        => false,
 				:driver       => 'firefox',
@@ -160,7 +188,9 @@ module Bauxite
 				:logger_opt   => {},
 				:extensions   => []
 			}
-
+			
+			default_logger = (ENV['TERM'] == 'xterm') ?  'xterm' : 'terminal'
+			
 			OptionParser.new do |opts|
 				opts.banner = "Usage: bauxite [options] [files...]"
 				
@@ -173,13 +203,19 @@ module Bauxite
 					end
 					self
 				end
-				def opts.multi(*args)
+				def opts.hash(*args)
 					on(*args[1..-1]) do |v|
 						n,v = v.split('=', 2)
 						@o[args[0]][n.to_sym] = v || true
 					end
 					self
 				end
+				def opts.multi(*args)
+					on(*args[1..-1]) do |v|
+						@o[args[0]] << v
+					end
+					self
+				end
 				opts.o = options
 
 				opts.separator ""
@@ -191,23 +227,36 @@ module Bauxite
 				.single(:debug       , "-d",  "--debug", "Break to debug on error. "+
 												"Start the debug console if no input files given.")
 				.single(:driver      , "-p",  "--provider PROVIDER"     , "Driver provider")
-				.multi( :driver_opt  , "-P",  "--provider-option OPTION", "Provider options (name=value)")
-				.single(:logger      , "-l",  "--logger LOGGER"         , "Logger type ('#{options[:logger]}')")
-				.multi( :logger_opt  , "-L",  "--logger-option OPTION"  , "Logger options (name=value)")
+				.hash(  :driver_opt  , "-P",  "--provider-option OPTION", "Provider options (name=value)")
+				.multi( :logger      , "-l",  "--logger LOGGER"         , "Logger type ('#{default_logger}')")
+				.hash(  :logger_opt  , "-L",  "--logger-option OPTION"  , "Logger options (name=value)")
 				.single(:reset       , "-r",  "--reset"                 , "Reset driver between tests")
 				.single(:wait        , "-w",  "--wait"                  , "Wait for ENTER before exiting")
 				.single(:selector    , "-s",  "--selector SELECTOR"     , "Default selector ('#{options[:selector]}')")
 				.single(:capture     , "-c",  "--capture"               , "If the test fails, capture a screenshot")
-				.single(:csv         , "--csv-summary FILE"             , "Output a single-line CSV summary")
 				.single(:output      , "--output DIR"                   , "Output directory for generated artifacts")
-				opts.on("-u", "--url [URL]", "Configure the remote provider listening in the given url.") do |v|
+				.multi( :extensions  , "-e",  "--extension DIR"         , "Load extensions from DIR")
+				
+				opts.on("-u", "--url [URL]", "Configure the remote provider listening in the given url") do |v|
 					v = 'localhost:4444' unless v
 					v = 'http://'+v unless v.match /^https?:\/\//
 					v = v + '/wd/hub' unless v.end_with? '/wd/hub'
 					options[:driver] = 'remote'
 					options[:driver_opt][:url] = v
 				end
-				opts.on("-e", "--extension DIR", "Load extensions from DIR") { |v| options[:extensions] << v }
+				
+				opts.on("--csv-summary [FILE]", "Output a single-line CSV summary") { |v| options[:csv] = v || 'summary.csv' }
+				
+				opts.on("--jenkins DIR", "Configure default options for Jenkins integration") do |v|
+					options[:driver] = 'remote'
+					options[:driver_opt][:url] = 'http://localhost:4444/wd/hub'
+					options[:logger] = ['echo', 'html']
+					options[:output] = v
+					options[:logger_opt][:html_package] = true
+					options[:capture] = true
+					options[:csv] = 'summary.csv'
+				end
+				
 				opts.on("--version", "Show version") do
 					puts "bauxite #{Bauxite::VERSION}"
 					exit
@@ -232,7 +281,9 @@ module Bauxite
 				
 				opts.separator ""
 			end.parse!
-
+			
+			options[:logger] << default_logger unless options[:logger].size > 0
+			
 			ctx = nil
 			begin
 				ctx = Context.new(options)
@@ -273,7 +324,7 @@ module Bauxite
 						ok     = ctx.tests.inject(0) { |s,t| s + (t[:status] == 'OK' ? 1 : 0) }
 						failed = total - ok
 						time   = ctx.tests.inject(0) { |s,t| s + t[:time] }
-						File.open(csv_file, 'w') do |f|
+						File.open(ctx.output_path(csv_file), 'w') do |f|
 							f.write "Total,OK,Failed,Time\n#{total},#{ok},#{failed},#{time}\n"
 						end
 					end

data/lib/bauxite/core/context.rb

@@ -23,6 +23,7 @@
 require 'selenium-webdriver'
 require 'readline'
 require 'csv'
+require 'pathname'
 
 # Load dependencies and extensions without leaking dir into the global scope
 lambda do
@@ -177,7 +178,12 @@ module Bauxite
 		#     #    and clicks the "Search" button.
 		#
 		def start(actions = [])
-			_load_driver
+			begin
+				_load_driver
+			rescue StandardError => e
+				print_error(e)
+				raise
+			end
 			return unless actions.size > 0
 			begin
 				actions.each do |action|
@@ -420,7 +426,13 @@ module Bauxite
 		# Constructs a Logger instance using +name+ as a hint for the logger
 		# type.
 		#
-		def self.load_logger(name, options)
+		def self.load_logger(loggers, options)
+			if loggers.is_a? Array
+				return Loggers::CompositeLogger.new(options, loggers)
+			end
+			
+			name = loggers
+			
 			log_name = (name || 'null').downcase
 			
 			class_name = "#{log_name.capitalize}Logger"
@@ -555,6 +567,29 @@ module Bauxite
 			end
 		end
 		
+		# Returns the output path for +path+ accounting for the 
+		# <tt>__OUTPUT__</tt> variable.
+		#
+		# For example:
+		#     # assuming --output /mnt/disk
+		#     
+		#     ctx.output_path '/tmp/myfile.txt'
+		#     # => returns '/tmp/myfile.txt'
+		#     
+		#     ctx.output_path 'myfile.txt'
+		#     # => returns '/mnt/disk/myfile.txt'
+		#
+		def output_path(path)
+			unless Pathname.new(path).absolute?
+				output = @variables['__OUTPUT__']
+				if output
+					Dir.mkdir output unless Dir.exists? output
+					path = File.join(output, path)
+				end
+			end
+			path
+		end
+		
 		# ======================================================================= #
 		# :section: Metadata
 		# ======================================================================= #

data/lib/bauxite/loggers/composite.rb

@@ -24,19 +24,23 @@
 #
 # This composite logger forwards logging calls to each of its children.
 #
-# Set the +:loggers+ option to a comma-separated list of logger names
+# Composite logger options include:
+# [<tt>loggers</tt>] A comma-separated list of logger names.
 #
 class Bauxite::Loggers::CompositeLogger
 	
 	# Constructs a new composite logger instance.
-	def initialize(options)
-		unless options[:loggers]
-			raise ArgumentError, "Missing required logger option 'loggers'. "+
-				"The value of this option is a comma-separated list of valid loggers. "+
-				"For example loggers=xterm,file."
+	def initialize(options, loggers = nil)
+		unless loggers
+			unless options[:loggers]
+				raise ArgumentError, "Missing required logger option 'loggers'. "+
+					"The value of this option is a comma-separated list of valid loggers. "+
+					"For example loggers=xterm,file."
+			end
+			loggers = options[:loggers].split(',')
 		end
 
-		@loggers = options[:loggers].split(',').map do |l|
+		@loggers = loggers.map do |l|
 			Bauxite::Context::load_logger(l, options)
 		end
 	end

data/lib/bauxite/loggers/file.rb

@@ -25,6 +25,10 @@
 # This logger outputs the raw action text for every action executed to
 # the file specified in the +file+ logger option.
 #
+# File logger options include:
+# [<tt>file</tt>] Output file name.
+#
+#
 class Bauxite::Loggers::FileLogger < Bauxite::Loggers::NullLogger
 	
 	# Constructs a new echo logger instance.
@@ -34,12 +38,17 @@ class Bauxite::Loggers::FileLogger < Bauxite::Loggers::NullLogger
 		unless @file and @file != ''
 			raise ArgumentError, "FileLogger configuration error: Undefined 'file' option."
 		end
-		File.open(@file, "w") {} # truncate file
+		@lines = []
+	end
+	
+	# Completes the log execution.
+	def finalize(ctx)
+		File.open(ctx.output_path(@file), 'w') { |f| f.write(@lines.join("\n")) }
 	end
 	
 	# Echoes the raw action text.
 	def log_cmd(action)
-		File.open(@file, 'a+') { |f| f.write(action.text+"\n") }
+		@lines << action.text
 		yield
 	end
 end

data/lib/bauxite/loggers/html.rb

@@ -20,12 +20,20 @@
 # SOFTWARE.
 #++
 
-# Echo logger.
+require 'base64'
+
+# Html logger.
 #
-# This logger outputs the raw action text for every action executed.
+# This logger creates an HTML report of the test execution, linking to the
+# captures taken, if any.
 #
-# Note that this logger does not include execution status information
-# (i.e. action succeeded, failed or was skipped).
+# Html logger options include:
+# [<tt>html</tt>] Name of the outpus HTML report file. If not present, defaults 
+#                 to "test.html".
+# [<tt>html_package</tt>] If set, embed captures into the HTML report file
+#                         using the data URI scheme (base64 encoded). The
+#                         captures embedded into the report are deleted from
+#                         the filesystem.
 #
 class Bauxite::Loggers::HtmlLogger < Bauxite::Loggers::NullLogger
 	
@@ -35,6 +43,7 @@ class Bauxite::Loggers::HtmlLogger < Bauxite::Loggers::NullLogger
 		super(options)
 		@data = []
 		@file = options[:html] || 'test.html'
+		@imgs = []
 	end
 	
 	# Logs the specified string.
@@ -158,12 +167,9 @@ class Bauxite::Loggers::HtmlLogger < Bauxite::Loggers::NullLogger
 		html << "
 	</body>
 </html>"
-		file = @file
-		if output != ''
-			file = File.join(output, file)
-			Dir.mkdir output unless Dir.exists? output
-		end
+		file = ctx.output_path(@file)
 		File.open(file, 'w') { |f| f.write html }
+		File.delete(*@imgs) if @imgs.size > 0
 	end
 	
 private
@@ -171,7 +177,13 @@ private
 		"\n"+depth.times.inject('') { |s,i| s + "\t" } + s
 	end
 	def _img(output, path)
-		path = path[output.size+1..-1] unless output == ''
-		"<img src='#{path}'/>"
+		if @options[:html_package]
+			content = Base64.encode64(File.open(path, 'r') { |f| f.read })
+			@imgs << path unless @imgs.include? path
+			"<img src='data:image/png;base64,#{content}'/>"
+		else
+			path = path[output.size+1..-1] unless output == ''
+			"<img src='#{path}'/>"
+		end
 	end
 end

data/lib/bauxite/loggers/xterm.rb

@@ -27,6 +27,14 @@ require_relative 'terminal'
 # This logger outputs colorized lines using xterm (VT100/2) escape
 # sequences.
 #
+# XTerm logger options include:
+# [<tt>nc</tt>, <tt>color</tt>] If set to 'no', prints text without using
+#                               colors. Note that positional escape sequences
+#                               will still be used to show progress. To disable
+#                               escape sequences completely, consider using the
+#                               Bauxite::Loggers::TerminalLogger logger
+#                               instead.
+#
 class Bauxite::Loggers::XtermLogger < Bauxite::Loggers::TerminalLogger
 
 protected

data/lib/bauxite.rb

@@ -22,7 +22,7 @@
 
 #--
 module Bauxite
-	VERSION = "0.6.5"
+	VERSION = "0.6.6"
 end
 #++
 

data/test/asserth.bxt

@@ -1,2 +1,2 @@
 open "https://www.ruby-lang.org"
-asserth "content-type=html" "content-length=^\d+$"
+asserth "content-type=html" "status=^\d+ .*$"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bauxite
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Patricio Zavolinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver