ole-qa-framework 2.1.0

data/lib/ole-qa-framework.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA
+  module Framework
+    # Load open-uri for DocStore Page Parsing
+    require 'open-uri'
+    require 'yaml'
+    require 'headless'
+    require 'watir-webdriver'
+
+    # Add absolute directory to $LOAD_PATH
+    @libdir = File.expand_path(File.dirname(__FILE__))
+    $LOAD_PATH.unshift(@libdir) unless $LOAD_PATH.include?(@libdir)
+
+    # Return absolute path from which the file was run
+    def self.load_dir
+      @libdir
+    end
+
+    # Load libraries from absolute path
+    def self.load_libs(filedir, filename = "*.rb")
+      Dir[@libdir + filedir + filename].sort.each do |file|
+        require file
+      end
+    end
+
+    # Load main class libraries
+    load_libs("/ole_qa_framework/")
+
+    # Load all independent modules
+    load_libs("/module/")
+
+    # Load Page & Element Definitions.
+    # Main directory is loaded first, then subdirectories in alphabetical order.
+    # If pages or elements need to be inherited by subclasses, put them in a (foo)/common/ directory.
+    # Subobject directories (foo)/subobjects/ should be loaded before object directories (foo)/objects/ for inheritance.
+    load_libs("/common/")
+    # load_libs("/olefs/")
+    load_libs("/olefs/common/")
+    load_libs("/olefs/subobjects/")
+    load_libs("/olefs/objects/")
+    load_libs("/olefs/pages/")
+    load_libs("/olels/common/")
+    load_libs("/olels/subobjects/")
+    load_libs("/olels/objects/")
+    load_libs("/olels/pages/")
+    # load_libs("/docstore/")
+
+    # Initialize wait variables to 0 for now.  They will be set programatically in {OLE_QA::Framework::Session}.
+    @explicit_wait = 0
+    @doc_wait = 0
+
+    # Set accessor methods for explicit_wait & doc_wait, to be used mainly by OLE_QA::Tools (ole-qa-tools).
+    class << self
+      attr_reader :explicit_wait, :doc_wait
+    end
+
+    # Handle Browser Functions, Headless Session
+    #   Invoke with @ole = Session.new(opts)
+    #   Exit with @ole.quit
+    #
+    # Default options loaded from
+    #   lib/config/default_options.yml
+    #
+    class Session
+
+      # OLE Installation Base URL
+      # - Also serves as OLE Financial System Main Menu URL
+      attr_reader :base_url
+      alias :fs_url :base_url
+
+      # OLE Library System Base URL
+      attr_reader :ls_url
+
+      # Wait period (in seconds) used by OLE QAF Web Element functions
+      attr_accessor :explicit_wait
+
+      # The options with which this OLE_QA Framework Session was invoked
+      attr_reader :options
+
+      # Options hash keys:
+      #   :base_url => "http://tst.ole.kuali.org/"
+      #     (URL for OLE Installation)
+      #   :ls_url => "http://tst.rice2.ole.kuali.org"
+      #     (URL for OLE Library System Rice Instance)
+      #   :headless => true/false
+      #     (Use Headless gem to handle XVFB session)
+      #   :implicit_wait => NN
+      #     (Set Selenium Webdriver's default wait period)
+      #   :explicit_wait => NN
+      #     (Set the wait period used by custom wait functions)
+      #   :doc_wait => NN
+      #     (Set the wait period for eDoc routing to complete)
+      #   :browser => selenium_webdriver
+      #     (Where browser is a Selenium WebDriver session)
+      #
+      # To configure the default options, edit
+      #   lib/config/default_options.yml
+      #
+      def initialize( options={} )
+        yaml_configuration = File.open(OLE_QA::Framework::load_dir + '/config/default_options.yml', 'r')
+        options_defaults = YAML.load(yaml_configuration)
+        yaml_configuration.close
+        @options = options_defaults.merge(options)
+
+        # Start headless session if requested
+        if @options[:headless?]
+          @headless = Headless.new
+          @headless.start
+        end
+
+        # Globalize options to accessors
+        @base_url = @options[:base_url]
+        @ls_url = @options[:ls_url]
+        @explicit_wait = @options[:explicit_wait]
+        @doc_wait = @options[:doc_wait]
+
+        # Pass explicit_wait to a module accessor for use with OLE_QA::Tools
+        OLE_QA::Framework.instance_variable_set(:@explicit_wait,@options[:explicit_wait])
+
+        # Pass doc_wait to a module accessor for use with OLE_QA::Tools
+        OLE_QA::Framework.instance_variable_set(:@doc_wait,@options[:doc_wait])
+
+        # Browser Start
+        if @options.has_key?(:browser) && @options[:browser].class == Watir::Browser
+          @browser = @options[:browser]
+        else
+          @browser = Watir::Browser.new :firefox
+          @browser.driver.manage.timeouts.implicit_wait = @options[:implicit_wait]
+        end
+
+      end
+
+      # Access Watir-Webdriver's browser session.
+      def browser
+        @browser
+      end
+
+      # Access Watir-Webdriver's Window Handling Method
+      def windows
+        @browser.windows
+      end
+
+      # Open a page via URL.  (Defaults to @base_url.)
+      def open(url = @base_url)
+        @browser.goto(url)
+      end
+
+      # Teardown the OLE QA Framework.
+      # - Exit the Selenium WebDriver browser session.
+      # - Exit the Headless (XVFB) session if necessary.
+      def quit
+        @browser.quit
+        if @options[:headless?] then
+          @headless.destroy
+        end
+      end
+    end
+
+    # Define OLE_QA::Framework::Error.
+    class Error < StandardError
+    end
+  end
+end

