qa_robusta 0.1.3

data/qa_observer/generators/site/templates/html_elements.yaml

@@ -0,0 +1,22 @@
+--- 
+:some_page:
+  :page_element1:
+    :type: text_field
+    :what: "watir's what parameter"
+    :what: "watir's how parameter"
+  :page_element2:
+    :type: text_field
+    :what: "watir's what parameter"
+    :what: "watir's how parameter"
+:another_page:
+  :page_element1:
+    :type: text_field
+    :what: "watir's what parameter"
+    :what: "watir's how parameter"
+  :page_element2:
+    :type: text_field
+    :what: "watir's what parameter"
+    :what: "watir's how parameter"
+
+
+

data/qa_observer/generators/site/templates/navigate.rb

@@ -0,0 +1,32 @@
+class Navigate
+  attr_reader :browser
+  def initialize(browser)
+    @browser = browser
+  end
+  def go(nav_path=[])
+    raise ArgumentError if nav_path.class != Array || nav_path.nitems < 1 
+    nav_path.each { |item|
+      case item[:type]
+        when 'link'
+          exec = "@browser.link(#{item[:how]}, #{item[:what]}).#{item[:action]}"
+          eval exec
+        when 'text_field'
+          if item.has_key?(:value)
+            # escape ' in item[:value] as it's used for quoted string in the set
+            #item[:value].gsub(/'/, /\'/)
+            exec = "@browser.text_field(#{item[:how]}, #{item[:what]}).#{item[:action]}('#{item[:value]}')"
+            eval exec
+          end
+        when 'check_box'
+          # escape ' in item[:value] as it's used for quoted string in the set
+          #item[:value].gsub(/'/, /\'/)
+          exec = "@browser.checkbox(#{item[:how]}, #{item[:what]}).#{item[:action]}"
+          eval exec
+        when 'submit'
+            exec = "@browser.button(#{item[:how]}, #{item[:what]}).#{item[:action]}"
+            eval exec
+         
+      end
+    }  
+  end
+end

data/qa_observer/generators/site/templates/reports.rb

@@ -0,0 +1,7 @@
+require 'pdf/writer'
+
+module BuildReport
+  def pdf(report)
+    
+  end  
+end

data/qa_observer/generators/site/templates/users_list.yaml

@@ -0,0 +1,21 @@
+:development:
+  :manager: 
+    :user: 'user1'
+    :password: 'user1_password'
+  :employee: 
+    :user: 'user2'
+    :password: 'user2_password'
+:test:
+  :manager: 
+    :user: 'user1'
+    :password: 'user1_password'
+  :employee: 
+    :user: 'user2'
+    :password: 'user2_password'
+:production:
+  :manager: 
+    :user: 'user1'
+    :password: 'user1_password'
+  :employee: 
+    :user: 'user2'
+    :password: 'user2_password'

data/qa_observer/generators/test_case/templates/test_case.rb.erb

@@ -0,0 +1,62 @@
+base = File.expand_path(File.dirname(__FILE__))
+
+# If the user is executing the test case stand alone
+# without an agent we need to set a reference to
+# for where to find the qa_observer_client as well as let
+# the qa_observer_client know where the test case directory is
+#  URGENT: DO NOT MODIFY
+unless $qa_observer_client
+  TEST_CASE_DIR = "#{base}"
+  $qa_observer_client = File.expand_path("#{base}/../../..")
+end
+# END OF DO NOT MODIFY
+
+require "#{$qa_observer_client}/lib/system_test"
+require "#{$qa_observer_client}/lib/env_details.rb"
+
+class <%= class_name.camelize %> < SystemTest
+  def setup
+    # if the user hasn't provided the environment as an input
+    # parameter to the interpreter default to :test
+    $test_environment ||= :test
+    super
+
+    @<%= app_name %>_flows = <%= app_name.camelize %>Flows.new 
+  end
+
+  def teardown
+    # NOTE: Place all items you wish to do at after each test method
+    # in the unless @skip section before the $browser.close.  DO NOT
+    # remove this section as it's critical if the test class is executed
+    # by an agent. 
+    unless @skip
+      begin
+        $browser.close 
+      rescue => e
+      end
+    end
+
+    super
+  end
+  
+  # TODO: add test methods
+  # don't forget to update the documentation associated with each test method,
+  # by placing an rdoc style comment in plain text.  The documentation will be
+  # included in the report for each execution.
+
+=begin rdoc
+   Test Purpose
+   After the user arrives on the home page verify the following links exists:
+   * some link 1
+   * some link 2
+   * some link 3
+=end
+  def test_home_links
+     @<%= app_name %>_flows.home
+     # TODO add asserts for testing home page links
+  end
+
+end
+
+
+

