wsl 0.1.4

data/Manifest

@@ -0,0 +1,18 @@
+examples/ClickExample.rb
+examples/DemoExample.rb
+examples/DemoTestSuite.rb
+examples/GoogleSearchExample_WSL.rb
+examples/SelectExample.rb
+examples/SuiteCleanup.rb
+examples/SuiteStartup.rb
+lib/IEContext.rb
+lib/utils/Logger.rb
+lib/utils/TestSuiteCleanup.rb
+lib/utils/TestSuiteStartup.rb
+lib/wsl.rb
+lib/wslPrivate.rb
+lib/wslSuite.rb
+Manifest
+Rakefile
+README.txt
+wsl.gemspec

data/README.txt

@@ -0,0 +1,18 @@
+This is the WSL gem. Currently there is no licence associated with it, and the source is not open source yet.
+
+Legal mumbo-jumbo disclaimer (just to cover my ass) -
+The software is provided as is, and there is no guarantee of its suitability for a particular task. 
+You use it at your own risk, and the creator(s) of the software accept no liability whatsoever.
+
+Go to http;//wsl.xqoob.com for more details.
+
+NOTE: if after installing WSL you get the following error -
+	"C:/Ruby/lib/ruby/gems/1.8/gems/windows-pr-0.9.3/lib/windows/thread.rb:59: 
+	 uninitialized constant Windows::API::Error (NameError)"
+run these commands-
+	$> Gem uninstall windows-pr
+	$> Gem install windows-pr 
+See http://groups.google.com/group/watir-general/browse_thread/thread/3f6741eccf0cb7b8 for more details.
+
+30-apr-2009
+Wadud Ruf

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+spec = Echoe.new('wsl', '0.1.4') do |s|
+    s.platform  =   Gem::Platform::RUBY
+    s.author    =   "Wadud Ruf"
+    s.email     =   "wadud.ruf@xqoob.com"
+    s.summary   =   "WSL (WATiR Scripting Language) is a DSL built on top of WATiR that allows for the automation of web application testing through Internet Explorer."
+    s.files     =   FileList['lib/*.rb', 'lib/utils/*.rb', 'lib/utils/cache/', 'test/*', 'examples/*'].to_a
+    s.runtime_dependencies = ["watir >=1.6.2"]
+    s.url = "http://wsl.xqoob.com"
+	s.project = "wsl"
+	s.need_tar_gz = false
+end

data/examples/ClickExample.rb

@@ -0,0 +1,37 @@
+require "wsl"	# You require this file for all the WSL keywords.
+
+# You start all test scripts by specifying a name for it.
+start "Click Keyword Example"
+
+rem "This example will show you how to use the 'click' keyword by searching for a stock quote through yahoo."
+
+open_url "http://www.yahoo.co.uk"
+
+rem "We will get a quote for the google (goog) share price."
+enter_text_in "Enter ticker symbol", ":title", "goog"
+
+rem "We need to click the go button to look up the share price."
+click "quote-submit"
+
+rem "We need to do a test to ensure it has worked properly."
+assert_text "NasdaqGS: GOOG", "Exists on screen for Google stock quote lookup."
+
+rem "Go back a page."
+back
+
+rem "This time we'll use the text of the button with the 'click' keyword (it is case sensitive)."
+click "Go", ":value"
+
+rem "Re-assert that it has worked."
+assert_text "NasdaqGS: GOOG", "Exists on screen for Google stock quote lookup."
+
+rem "Let's click something other than a button and asset it has worked ok."
+click "Google Inc. (GOOG)", ":alt"
+assert_all_text ["Basic Chart", "Full Screen", "Print", "Share", "Send Feedback"]
+
+rem "Finally let's click a link to go back to the summary page."
+click "/q?s=GOOG", ":href"
+
+rem "Finish all test scripts using the 'finish' keyword. 
+This closes the browser and outputs a test summary of passed and failed tests in the script."
+finish

data/examples/DemoExample.rb

