testcentricity_web 0.2.2

data/lib/testcentricity_web/excel_helper.rb

@@ -0,0 +1,241 @@
+require 'time'
+require 'chronic'
+require 'faker'
+require 'spreadsheet'
+
+
+module TestCentricity
+
+  XL_PRIMARY_DATA_PATH  ||= 'features/test_data/'
+  XL_PRIMARY_DATA_FILE  ||= "#{XL_PRIMARY_DATA_PATH}data.xls"
+
+
+  class Excel_Data
+    @mru = {}
+
+    def self.get_environment_data_file
+      environment = ENV['TEST_ENVIRONMENT']
+      "#{XL_PRIMARY_DATA_PATH}#{environment}_data.xls"
+    end
+
+    def self.worksheet_exists?(file, sheet)
+      exists = false
+      work_book  = Spreadsheet.open file
+      worksheets = work_book.worksheets
+      worksheets.each do |worksheet|
+        if worksheet.name == sheet
+          exists = true
+          break
+        end
+      end
+      exists
+    end
+
+    def self.rowspec_exists?(file, sheet, rowspec)
+      exists = false
+      if worksheet_exists?(file, sheet)
+        work_book  = Spreadsheet.open file
+        work_sheet  = work_book.worksheet sheet
+        # get column headings from row 0 of worksheet
+        headings = work_sheet.row(0)
+        # if rowspec is a string then we have to find a matching row name
+        if rowspec.is_a? String
+          column_number = 0
+          exists = false
+          headings.each do |heading|
+            if heading == 'ROW_NAME'
+              exists = true
+              break
+            end
+            column_number += 1
+          end
+          raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless exists
+          # find first cell in ROW_NAME column containing a string that matches the rowspec parameter
+          exists = false
+          row_number = 0
+          work_sheet.each do |row|
+            if row[column_number] == rowspec
+              exists = true
+              break
+            end
+            row_number += 1
+          end
+        end
+      end
+      exists
+    end
+
+    def self.read_row_from_pool(file, sheet, rowspec, columns = nil)
+      work_book  = Spreadsheet.open file
+      work_sheet = work_book.worksheet sheet
+
+      pool_spec_key = "#{sheet}:#{rowspec}"
+      if @mru.key?(pool_spec_key)
+        pool_spec = @mru[pool_spec_key]
+        row_start = pool_spec[:start_row]
+        row_end   = pool_spec[:num_rows]
+        pool_rows = (row_start..row_start + row_end - 1).to_a
+        mru_rows  = pool_spec[:used_rows]
+        new_row   = pool_rows.sample.to_i
+        if mru_rows.size == pool_spec[:num_rows]
+          mru_rows = [new_row]
+        else
+          while mru_rows.include?(new_row)
+            new_row = pool_rows.sample.to_i
+          end
+          mru_rows.push(new_row)
+          mru_rows.sort!
+        end
+
+        pool_spec = {
+            :start_row => row_start,
+            :num_rows  => row_end,
+            :used_rows => mru_rows
+        }
+      else
+        # get column headings from row 0 of worksheet
+        headings      = work_sheet.row(0)
+        column_number = 0
+        found         = false
+        headings.each do |heading|
+          if heading == 'ROW_NAME'
+            found = true
+            break
+          end
+          column_number += 1
+        end
+        raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
+        # find cell(s) in ROW_NAME column containing a string that matches the rowspec parameter
+        found      = []
+        row_number = 0
+        work_sheet.each do |row|
+          if row[column_number] == rowspec
+            found.push(row_number)
+          elsif !found.empty?
+            break
+          end
+          row_number += 1
+        end
+        raise "Could not find a row named '#{rowspec}' in worksheet #{sheet}" if found.empty?
+
+        new_row   = found.sample.to_i
+        pool_spec = {
+            :start_row => found[0],
+            :num_rows  => found.size,
+            :used_rows => [new_row]
+        }
+      end
+      @mru[pool_spec_key] = pool_spec
+
+      read_row_data(file, sheet, new_row, columns)
+    end
+
+    def self.read_row_data(file, sheet, rowspec, columns = nil)
+      work_book  = Spreadsheet.open file
+      work_sheet  = work_book.worksheet sheet
+      # get column headings from row 0 of worksheet
+      headings = work_sheet.row(0)
+      # if rowspec is a string then we have to find a matching row name
+      if rowspec.is_a? String
+        column_number = 0
+        found = false
+        headings.each do |heading|
+          if heading == 'ROW_NAME'
+            found = true
+            break
+          end
+          column_number += 1
+        end
+        raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
+        # find first cell in ROW_NAME column containing a string that matches the rowspec parameter
+        found = false
+        row_number = 0
+        work_sheet.each do |row|
+          if row[column_number] == rowspec
+            found = true
+            break
+          end
+          row_number += 1
+        end
+        raise "Could not find a row named '#{rowspec}' in worksheet #{sheet}" unless found
+        data = work_sheet.row(row_number)
+        # if rowspec is a number then ensure that it doesn't exceed the number of available rows
+      elsif rowspec.is_a? Numeric
+        raise "Row # #{rowspec} is greater than number of rows in worksheet #{sheet}" if rowspec > work_sheet.last_row_index
+        data = work_sheet.row(rowspec)
+      end
+
+      # if no columns have been specified, return all columns
+      columns = headings if columns == nil
+      # create results hash table
+      result = Hash.new
+      columns.each do |column|
+        column_number = 0
+        found = false
+        headings.each do |heading|
+          if column == heading
+            value = data[column_number].to_s
+            value = calculate_dynamic_value(value) if value.start_with? 'eval!'
+            result[column] = value
+            found = true
+            break
+          end
+          column_number += 1
+        end
+        raise "Could not find a column named '#{column}' in worksheet #{sheet}" unless found
+      end
+      result
+    end
+
+    def self.read_range_data(file, sheet, rangespec)
+      work_book  = Spreadsheet.open file
+      work_sheet = work_book.worksheet sheet
+      # get column headings from row 0 of worksheet
+      headings = work_sheet.row(0)
+      column_number = 0
+      found = false
+      headings.each do |heading|
+        if heading == 'ROW_NAME'
+          found = true
+          break
+        end
+        column_number += 1
+      end
+      raise "Could not find a column named ROW_NAME in worksheet #{sheet}" unless found
+      # find cell(s) in ROW_NAME column containing a string that matches the rangespec parameter
+      found      = []
+      row_number = 0
+      work_sheet.each do |row|
+        if row[column_number] == rangespec
+          found.push(row_number)
+        elsif !found.empty?
+          break
+        end
+        row_number += 1
+      end
+      raise "Could not find a row named '#{rangespec}' in worksheet #{sheet}" if found.empty?
+
+      result = []
+      found.each do |row|
+        result.push(read_row_data(file, sheet, row))
+      end
+      result
+    end
+
+    private
+
+    def self.calculate_dynamic_value(value)
+      test_value = value.split('!', 2)
+      parameter = test_value[1].split('.', 2)
+      case parameter[0]
+      when 'Address', 'Business', 'Code', 'Company', 'PhoneNumber', 'Number', 'Name', 'Internet', 'Lorem', 'Commerce', 'Hacker'
+        result = eval("Faker::#{parameter[0]}.#{parameter[1]}")
+      when 'Date'
+        result = eval("Chronic.parse('#{parameter[1]}')")
+      else
+        result = eval(test_value[1])
+      end
+      result.to_s
+    end
+  end
+end

