ole-qa-framework 2.1.0

data/lib/common/common_object.rb

@@ -0,0 +1,57 @@
+#  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
+  # OLE object class to be inherited by both Page Object and Data Object classes.
+  #   (Grouping together common initialize settings for DRYness.)
+  # @note The instance variable @browser can be used internally to refer to the
+  #   browser and only the browser, whereas the instance method .browser, defined
+  #   in {OLE_QA::Framework::Helpers#browser} will refer either to the browser
+  #   itself or to the browser within the context of the "iframeportlet" frame,
+  #   if it is found to be present.
+  class Common_Object
+    include OLE_QA::Framework::Helpers
+
+    # The OLE_QA::Framework::Session instance passed to the Data Object.
+    attr_accessor :ole
+
+    # Arrays containing the names(Symbol) of each element or function declared
+    #   on a data object.
+    attr_reader :elements, :functions
+
+    # @param ole_session [Object] The OLE_QA::Framework::Session instance with which the object should load.
+    def initialize(ole_session)
+      @ole = ole_session
+      @browser = ole_session.browser
+      @elements = Array.new
+      @functions = Array.new
+      set_elements if defined?(self.set_elements)
+      set_functions if defined?(self.set_functions)
+    end
+
+    # Fill this method with element definitions in a subclass.
+    # - Call super first in this method if the subclass overrides elements from the superclass.
+    # - Use with {OLE_QA::Framework::Helpers#set_element}
+    # @note This method is automatically called on any subclass if defined therein.
+    def set_elements
+    end
+
+    # Fill this method with function definitions in a subclass.
+    # - Call super first in this method if the subclass overrides functions from the superclass.
+    # - Use with {OLE_QA::Framework::Helpers#set_function}
+    # @note This method is automatically called on any subclass if defined therein.
+    def set_functions
+    end
+  end
+end

data/lib/common/data_object.rb

@@ -0,0 +1,21 @@
+#  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
+
+  # An object in OLE which contains screen elements but is not itself a screen element.
+  class Data_Object < Common_Object
+    include OLE_QA::Framework::Data_Helpers
+  end
+end

data/lib/common/line_object.rb

@@ -0,0 +1,44 @@
+#  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
+
+  # A Data Object in OLE that represents a single line in a given area.
+  # A line object can usually be added or deleted, and may or may not
+  # have its own line objects beneath it in the page-object hierarchy.
+  class Line_Object < Data_Object
+
+    # The line number that this object will have on the screen.
+    # - Used for line identifier replacement.
+    attr_reader :line_number
+    attr_reader :line_id
+
+    # @param ole_session [Object] The OLE_QA::Framework::Session session to pass to the Data Object.
+    # @param line_number [Fixnum] The number this line object will use for element definitions.
+    def initialize(ole_session, line_number = 1)
+      @line_number = line_number
+      @line_id = line_number - 1
+      super(ole_session)
+    end
+
+    # Set element definitions, if any.
+    # @note Use @line_number or @line_id in an element definition to specify either the textual,
+    #   human-readable (1-based) line number of the line object, or the coded, application-readable
+    #   (0-based) line identifier number of the line object.
+    def set_elements
+    end
+
+
+  end
+end

data/lib/common/page.rb

@@ -0,0 +1,72 @@
+#  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
+
+  # An OLE Page object
+  class Page < Common_Object
+
+    # The URL to open a given page.
+    # @note Do not use this value for the URL to open a new page of a given
+    #   document type.  If the page object represents an e-Document in OLEFS
+    #   or OLELS, instead use the :new_url accessor set on the e-Doc object.
+    attr_reader :url
+
+    include OLE_QA::Framework::Page_Helpers
+
+    # @param ole_session [Object] The OLE_QA::Framework::Session instance in which the page should load.
+    # @param url [String] The URL (if any) used to open the page.  (Set to "" if unused.)
+    def initialize(ole_session, url)
+      super(ole_session)
+      @url = url
+      @wait_on = Array.new
+      wait_for_elements if defined?(self.wait_for_elements)
+    end
+
+    # Open the page via URL.
+    # @note Some pages may not have custom open URLs.  If this is the case,
+    #   this method can be passed a lookup URL with a document ID #.
+    # @note This method will invoke the wait_for_elements method if it is defined on a page.
+    # @note If a page has declared elements to wait on, invoking this method will return
+    #   an array of the symbols used to call those methods.
+    def open(url = @url)
+      @browser.goto(url)
+      @wait_on.each { |element| wait_for_element(element) } if defined?(wait_for_elements)
+    end
+
+    # Define this method on a subclass.  Add element symbols to the @wait_on array.
+    # This will require the open method to wait for each of these elements to be present before it finishes.
+    #   e.g.
+    #   def wait_for_elements
+    #     @wait_on << :title
+    #     @wait_on << :close_button
+    #     super
+    #   end
+    #
+    def wait_for_elements
+    end
+
+    # Use this method on subclasses to define elements that must be loaded for the page to be considered completely loaded.
+    # This method can be called individually or will be called on an open command if .wait_for_elements is defined on the subclass.
+    def wait_for_element(element)
+      self.send(element).wait_until_present(@ole.explicit_wait)
+    end
+
+    # Call this method on a page that has wait_for_elements defined
+    # to wait for all required elements on that page to load.
+    def wait_for_page_to_load
+      @wait_on.each { |element| wait_for_element(element) }
+    end
+  end
+end