data/lib/ole_qa_framework/COMPATIBILITY.rb

@@ -0,0 +1,20 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA
+  module Framework
+    # The most recent version of OLE with which this framework is compatible.
+    OLE_VERSION = '0.8.0 - 1.0.0-M1-r12784 2013-07-03'
+  end
+end

data/lib/ole_qa_framework/VERSION.rb

@@ -0,0 +1,20 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA
+  module Framework
+    # The version number for this project.
+    VERSION = '2.1.0'
+  end
+end

data/lib/olefs/common/e_doc.rb

@@ -0,0 +1,79 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA::Framework::OLEFS
+
+  # This class contains element definitions common to OLE Financial System E-Docs.
+  # Element definitions are stored in lib/olefs/e_doc/elements.yml
+  class E_Doc < OLE_QA::Framework::Page
+    # Automatically set element definitions on the E-Document object.
+    # @note This method is automagically invoked on any Page object.  (see {OLE_QA::Framework::OLEFS::Page#initialize})
+    def set_elements
+      super
+      # General Info
+      element(:title)                         {b.div(:id => 'headerarea').h1}
+      # Header Area
+      element(:document_id)                   {b.th(:text => /Doc Nbr\:/).parent.td(:index => 0)}
+      element(:document_status)               {b.th(:text => /Status\:/).parent.td(:index => 1)}
+      element(:document_type_id)              {b.table(:class => 'headerinfo').tbody.tr(:index => 2).td(:index => 0)}
+      element(:document_type_status)          {b.table(:class => 'headerinfo').tbody.tr(:index => 2).td(:index => 1)}
+      element(:document_create_date)          {b.table(:class => 'headerinfo').tbody.tr(:index => 1).td(:index => 1)}
+      # Document Overview
+      element(:document_overview_tab_toggle)  {b.input(:id => 'tab-DocumentOverview-imageToggle')}
+      element(:description_field)             {b.text_field(:id => 'document.documentHeader.documentDescription')}
+      element(:explanation_field)             {b.text_field(:id => 'document.documentHeader.explanation')}
+      # Global Input Buttons
+      element(:approve_button)                {b.div(:id => 'globalbuttons').input(:title => 'blanket approve')}
+      element(:save_button)                   {b.div(:id => 'globalbuttons').input(:title => 'save')}
+      element(:submit_button)                 {b.div(:id => 'globalbuttons').input(:title => 'submit')}
+      element(:calculate_button)              {b.div(:id => 'globalbuttons').input(:title => 'Calculate')}
+      element(:close_button)                  {b.div(:id => 'globalbuttons').input(:title => 'close')}
+      element(:cancel_button)                 {b.div(:id => 'globalbuttons').input(:title => 'cancel')}
+      element(:copy_button)                   {b.div(:id => 'globalbuttons').input(:title => 'Copy current document')}
+      element(:send_ad_hoc_button)            {b.div(:id => 'globalbuttons').input(:title => 'Send AdHoc Requests')}
+      element(:reload_button)                 {b.div(:id => 'globalbuttons').input(:title => 'reload')}
+      # Confirmation Screen Buttons
+      element(:close_yes_button)              {b.div(:id => 'globalbuttons').input(:name => 'methodToCall.processAnswer.button0')}
+      element(:close_no_button)               {b.div(:id => 'globalbuttons').input(:name => 'methodToCall.processAnswer.button1')}
+      element(:cancel_yes_button)             {b.div(:id => 'globalbuttons').input(:name => 'methodToCall.processAnswer.button0')}
+      element(:cancel_no_button)              {b.div(:id => 'globalbuttons').input(:name => 'methodToCall.processAnswer.button1')}
+      # Messages
+      element(:save_message)                  {b.div(:class => 'left-errmsg').div(:text => /Document was successfully saved\./)}
+      element(:submit_message)                {b.div(:class => 'left-errmsg').div(:text => /Document was successfully submitted\./)}
+      element(:error_message)                 {b.div(:class => 'left-errmsg').div(:class => 'error', :text => /error/, :text => /found on page/)}
+      element(:generic_message)               {b.div(:class => 'left-errmsg').div}
+      # Multiple Error Message Components     Watir::HTMLElementCollection
+      element(:errors_in_tab)                 {b.strongs(:text => /Errors found in this Section\:/)}
+    end
+
+    # Wait for the following elements to be loaded when opening an E-Document page.
+    def wait_for_elements
+      @wait_on << :title
+      @wait_on << :document_id
+      super
+    end
+
+    # Returns an array of both "Errors in this Section" messages and individual error messages from each section.
+    def get_error_array
+      error_array = Array.new
+      self.errors_in_tab.each do |error_in_tab|
+        error_array << error_in_tab
+        error_in_tab.parent.divs.each do |error|
+         error_array << error
+        end
+      end
+      error_array
+    end
+  end
+end

