WAAT 1.4.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,19 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+#**
+
+source "http://rubygems.org"
+
+group :development do
+  gem "selenium-webdriver", ">= 2.0.0"
+  gem "cucumber", ">= 0"
+  gem "jeweler", "~> 1.6.4"
+  gem 'ffi', "1.0.7"
+end
+
+gem "bundler", "~> 1.0.0"

data/LICENSE.txt

@@ -0,0 +1,13 @@
+ Copyright 2010 Anand Bagmar (abagmar@gmail.com). 
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1 @@
+WAAT-ruby

data/README.rdoc

@@ -0,0 +1,41 @@
+= WAAT-ruby
+
+/**
+ * Created by: Anand Bagmar
+ * Email: abagmar@gmail.com
+ *
+ * Copyright 2010 Anand Bagmar.  Distributed under the Apache 2.0 License
+ *
+ * See LICENSE.txt for further details.
+**/
+
+
+== What is Web Analytics
+
+Web Analytics is the measurement, collection, analysis and reporting of internet data for purposes of understanding and optimizing web usage. Web Analytics is not just a tool for measuring website traffic, but can also be used as a tool for business research and market research.
+Web Analytics applications can also help companies measure the results of traditional print advertising campaigns. It helps one to estimate how the traffic to the web site changed after the launch of a new advertising campaign.
+
+Web Analytics provides data on the number of visitors, page views, etc. to gauge the traffic popularity trends which helps doing the market research.
+Official definition of Web Analytics from Wikipedia[http://en.wikipedia.org/wiki/Web_analytics)]
+
+
+== What is WAAT?
+
+<b>{WAAT = Web Analytics Automation Testing.}[http://essenceoftesting.blogspot.com/search/label/waat]</b>
+
+See the {WAAT-Ruby wiki}[http://github.com/anandbagmar/WAAT-Ruby/wiki] for answers to questions like what, why, how, and more.
+
+For any other questions, comments, help, email Anand Bagmar @ abagmar@gmail.com
+
+
+== Latest version
+
+* <b>WAAT-Ruby v1.4 gem is available from the {WAAT-Ruby pkg}[http://github.com/anandbagmar/WAAT-ruby/tree/master/pkg] folder.</b>
+* <b>WAAT-Java v1.4 is available from the {WAAT-Java dist}[http://github.com/anandbagmar/WAAT/tree/master/dist] folder.</b>
+
+
+== Platforms supported
+
+* {WAAT}[http://github.com/anandbagmar/WAAT] for Java.
+* {WAAT}[http://github.com/anandbagmar/WAAT-Ruby] for Ruby. The Ruby gem uses RJB (Ruby-Java-Bridge) to invoke APIs defined by WAAT-Java to enable Web Analytics Testing.
+* <b>See {my blog}[http://essenceoftesting.blogspot.com/search/label/waat] for all activity around WAAT.</b>

data/Rakefile

@@ -0,0 +1,52 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+#**
+
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "WAAT"
+  gem.homepage = "http://github.com/anandbagmar/WAAT-ruby"
+  gem.license = "Apache 2.0"
+  gem.summary = %Q{Web Analytics Automation Testing Framework}
+  gem.description = %Q{An automated way of testing the Web Analytic tags reported to 'n' number of Web Analytic tools by your product. See here for more details: http://essenceoftesting.blogspot.com/search/label/waat}
+  gem.email = "abagmar@gmail.com"
+  gem.authors = ["Anand Bagmar"]
+
+  # dependencies defined in Gemfile
+#  gem.add_dependency('rjb', ">= 1.3.2")
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :features
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "WAAT-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.4.0

data/WAAT.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{WAAT}
+  s.version = "1.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anand Bagmar"]
+  s.date = %q{2011-07-28}
+  s.description = %q{An automated way of testing the Web Analytic tags reported to 'n' number of Web Analytic tools by your product. See here for more details: http://essenceoftesting.blogspot.com/search/label/waat}
+  s.email = %q{abagmar@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "WAAT.gemspec",
+    "features/WAAT-ruby.feature",
+    "features/step_definitions/WAAT-ruby_steps.rb",
+    "features/support/env.rb",
+    "features/support/hook.rb",
+    "lib/WAAT.rb",
+    "lib/WAAT/LICENSE.txt",
+    "lib/WAAT/docs/Jpcap_Install.html",
+    "lib/WAAT/docs/README",
+    "lib/WAAT/docs/README.rdoc",
+    "lib/WAAT/docs/WAAT Readme.doc",
+    "lib/WAAT/docs/WAAT Readme.docx",
+    "lib/WAAT/docs/WAAT Readme.html",
+    "lib/WAAT/docs/WAAT Readme.pdf",
+    "lib/WAAT/lib/WAAT_v1.4.jar",
+    "lib/WAAT/lib/commons-lang-2.3.jar",
+    "lib/WAAT/lib/httpSniffer/Linux/jpcap-0.7-1.i386.rpm",
+    "lib/WAAT/lib/httpSniffer/Linux/jpcap-0.7.deb",
+    "lib/WAAT/lib/httpSniffer/Linux/libpcap-1.1.1.tar.gz",
+    "lib/WAAT/lib/httpSniffer/Windows/JpcapSetup-0.7.exe",
+    "lib/WAAT/lib/httpSniffer/Windows/System32/Jpcap.dll",
+    "lib/WAAT/lib/httpSniffer/Windows/System32/Packet.dll",
+    "lib/WAAT/lib/httpSniffer/Windows/System32/drivers/npf.sys",
+    "lib/WAAT/lib/httpSniffer/Windows/System32/pthreadVC.dll",
+    "lib/WAAT/lib/httpSniffer/Windows/System32/wpcap.dll",
+    "lib/WAAT/lib/httpSniffer/Windows/WinPcap_4_1_2.exe",
+    "lib/WAAT/lib/httpSniffer/jpcap.jar",
+    "lib/WAAT/lib/jpcap.jar",
+    "lib/WAAT/lib/log4j-1.2.16.jar",
+    "lib/WAAT/lib/xstream-1.3.1.jar",
+    "lib/WAAT/resources/log4j.properties",
+    "lib/WAAT/sampledata/TestData.xml",
+    "lib/WAAT/samplescripts/com/thoughtworks/webanalyticsautomation/scriptrunner/SeleniumScriptRunner.java",
+    "lib/WAAT/samplescripts/com/thoughtworks/webanalyticsautomation/scriptrunner/WebDriverScriptRunner.java",
+    "sampledata/TestData.xml"
+  ]
+  s.homepage = %q{http://github.com/anandbagmar/WAAT-ruby}
+  s.licenses = ["Apache 2.0"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Web Analytics Automation Testing Framework}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<selenium-webdriver>, [">= 2.0.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<ffi>, ["= 1.0.7"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<selenium-webdriver>, [">= 2.0.0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<ffi>, ["= 1.0.7"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<selenium-webdriver>, [">= 2.0.0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<ffi>, ["= 1.0.7"])
+  end
+end
+

data/features/WAAT-ruby.feature

@@ -0,0 +1,19 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+# *
+# * http://essenceoftesting.blogspot.com/search/label/waat
+# * http://github.com/anandbagmar/WAAT-Ruby
+# * http://github.com/anandbagmar/WAAT
+# *
+#**
+
+Feature: Check if tags are reported when my blog page is opened
+
+  @waat
+  Scenario: Tags reported on loading blog page
+    Given I navigate to Anand Bagmar's blog

data/features/step_definitions/WAAT-ruby_steps.rb

@@ -0,0 +1,41 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+# *
+# * http://essenceoftesting.blogspot.com/search/label/waat
+# * http://github.com/anandbagmar/WAAT-Ruby
+# * http://github.com/anandbagmar/WAAT
+# *
+#**
+
+require 'selenium-webdriver'
+
+Given /^I navigate to Anand Bagmar's blog$/ do
+  url_patterns = ["GET /ps/ifr?container=friendconnect&mid=0"]
+  action_name = "OpenWAATArticleOnBlog_HttpSniffer"
+  test_data_file_name = File.join(File.dirname(__FILE__), "..", "..", "sampleData", "TestData.xml")
+
+#  initialize_waat()
+#
+#  enable_web_analytics_testing
+
+  url = "http://essenceoftesting.blogspot.com"
+  @driver = Selenium::WebDriver.for :firefox
+  @driver.get url
+
+  params = [:test_data_file_name=> test_data_file_name, :action_name => action_name, :url_patterns => url_patterns, :minimum_number_of_packets => 1]
+  result = verify_web_analytics_data(params)
+
+  puts "->#{result.status}"
+  assert (result.status=="FAIL"), "Incorrect Verification Status. Expected: 'FAIL', Actual: #{result.status}"
+  assert (result.list_of_errors.size==14), "Incorrect number of errors. Expected: '14', Actual: #{result.list_of_errors.size}"
+  result.list_of_errors.each do |err|
+    puts "->\t#{err}"
+  end
+
+#  disable_web_analytics_testing
+end

data/features/support/env.rb

@@ -0,0 +1,42 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+# *
+# * http://essenceoftesting.blogspot.com/search/label/waat
+# * http://github.com/anandbagmar/WAAT-Ruby
+# * http://github.com/anandbagmar/WAAT
+# *
+#**
+
+require 'bundler'
+require 'selenium-webdriver'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require 'test/unit/assertions'
+
+#
+#
+#   WAAT configuration
+#
+#
+
+@waat_src = File.join(File.dirname(__FILE__), "..", "..", "lib", "WAAT")
+puts "@WAAT_root_location: #{@waat_src}"
+require @waat_src
+
+#   end WAAT configuration
+
+World(Test::Unit::Assertions)

data/features/support/hook.rb

@@ -0,0 +1,34 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: Dec 29, 2010
+# * Time: 9:34:02 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+# *
+# * http://essenceoftesting.blogspot.com/search/label/waat
+# * http://github.com/anandbagmar/WAAT-Ruby
+# * http://github.com/anandbagmar/WAAT
+# *
+#**
+
+Before do
+  puts "Generic before hook"
+end
+
+Before ('@waat') do
+  puts "*** Before hook for WAAT ***"
+  initialize_waat()
+  enable_web_analytics_testing
+end
+
+After do
+  puts "Generic after hook"
+  @driver.quit
+end
+
+After ('@waat') do
+  puts "*** After hook for WAAT ***"
+  disable_web_analytics_testing
+end
+

data/lib/WAAT.rb

@@ -0,0 +1,188 @@
+#**
+# * Created by: Anand Bagmar
+# * Email: abagmar@gmail.com
+# * Date: July 20, 2011
+# * Time: 9:34:00 AM
+# *
+# * Copyright 2010 Anand Bagmar (abagmar@gmail.com).  Distributed under the Apache 2.0 License
+# *
+# * http://essenceoftesting.blogspot.com/search/label/waat
+# * http://github.com/anandbagmar/WAAT-Ruby
+# * http://github.com/anandbagmar/WAAT
+# *
+#**
+
+module WAAT
+
+  #
+  # Result class converts the Result object returned by WAAT-Java to a Ruby class
+  #
+  # This class has 2 methods
+  # * status          => PASS | FAIL | SKIP
+  # * list_of_errors  => An array of strings containing all the Web Analytic validation errors as returned by the verify_web_analytics_data method
+  #
+
+  class Result
+    attr_reader :status, :list_of_errors
+
+    def initialize(java_result)
+      @status = java_result.getVerificationStatus.name
+      @list_of_errors = []
+      java_result.getListOfErrors.toArray.each do |each_error|
+        @list_of_errors << each_error.toString
+      end
+    end
+  end
+
+  #
+  # === Synopsis
+  # This method initializes 'WAAT-Ruby'
+  #
+  # === Args
+  # *keep_loaded_file_in_memory*: Default: true
+  # This means the loaded test data file will be kept in memory till the tests are running.
+  #
+  # === Examples:
+  #
+  # * initialize_waat        => This will use the default value for keep_loaded_file_in_memory
+  # * initialize_waat(true)  => Same as initialize_waat
+  # * initialize_waat(false) => This will unload the test data file after the Web Analytic tags verification is done
+  #
+  # === Corresponding WAAT-Java API
+  # getInstance(WebAnalyticTool, InputFileType, keepLoadedFileInMemory, log4jPropertiesFilePath)::
+  #      This method initializes WAAT-Java.
+  #      Unlike WAAT-Java, WAAT-Ruby supports only the http_sniffer mechanism for doing Web Analytics testing.
+  #      Also, WAAT-Ruby supports specification of the input test data in XML format only.
+  #
+  #
+  def initialize_waat(keep_loaded_file_in_memory = true)
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    logger.info("Initializing WAAT")
+    load_java_classes
+    engine_instance(keep_loaded_file_in_memory)
+  end
+
+  #
+  # === Synopsis
+  # This method enables Web Analytic testing for all subsequent tests till it is explicitly disabled
+  #
+  # === Corresponding WAAT-Java API
+  # enableWebAnalyticsTesting::
+  #      This method enables Web Analytic testing in WAAT-Java
+  #      When this method is called, the packet capturing is started on all the network interfaces on the machine where the tests are running.
+  #
+  def enable_web_analytics_testing
+    logger.info("Enable Web Analytics Testing")
+    engine_instance.enableWebAnalyticsTesting
+  end
+
+  #
+  # === Synopsis
+  # This method disables Web Analytic testing for all subsequent tests till it is explicitly enabled again
+  #
+  # === Corresponding WAAT-Java API
+  # disableWebAnalyticsTesting::
+  #      This method disables Web Analytic testing in WAAT-Java
+  #      When this method is called, the packet capturing is stopped for all the network interfaces on the machine where the tests are running.
+  #
+  def disable_web_analytics_testing
+    logger.info("Disable Web Analytics Testing")
+    engine_instance.disableWebAnalyticsTesting
+  end
+
+  #
+  # === Synopsis
+  # This method verifies the Web Analytic tags using the http_sniffer mechanism
+  #
+  # === Args
+  # params Hash with the following entries
+  #
+  # *:test_data_file_name*:
+  # Absolute path to the input Test Data (xml) file name.
+  #
+  # *:action_name*:
+  # A (String) name representing the action done in the UI, for which we want to do Web Analytics Testing.
+  # This action_name matches the corresponding name in the test_data_file_name
+  #
+  # *:url_patterns*:
+  # An array of Strings containing URL snippets that will be used to filter the packets captured by HttpSniffer
+  #
+  # *:minimum_number_of_packets*:
+  # The minimum number of "filtered" packets to capture based on the url_patterns provided
+  #
+  # === Examples:
+  #
+  # * verify_web_analytics_data({:test_data_file_name, :action_name, :url_patterns, :minimum_number_of_packets}) => This will enable Web Analytic Testing
+  #   where:
+  #     :test_data_file_name         => File.join(File.dirname(__FILE__), "..", "..", "sampleData", "TestData.xml")
+  #     :action_name                 => "OpenWAATArticleOnBlog_HttpSniffer"
+  #     :url_patterns                => ["GET /ps/ifr?container=friendconnect&mid=0"]
+  #     :minimum_number_of_packets   => 1
+  #
+  # === Corresponding WAAT-Java API
+  # verifyWebAnalyticsData(test_data_file_name, action_name, url_patterns, minimum_number_of_packets)::
+  #      This method enables Web Analytic testing in WAAT-Java
+  #      When this method is called, the packet capturing is started on all the network interfaces on the machine where the tests are running.
+  #
+  def verify_web_analytics_data(params)
+    logger.info("Verify Web Analytics Data")
+    logger.info("\tTest Data File Name: #{params[:test_data_file_name]}")
+    logger.info("\tAction Name: #{params[:action_name]}")
+    java_result = @engine_instance.verifyWebAnalyticsData(params[:test_data_file_name], params[:action_name], params[:url_patterns], params[:minimum_number_of_packets])
+    Result.new(java_result)
+  end
+
+  private
+  def logger
+    @logger ||= Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+    @logger
+  end
+
+  def engine_instance(keep_loaded_file_in_memory = true)
+    log4j_properties_absolute_file_path = File.join(File.dirname(__FILE__), "WAAT", "resources", "log4j.properties")
+    @engine_instance ||=  controller.getInstance(web_analytic_tool("http_sniffer"), input_file_type("xml"), keep_loaded_file_in_memory, log4j_properties_absolute_file_path)
+  end
+
+  def controller
+    @controller ||= Rjb::import('com.thoughtworks.webanalyticsautomation.Controller')
+  end
+
+  def input_file_type_reference
+    @input_file_type_reference ||= Rjb::import('com.thoughtworks.webanalyticsautomation.inputdata.InputFileType')
+  end
+
+  def web_analytic_tool_reference
+    @web_analytic_tool_reference ||= Rjb::import('com.thoughtworks.webanalyticsautomation.plugins.WebAnalyticTool')
+  end
+
+  def load_java_classes
+    separator = (Config::CONFIG['target_os'] =~ /[win|mingw]/) == 0 ? ';' : ':'
+
+    waat_lib_directory = File.join(File.dirname(__FILE__), "WAAT", "lib")
+    logger.info("WAAT LIB directory: #{waat_lib_directory}")
+
+    waat_file_list = Dir.glob("#{waat_lib_directory}/*.jar").join(separator)
+    logger.info("Loading following JARs: #{waat_file_list}")
+
+    require 'rjb'
+    Rjb::load(classpath = waat_file_list,[])
+  end
+
+  def proxy_from_java_enum(java_enum, web_analytic_tool)
+    java_enum.values.each do |each_value|
+      return each_value if each_value.name==web_analytic_tool.upcase
+    end
+  end
+
+  def web_analytic_tool(web_analytic_tool)
+    proxy_from_java_enum(web_analytic_tool_reference, web_analytic_tool)
+  end
+
+  def input_file_type(input_file_type)
+    proxy_from_java_enum(input_file_type_reference, input_file_type)
+  end
+
+end
+World(WAAT)