data/lib/common/subline_object.rb

@@ -0,0 +1,47 @@
+#  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
+  # A Data Object in OLE that represents a line nested under another line.
+  # A subline can usually be added or deleted, and has element identifiers
+  # which vary dependent upon the line below which they are nested.
+  class Subline_Object < Data_Object
+
+    # The line number that this object will have on the screen.
+    # - Used for line identifier replacement.
+    attr_reader :line_number
+    attr_reader :line_id
+
+    # The line number that this subline object will have on the screen.
+    # - Used for subline identifier replacement.
+    attr_reader :subline_number
+    attr_reader :subline_id
+
+    # @param ole_session [Object] The OLE_QA::Framework::Session session to pass to the Data Object.
+    # @param line_number [Fixnum] The line number this subline object will use for element definitions.
+    # @param subline_number [Fixnum] The subline number this subline object will use for element definitions.
+    def initialize(ole_session, line_number = 1, subline_number = 1)
+      @line_number, @subline_number = line_number, subline_number
+      @line_id = line_number -1
+      @subline_id = subline_number -1
+      super(ole_session)
+    end
+
+    # Set elements on the subline object.
+    # @note Use line_number, line_id, subline_number, and subline_id to replace dynamic identifier numbers.
+    #   (See {OLE_QA::Framework::Line_Object#set_elements} for more on line number substitution.)
+    def set_elements
+    end
+  end
+end

data/lib/config/default_options.yml

@@ -0,0 +1,7 @@
+---
+:base_url: http://tst.ole.kuali.org/
+:ls_url: http://tst.rice2.ole.kuali.org/
+:headless?: true
+:implicit_wait: 0
+:explicit_wait: 15
+:doc_wait: 45

data/lib/docstore/docstore.rb

@@ -0,0 +1,13 @@
+#  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.

data/lib/module/qa_data_helpers.rb

@@ -0,0 +1,17 @@
+#  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::Data_Helpers
+
+end

data/lib/module/qa_helpers.rb

