ole-qa-framework 3.4.6 → 3.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjEyMTA4YTJmMGUzYWU3M2FkMDczZGI3MWVjNWUxN2RhZmUxNTEzMg==
+    ODlmZmJiYmUwYjkzMzg1MzAyODk1MzA5OTMzYjYwYzhhODJiNTE5Yg==
   data.tar.gz: !binary |-
-    MWQ0ZWM2MDQ2YTczZmZlZTFmNTA4ZTkzNzQ2YTkwZjdjYmM4M2IxNA==
+    MTBlNTAzMzI4NTIzMTQwNjAxY2FjODgyOTBjNjVhOGMzNTdmNjdlZA==
 SHA512:
   metadata.gz: !binary |-
-    ZDFlZjZjMWE0NmYyOTZmZDYzOGM5YmM3Y2Q2YjI4MWZmZTBjMWIyM2VjZWZl
-    MzE3MmYwM2JjNjQ0NjIxMjg5MzNkMDVlYmE1YWQzMTZkNGRlZmRlZmJhMDE5
-    N2JmMjQ2MWNhYTYxNmMyZWM2YTU1Yzk5ZTk4YjdjNzBhMjM5YzI=
+    YWIwNGQ1NjFkYzQyNDE5OTM2MjU5OTZkYTk3ZmIxNjk2NDY0YTAyMmQwY2Qx
+    ZjE3NjZiNzAyZGUxNzFiMTAxZmI0ZjA1N2ZkMDljYTI4YjMyMmNlMGIwZDZh
+    NmIyZTRlNzYzOGQzOWI4MmQxZDc5NDQ1MjUwOWEzZjUzMDE3Nzc=
   data.tar.gz: !binary |-
-    MmY1N2MzZDJiNjA4Yjg1MWRkNGRjODNlZTEzYjgwMDU4MTg0MTNlYjQzMWRh
-    OTExOGQ2ODE5ZjdlZWRlMTcxNWRmZTIxZGRlYWQwMTYzYTI0MTU5Nzc5MjNj
-    MzcwYzJlZmQyYzMyMDViNTJjYjFiMjEzODQzMTA0NWFlNjQ1YjI=
+    NzM2YTFkMDViYmU3OTQwMjg3N2M1NjhlY2E0MjcxM2VjZjU5YzNjMTVjNjUy
+    YjkzZmJhZWUwNjYwMzFlZDRhMDM3OTcxY2EwYmE3MGRhM2M1NGJmN2I1MjI5
+    MDI0YzVlOWUxN2NmMGJhM2ZkNTk3YWMzZGQ4OWM1MjY2YjMyNGY=

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### v3.5.0 - 2013/12/09
+
+* Docstore
+    * Added .docstore_url (.docstore) method to Session
+    * Added :docstore_url: to all config files
+    * Added Pages:
+        * Search
+        * Search Results
+        * Marc Search Results
+
 ### v3.4.6 - 2013/12/05
 
 * OLEFS Invoice

data/lib/config/alt/dev_env.yml

@@ -1,6 +1,7 @@
 # Default options for using development environment.
 ---
 :url: http://dev.ole.kuali.org/
+:docstore_url: http://dev.docstore.ole.kuali.org/
 :headless?: true
 :implicit_wait: 0
 :explicit_wait: 15

data/lib/config/alt/test_env.yml

@@ -1,6 +1,7 @@
 # Default options for non-development use.
 ---
 :url: http://tst.ole.kuali.org/
+:docstore_url: http://tst.docstore.ole.kuali.org/
 :headless?: true
 :implicit_wait: 0
 :explicit_wait: 15

data/lib/config/default_options.yml

@@ -1,6 +1,7 @@
 # Default options for using development environment.
 ---
 :url: http://dev.ole.kuali.org/
+:docstore_url: http://dev.docstore.ole.kuali.org/
 :headless?: true
 :implicit_wait: 0
 :explicit_wait: 15

data/lib/docstore/common/results.rb

