ole-qa-framework 3.14.1 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fda8afd432cda6d8ec31f2da530e71da8e1ef1e5
-  data.tar.gz: b98b3bec9e9ce315d3cd018fac14489a03f98505
+  metadata.gz: 725c44e11f55eccafd6ff4c7809e2b73b8e67eb4
+  data.tar.gz: 03eb2fb83bfd8cab61508524ca0ed69caffd0e61
 SHA512:
-  metadata.gz: 8a82c0e74359a8b1059e9fef39a72a568101b7d69f1fe9b64a791a96fa9ee7b121757847d999b03fb00f73e9d870b00f62710990c4a4d752b3013c4958309afd
-  data.tar.gz: 4a6e391e174c7edce8956702243ca2b486510f703bf640730e58fd3106e2104e2b395294b04d2c393f11842ebe045e7d88951097f9d4c90971f1be8725a60c73
+  metadata.gz: e30b829f8bef67fc32d46346b0a0a4644cb59422825cbeb5479d7082a8e3d1106ac9cb3a93bfd596071988e03bd9167292f9b17a7a1dfd1d0372bf7fcfda469d
+  data.tar.gz: e36db42fcfbbf8ebb55adf695acc3c51ce0ea3ae17978bbfb73c9ed8144b506a864a5af0b866479af4ebe9544dc3afc2fb76ef7f39d5de3f88b765f1bf8cdb02

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### v3.15.0 - 2014/06/18
+
+* Update Framework module & Session class
+    * Add session spec
+    * Move lib/config/default_options.yml to config/options.yml
+* Update Rakefile
+    * Remove select_config task
+    * Add show_config task
+    * Add configurator task
+* Update Readme
+    * Add instructions for show_config & configurator tasks
+* Clean up modules
+    * Move page helpers to lib/common/page.rb
+    * Remove lib/module/qa_page_helpers.rb
+    * Remove redundant page helpers spec
+    * Remove lib/module/qa_data_helpers.rb
+* Clean up Data Factories
+    * Change classes to modules
+    * Add country attribute to patron factory
+* Add country data file to data/
+* Update Copyright info
+* Clean up specs
+    * Add @ole.nil? check to specs using live sessions
+* Add circulation info selector to Bib Factory
+    * OLE_QA::Framework::Bib_Factory.circulation_info will return a hash containing
+      a circulation desk code, circulation desk name, and an array of locations which
+      are mapped to that circulation desk.
+    * Added examples to spec/data_factory/bib_factory_spec.rb
+* Add institutional data configuration section to README.md
+
 ### v3.14.1 - 2014/05/19
 
 * Add Conributions document

data/LICENSE.md

@@ -1,4 +1,4 @@
-### Copyright 2005-2013 The Kuali Foundation
+### Copyright 2005-2014 The Kuali Foundation
 - - -
 
 Licensed under the Educational Community License, Version 2.0 (the "License");

data/README.md

@@ -8,4 +8,96 @@ http://www.kuali.org/ole
 - - -
 This is a testing framework for the Kuali Open Library environment.  It
 is be used to define OLE pages and screen elements for OLE regression