data/lib/testcentricity_web/exception_queue_helper.rb

@@ -0,0 +1,29 @@
+module TestCentricity
+  class ExceptionQueue
+    @error_queue
+
+    def self.enqueue_assert_equal(expected, actual, error_message)
+      unless expected == actual
+        @error_queue = "#{@error_queue}#{error_message} to be\n  #{expected}\nbut found\n  #{actual}\n\n"
+        screen_shot_and_save_page(nil)
+      end
+    end
+
+    def self.enqueue_assert_not_equal(expected, actual, error_message)
+      unless expected != actual
+        @error_queue = "#{@error_queue}#{error_message} to not be equal to #{expected}\n\n"
+        screen_shot_and_save_page(nil)
+      end
+    end
+
+    def self.enqueue_exception(error_message)
+      @error_queue = "#{@error_queue}#{error_message}\n\n"
+    end
+
+    def self.post_exceptions
+      raise @error_queue unless @error_queue.nil?
+    ensure
+      @error_queue = nil
+    end
+  end
+end

data/lib/testcentricity_web/page_objects_helper.rb

@@ -0,0 +1,147 @@
+module TestCentricity
+  class PageObject
+    include Capybara::DSL
+    include Capybara::Node::Matchers
+    include RSpec::Matchers
+    include Test::Unit::Assertions
+
+    def self.trait(trait_name, &block)
+      define_method(trait_name.to_s, &block)
+    end
+
+    def self.element(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, nil);end))
+    end
+
+    def self.button(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :button);end))
+    end
+
+    def self.textfield(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :textfield);end))
+    end
+
+    def self.checkbox(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :checkbox);end))
+    end
+
+    def self.label(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :label);end))
+    end
+
+    def self.link(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :link);end))
+    end
+
+    def self.table(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :page, :table);end))
+    end
+
+    def self.section(section_name, class_name, locator = nil)
+      class_eval(%Q(def #{section_name.to_s};@#{section_name.to_s} ||= #{class_name.to_s}.new(self, "#{locator}", :page);end))
+    end
+
+    def open_portal
+      environment = Environ.current
+      (environment.hostname.length > 0) ?
+          url = "#{environment.hostname}/#{environment.base_url}#{environment.append}" :
+          url = "#{environment.base_url}#{environment.append}"
+      if environment.user_id.length > 0 && environment.password.length > 0
+        visit "#{environment.protocol}://#{environment.user_id}:#{environment.password}@#{url}"
+      else
+        visit "#{environment.protocol}://#{url}"
+      end
+      Environ.set_portal_state(:open)
+    end
+
+    def verify_page_exists
+      unless page.has_selector?(page_locator)
+        body_class = find(:xpath, '//body')[:class]
+        error_message = "Expected page to have selector '#{page_locator}' but found '#{body_class}' instead.\nURL of page loaded = #{URI.parse(current_url)}"
+        raise error_message
+      end
+    end
+
+    def navigate_to; end
+
+    def verify_page_ui; end
+
+    def load_page
+      return if exists?
+      if defined?(page_url) && !page_url.nil?
+        visit page_url
+        begin
+          page.driver.browser.switch_to.alert.accept
+        rescue => e
+        end unless Environ.browser == :safari || Environ.browser == :ie || Environ.is_device?
+      else
+        navigate_to
+      end
+      verify_page_exists
+      PageManager.set_current_page(self)
+    end
+
+    def take_screen_shot(page_name, context)
+      save_page_screen_shot(page_name, context)
+    end
+
+    def verify_page_contains(content)
+      raise "Expected page to have content '#{content}'" unless page.has_content?(:visible, content)
+    end
+
+    def exists?
+      saved_wait_time = Capybara.default_max_wait_time
+      Capybara.default_max_wait_time = 0.1
+      tries ||= 2
+      attributes = [:id, :css, :xpath]
+      type = attributes[tries]
+      obj = page.find(type, page_locator)
+      obj != nil
+    rescue
+      Capybara.default_max_wait_time = saved_wait_time
+      retry if (tries -= 1) > 0
+      false
+    ensure
+      Capybara.default_max_wait_time = saved_wait_time
+    end
+
+    def secure?
+      !current_url.match(/^https/).nil?
+    end
+
+    def verify_ui_states(ui_states)
+      ui_states.each do | ui_object, object_states |
+        object_states.each do | property, state |
+          case property
+            when :exists
+              actual = ui_object.exists?
+            when :enabled
+              actual = ui_object.enabled?
+            when :visible
+              actual = ui_object.visible?
+            when :readonly
+              actual = ui_object.read_only?
+            when :checked
+              actual = ui_object.checked?
+            when :value
+              actual = ui_object.get_value
+            when :maxlength
+              actual = ui_object.get_max_length
+            when :options
+              actual = ui_object.get_options
+            when :siebel_options
+              actual = ui_object.get_siebel_options
+            else
+              if property.to_s.start_with? ('cell_')
+                cell = property.to_s.gsub('cell_', '')
+                cell = cell.split('_')
+                actual = ui_object.get_table_cell(cell[0].to_i, cell[1].to_i)
+              end
+          end
+          ExceptionQueue.enqueue_assert_equal(state, actual, "Expected #{ui_object.get_locator} #{property.to_s} property")
+        end
+      end
+      ExceptionQueue.post_exceptions
+    end
+  end
+end

data/lib/testcentricity_web/page_sections_helper.rb

@@ -0,0 +1,161 @@
+module TestCentricity
+  class PageSection
+    include Capybara::DSL
+    include Capybara::Node::Matchers
+    include RSpec::Matchers
+    include Test::Unit::Assertions
+
+    attr_reader   :locator, :context
+    attr_accessor :parent
+
+    def self.trait(trait_name, &block)
+      define_method(trait_name.to_s, &block)
+    end
+
+    def initialize(parent, locator, context)
+      @parent = parent
+      @locator = locator
+      @context = context
+    end
+
+    def self.element(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, nil);end))
+    end
+
+    def self.button(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :button);end))
+    end
+
+    def self.textfield(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :textfield);end))
+    end
+
+    def self.checkbox(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :checkbox);end))
+    end
+
+    def self.label(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :label);end))
+    end
+
+    def self.link(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :link);end))
+    end
+
+    def self.table(element_name, locator)
+      class_eval(%Q(def #{element_name.to_s};@#{element_name.to_s} ||= TestCentricity::UIElement.new(self, "#{locator}", :section, :table);end))
+    end
+
+    def self.section(section_name, class_name, locator = nil)
+      class_eval(%Q(def #{section_name.to_s};@#{section_name.to_s} ||= #{class_name.to_s}.new(self, "#{locator}", :section);end))
+    end
+
+    def get_locator
+      (@locator.empty? && defined?(section_locator)) ? locator = section_locator : locator = @locator
+      (@context == :section && !@parent.nil? && !@parent.get_locator.nil?) ? "#{@parent.get_locator}#{locator}" : locator
+    end
+
+    def set_parent(parent)
+      @parent = parent
+    end
+
+    def exists?
+      section, _ = find_section
+      section != nil
+    end
+
+    def visible?
+      section, type = find_section
+      exists = section
+      invisible = false
+      if type == :css
+        Capybara.using_wait_time 0.1 do
+          # is section itself hidden with .ui-helper-hidden class?
+          self_hidden = page.has_css?("#{@locator}.ui-helper-hidden")
+          # is parent of section hidden, thus hiding the section?
+          parent_hidden = page.has_css?(".ui-helper-hidden > #{@locator}")
+          # is grandparent of section, or any other ancestor, hidden?
+          other_ancestor_hidden = page.has_css?(".ui-helper-hidden * #{@locator}")
+          # if any of the above conditions are true, then section is invisible
+          invisible = self_hidden || parent_hidden || other_ancestor_hidden
+        end
+      end
+      # the section is visible if it exists and it is not invisible
+      (exists && !invisible) ? true : false
+    end
+
+    def hidden?
+      not visible?
+    end
+
+    def wait_until_exists(seconds)
+      timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { exists? }
+    rescue
+      raise "Could not find section #{get_locator} after #{timeout} seconds" unless exists?
+    end
+
+    def wait_until_gone(seconds)
+      timeout = seconds.nil? ? Capybara.default_max_wait_time : seconds
+      wait = Selenium::WebDriver::Wait.new(timeout: timeout)
+      wait.until { !exists? }
+    rescue
+      raise "Section #{get_locator} remained visible after #{timeout} seconds" if exists?
+    end
+
+    def verify_ui_states(ui_states)
+      ui_states.each do | ui_object, object_states |
+        object_states.each do | property, state |
+          case property
+            when :exists
+              actual = ui_object.exists?
+            when :enabled
+              actual = ui_object.enabled?
+            when :visible
+              actual = ui_object.visible?
+            when :readonly
+              actual = ui_object.read_only?
+            when :checked
+              actual = ui_object.checked?
+            when :value
+              actual = ui_object.get_value
+            when :maxlength
+              actual = ui_object.get_max_length
+            when :options
+              actual = ui_object.get_options
+            when :siebel_options
+              actual = ui_object.get_siebel_options
+            else
+              if property.to_s.start_with? ('cell_')
+                cell = property.to_s.gsub('cell_', '')
+                cell = cell.split('_')
+                actual = ui_object.get_table_cell(cell[0].to_i, cell[1].to_i)
+              end
+          end
+          ExceptionQueue.enqueue_assert_equal(state, actual, "Expected #{ui_object.get_locator} #{property.to_s} property")
+        end
+      end
+      ExceptionQueue.post_exceptions
+    end
+
+    private
+
+    def find_section
+      locator = get_locator
+      saved_wait_time = Capybara.default_max_wait_time
+      Capybara.default_max_wait_time = 0.1
+      tries ||= 4
+      attributes = [:text, :name, :id, :css, :xpath]
+      type = attributes[tries]
+      obj = page.find(type, locator)
+      [obj, type]
+    rescue
+      Capybara.default_max_wait_time = saved_wait_time
+      retry if (tries -= 1) > 0
+      [nil, nil]
+    ensure
+      Capybara.default_max_wait_time = saved_wait_time
+    end
+  end
+end