@@ -0,0 +1,54 @@
+#  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::DocStore
+  # The base page object for a given set of DocStore search results.
+  # @note Elements in the search results will be vastly different depending on the
+  #   type of search performed.  If it matters, then be sure to use the subclass
+  #   for the type of search results you are expecting.
+  class Results < OLE_QA::Framework::Page
+    def initialize(ole_session)
+      url = ole_session.docstore_url + 'discovery.do'
+      super(ole_session, url)
+    end
+
+    def set_elements
+      super
+      element(:revise_search_button)                      {b.button(:id => 'Back')}
+      element(:new_search_button)                         {b.button(:name => 'newSearch')}
+      element(:page_field)                                {b.text_field(:id => 'pageSpinner')}
+      element(:go_to_page_button)                         {b.button(:id => 'gotoPage')}
+      element(:page_list)                                 {b.div(:id => 'pageList').b}
+      element(:no_results)                                {b.div(:id => 'demo2').b(:text => /^([Nn]o).*(results)/)}
+    end
+
+    def wait_for_elements
+      super
+      @wait_on << :revise_search_button
+    end
+
+    def set_functions
+      super
+      # Title bar for a given record, ordered by appearance on the screen (1-based).
+      # @note Not reliable as a source of textual information!  If there is any highlighting
+      #   on this element, the text will be broken up by a <span></span> wherever the
+      #   highlighting is applied.
+      function(:title_bar)                                { |which| which -= 1 ; b.h3(:class => 'expand', :index => "#{which}").a(:title => 'Expand/Collapse')}
+      # Check if results are present and return true or false.
+      function(:any_results?)                             { no_results.present? ? false : true}
+      # Check if there is more than one page of results listed and return true or false.
+      function(:multiple_pages?)                          { page_field.present? }
+    end
+  end
+end

data/lib/docstore/pages/marc_results.rb