-testing scripts and the OLE Smoketest application.
+testing scripts and the OLE Smoketest application.
+
+### Configuration
+
+Options can be set in the file config/options.yml.  Here is a list of the
+options hash keys and their meanings:
+
+- :url:
+    - The URL of the main OLE installation you will be testing.
+- :docstore_url:
+    - The URL of the OLE Document Store installation.
+- :headless?:
+    - If set to true, the testing session will be run headlessly
+    in an XVFB session handled by the Headless gem.
+-  :implicit_wait:
+    - Used to set Selenium Webdriver's default wait period.
+- :explicit_wait:
+    - Used to set the Watir Webdriver default wait period.
+- :doc_wait:
+    - Used to set the maximum timeout for an OLE eDocument
+    to finish routing to the next step in its workflow.
+-  :browser:
+    - Pass an active instance of Watir Webdriver if you want to start
+    an OLE Framework session with an already-running browser.
+
+These options can be set manually, or using the Rake configurator task.
+Use the Rake show_config task to see the current options settings at any time.
+
+### Instituational Data
+
+Institutional data is defined in the YAML files in the data/ directory.  The
+OLE QA Framework can be adapted to use different institutional data first by
+editing the YAML data files in data/, and optionally altering the default values
+of a few data factories and their respective RSpec tests in the spec/ directory.
+
+#### YAML Data Files
+
+The data/ directory contains the following YAML data files:
+
+- accounts.yml
+    - OLE account numbers, organized into a hash containing arrays of
+      account numbers organized by chart code.
+- borrower_types.yml
+    - Borrower types used for patron and circulation information,
+      organized into an array.
+- circulation.yml
+    - Circulation desks and the locations which they serve, organized
+      into an array containing a hash for each desk, which itself contains
+      an array of locations served by that desk.
+- country.yml
+    - A string containing the country name to be used for patron information,
+      as it appears in the OLE application itself.
+- objects.yml
+    - Object code values for accounting, organized into a hash containing
+      arrays of object codes organized by chart code.
+- patron.yml
+    - An array of hashes containing patron information drawn from the OLE
+      demo data, with keys for ID, first and last name, and barcode.
+- states.yml
+    - An array of states used for OLE patron information, as they appear
+      in the OLE application itself.
+
+#### Default Data Values in Classes
+
+The following classes in the lib/data_factory/ directory contain default
+selections which may need to be changed for optimal functionality:
+
+- account_factory.rb
+    - Methods for selecting account and object codes default to the :BL
+      chart selector.
+- string_factory.rb
+    - Prices are formatted to two decimal places by default.  Non-US prices
+      may need commas or other separator values.
+    - Phone numbers are in US NNN-NNN-NNNN format.
+- patron_factory.rb
+    - Phone numbers are in US NNN-NNN-NNNN format.
+
+#### Default Data Values in Specs
+
+The following specs in spec/data_factory contain default selections which
+may need to be changed for optimal functionality:
+
+- bib_factory_spec.rb
+    - Tests for selecting a circulation desk use the 'BL_EDUC' circulation
+      desk, taken from the OLE demo data.
+- string_factory_spec.rb
+    - Tests for phone numbers default to the US NNN-NNN-NNNN phone number
+      format.
+- patron_factory_spec.rb
+    - Tests for phone numbers default to the US NNN-NNN-NNNN phone number
+      format.
+
+

data/Rakefile.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -20,6 +20,7 @@ require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
 require 'fileutils'
 require 'lib/ole_qa_framework/COMPATIBILITY.rb'
+require 'yaml'
 
 desc "Print the current version number."
 task :version do
@@ -31,16 +32,41 @@ task :works_with do
   puts OLE_QA::Framework::OLE_VERSION
 end
 
-desc "Select a config file from lib/config/alt."
-task :select_config do
-  puts 'Enter filename:  '
-  target_file = STDIN.gets.chomp
-  target_file += '.yml' unless target_file =~ /\.yml$/
-  file_path = "#{loaddir}/lib/config/"
-  if File.exists?(file_path + 'alt/' + target_file)
-    FileUtils.cp "#{file_path}alt/#{target_file}", "#{file_path}default_options.yml"
-    puts "Successfully copied #{file_path}alt/#{target_file}."
-  else
-    puts "File not found: #{file_path}alt/#{target_file}"
+desc 'Interactively configure config/options.yml'
+task :configurator do
+  config_file = File.open('config/options.yml','r')
+  options     = YAML.load(config_file)
+  config_file.close
+
+  options.each do |k,v|
+    puts "#{k.to_s.ljust(20)}:  #{v}"
+    puts "... (k)eep or (c)hange? [k|c]"
+    ans = STDIN.gets.chomp
+    if ans =~ /[Cc]/
+      puts "Enter new value:"
+      new_val    = STDIN.gets.chomp
+      if v.is_a?(TrueClass) || v.is_a?(FalseClass)
+        new_val.match(/^[Tt]/) ? new_val = true : new_val = false
+      else
+        new_val = new_val.to_i unless new_val.to_i == 0
+      end
+      options[k] = new_val
+      puts "#{k.to_s.ljust(20)} updated to:  #{new_val}"
+    end
   end