data/lib/olefs/common/line_object.rb

@@ -0,0 +1,39 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA::Framework::OLEFS
+  # A line object with methods specific to OLEFS line objects.
+  class Line_Object < OLE_QA::Framework::Line_Object
+    def initialize(ole_session, line_number)
+      super(ole_session, line_number)
+      set_sublines if defined?(self.set_sublines)
+    end
+
+    def create_subline(instance_name, class_name, which=0)
+      raise StandardError, "Subline object already exists. (#{instance_name})" if self.instance_variables.include?("@#{instance_name}".to_sym)
+      new_line_name = instance_name
+      make_accessor(:"#{new_line_name}")
+      klas = OLE_QA::Framework::OLEFS.const_get(:"#{class_name}")
+      instance_variable_set(:"@#{new_line_name}", klas.new(@ole, @line_number, which))
+    end
+    alias_method(:add_subline,:create_subline)
+
+    def remove_subline(instance_name)
+      raise StandardError, "Subline object does not exist. (#{instance_name})" unless self.instance_variables.include?("@#{instance_name}".to_sym)
+      remove_instance_variable("@#{instance_name}".to_sym)
+      unmake_attr(instance_name.to_sym)
+    end
+    alias_method(:delete_subline,:remove_subline)
+  end
+end

data/lib/olefs/common/lookup.rb

@@ -0,0 +1,30 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA::Framework::OLEFS
+  # A Lookup Screen in OLEFS
+  class Lookup < OLE_QA::Framework::Page
+    # Set lookup page elements.
+    def set_elements
+      super
+      element(:title)                           {b.h1(:xpath => "//div[@id='headerarea-small']/h1")}
+      element(:active_indicator_yes)            {b.radio(:id => "activeYes")}
+      element(:active_indicator_no)             {b.radio(:id => "activeNo")}
+      element(:active_indicator_both)           {b.radio(:id => "activeBoth")}
+      element(:search_button)                   {b.input(:title => "search")}
+      element(:clear_button)                    {b.input(:title => "clear")}
+      element(:cancel_button)                   {b.input(:title => "cancel")}
+    end
+  end
+end

data/lib/olefs/common/purap_document.rb