@@ -0,0 +1,41 @@
+require "wsl"
+
+#-------------------------------------------------------------#
+# Demo test for the WSL.
+#
+# Purpose: to demonstrate the following Watir functionality:
+#   * entering text into a text field,
+#   * clicking a button,
+#   * checking to see if a page contains text.
+# Test will search Google for the "pickaxe" Ruby book and buy 
+# from amazon.
+#-------------------------------------------------------------#
+
+# open a browser
+start "Google Search Test"
+
+# print some comments
+rem "Beginning of test: Google search."
+
+open_url "http://www.google.com"
+
+rem "Enter 'pickaxe' in the search text field."
+enter_text_in "Google Search", ":title", "pickaxe book"
+
+rem "Click the 'Google Search' button."
+click "Google Search", ":value"
+
+assert_text "Programming Ruby: The Pragmatic Programmer's", "is shown high on the list."
+
+rem "Lets buy the book!"
+click "http://www.amazon.co.uk/Programming-Ruby-Pragmatic-Programmers-Second/dp/0974514055", ":href"
+
+assert_url "http://www.amazon.co.uk/Programming-Ruby-Pragmatic-Programmers-Second/dp/0974514055", "is the current page."
+
+rem "Lets buy 10 copies."
+select "quantity", ":id", "10"
+click "Add to Shopping Basket", ":alt"
+click "Proceed to Checkout", ":alt"
+
+assert_text "Enter your e-mail address:", "exists on screen for the sign in page."
+finish

data/examples/DemoTestSuite.rb

@@ -0,0 +1,18 @@
+#-------------------------------------------------------------#
+# This script declares a suite of tests that are to be run sequentially.
+# Before the tests are run a startup script is run, and after a cleanup script.
+#
+#-------------------------------------------------------------#
+
+require "wslSuite"
+
+# The startup script.
+startup_script 	"SuiteStartup"
+
+# The test suite.
+test_suite 		"DemoExample",
+				"ClickExample",
+				"SelectExample"
+
+# The cleanup script.
+cleanup_script  "SuiteCleanup"

data/examples/GoogleSearchExample_WSL.rb

@@ -0,0 +1,19 @@
+#-------------------------------------------------------------#
+# Demo test for the Watir controller.
+#
+# Purpose: to demonstrate the following WSL functionality:
+#   * entering text into a text field,
+#   * clicking a button,
+#   * checking to see if a page contains text.
+# Test will search Google for the "pickaxe" Ruby book.
+#-------------------------------------------------------------#
+
+require "wsl"
+
+start "Google Search Test"
+open_url "http://www.google.com"
+enter_text_in "Google Search", ":title", "pickaxe book"
+click "Google Search", ":value"
+assert_text "The Pragmatic Bookshelf | Programming Ruby", "is shown high on the list."
+
+finish

data/examples/SelectExample.rb

@@ -0,0 +1,50 @@
+require "wsl"	# You require this file for all the WSL keywords.
+
+# You start all test scripts by specifying a name for it.
+start "Select Keyword Example"
+
+rem "This example will show you how to use the 'select' keyword by searching for some train times."
+
+open_url "http://www.thetrainline.com"
+
+enter_text_in "fromfield", ":id", "Bristol temple meads"
+enter_text_in "tofield", ":id", "glasgow"
+
+rem "Enter our departure date as tomorrow."
+click "Tomorrow", ":text"
+
+rem "Lets set our departure time as 11:15am."
+select "ttl-e842cbdc-2bda-4ad4-bb17-1c6ddad60de1", ":id", "11"
+select "outMinuteField", ":name", "15"
+
+rem "and I want it to be one-way"
+select "outonly"
+
+rem "actually I change my mind and want to make it an open return for the next day."
+select "outonly", ":id", false
+click "Next Day", ":text"
+
+rem "Let's get the train times."
+click "Get times & tickets", ":value"
+
+rem "Test to see that we have successfully performed a search."
+assert_text "Bristol Temple Meads to Glasgow", "exists on screen for a successful search."
+
+rem "Ensure we have selected the return ticket option."
+select "ttl-4b048d62-93a1-4408-b4b5-28159e1f8de7", ":id", "Return"
+
+rem "And the correct railcard"
+select "ttl-6c1cba59-9ffd-4a5c-a188-2234b04a2419", ":id", "16-25 RAILCARD"
+
+click "Advanced Options >>", ":text"
+select "ttl-e8d8a9b9-5c78-44d1-9635-98e5c0203339"
+enter_text_in "ttl-cfa9a1a7-e970-4f98-ac90-8e7dc35ff759", ":id", "MANCHESTER PICCADILLY"
+
+click "CHECK_AVAILABILITY", ":name"
+
+rem "Test for the success of the availability search."
+assert_text "Tickets /", "Exists on screen for a successful search."
+
+rem "Finish all test scripts using the 'finish' keyword. 
+This closes the browser and outputs a test summary of passed and failed tests in the script."
+finish