+
+  config_file = File.open('config/options.yml','w')
+  YAML.dump(options,config_file)
+  config_file.close
+
 end
+
+desc 'Show current options in config/options.yml'
+task :show_config do
+  config_file = File.open('config/options.yml','r')
+  options     = YAML.load(config_file)
+  config_file.close
+  options.each do |k,v|
+    puts "#{k.to_s.ljust(20)}:  #{v}"
+  end
+end

data/config/options.yml

@@ -0,0 +1,11 @@
+# Default options for an OLE QA Framework session.
+# (Parsed at session instantiation.  See
+#   OLE_QA::Framework::Session#new for
+#   more information.)
+---
+:url: http://tst.ole.kuali.org/
+:docstore_url: http://tst.docstore.ole.kuali.org/
+:headless?: true
+:implicit_wait: 0
+:explicit_wait: 30
+:doc_wait: 45

data/data/circulation.yml

@@ -0,0 +1,10 @@
+#
+# Circulation sample data culled from the Kuali OLE Development Environment at:
+#   http://dev.ole.kuali.org/
+#
+---
+- :code: BL_EDUC
+  :name: BL Education
+  :locations:
+  - B-EDUC/BED-TEACHMAT
+  - B-EDUC/BED-STACKS

data/data/country.yml

@@ -0,0 +1,3 @@
+# Set the default country name to be returned by data factories.
+---
+United States

data/lib/common/common_object.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.

data/lib/common/data_object.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -16,6 +16,5 @@ 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

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.

data/lib/common/page.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -29,8 +29,6 @@ module OLE_QA::Framework
     # An array containing the elements (Symbol) to wait on before the page is considered loaded.
     attr_reader :wait_on
 
-    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.)
     # @param lookup_url [String] The URL (if any) by which a document represented by the page can be opened.
@@ -99,6 +97,31 @@ module OLE_QA::Framework
       false
     end
 
+    # Set a line object definition on a page object.
+    # - A line object 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 line object will have on the object.
+    #   (This will be an instance variable, so it cannot contain spaces.)
+    # @param klas [Class] The class to instantiate for the new line object.
+    #   (An error will be returned if the class given is not defined.)
+    # @param force [Boolean] If set to true, this method can be used to override an existing line object definition.
+    #
+    # @raise StandardError if a parameter is of an incorrect type.
+    # @raise StandardError if an instance method already exists for a line object with the same name.
+    #   (Suppress with force = true.)
+    #
+    def set_line(name, klas, force = false)
+      raise StandardError, "Name must be a symbol.  Given:  #{name}  (#{name.class})" unless name.instance_of?(Symbol)
+      raise StandardError, "Klas must be a class.  Given:  #{klas}  (#{klas.class})"  unless klas.instance_of?(Class)
+      raise StandardError, "Line object is already defined.  (Use the 'force = true' option to suppress this error.)" if @lines.include?(name) && ! force
+      instance_variable_set("@#{name}", klas.new(@ole, 1))
+      make_reader(name) unless force
+      @lines << name unless force
+    end
+    alias_method(:line, :set_line)
+
     # Set screen elements common to most or all pages across the OLE interface.
     def set_elements
       # These elements exist outside of any frame, so @browser is used to force
@@ -121,5 +144,6 @@ module OLE_QA::Framework
       # @return [Boolean] Whether the logout process succeeded.
       function(:logout)               { logout_button.click ; login_confirmation.present? ? false : true}
     end
+
   end
 end

data/lib/common/subline_object.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.

data/lib/data_factory/account_factory.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -15,7 +15,7 @@
 module OLE_QA::Framework
 
   # Generate usable accounting strings from source files in ole-qa-framework/data/