data/qa_observer/generators/test_case/test_case_generator.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rubigen'
+
+class TestCaseGenerator < RubiGen::Base
+  attr_reader :app_test_dir, :app_name, :qa_observer_client, :class_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.size != 2
+    @app_test_dir = 'sites'
+    @qa_observer_client = File.expand_path("#{File.dirname(__FILE__)}/../../")
+    @app_name=args.shift
+    @class_name=args.shift
+  end
+
+  def manifest
+    record do |m|
+      m.template "test_case.rb.erb", "#{@app_test_dir}/#{@app_name}/test_cases/#{@class_name.downcase}.rb"
+    end
+  end
+
+  protected
+  def banner
+    <<-EOS
+    USAGE: #{$0} #{spec.name} app_name test_class_name
+    EOS
+  end
+
+end

data/qa_observer/lib/doc.rb

@@ -0,0 +1,103 @@
+base = File.expand_path(File.dirname(__FILE__))
+require "#{base}/../../common/lib/formatters"
+
+module TCDoc
+  def self.build_html(report, save_to)
+    html = '<html><head><head><body>'
+    report.each_pair { |klass, r|
+      next unless r.kind_of?(Array)
+      r.each { |test|
+        html += "<h1>Report for #{klass}::#{test[:method]}</h1>"
+        html += "Num Assertions: #{test[:num_asserts]}<br>"
+        html += "Pass: #{test[:passed]}<br>"
+        html += "Failed: #{test[:failed]}<br><br>"
+        html += "#{test[:documentation]}<br><br>" if test[:documentation]
+        test[:images].each { |i|
+          image = "#{$test_case_dir}/../results/images/#{File.basename(i)}"
+          FileUtils.mv i, "#{$test_case_dir}/../results/images"
+          html += "<img src = '#{image}'><br><br>"
+        } 
+      }
+    }
+    html += "</body></html>"
+    fd = File.open(save_to, 'w+')
+    fd.puts html
+    fd.close
+  end
+
+  def self.class_names_from_file(file_content)
+    class_names = file_content.grep(/class .* <.*SystemTest/)
+    class_names.each_with_index { |name, ct|
+      class_names[ct] = name.gsub!(/\n|class| |<|SystemTest/, '')
+    }
+    class_names
+  end
+  
+  def self.method_names_from_file(file_content)
+    methods = []
+    file_content.grep(/def .*/).each { |method|
+      methods << method.grep(/def .*/).first.strip.gsub("def ", '')    
+    }
+    methods
+  end
+  
+  # return 
+  # {:method_name => test documenation, :some_other_method => 'of course it's doc'}
+  def self.test_documentation(current_test_class, test_methods=[], format='txt')
+    execution_file=nil
+    methods_doc = {}
+    rdoc_dir = "#{$test_case_dir}/../tmp_doc".gsub(/c:/i, '')
+    
+    # remove all previously generated rdoc
+    FileUtils.rm_rf rdoc_dir if File.directory?(rdoc_dir)
+    
+    Dir.entries("#{$test_case_dir}/").each { |i|
+      next if File.directory?(i) || i !~ /.rb$/
+      content = File.read("#{$test_case_dir}/#{i}")
+      klass = class_names_from_file(content).first
+      if klass == current_test_class
+        execution_file = "#{$test_case_dir}/#{i}".gsub(/c:/i, '')
+      end
+    }
+    
+    html=''
+    `#{$test_case_dir}/../../../../common/gems/installed/gems/rdoc-3.9.4/bin/rdoc -o #{rdoc_dir} #{execution_file}`
+    current_test_class.gsub!(/\r/, '')
+    rdoc_content = File.read("#{rdoc_dir}/#{current_test_class}.html")
+    doc=Hpricot(rdoc_content)
+
+    test_methods.each { |method|    
+      html = doc.search("/html/body/div[2]/div[2]/div/div[@id='#{method}-method']/div[2]").inner_html
+
+      if format == 'txt'
+        gen_doc = Format::HTML.to_txt(html)
+      elsif format == 'html'
+        gen_doc = html
+      end
+      
+      methods_doc[method] = gen_doc
+    }
+    FileUtils.rm_rf rdoc_dir if File.directory?(rdoc_dir)
+    methods_doc
+  end
+
+  def self.test_methods_from_class(class_content)
+    test_methods = []
+    class_content.grep(/def .*/).each { |meth| test_methods << meth.gsub(/ |def|\n/, '') }
+    test_methods - ['setup', 'teardown']
+  end
+  
+  # assumes absolute path 
+  # assumes all test classes < from SystemTest
+  def self.process_test_class_file(file)
+    text_doc = {}
+    content = File.readlines(file).to_s
+    test_methods = test_methods_from_class(content)
+    class_names = class_names_from_file(content)
+    
+    raise ArgumentError, "Expecting one test class per file" unless class_names.nitems == 1
+    
+    test_documentation(class_names.first, test_methods)
+  end
+
+end