@@ -0,0 +1,40 @@
+#  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::DocStore
+  # OLE Document Store Search Results for a Marc Bibliographic Record search.
+  class Marc_Results < Results
+
+    def set_elements
+      super
+
+    end
+
+    def set_functions
+      super
+      # Return a 'view' button by a given (1-based) numerical value.
+      function(:view_button)                        { |which = 1| which -= 1 ; b.button(:value => /View/, :index => which)}
+      # Return an 'edit' button by a given (1-based) numerical value.
+      function(:edit_button)                        { |which = 1| which -= 1 ; b.button(:name => 'Edit', :index => which)}
+      # Return an 'instance' link by a given (1-based) numerical value.
+      function(:instance_link)                      { |which = 1| which -= 1 ; b.b(:text => /Instance/, :index => which).parent}
+      # Return a field value (other than title) in the results.
+      # @note This just returns the object for the value.  Interrogate that object with .present? to confirm
+      #   its existence in the search results.
+      function(:value_in_results)                   { |which| b.dd(:text => /#{which}/) }
+      # Return an instance link containing the given text.
+      function(:instance_text)                      { |which| b.b(:text => /#{which}/).parent }
+    end
+  end
+end

data/lib/docstore/pages/search.rb

@@ -0,0 +1,74 @@
+#  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::DocStore
+  # The search page for the OLE Document Store.
+  class Search < OLE_QA::Framework::Page
+    def initialize(ole_session)
+      url = ole_session.docstore_url + 'discovery.do?searchType=newSearch'
+      super(ole_session, url)
+    end
+
+    def set_elements
+      super
+      element(:category_selector)                           {b.select_list(:id => 'documentCategory')}
+      element(:type_selector)                               {b.select_list(:id => 'documentType')}
+      element(:format_selector)                             {b.select_list(:id => 'documentFormat')}
+      element(:sort_selector)                               {b.select_list(:id => 'sorting_order')}
+      element(:search_field_1)                              {b.text_field(:name => 'st')}
+      element(:search_field_2)                              {b.text_field(:name => 'st1')}
+      element(:search_field_3)                              {b.text_field(:name => 'st2')}
+      element(:search_field_4)                              {b.text_field(:name => 'st3')}
+      element(:search_field_5)                              {b.text_field(:name => 'st4')}
+      element(:scope_selector_1)                            {b.select_list(:name => 'searchScope')}
+      element(:scope_selector_2)                            {b.select_list(:name => 'searchScope1')}
+      element(:scope_selector_3)                            {b.select_list(:name => 'searchScope2')}
+      element(:scope_selector_4)                            {b.select_list(:name => 'searchScope3')}
+      element(:scope_selector_5)                            {b.select_list(:name => 'searchScope4')}
+      element(:field_selector_1)                            {b.select_list(:name => 'searchField')}
+      element(:field_selector_2)                            {b.select_list(:name => 'searchField1')}
+      element(:field_selector_3)                            {b.select_list(:name => 'searchField2')}
+      element(:field_selector_4)                            {b.select_list(:name => 'searchField3')}
+      element(:field_selector_5)                            {b.select_list(:name => 'searchField4')}
+      element(:search_button)                               {b.button(:class => 'searchButton')}
+      element(:clear_button)                                {b.button(:name => 'Clear')}
+    end
+
+    def wait_for_elements
+      super
+      @wait_on << :search_field_1
+      @wait_on << :search_field_5
+      @wait_on << :search_button
+    end
+
+    def set_functions
+      super
+      # The 'AND' join operator option for a given search line.
+      # @note Integer should be between 1 and 3, corresponding to the operator line.
+      #   Each operator line affects the next search query line in sequence,
+      #   (i.e., .and_option(1) affects search_field_2)
+      function(:and_option)                                 { |which = 1| which -= 1 ; b.radio(:name => "operator#{which}", :index => 0)}
+
+      # The 'OR' join operator option for a given search line.
+      #   Each operator line affects the next search query line in sequence,
+      #   (i.e., .or_option(1) affects search_field_2)
+      function(:or_option)                                  { |which = 1| which -= 1 ; b.radio(:name => "operator#{which}", :index => 1)}
+
+      # The 'NOT' join operator option for a given search line.
+      #   Each operator line affects the next search query line in sequence,
+      #   (i.e., .not_option(1) affects search_field_2)
+      function(:not_option)                                 { |which = 1| which -= 1 ; b.radio(:name => "operator#{which}", :index => 2)}
+    end
+  end
+end

data/lib/ole-qa-framework.rb

@@ -61,16 +61,18 @@ module OLE_QA
     # 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("/docstore/common/")
     load_libs("/olefs/common/")
     load_libs("/olels/common/")
     load_libs("/olefs/subobjects/")
     load_libs("/olels/subobjects/")
     load_libs("/olefs/objects/")
     load_libs("/olels/objects/")
+    load_libs("/docstore/pages/")
     load_libs("/olefs/pages/")
     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
@@ -91,13 +93,18 @@ module OLE_QA
     class Session
 
       # OLE Installation Base URL
-      #   (e.g. http://ole.your-site.edu)
+      #   (e.g. http://ole.your-site.edu/)
       attr_reader :url
       # @deprecated Included for backwards compatibility.  Unnecessary after 1.0.0 unification (milestone m2-r13245).
       alias :fs_url   :url
       alias :base_url :url
       alias :ls_url   :url
 
+      # OLE Document Store Installation Base URL
+      #   (e.g. http://docstore.ole.your-site.edu/)
+      attr_reader :docstore_url
+      alias :docstore :docstore_url
+
       # Wait period (in seconds) used by OLE QAF Web Element functions
       attr_accessor :explicit_wait
 
@@ -107,6 +114,8 @@ module OLE_QA
       # Options hash keys:
       #   :url => "http://tst.ole.kuali.org/"
       #     (URL for OLE Installation)
+      #   :docstore_url => 'http://tst.docstore.ole.kuali.org/'
+      #     (URL for OLE DocStore Installation)
       #   :headless => true/false
       #     (Use Headless gem to handle XVFB session)
       #   :implicit_wait => NN
@@ -133,10 +142,14 @@ module OLE_QA
           @headless.start
         end
 
+        # Set trailing slash on URLs for consistency if not set.
+        add_slash = ->(which) { which =~ /\/$/ ? which : which + '/' }
+
         # Globalize options to accessors
-        @url = @options[:url]
-        @explicit_wait = @options[:explicit_wait]
-        @doc_wait = @options[:doc_wait]
+        @url            = add_slash.call(@options[:url])
+        @docstore_url   = add_slash.call(@options[:docstore_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])

data/lib/ole_qa_framework/VERSION.rb

@@ -15,6 +15,6 @@
 module OLE_QA
   module Framework
     # The version number for this project.
-    VERSION = '3.4.6'
+    VERSION = '3.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ole-qa-framework
 version: !ruby/object:Gem::Version
-  version: 3.4.6
+  version: 3.5.0
 platform: ruby
 authors:
 - Jain Waldrip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,7 +121,9 @@ files:
 - lib/data_factory/account_factory.rb
 - lib/data_factory/bib_factory.rb
 - lib/data_factory/string_factory.rb
-- lib/docstore/docstore.rb
+- lib/docstore/common/results.rb
+- lib/docstore/pages/marc_results.rb
+- lib/docstore/pages/search.rb
 - lib/module/qa_data_helpers.rb
 - lib/module/qa_helpers.rb
 - lib/module/qa_page_helpers.rb

data/lib/docstore/docstore.rb

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