-  class Account_Factory
+  module Account_Factory
 
     account_file = File.open("#{OLE_QA::Framework.data_dir}/accounts.yml",'r')
     @account_matrix = YAML.load(account_file)
@@ -49,4 +49,4 @@ module OLE_QA::Framework
 
     end
   end
-end
+end

data/lib/data_factory/bib_factory.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -13,8 +13,8 @@
 #  limitations under the License.
 
 module OLE_QA::Framework
-  # Manufacture strings for bibliographic record testing
-  class Bib_Factory
+  # Manufacture strings for bibliographic, instance, and item record testing
+  module Bib_Factory
     class << self
 
       include OLE_QA::Framework::Factory_Helpers
@@ -60,6 +60,16 @@ module OLE_QA::Framework
           str << name_builder(last_len.to_i)
         end
       end
+
+      # Return a hash containing circulation desk and location information.
+      # @note Pass a circulation desk code defined in data/circulation.yml to return
+      #   info on a specific circulation desk.
+      def circulation_info(desk_code = '')
+        circ_ary = YAML.load_file(OLE_QA::Framework.data_dir + '/circulation.yml')
+        hsh_out = desk_code.empty? ? circ_ary.sample : circ_ary.find {|circ| circ[:code] == desk_code}
+        raise OLE_QA::Framework::Error,"No circulation desk found.#{  ' Given: ' + desk_code unless desk_code.empty?}" if hsh_out.nil?
+        return hsh_out
+      end
     end
   end
-end
+end

data/lib/data_factory/metadata_factory.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -13,8 +13,9 @@
 #  limitations under the License.
 
 module OLE_QA::Framework
-  # This class contains methods to generate assorted metadata.
-  class Metadata_Factory
+  # This class contains methods to generate assorted metadata for the OLE application.
+  #   {OLE_QA::Framework::Bib_Factory} should be used for creating bibliographic metadata.
+  module Metadata_Factory
     class << self
       include OLE_QA::Framework::Factory_Helpers
       

data/lib/data_factory/patron_factory.rb

@@ -1,4 +1,4 @@
-#  Copyright 2005-2013 The Kuali Foundation
+#  Copyright 2005-2014 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.
@@ -14,12 +14,13 @@
 
 module OLE_QA::Framework
   # Return usable patron records from source files in ole-qa-framework/data/patron.yml
-  class Patron_Factory
+  module Patron_Factory
 
 
-    @patron_matrix    = YAML.load(File.read("#{OLE_QA::Framework.data_dir}/patron.yml"))
-    @states           = YAML.load(File.read("#{OLE_QA::Framework.data_dir}/states.yml"))
-    @borrower_types   = YAML.load(File.read("#{OLE_QA::Framework.data_dir}/borrower_types.yml"))
+    @patron_matrix    = YAML.load_file("#{OLE_QA::Framework.data_dir}/patron.yml")
+    @states           = YAML.load_file("#{OLE_QA::Framework.data_dir}/states.yml")
+    @borrower_types   = YAML.load_file("#{OLE_QA::Framework.data_dir}/borrower_types.yml")
+    @country          = YAML.load_file("#{OLE_QA::Framework.data_dir}/country.yml")
 
     class << self
 
@@ -35,6 +36,9 @@ module OLE_QA::Framework
       # An array containing a collection of valid borrower types to use for patron records.
       attr_reader :borrower_types
 
+      # A string containing the country name as it appears in the OLE application.
+      attr_reader :country
+
       # Return a random patron record.
       def select_patron
         @patron_matrix.sample
@@ -50,6 +54,7 @@ module OLE_QA::Framework
         patron[:city]           = name_builder(sampler(4..12))
         patron[:state]          = @states.sample.upcase
         patron[:postal_code]    = num_str(5)
+        patron[:country]        = @country
         patron[:phone]          = num_str(3) + '-' + num_str(3) + '-' + num_str(4)
         patron[:email]          = patron[:first] + patron[:last] + '@' + str(sampler(4..8)) + '.' + str(3)
         patron