WAAT 1.4.1 → 1.5.0

data/Gemfile

@@ -14,6 +14,7 @@ group :development do
   gem "cucumber", ">= 0"
   gem "jeweler", "~> 1.6.4"
   gem 'ffi', "1.0.7"
+  gem 'rjb'
 end
 
 gem "bundler", ">= 0"

data/README.rdoc

@@ -31,7 +31,8 @@ For any other questions, comments, help, email Anand Bagmar @ abagmar@gmail.com
 == Latest version
 
 * <b>WAAT-Ruby v1.4.1 gem is available from http://rubygems.org</b>
-* <b>WAAT-Java v1.4 is available from the {WAAT-Java dist}[http://github.com/anandbagmar/WAAT/tree/master/dist] folder.</b>
+* <b>WAAT-Ruby v1.5.0 gem is available from https://github.com/anandbagmar/WAAT-ruby/downloads</b>
+* <b>WAAT-Java v1.5.0 is available from the {WAAT-Java dist}[http://github.com/anandbagmar/WAAT/tree/master/dist] folder.</b>
 
 
 == Platforms supported
@@ -43,4 +44,26 @@ For any other questions, comments, help, email Anand Bagmar @ abagmar@gmail.com
 
 == How to use WAAT-Ruby?
 
-See {this wiki page}[https://github.com/anandbagmar/WAAT-ruby/wiki/WAAT-Ruby-HttpSniffer] for step-by-step instructions on how to use WAAT-Ruby in your project.
+See the {HttpSniffer}[https://github.com/anandbagmar/WAAT-ruby/wiki/WAAT-Ruby-HttpSniffer] or {JSSniffer}[https://github.com/anandbagmar/WAAT-ruby/wiki/WAAT-Ruby-JsSniffer] wiki page for step-by-step instructions on how to use WAAT-Ruby in your project.
+
+== Changes in v1.5.0
+
+Some APIs have changed between v1.4.0 and v1.5.0.
+
+* **initailze_waat**: See method definition in {WAAT.rb}[https://github.com/anandbagmar/WAAT-ruby/blob/master/lib/WAAT.rb] for usage information
+    v1.4.0: initialize_waat() or initialize_waat(true)
+    where the boolean value was to specify the value for keep_loaded_file_in_memory
+    -
+    v1.5.0: initialize_waat now takes an optional hash.
+
+* **verify_web_analytics_data**: See method definition in {WAAT.rb}[https://github.com/anandbagmar/WAAT-ruby/blob/master/lib/WAAT.rb] for usage information
+    v1.4.0: This method took a Array as an input
+    -
+    v1.5.0: This method now takes a Hash as an input, with symbols as keys.
+
+* Default plugin: HttpSniffer
+    v1.4.0 only supported the http_sniffer plugin.
+    -
+    v1.5.0 supports http_sniffer and js_sniffer plugins (default: http_sniffer).
+    To override, initialize WAAT using the following command:
+    initialize_waat(:waat_plugin => "js_sniffer")

data/Rakefile

@@ -30,6 +30,7 @@ Jeweler::Tasks.new do |gem|
   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"]
+  gem.files.exclude "dist/**/*"
 
   # dependencies defined in Gemfile
 #  gem.add_dependency('rjb', ">= 1.3.2")

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.5.0

data/WAAT.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{WAAT}
-  s.version = "1.4.1"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Anand Bagmar"]
-  s.date = %q{2012-09-25}
+  s.date = %q{2012-11-05}
   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 = [
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
     "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/WAAT_v1.5.0.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",
@@ -77,12 +77,14 @@ Gem::Specification.new do |s|
       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"])
+      s.add_development_dependency(%q<rjb>, [">= 0"])
     else
       s.add_dependency(%q<bundler>, [">= 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"])
+      s.add_dependency(%q<rjb>, [">= 0"])
     end
   else
     s.add_dependency(%q<bundler>, [">= 0"])
@@ -90,6 +92,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<ffi>, ["= 1.0.7"])
+    s.add_dependency(%q<rjb>, [">= 0"])
   end
 end
 

data/features/WAAT-ruby.feature

@@ -15,5 +15,8 @@
 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
+  Scenario: Tags reported on loading blog page - HttpSniffer
+    Given I navigate to Anand Bagmar's blog - HttpSniffer
+
+  Scenario: Tags reported on loading blog page - JsSniffer
+    Given I navigate to some page - JsSniffer

data/features/step_definitions/WAAT-ruby_steps.rb

@@ -14,20 +14,19 @@
 
 require 'selenium-webdriver'
 
-Given /^I navigate to Anand Bagmar's blog$/ do
+Given /^I navigate to Anand Bagmar's blog - HttpSniffer$/ 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
+  initialize_waat(:waat_plugin => "http_sniffer")
+  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]
+  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}"
@@ -37,5 +36,35 @@ Given /^I navigate to Anand Bagmar's blog$/ do
     puts "->\t#{err}"
   end
 
-#  disable_web_analytics_testing
-end
+  disable_web_analytics_testing
+end
+
+Given /^I navigate to some page - JsSniffer$/ do
+  base_url = "https://www.mirena.com/en/privacy_statement_user.php"
+
+  test_data_file_name = File.join(File.dirname(__FILE__), "..", "..", "sampleData", "TestData.xml")
+  action_name = "OpenAMirenaSecureSite_JsSniffer"
+
+  JS_FOR_MIRENA_SITE = "window.WAAT_URL=\"\";window.WebTrends.prototype.dcsTag=function(){if(document.cookie.indexOf(\"WTLOPTOUT=\")!=-1){return}var WT=this.WT;var DCS=this.DCS;var DCSext=this.DCSext;var i18n=this.i18n;var P=\"http\"+(window.location.protocol.indexOf('https:')==0?'s':'')+\"://\"+this.domain+(this.dcsid==\"\"?'':'/'+this.dcsid)+\"/dcs.gif?\";if(i18n){WT.dep=\"\"}for(var N in DCS){if(DCS[N]&&(typeof DCS[N]!=\"function\")){P+=this.dcsA(N,DCS[N])}}for(N in WT){if(WT[N]&&(typeof WT[N]!=\"function\")){P+=this.dcsA(\"WT.\"+N,WT[N])}}for(N in DCSext){if(DCSext[N]&&(typeof DCSext[N]!=\"function\")){if(i18n){WT.dep=(WT.dep.length==0)?N:(WT.dep+\";\"+N)}P+=this.dcsA(N,DCSext[N])}}if(i18n&&(WT.dep.length>0)){P+=this.dcsA(\"WT.dep\",WT.dep)}if(P.length>2048&&navigator.userAgent.indexOf('MSIE')>=0){P=P.substring(0,2040)+\"&WT.tu=1\"}this.dcsCreateImage(P);window.WAAT_URL=P;this.WT.ad=\"\"};_tag.dcsCustom=function(){}; _tag.DCS.dcscfg=\"1\"; _tag.dcsCollect();return window.WAAT_URL"
+
+  initialize_waat(:waat_plugin => "js_sniffer")
+
+  @driver = Selenium::WebDriver.for :firefox
+  @driver.get base_url
+
+  extracted_url = extract_url_from_javascript(JS_FOR_MIRENA_SITE);
+
+  params = {:test_data_file_name=> test_data_file_name, :action_name => action_name, :url_patterns => extracted_url}
+  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
+end
+
+def extract_url_from_javascript(javascript)
+  @driver.execute_script(javascript)
+end

data/features/support/hook.rb

@@ -16,19 +16,28 @@ Before do
   puts "Generic before hook"
 end
 
-Before ('@waat') do
-  puts "*** Before hook for WAAT ***"
-  initialize_waat()
-  enable_web_analytics_testing
-end
+#Before ('@waat') do
+#  puts "*** Before hook for WAAT ***"
+
+#  If you want to use http_sniffer
+#  initialize_waat(:waat_plugin => "http_sniffer")
+#  enable_web_analytics_testing
+
+#  OR
+
+#  If you want to use js_sniffer
+#  initialize_waat(:waat_plugin => "js_sniffer")
+#end
 
 After do
   puts "Generic after hook"
   @driver.quit
 end
 
-After ('@waat') do
-  puts "*** After hook for WAAT ***"
-  disable_web_analytics_testing
-end
+#After ('@waat') do
+#  puts "*** After hook for WAAT ***"
+
+#  If you want to use http_sniffer
+#  disable_web_analytics_testing
+#end
 

data/lib/WAAT.rb

@@ -39,33 +39,42 @@ module WAAT
   # 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.
+  # This takes a hash as an input with the following possible name/value pairs
+
+  # {
+  #   *:keep_loaded_file_in_memory* => Default: true,
+  #   *:waat_plugin* => Default: "http_sniffer",
+  #   *:input_file_type* => Default: "xml", (Currently the only supported file type)
+  #   *:log4j_properties_absolute_file_path => Default: File.join(File.dirname(__FILE__), "WAAT", "resources", "log4j.properties")}
+
+  # keep_loaded_file_in_memory: This means the loaded test data file will be kept in memory till the tests are running.
+  # waat_plugin: http_sniffer or js_sniffer
   #
   # === 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
+  # * initialize_waat        => This will use the default value for keep_loaded_file_in_memory, and will use the http_sniffer
+  # * initialize_waat(:keep_loaded_file_in_memory => true)  => Uses http_sniffer by default
+  # * initialize_waat(:keep_loaded_file_in_memory => false, :waat_plugin => "js_sniffer") => This will unload the test data file after the Web Analytic tags verification is done AND uses js_sniffer as the web analytic plugin
   #
   # === 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.
+  #      Unlike WAAT-Java, WAAT-Ruby supports the http_sniffer & js_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)
+  def initialize_waat(init_params={})
     logger = Logger.new(STDOUT)
     logger.level = Logger::INFO
     logger.info("Initializing WAAT")
     load_java_classes
-    engine_instance(keep_loaded_file_in_memory)
+    engine_instance(init_params)
   end
 
   #
   # === Synopsis
   # This method enables Web Analytic testing for all subsequent tests till it is explicitly disabled
+  # This is applicable ONLY WHEN USING HTTP_SNIFFER
   #
   # === Corresponding WAAT-Java API
   # enableWebAnalyticsTesting::
@@ -80,6 +89,7 @@ module WAAT
   #
   # === Synopsis
   # This method disables Web Analytic testing for all subsequent tests till it is explicitly enabled again
+  # This is applicable ONLY WHEN USING HTTP_SNIFFER
   #
   # === Corresponding WAAT-Java API
   # disableWebAnalyticsTesting::
@@ -110,6 +120,7 @@ module WAAT
   #
   # *:minimum_number_of_packets*:
   # The minimum number of "filtered" packets to capture based on the url_patterns provided
+  # *This is applicable ONLY WHEN USING HTTP_SNIFFER*
   #
   # === Examples:
   #
@@ -126,10 +137,21 @@ module WAAT
   #      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("Verify Web Analytics Data with params: #{params.inspect}")
     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])
+
+    params = symbolize_keys(params)
+    if(@waat_plugin_type.nil?)
+      logger.error("WAAT plugin not initialized. Have you invoked the initialize_waat method?")
+    elsif(@waat_plugin_type.upcase=="HTTP_SNIFFER")
+      logger.info("Verifying web analytics data for: #{params.inspect}")
+      java_result = @engine_instance.verifyWebAnalyticsData(params[:test_data_file_name], params[:action_name], params[:url_patterns], params[:minimum_number_of_packets])
+    else
+      logger.info("Verifying web analytics data for: #{params.inspect}")
+      java_result = @engine_instance.verifyWebAnalyticsData(params[:test_data_file_name], params[:action_name], params[:url_patterns])
+    end
+
     Result.new(java_result)
   end
 
@@ -140,9 +162,19 @@ module WAAT
     @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)
+  def engine_instance(init_params={})
+    waat_defaults = {:keep_loaded_file_in_memory => true,
+                     :waat_plugin => "http_sniffer",
+                     :input_file_type => "xml",
+                     :log4j_properties_absolute_file_path => File.join(File.dirname(__FILE__), "WAAT", "resources", "log4j.properties")}
+
+    init_params = waat_defaults.merge(symbolize_keys(init_params))
+    logger.info("Initializing WAAT with following params: #{init_params.inspect}")
+    @engine_instance ||=  controller.getInstance(
+        web_analytic_tool(init_params[:waat_plugin]),
+        input_file_type(init_params[:input_file_type]),
+        init_params[:keep_loaded_file_in_memory],
+        init_params[:log4j_properties_absolute_file_path])
   end
 
   def controller
@@ -170,19 +202,26 @@ module WAAT
     Rjb::load(classpath = waat_file_list,[])
   end
 
-  def proxy_from_java_enum(java_enum, web_analytic_tool)
+  def proxy_from_java_enum(java_enum, java_enum_value)
     java_enum.values.each do |each_value|
-      return each_value if each_value.name==web_analytic_tool.upcase
+      return each_value if each_value.name==java_enum_value.upcase
     end
   end
 
-  def web_analytic_tool(web_analytic_tool)
-    proxy_from_java_enum(web_analytic_tool_reference, web_analytic_tool)
+  def web_analytic_tool(waat_plugin)
+    @waat_plugin_type = waat_plugin
+    proxy_from_java_enum(web_analytic_tool_reference, waat_plugin)
   end
 
   def input_file_type(input_file_type)
     proxy_from_java_enum(input_file_type_reference, input_file_type)
   end
 
+  def symbolize_keys(hash)
+    hash.keys.each do |key|
+      hash[(key.to_sym rescue key) || key ] = hash.delete(key)
+    end
+    hash
+  end
 end
 World(WAAT)

data/lib/WAAT/sampledata/TestData.xml

@@ -48,9 +48,9 @@
 -->
 
 <Sections>
-    <Section actionName="OpenUpcomingPage_OmnitureDebugger_Selenium"
-             numberOfEventsTriggered="1"
-             tagList="s.pageName = 'upcoming:index'||
+  <Section actionName="OpenUpcomingPage_OmnitureDebugger_Selenium"
+           numberOfEventsTriggered="1"
+           tagList="s.pageName = 'upcoming:index'||
                                 s.eVar23 = 'upcoming:index'||
                                 s.heir1 = 'upcoming'||
                                 s.heir2 = 'index'||
@@ -64,23 +64,29 @@
                                 s.eVar9 = 'all'||
                                 s.events = 'event2'||"/>
 
-    <Section actionName="OpenUpcomingPage_OmnitureDebugger_WebDriver"
-             numberOfEventsTriggered="1"
-             tagList="pageName=upcoming:index||
+  <Section actionName="OpenUpcomingPage_OmnitureDebugger_WebDriver"
+           numberOfEventsTriggered="1"
+           tagList="pageName=upcoming:index||
                                 cc=USD||
                                 ch=upcoming||
                                 events=event2||"/>
 
-    <Section actionName="OpenUpcomingPage_HttpSniffer"
-             numberOfEventsTriggered="1"
-             tagList="pageName=upcoming:index||
+  <Section actionName="OpenUpcomingPage_HttpSniffer"
+           numberOfEventsTriggered="1"
+           tagList="pageName=upcoming:index||
                                 cc=USD||
                                 ch=upcoming||
                                 events=event2||"/>
 
-    <Section actionName="OpenWAATArticleOnBlog_HttpSniffer"
-             numberOfEventsTriggered="1"
-             tagList="caller=http://essenceoftesting.blogspot.com/2011/01/my-article-on-future-of-test-automation.html||
+  <Section actionName="OpenWAATArticleOnBlog_HttpSniffer"
+           numberOfEventsTriggered="1"
+           tagList="caller=http://essenceoftesting.blogspot.com/2011/01/my-article-on-future-of-test-automation.html||
                                 container=friendconnect||
                                 parent=http://essenceoftesting.blogspot.com/||"/>
+
+  <Section actionName="OpenAMirenaSecureSite_JsSniffer"
+           numberOfEventsTriggered="1"
+           tagList="dcssip=www.mirena.com||
+                        dcsuri=/en/privacy_statement_user.php||"/>
+
 </Sections>

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 4
-  - 1
-  version: 1.4.1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Anand Bagmar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-25 00:00:00 +05:30
+date: 2012-11-05 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,6 +83,18 @@ dependencies:
         - 7
         version: 1.0.7
   requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rjb
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
 description: "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"
 email: abagmar@gmail.com
 executables: []
@@ -115,7 +127,7 @@ files:
 - 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/WAAT_v1.5.0.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