data/qa_observer/lib/env_details.rb

@@ -0,0 +1,2 @@
+$environment = :test
+$run_on_browser = 'chrome'

data/qa_observer/lib/error_defns.rb

@@ -0,0 +1,3 @@
+class ElementError < StandardError ; end
+class LinuxIscsiActiveMachineMismatch < StandardError ; end
+class WindowsIscsiActiveMachineMismatch < StandardError ; end

data/qa_observer/lib/form_helpers.rb

@@ -0,0 +1,52 @@
+module FormHelpers
+  # params is an array of hashes for ordering.  has structure is described 
+  # in the usage msg
+  def self.auto_form(params=[], objs=[])
+    msg =<<EOF
+    params should contain keys for commands to execute.  Where
+    each command key should begin with ':command_' and end with 'element_name'
+    which maps to a valid element definition.  objs should be an array
+    of element objects.  We will dynamically see which object the associated
+    command maps to.
+EOF
+    
+    raise ArgumentError, msg unless params.nitems > 0 && objs.nitems > 0
+    
+    checkbox_state=[true, false]
+    params.each { |i|
+      
+      objs.each {|o|
+        key = i.keys.first
+        value = i.values.first
+        next unless key.to_s =~ /^command_/
+
+        object_class=''
+        current=''
+        element = key.to_s.split('command_').last
+        if o.respond_to?(element)
+          eval "object_class = o.#{element}.class.to_s"
+          if object_class =~ /checkbox/i
+            raise ArgumentError unless checkbox_state.include?(value)
+            eval "current = o.#{element}.checked?"
+            o.send(element).set(value)
+          if object_class =~ /radio/i
+            if value
+              o.send(element).check
+            else
+              o.send(element).uncheck              
+            end
+          end
+          elsif object_class =~ /selectlist/i
+            o.send(element).select(value)
+          elsif object_class =~ /textfield/i
+            # skip if key supplied but empty string or nil
+            o.send(element).set(value) #unless value != ''
+          elsif object_class =~ /button|link|image/i
+            eval "o.#{element}.#{value}"
+          end
+          
+        end
+      }
+    }
+  end
+end

data/qa_observer/lib/reports.rb

@@ -0,0 +1,7 @@
+require 'pdf/writer'
+
+module BuildReport
+  def pdf(report)
+    
+  end  
+end

data/qa_observer/lib/requires.rb

@@ -0,0 +1,23 @@
+module Requires
+  def self.run
+    begin
+      Dir.entries("#{TEST_CASE_DIR}/../elements").each { |i|
+        next if i =~ /^\./ || i !~ /_elements\.rb$/
+        puts "loading: #{i}"
+        require "#{TEST_CASE_DIR}/../elements/#{i}"
+      }
+      Dir.entries("#{TEST_CASE_DIR}/../flows").each { |i|
+        next if i =~ /^\./ || i !~ /.rb$/
+        puts "loading: #{i}"
+        require "#{TEST_CASE_DIR}/../flows/#{i}"
+      }
+      Dir.entries("#{TEST_CASE_DIR}/../helpers").each { |i|
+        next if i =~ /^\./ || i !~ /.rb$/
+        puts "loading: #{i}"
+        require "#{TEST_CASE_DIR}/../helpers/#{i}"
+      }
+    rescue NameError => e
+      raise e unless e.inspect =~ /TEST_CASE_DIR/
+    end
+  end
+end

data/qa_observer/lib/system_test.rb