@@ -0,0 +1,153 @@
+#  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::Helpers
+  # Handle frame selection in the browser via aliasing the @browser session passed to a page or data object.
+  # - If the page or data object is inherited by any kind of OLE e-Doc, all elements will be encapsulated within a frame
+  #   with an ID of 'iframeportlet'.
+  # - If the page is a main menu page or a lookup page, the frame may not be present.
+  def browser
+    if @ole.browser.frame(:class => 'fancybox-iframe').present?
+      @ole.browser.frame(:class => 'fancybox-iframe')
+    elsif @ole.browser.frame(:id => 'iframeportlet').present?
+      @ole.browser.frame(:id => 'iframeportlet')
+    else
+      @ole.browser
+    end
+  end
+  alias_method(:b,:browser)
+
+  # Add an accessor to a class from within that class only.
+  def make_accessor(symbol)
+    eigenclass = class << self;
+                   self
+    end
+    eigenclass.class_eval do
+      attr_accessor symbol
+    end
+  end
+  private :make_accessor
+
+  # Add a reader to a class from within that class only.
+  def make_reader(symbol)
+    eigenclass = class << self;
+                   self
+    end
+    eigenclass.class_eval do
+      attr_reader symbol
+    end
+  end
+  private :make_reader
+
+  # Add a writer to a class from within that class only.
+  def make_writer(symbol)
+    eigenclass = class << self;
+                   self
+    end
+    eigenclass.class_eval do
+      attr_writer symbol
+    end
+  end
+  private :make_writer
+
+  # Unset a previously defined attribute on a class.
+  def unmake_attr(method_name)
+    eigenclass = class << self;
+                   self
+    end
+    eigenclass.class_eval do
+      undef_method(method_name)
+    end
+  end
+  private :unmake_attr
+
+  # Set an element definition on a page or data object.
+  # - An element created with this method becomes an accessor attribute
+  #   associated with an instance variable on the page or data object on
+  #   which it is created.
+  #
+  # @param name [Symbol] The name the new element will have on the object.
+  #   (This will be an instance variable, so it cannot contain spaces.)
+  # @param force [Boolean] If set to true, this method can be used to override an existing element definition.
+  #
+  # @raise StandardError if a parameter is of an incorrect type.
+  # @raise StandardError if an instance method already exists for an element with the same name.
+  #   (Suppress with force = true.)
+  #
+  # @note This method can also be used to add an element to an existing page object instance.
+  #   The code block passed to the method will need to explicitly name the class instance in order to
+  #   access the browser method.
+  #
+  # @note In some cases in OLE, text_field elements are coded as <input> elements.  If Watir-Webdriver
+  #   returns an error in a case like this, affixing .to_subtype should make the #set method available.
+  #
+  def set_element(name, force = false)
+    raise StandardError, "Name must be a symbol.  Given: #{name} (#{name.class})" unless name.instance_of?(Symbol)
+    eigenclass = class << self;
+      self
+    end
+    raise StandardError, "Element is already defined.  (Use the 'force = true' option to suppress this error.)" if eigenclass.instance_methods.include?(name) && ! force
+    eigenclass.class_eval do
+      define_method name.to_s do
+        yield self
+      end
+    end
+    @elements << name
+  end
+  alias_method(:element, :set_element)
+
+  # Set a function definition on a page or data object.
+  # - A function created with this method becomes an accessor attribute
+  #   associated with an instance variable on the page or data object on
+  #   which it is created.
+  #
+  # @param name [Symbol] The name the new function will have on the object.
+  #   (This will be an instance variable, so it cannot contain spaces.)
+  # @param force [Boolean] If set to true, this method can be used to override an existing function definition.
+  #
+  # @raise StandardError if a parameter is of an incorrect type.
+  # @raise StandardError if an instance method already exists for a function with the same name.
+  #   (Suppress with force = true.)
+  #
+  # @note Invoking a function without passing the expected parameter/s may not return an appropriate error message.
+  def set_function(name, force = false, &block)
+    raise StandardError, "Name must be a symbol.  Given: #{name} (#{name.class})" unless name.instance_of?(Symbol)
+    eigenclass = class << self;
+      self
+    end
+    raise StandardError, "Element is already defined.  (Use the 'force = true' option to suppress this error.)" if eigenclass.instance_methods.include?(name) && ! force
+    eigenclass.class_eval do
+      define_method name.to_s do |*arg|
+        yield *arg
+      end
+    end
+    @functions << name
+  end
+  alias_method(:function,:set_function)
+
+  # Load a YML file.
+  def load_yml(subdir, filename)
+    basedir = OLE_QA::Framework::load_dir
+    file_path = basedir + '/' + subdir + filename
+    if File.exists?(file_path) then
+      yaml_file = File.open(file_path, 'r')
+      yaml = YAML.load(yaml_file)
+      yaml_file.close
+      yaml
+   else
+      raise StandardError, "File does not exist. (#{basedir + subdir + filename})"
+    end
+  end
+  alias_method(:load_yaml,:load_yml)
+end

data/lib/module/qa_page_helpers.rb

@@ -0,0 +1,33 @@
+#  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::Page_Helpers
+  # Login as a given user.
+  # @param username [String] The username to use.
+  # @return [Boolean] Whether the login process succeeded.
+  def login(username)
+    raise OLE_QA::Framework::Error,"Login field not present on this page: #{self.class.name}" unless @browser.text_field(:name => "backdoorId").present?
+    @browser.text_field(:name => "backdoorId").set(username)
+    @browser.input(:class => "go", :value => "Login").click
+    @browser.div(:id => "login-info").strong(:text => /Impersonating User\:/, :text => /#{username}/).present?
+  end
+
+  # Logout from previous login.
+  # @return [Boolean] Whether the logout process succeeded.
+  def logout
+    @browser.input(:class => "go", :value => "Logout").click
+    # Return false if still impersonating user, true if not.
+    @browser.div(:id => "login-info").strong(:text => /Impersonating User\:/).present? ? false : true
+  end
+end