data/examples/SuiteCleanup.rb

@@ -0,0 +1,9 @@
+# You must call the TestSuiteCleanup script.
+require "utils/TestSuiteCleanup"
+require "wsl"
+
+# Do any additonal cleanup activities here.
+
+
+# Finished cleanup.
+rem "Cleanup activities completed."

data/examples/SuiteStartup.rb

@@ -0,0 +1,9 @@
+# You must call the TestSuiteStartup script.
+require "utils/TestSuiteStartup"
+require "wsl"
+
+# Do any additonal startup activities.
+
+
+# Finished startup.
+rem "Startup activities completed."

data/lib/IEContext.rb

@@ -0,0 +1,73 @@
+require "watir"
+require "watir/watir_simple"
+require "utils/Logger"
+
+
+class BrowserContext
+	include Watir::Simple
+	include Watir
+	include Test::Unit::Assertions
+	
+	attr_accessor :testName
+	attr_reader :logger			# Readonly access to logger.
+	
+	##
+	# Initialises a new BrowserContext object. 
+	# Essentially this is inherits from Watir.Simple, 
+	# and uses it's class variable '@@browser'.
+	#
+	# testName: The name you want to give the test.
+	# logFile: The file you want to log to. Defaults to
+	# a log file with the same name as the script in the logs directory.
+	#
+	def initialize(testName=nil, logFile=nil)
+		# Set the test name.
+		@testName = testName
+
+		# Put the log file in the logs directory.
+		if logFile == nil then
+			logFile = $0.to_s.split("/")[-1].chomp(".rb") + ".log"
+		end
+		
+		logFile = "logs/" + logFile
+					
+		# Create the logger.
+		@logger = Wsl::CustomLogger.new(logFile)	
+
+		# Output name if passed in.
+		@logger.logTestName(testName) if testName != nil
+	end
+	
+	##
+	# Returns the browser url.
+	#
+	def currentUrl
+		if defined? @@browser then
+			return @@browser.url()
+		else
+		return ""
+		end
+	end
+	
+	##
+	# Provides access to the browser class variable.
+	#
+	def browser
+		return @@browser
+	end	
+	
+	##
+	# Attaches to a titled browser window.
+	#
+	def attach(windowTitle)
+		@@browser = Watir::IE.attach(:title, windowTitle)
+	end
+	
+	##
+	# The tags which are valid within the browser context.
+	# Note: Ordering of the tags is important.
+	#
+	def tagsInContext()
+		%w[button link image div span text_field checkbox radio select_list]
+	end
+end	

data/lib/utils/Logger.rb