@@ -0,0 +1,73 @@
+#  Copyright 2005-2013 The Kuali Foundation
+#
+#  Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
+#
+#  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.
+
+module OLE_QA::Framework::OLEFS
+  # An OLE Financial System PURchasing/Accounts Payable Document
+  class PURAP_Document < E_Doc
+    def initialize(ole_session, url)
+      super(ole_session, url)
+      set_lines if defined?(self.set_lines)
+    end
+
+    # Set PURAP Document Elements.
+    def set_elements
+      super
+      # View Related Documents Tab
+      element(:view_related_tab_toggle)                           {b.input(:id => "tab-ViewRelatedDocuments-imageToggle")}
+      element(:view_related_po_link)                              {b.a(:xpath => "//div[@id='tab-ViewRelatedDocuments-div']/descendant::h3[contains(text(),'Purchase Order')]/a")}
+      element(:view_related_requisition_link)                     {b.a(:xpath => "//div[@id='tab-ViewRelatedDocuments-div']/descendant::h3[contains(text(),'Requisition')]/a")}
+      # Delivery Tab
+      element(:delivery_tab_toggle)                               {b.input(:id => "tab-Delivery-imageToggle")}
+      element(:building_field)                                    {b.td(:xpath => "//div[@id='tab-Delivery-div']/div/table/tbody/tr[2]/td[1]")}
+      element(:campus_field)                                      {b.td(:xpath => "//div[@id='tab-Delivery-div']/div/table/tbody/tr[1]/td[1]")}
+      element(:closed_room_field)                                 {b.td(:xpath => "//div[@id='tab-Delivery-div']/div/table/tbody/tr[5]/td[1]")}
+      element(:closed_building_field)                             {b.td(:xpath => "//div[@id='tab-Delivery-div']/div/table/tbody/tr[2]/td[1]")}
+      element(:closed_campus_field)                               {b.td(:xpath => "//div[@id='tab-Delivery-div']/div/table/tbody/tr[1]/td[1]")}
+      element(:closed_address_1_field)                            {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[3]/th[1]/following-sibling::td[1]")}
+      element(:closed_address_2_field)                            {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[4]/th[1]/following-sibling::td[1]")}
+      element(:closed_city_field)                                 {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[6]/th[1]/following-sibling::td[1]")}
+      element(:closed_state_field)                                {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[7]/th[1]/following-sibling::td[1]")}
+      element(:closed_postal_code_field)                          {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[8]/th[1]/following-sibling::td[1]")}
+      element(:closed_country_field)                              {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[9]/th[1]/following-sibling::td[1]")}
+      element(:closed_delivery_to_field)                          {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[1]/th[1]/following-sibling::td[2]")}
+      element(:closed_delivery_phone_number_field)                {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[2]/th[1]/following-sibling::td[2]")}
+      element(:closed_email_field)                                {b.td(:xpath => "//div[@id='tab-Delivery-div']/descendant::tr[3]/th[1]/following-sibling::td[2]")}
+      # Vendor Tab
+      element(:vendor_tab_toggle)                                 {b.input(:id => "tab-Vendor-imageToggle")}
+      element(:closed_vendor_name_field)                          {b.td(:xpath => "//tr/th[div[contains(text(),'Suggested Vendor:')]]/following-sibling::td[1]")}
+      # Route Log Tab
+      element(:route_log_tab_toggle)              {b.input(:id => "tab-RouteLog-imageToggle")}
+      # element(:actions_taken)                     {b.bs(:xpath => "//div[@id='tab-ActionsTaken-div']/div[1]/table/tbody/tr/td[1]/b")}
+      # element(:actions_taken_by)                  {b.as(:xpath => "//div[@id='tab-ActionsTaken-div']/div[1]/table/tbody/tr/td[2]/a")}
+    end
+
+    # Create a Line Object on a PURAP Document page.
+    def create_line(instance_name, class_name, which=0)
+      raise StandardError, "Line object already exists.  (#{instance_name})" if self.instance_variables.include?("@#{instance_name}".to_sym)
+      new_line_name = instance_name
+      make_accessor(:"#{instance_name}")
+      klas = OLE_QA::Framework::OLEFS.const_get(:"#{class_name}")
+      instance_variable_set(:"@#{new_line_name}", klas.new(@ole, which))
+    end
+    alias_method(:add_line,:create_line)
+
+    # Remove a Line Object from a PURAP Document page.
+    def remove_line(instance_name)
+      raise StandardError, "Line object does not exist.  (#{instance_name})" unless self.instance_variables.include?("@#{instance_name}".to_sym)
+      remove_instance_variable("@#{instance_name}".to_sym)
+      unmake_attr(instance_name.to_sym)
+    end
+    alias_method(:delete_line,:remove_line)
+  end
+end