@@ -0,0 +1,146 @@
+base_dir = File.expand_path(File.dirname(__FILE__))
+require 'yaml'
+require 'pstore'
+require "#{base_dir}/doc"
+require "#{$qa_observer_client}/../common/lib/gem_helpers"
+GemHelpers.update_gem_path "#{$qa_observer_client}/../common/gems/installed"
+require 'platform_helpers'
+require 'capture_io'
+require 'wait_for'
+require "#{$qa_observer_client}/lib/test_extention"
+require "#{$qa_observer_client}/lib/requires"
+require "#{$qa_observer_client}/../common/lib/formatters"
+require "#{$qa_observer_client}/../common/lib/load_test_data"
+require "#{$qa_observer_client}/../common/lib/constants"
+require "#{$qa_observer_client}/lib/error_defns"
+require "#{$qa_observer_client}/lib/form_helpers"
+require "#{$qa_observer_client}/../remote_unix/lib/requires"
+
+require 'watir-webdriver'
+require "#{$qa_observer_client}/lib/watir"
+$environment ||= :test
+$test_case_dir = TEST_CASE_DIR
+require 'minitest/unit'
+require 'fileutils'
+require 'faker'
+require 'hpricot'
+require 'RMagick'
+require 'getoptions'
+require 'timeout'
+#require 'ruby-debug'
+
+
+$report = {}
+class SystemTest < MiniTest::Unit::TestCase
+  TestExtention.require_for_platform
+  def element(name, &blk)
+    define_me(name, &blk) 
+  end
+  
+#  if $junit_format
+#    MiniTest::Unit.autorun junit_xml=true
+#  else
+    MiniTest::Unit.autorun
+#  end
+
+  def setup
+    raise ArgumentError unless $run_on_browser
+
+    # FIXME: add self.name for ruby 1.9.2 under platform_helpers
+    if RUBY_VERSION =~ /^1\.9/
+      $current_test_method = self.__name__
+    else
+      $current_test_method = self.name
+    end
+    $current_test_class = self.class.name
+
+    if $job
+      unless $job[:methods].include?($current_test_method)
+        @skip = true
+        #skip_msg = "skipping '#{$current_test_method}' as it is only supported under windows but RUBY_PLATFORM is: #{RUBY_PLATFORM}"     
+        skip ''
+      end
+    end
+   
+    #@images = []
+    # inject required code into TestExtention
+    TestExtention.module_eval { @images = [] }
+
+    @capture_io = CaptureIO.new
+    @capture_io.start
+    super
+
+    LoadTestConfig.stuff("#{TEST_CASE_DIR}/../conf")
+    
+    # there are some items that need to be required before items in the
+    # list below this if File.exists? block.  Conflict of libs, etc..
+    if File.exists?("#{TEST_CASE_DIR}/../conf/preload.yaml")
+      YAML::load_file("#{TEST_CASE_DIR}/../conf/preload.yaml").each { |rb|
+        puts "PRELOADING: #{TEST_CASE_DIR}#{rb}"
+        require "#{TEST_CASE_DIR}#{rb}"
+      }
+    end
+    
+    @skip = false
+    @tmp_image_path = "#{$qa_observer_client}/tmp/images"
+
+
+    # cleanup images from previous test case
+    #FileUtils.rm_rf @tmp_image_path if File.directory?(@tmp_image_path)
+    FileUtils.mkdir_p @tmp_image_path unless File.directory?(@tmp_image_path)
+    
+    # check to see if the platform executing on matches desired results
+    if @windows_only && RUBY_PLATFORM !~ /win32/i
+      skip_msg = "skipping '#{$current_test_method}' as it is only supported under windows but RUBY_PLATFORM is: #{RUBY_PLATFORM}"     
+      skip skip_msg      
+    end
+   
+    if $cfg.kind_of?(Hash) 
+      $cfg = $cfg.merge(:base_url => $test_data[:base_urls][$environment][:root])
+    else
+      $cfg = $cfg = { :base_url => $test_data[:base_urls][$environment][:root] }
+    end
+
+    $sequence = 0
+    unless @no_browser
+      if Constants::SUPPORTED_BROWSERS.include?($run_on_browser)
+        $browser = Watir::Browser.new $run_on_browser.to_sym
+      else
+        raise ArgumentError, "Unsuppored browser provided: #{$run_on_browser}"
+      end
+    end
+  end
+
+  def teardown
+    unless @skip
+      io = @capture_io.stop
+      file_base = "#{$current_test_class}_#{Time.now}.html"
+      $html_file = "#{TEST_CASE_DIR}/../results/" + file_base.gsub(/[ :]/, '_')
+      #images = Images::Results.new(@tmp_image_path).result_images
+      begin
+        doc = TCDoc.test_documentation($current_test_class, [$current_test_method], 'html')
+        doc = doc[$current_test_method] + "\n\n#{io[:stdout].pp}"
+        if $report.has_key?($current_test_class)
+          $report[$current_test_class] << {:num_asserts => @_assertions, :passed => @passed, :images => TestExtention.get_images,
+                                            :documentation => doc, :method => $current_test_method}
+        else
+          $report.merge!($current_test_class => [{:num_asserts => @_assertions, :passed => @passed, :images => TestExtention.get_images,
+                                            :documentation => doc, :method => $current_test_method}])
+        end
+
+      rescue => e
+        puts "EEE: generating result doc\n#{e.inspect}"
+      ensure
+        #FileUtils.rm_rf @tmp_image_path
+        begin
+          $browser.close if $browser
+        rescue => e
+        end
+      end
+    end
+  end
+
+  MiniTest::Unit.after_tests { TCDoc.build_html($report, $html_file) }
+
+end
+Requires.run