@@ -0,0 +1,311 @@
+
+#-------------------------------------------------------------#
+# Summary:  Lightweight logger implementation.
+#
+# Purpose:  To allow logging of messages to console and file.
+#			It is anticipated that the logging mechanism will evolve
+#			in general so having a logger class that implements the 
+#			standard logger is the best way to go.
+# Pre-con:  Ensure log file directory exists.
+# Post-con: None.
+#-------------------------------------------------------------#
+
+require "log4r"
+require "log4r/formatter/patternformatter"
+
+module Wsl
+	class CustomLogger
+			
+		# Class constant cannot be accessed outside of class.
+		@@HEADER = "======"
+		@@localCacheFile = ".\\logs\\.cache\\TestSummary.dat"
+		
+		# Static methods to get log level (cannot assign to these).
+		# Within class, but outside of method, use 'self.debug' to call.
+		# within method use 'CustomLogger.debug' to call.
+		def self.debug; "debug"; end		
+		def self.info; "info"; end		
+		def self.warn; "warn"; end		
+		def self.error; "error"; end		
+		def self.fatal; "fatal"; end
+		
+		# Actual results constants.
+		def self.pass; "PASS"; end		
+		def self.fail; "FAIL"; end
+		
+		attr_reader :passedTests, :failedTests
+		
+		##
+		# Constructor logs to file as well 
+		# as screen if specified.
+		#
+		# logFile: path to log file.
+		#
+		def initialize(logFile)			
+			# Initialise instance counters.
+			@step = 1
+			@passedTests = 0
+			@failedTests = 0
+			@logFile = logFile
+			
+			# Create the log dir and cache dir structure.
+			createDirs()
+		end
+		
+		##
+		# Logs the name of the test.
+		#
+		def logTestName(testName)
+			@testName = testName
+			# logEntry(CustomLogger.info, "")
+			logEntry(CustomLogger.info, @@HEADER + " Started Test: " + @testName + " " + @@HEADER)
+		end
+		
+		##
+		# Logs a test step.
+		#
+		def logStep(description)
+			logEntry(CustomLogger.info, " Step " + @step.to_s + ": " + description)		
+			@step += 1
+		end
+		
+		##
+		# Logs a test comment.
+		#
+		def logComment(description)
+			logEntry(CustomLogger.info, ">" +  description)	
+		end
+		
+		##
+		# Logs the expected results.
+		#
+		def logExpectedResult(expectedResults)
+			logEntry(CustomLogger.info, "")
+			logEntry(CustomLogger.info, " Expected Result:")
+			logEntry(CustomLogger.info, "  " + expectedResults)
+		end
+		
+		##
+		# Resets the logger by doing the following - 
+		# Step counter starts from 1 again.
+		#
+		def reset
+			@step = 1
+		end
+		
+		##
+		# Logs the actual results.
+		#
+		def logActualResult(passOrFail, message)
+			logEntry(CustomLogger.info, " Actual Result:")
+			logEntry(CustomLogger.info, "  " + passOrFail + ": " + message)
+			logEntry(CustomLogger.info, "")
+			
+			if passOrFail == CustomLogger.pass then
+				@passedTests += 1
+			else
+				@failedTests += 1
+			end
+		end
+		
+		##
+		# Logs an exception.
+		#
+		# exception: The exception to log.
+		#
+		def logException(exception)
+			logEntry(CustomLogger.error, "  FAIL WITH EXCEPTION: " + exception.message + "\n" + 
+					exception.backtrace.join("\n"))
+					
+			@failedTests += 1
+		end
+		
+		def logEndTest()		
+			logEntry(CustomLogger.info, @@HEADER + " Finished Test: " + @testName + " " + @@HEADER)
+		end
+		
+		##
+		# Prints a summary of passed and failed tests for
+		# a script.
+		#
+		def summary
+			logEntry(CustomLogger.info, "")
+			logEntry(CustomLogger.info, "Test Summary:")
+			logEntry(CustomLogger.info, " Passed Tests: " + @passedTests.to_s)
+			logEntry(CustomLogger.info, " Failed Tests: " + @failedTests.to_s)	
+			logEntry(CustomLogger.info, "")
+						
+			file = File.open(@@localCacheFile, "a")
+			file.puts("Passed:" + @passedTests.to_s + "\tFailed:" + @failedTests.to_s + "\t" + @testName)
+			file.close
+		end
+		
+		##
+		# Prints a summary of the total passed and failed tests for
+		# all scripts in a run.
+		#
+		def totalSummary
+			
+			# Ensure cache file exists first.
+			if !File.exist?(@@localCacheFile) then
+				return
+			end 
+		
+			# Output the total summary to logger.
+			
+			logEntry(CustomLogger.info, "+-------------------------------------------------------------------------------+")
+			logEntry(CustomLogger.info, " Total Test Summary:")
+						
+			lines = IO.readlines(@@localCacheFile)
+			lines.each do |line|
+				if line != nil then
+					logEntry(CustomLogger.info, "  " + line.chomp)
+				end
+			end
+			
+			logEntry(CustomLogger.info, "+-------------------------------------------------------------------------------+")
+			
+			# Delete the file.
+			clearCache
+		end
+		
+		##
+		# Clears the cache with the results of any old tests that have run.
+		#
+		def clearCache
+			# Delete the file.
+			if File.exist?(@@localCacheFile) then
+				File.delete(@@localCacheFile)		
+			end
+		end
+		
+		##
+		# Logs an entry to the log.
+		#
+		# entry: What to log
+		#
+		def log(entry)
+			logEntry(CustomLogger.info, entry)
+		end
+		
+		##
+		# Initialises a logger with the standard WSL logger settings
+		# and returns it.
+		#
+		def self.initializeSuiteLogger(logFile)
+			CustomLogger.initializeLogger(logFile)
+		end
+		
+		##
+		# Private method from here onwards.
+		#
+		private 
+				
+		def logEntry(level, entry)		
+			# Initialise the logger if it is not already defined.
+			if ! defined? $logger then
+				CustomLogger.initializeLogger(@logFile)
+			end
+		
+			# Log to file at correct level.
+			if level == CustomLogger.debug then
+				$logger.debug(entry)
+			elsif level == CustomLogger.info then
+				$logger.info(entry)
+			elsif level == CustomLogger.warn then
+				$logger.warn(entry)
+			elsif level == CustomLogger.error then
+				$logger.error(entry)
+			elsif level == CustomLogger.fatal then
+				$logger.fatal(entry)
+			end
+		end
+		
+		##
+		# Creates the directories required by the logger class to
+		# output the log files to.
+		#
+		def createDirs()
+			if(@logFile == nil) then
+				return
+			end
+			
+			tmp = ""
+			elems = @logFile.split("/")			
+			elems.length.times do |elem|
+				# If it's the current dir '.' skip it.
+				if elems[elem] == "." then
+					next			
+				elsif elem == (elems.length - 1) then
+					# Create the .cache directory in the leaf dir.
+					if File.exist?(tmp + ".cache") == false then
+						FileUtils.mkdir(tmp + ".cache")
+					end					
+					next
+				end
+				
+				# Aggregate the files.
+				tmp += elems[elem] + "/"
+			
+				# If subdir doesn't exist create it.
+				if File.exist?(tmp) == false then	
+					FileUtils.mkdir(tmp)
+				end
+			end
+		end
+		
+		##
+		# Static method that initialises a Log4r logger instance
+		# with default values.
+		#
+		# logFile: The name of the log file.
+		#
+		def self.initializeLogger(logFile)
+			Log4r::Logger.root.level = Log4r::INFO
+			$logger = Log4r::Logger.new("WSL")
+			
+			consoleFormat = Log4r::PatternFormatter.new(:pattern => "%.2000m")
+			fileFormat = Log4r::PatternFormatter.new(:pattern => "[%d] [%l] : %.2000m")
+
+			# Create an outputter for $stderr. It defaults to the root level
+			stdOutputter = Log4r::StderrOutputter.new('console', :formatter => consoleFormat)
+									
+			# for the file, we want to log only INFO, FATAL and ERROR and don't trunc
+			fileOutputter = Log4r::FileOutputter.new('logfile', :filename=>logFile, 
+									 :trunc=>true, :level=>Log4r::INFO,
+									 :formatter => fileFormat)
+
+			# add the outputters (this method accepts outputter names or references)
+			$logger.add('console','logfile')
+		end
+	end
+end
+
+# ===================================
+# test methods - comment when released!	
+# =====================================
+# log = Wsl::CustomLogger.new(".\\test\\test2\\testfile.log")
+# log = Wsl::CustomLogger.new
+# log.logStep "test step 1"
+# log.logStep "test step 2"
+# log.logStep "test step 3"
+
+# log = Wsl::CustomLogger.new("testfile.log")
+# log.logStep "Step 1"
+# log.logStep "Step 2"
+# log.logStep "Step 3"
+# log.logStep "Step 4"
+# log.logStep "Step 5"
+# log.logStep "Step 6"
+# log.logStep "Step 7"
+# log.logStep "Step 8"
+# log.logStep "Step 9"
+# log.logStep "Step 10"
+
+# puts Wsl::CustomLogger::Fail	# Access class constant
+# puts Wsl::CustomLogger::Fail = "unknown"	# Get warning cannot assign to constant more than once.
+# puts Wsl::CustomLogger::Pass
+# puts log.logTestName("something")
+# puts Wsl::CustomLogger::HEADER = "$$$$"
+# puts Wsl::CustomLogger::info
+# log.logEndTest "something"