umlaut 3.3.1 → 4.0.0.beta1

data/test/functional/resolve_controller_test.rb

@@ -4,17 +4,60 @@ require 'test_helper'
 require 'uri'
 require 'rack/utils'
 
+# This test is kind of a mess. Testing the resolve controller is hard, with it's threading and it's
+# standard use of services that make HTTP calls. 
+#
+# We are not testing a 'live' request, but instead mocking already returned service responses,
+# and testing with DummyServices. Could be refactored further to have the DummyServices
+# actually returning responses instead of loading them into the DB ourselves. 
+#
+# Note on testing the resolve controller: Making a request to ResolveController#index will
+# fire off a background thread (which fires off more bg threads) to dispatch background services. 
+#
+# If you don't wait on these, they will be going on in the background of possible subsequent
+# tests, which is messy. And more painfully, they'll wind up making http requests OUTSIDE
+# of the VCR block, since the VCR block ends with the threads still going on their own. 
+#
+# So it's important to wait on them before ending the VCR block or otherwise going on. 
+# Immediately after doing an HTTP interaction, you can get the bg thread by:
+#
+#     bg_thread = @controller.bg_thread
+#
+# (Do this before making another HTTP interaction which will reset @controller). 
+# Then you can wait on it by `bg_thread.join`. 
 class ResolveControllerTest < ActionController::TestCase
   extend TestWithCassette
-  fixtures :requests, :referents, :referent_values, :dispatched_services, :service_responses
 
   setup do
     @controller = ResolveController.new
+
+    # Set it up with a fake Service Collection, so it will go quick and won't
+    # try to contact any external resources. We mock all our service responses
+    # anyhow.  Right now we can only use ID's that already exist in the umlaut_services.yml
+    # though. 
+    @controller.extend(Module.new do 
+      def create_collection
+        services = {
+          "DummyService" => {
+            "type" => "DummyService",
+            "priority" => 'c'
+          }
+        }        
+        return Collection.new(@user_request, services)
+      end
+      protected :create_collection
+    end)
+
   end
 
-  test_with_cassette("nytimes by issn", :resolve, :match_requests_on => [:method, :uri_without_ctx_tim]) do
-    umlaut_request = requests(:nytimes)
+  test("nytimes by issn") do
+    umlaut_request = nytimes_request!
+
     get :index, "umlaut.request_id" => umlaut_request.id
+
+    # Wait on all bg services
+    @controller.bg_thread.join
+    
     assert_response :success
     assert_select "title", "Find It | The New York times"
     assert_select "h1", "Find It"
@@ -25,7 +68,7 @@ class ResolveControllerTest < ActionController::TestCase
       assert_equal 1, scripts.size
       # Make sure we have an HtmlUpdater in our script
       scripts.each do |script|
-        assert_match /var updater = new Umlaut.HtmlUpdater\("http:\/\/test\.host\/", "umlaut\.request_id=#{umlaut_request.id}"\);/, script.to_s
+        assert_match /var updater = new Umlaut.HtmlUpdater\("http:\/\/test\.host\/", "umlaut\.request_id=#{umlaut_request.id}", "en"\);/, script.to_s
       end
     end
     # Citation section assertions
@@ -77,7 +120,7 @@ class ResolveControllerTest < ActionController::TestCase
     assert_select ".umlaut-sidebar .umlaut-section.export_citation" do |sections|
       assert_equal 1, sections.size
       sections.each do |section|
-        assert_select section, ".section_heading h3", { :count => 1, :text => "Export tool" }
+        assert_select section, ".section_heading h3", { :count => 1, :text => ServiceTypeValue.find("export_citation").display_name_pluralize.titlecase }
         assert_select section, ".response_list", 1
       end
     end
@@ -108,7 +151,7 @@ class ResolveControllerTest < ActionController::TestCase
     end
   end
 
-  test_with_cassette("POSTed OpenURL redirects to GET", :resolve, :match_requests_on => [:method, :uri_without_ctx_tim]) do
+  test("POSTed OpenURL redirects to GET") do
     # an actual post request Gale GREENr was sending us
     pparams = {"genre"=>"article", "sid"=>"gale:GRNR", "__char_set"=>"utf8", "spage"=>"138", "issn"=>"0016-7398", "issue"=>"2", "pid"=>"info:sid/gale:ugnid:balt85423", "date"=>"2010", "aulast"=>"Hedley, Peter J.", "au"=>"Hedley, Peter J.", "atitle"=>"Evolution of the Irrawaddy delta region since 1850.(Report)", "title"=>"The Geographical Journal", "aufirst"=>"Hedley, Peter J.", "volume"=>"176"}
     post(:index, pparams)
@@ -125,22 +168,44 @@ class ResolveControllerTest < ActionController::TestCase
     assert  (redirected_params.to_a - pparams.to_a).empty?, "Redirected params include all of original POSTed params"
   end
 
-  test_with_cassette("fulltext with edition warning", :resolve, :match_requests_on => [:method, :uri_without_ctx_tim]) do
-    umlaut_request = requests(:momo)
+  test("fulltext with edition warning") do
+    umlaut_request = fake_umlaut_request("?aufirst=Michael&aulast=Ende&btitle=Momo&genre=book&isbn=038519093X&pub=Doubleday")
+    umlaut_request.service_responses.build(
+      service_id: "InternetArchive",
+      display_text: "the Internet Archive: Open Source Book",
+      url: "http://archive.org/details/MomoOvveroLarcanaStoria...",
+      service_data: {:match_reliability=>"unsure", :edition_str=>"Momo, ovvero l'arcana storia dei ladri di tempo e della bambina che restituì agli uomini il tempo trafugato"},
+      service_type_value_name: "fulltext"
+    )
+    umlaut_request.save!
+
     get(:index, {'umlaut.request_id' => umlaut_request.id})
+
     assert_response :success
     assert_select 'div#fulltext ul.response_list li.response_item' do |elements|
       assert_equal(1, elements.size)
       elements.each do |element|
         assert_select element, "a", {:count => 1, :href => "", :text => "the Internet Archive: Open Source Book"}
         assert_select element, 'div.edition_warning', {:count => 1,
-          :text => "Edition information Momo, ovvero l&#x27;arcana storia dei ladri di tempo e della bambina che restituì agli uomini il tempo trafugato"}
+          :text => "Edition information Momo, ovvero l&#39;arcana storia dei ladri di tempo e della bambina che restituì agli uomini il tempo trafugato"}
       end
     end
+
+    # Wait on all bg services
+    @controller.bg_thread.join
   end
 
-  test_with_cassette("no holdings", :resolve, :match_requests_on => [:method, :uri_without_ctx_tim]) do
-    umlaut_request = requests(:advocate)
+  test("no holdings") do
+    umlaut_request = fake_umlaut_request("/?issn=1832-9373&jtitle=Advocate&rfr_id=info%3Asid%2Fsfxit.com%3Acitation&object_id=2670000000017711")
+    umlaut_request.service_responses.build(
+      service_id: "SFX", 
+      display_text: "Gale Cengage Newsstand", 
+      url: "http://find.galegroup.com/openurl/openurl?res_id=i...", 
+      service_type_value_name: "fulltext",
+      service_data: {:authentication=>"", :source=>"SFX/", :coverage=>"Available from 2009.", :sfx_base_url=>"http://sfx.library.nyu.edu/sfxlcl41", :sfx_obj_index=>1, :sfx_target_index=>1, :sfx_request_id=>"3766609", :sfx_target_service_id=>"1000000000003344", :sfx_target_name=>"GALEGROUP_IT_NEWSSTAND", :citation_volume=>nil, :citation_issue=>nil, :citation_spage=>nil, :debug_info=>" Target: GALEGROUP_IT_NEWSSTAND ; SFX object ID: 2670000000017711"}
+    )
+    umlaut_request.save!
+
     get(:index, {'umlaut.request_id' => umlaut_request.id})
     assert_response :success
     assert_select 'div#fulltext ul.response_list li.response_item' do |elements|
@@ -152,18 +217,94 @@ class ResolveControllerTest < ActionController::TestCase
     end
     # Assert no holdings
     assert_select 'div#holding div.umlaut-holdings', :count => 0
+
+    # Wait on all bg services
+    @controller.bg_thread.join
   end
 
-  test_with_cassette("manually entered", :resolve, :match_requests_on => [:method, :uri_without_ctx_tim]) do
-    umlaut_request = requests(:manually_entered)
+  test("manually entered") do
+    umlaut_request = fake_umlaut_request("?genre=article&jtitle=Entry+Manual&rfr_id=info%3Asid%2Fsfxit.com%3Acitation")
+
     get(:index, {'umlaut.request_id' => umlaut_request.id})
     assert_response :success
-    assert_select('.resource_info_sections > div.alert.alert-error',
+    assert_select('.resource_info_sections > div.alert.alert-danger',
       {:text => "Warning: Find It does not know about a journal with this name. Please check your entry."}) do |error_divs|
       assert_equal 1, error_divs.size, "More than one error div"
       error_divs.each do |error_div|
         assert_select error_div, 'i.umlaut_icons-famfamfam-error', 1
       end
     end
+
+    # Wait on all bg services
+    @controller.bg_thread.join
+  end
+
+  def nytimes_request!
+    umlaut_request = fake_umlaut_request("?title=The+New+York+times&issn=0362-4331")
+
+    umlaut_request.service_responses.build(
+      service_id: "SFX", 
+      display_text: "EBSCOhost Newspaper Source Plus", 
+      url: "http://search.ebscohost.com/login.aspx?direct=true&db=n5h&scope=site&jn=New+York+Times", 
+      service_data: {:coverage=>"Available from 1985.", }, 
+      service_type_value_name: "fulltext"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "DummyService", 
+      display_text: "Library holding", 
+      url: "http://holding.library.edu/DOCID", 
+      notes: "Some notes.", 
+      service_data: {:title=>"The New York times", :status=>"Check Availability", :display_type=>"journal", :request_url=>"http://request.library.edu/DOCID", :call_number=>"(Call Number)", :collection=>"Library Holding", :collection_str=>"Library Holding", :coverage_str_array=>["Coverage 1", "Coverage 2"], :match_reliability=>"unsure"}, 
+      service_type_value_name: "holding"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "SFX", 
+      display_text: "EBSCOhost Business Abstracts with Full Text", 
+      url: "http://search.ebscohost.com/direct.asp?db=bft&jn=3...",
+      service_data: {:authentication=>"", :source=>"SFX/", :coverage=>"Available from 2011.", :sfx_base_url=>"http://sfx.library.edu/local", :sfx_obj_index=>1, :sfx_target_index=>1, :sfx_request_id=>"2576884", :sfx_target_service_id=>"3450000000000057", :sfx_target_name=>"EBSCOHOST_BUSINESS_ABSTRACTS_FULL_TEXT_WILSON", :citation_volume=>nil, :citation_issue=>nil, :citation_spage=>nil, :debug_info=>" Target: EBSCOHOST_BUSINESS_ABSTRACTS_FULL_TEXT_WILSON ; SFX object ID: 110975413976006"}, 
+      service_type_value_name: "fulltext"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "EmailExport", 
+      display_text: "Email", 
+      service_data: {:link_supports_ajax_call=>true},
+      service_type_value_name: "export_citation"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "SFX", 
+      display_text: "Ask a Librarian", 
+      url: "http://library.edu/ask", 
+      service_data: {:display_text=>"Ask a Librarian", :url=>"http://library.edu/ask"}, 
+      service_type_value_name: "help"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "SFX",
+      display_text: "EBSCOhost Business Abstracts with Full Text",
+      url: "https://ezproxy.library.edu/login?url=http://searc...",
+      service_data: {:authentication=>"", :source=>"SFX/", :coverage=>"Available from 2011.", :sfx_base_url=>"http://sfx.library.edu/local", :sfx_obj_index=>1, :sfx_target_index=>1, :sfx_request_id=>"2567643", :sfx_target_service_id=>"3450000000000057", :sfx_target_name=>"EBSCOHOST_BUSINESS_ABSTRACTS_FULL_TEXT_WILSON", :citation_volume=>nil, :citation_issue=>nil, :citation_spage=>nil, :debug_info=>" Target: EBSCOHOST_BUSINESS_ABSTRACTS_FULL_TEXT_WILSON ; SFX object ID: 110975413976006"}, 
+      service_type_value_name: "fulltext"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "Ulrichs", 
+      display_text: "Periodical information", 
+      url: "https://ulrichsweb.serialssolutions.com/api/openur...", 
+      service_type_value_name: "highlighted_link"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "Ulrichs",
+      display_text: "Periodical information",
+      url: "https://ulrichsweb.serialssolutions.com/api/openur...", 
+      service_type_value_name: "highlighted_link"
+    )
+    umlaut_request.service_responses.build(
+      service_id: "SFX", 
+      display_text: "Proquest",
+      url: "http://proquest.umi.com/pqdweb?RQT=318&VName=PQD&c...",
+      service_data: {:display_text=>"Proquest", :url=>"http://proquest.umi.com/pqdweb?RQT=318&VName=PQD&clientid=9269&pmid=7818"},
+      service_type_value_name: "fulltext"
+    )
+    umlaut_request.save!
+
+    return umlaut_request
   end
 end

data/test/functional/search_controller_test.rb

@@ -18,7 +18,7 @@ class SearchControllerTest < ActionController::TestCase
     return unless Sfx4::Local::AzTitle.connection_configured?
     get :journal_search, "rft.jtitle"=>"Account", "umlaut.title_search_type"=>"begins"
     assert_response :success
-    assert_select "title", "Find It | Journal titles that begin with &#x27;Account&#x27;"
+    assert_select "title", "Find It | Journal titles that begin with &#39;Account&#39;"
     assert_select ".umlaut-search-form", 1
     assert_select ".umlaut-results", 1
     assert_select ".umlaut-results .umlaut-result", :minimum => 1

data/test/helper/list_with_limit_test.rb

@@ -4,6 +4,17 @@ require 'nokogiri'
 class ListWithLimitTest < ActionView::TestCase
   include ResolveHelper
   
+  # Have to override url_for to supply a default controller, so
+  # routing won't complain for our tests -- we don't actually
+  # want/need to test routing here, we just need to stop routing
+  # from complaining. This is very hacky yes. 
+  def url_for(*args)
+    if args.first.kind_of? Hash
+      args.first[:controller] ||= "resolve"
+    end
+    super
+  end
+
   def setup
     @user_request = Request.new(:id => 999999)
   end

data/test/test_helper.rb

@@ -1,10 +1,16 @@
+ENV["RAILS_ENV"] ||= "test"
+
+require File.expand_path('../dummy/config/environment', __FILE__)
+#require 'engine_cart'
+#EngineCart.load_application!
+
+require 'rails/test_help'
+require 'minitest/unit'
+
 require 'coveralls'
 Coveralls.wear!
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
+
 ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__) 
 
 Rails.backtrace_cleaner.remove_silencers!
@@ -14,8 +20,23 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 # Complete stack trace with deprecation warnings from rails
 ActiveSupport::Deprecation.debug = true
+#ActiveSupport::Deprecation.silenced = true
+
+# Fix stack traces to include Umlaut source lines
+#Rails.backtrace_cleaner.remove_silencers!
+#app_dirs_pattern = /^\/?(app|config|lib|test)/
+#Rails.backtrace_cleaner.add_silencer do |line|
+#  require 'debugger'
+#  debugger if line =~ /umlaut/
+#  line =~ app_dirs_pattern 
+#end
+
+require 'collection'
+Collection.forward_background_exceptions = true
 
 class ActiveSupport::TestCase
+  ActiveRecord::Migration.check_pending!
+
   # Load SFX 4 fixtures only if we are explicitly creating a mock_instance
   # which should really only be the case for travis-ci.org
   def self.sfx4_fixtures(*fixture_names)
@@ -23,38 +44,41 @@ class ActiveSupport::TestCase
     # which should really only be the case for travis-ci.org
     if (sfx4_mock_instance?)
       warn "Loading SFX4 fixtures."
-      sfx4s = ["Global", "Local"]
-      sfx4s.each do |sfx4|
-        # Get the db module associate with this sfx4 instance
-        sfx4_module = Sfx4.const_get(sfx4.to_sym)
-        # Get the connection from the :Base class for each sfx4
-        # Set the path
-        path = "#{File.dirname(__FILE__)}/fixtures/#{sfx4_module.to_s.underscore}"
-        # Get class names hash of table_name => class_name
-        class_names = {}
-        connection = nil
-        fixture_names.collect{|t|t.to_s}.each do |table| 
-          next unless sfx4_module.const_defined?(table.classify)
-          #Find class from table name
-          klass = sfx4_module.const_get table.classify
-          connection ||= klass.connection
-          class_names[klass.table_name.downcase.to_sym] = klass.name
-        end
+      sfx4s = ["Local"]
+
+      # Get the db module associate with this sfx4 instance
+      # Get the connection from the :Base class for each sfx4
+      # Set the path
+      path = "#{File.dirname(__FILE__)}/fixtures/sfx4/local"
+
+      # Get class names hash of table_name => class_name
+      class_names = {}
+      connection = nil
+
+      fixture_names.collect{|t|t.to_s}.each do |table| 
+
+        require "sfx4/local/#{table}" rescue nil
+
+        next unless Sfx4::Local.const_defined?(table.classify)
+        #Find class from table name
+        klass = Sfx4::Local.const_get table.classify
+        connection ||= klass.connection
+
+        class_names[klass.table_name.downcase.to_sym] = klass
+
         # Table names are just the keys of the class names
         table_names = class_names.keys.collect{|t| t.to_s.upcase}
         # Create and Instantiate Fixtures
-        ActiveRecord::Fixtures.create_fixtures(path, table_names, class_names){connection}.first.fixtures
+        ActiveRecord::FixtureSet.create_fixtures(path, table_names, class_names){connection}.first.fixtures
       end
     else
-      warn  "Skipping SFX4 fixtures since the SFX DB specified is not a mock instance."
+      warn  "\n!!!Skipping SFX4 fixtures since the SFX DB specified is not a mock instance.!!!\n"
     end
   end
   
   def self.sfx4_mock_instance?
     (Sfx4::Local::Base.connection_configured? and
-      Sfx4::Local::Base.connection_config[:mock_instance] and 
-        Sfx4::Global::Base.connection_configured? and
-          Sfx4::Global::Base.connection_config[:mock_instance])
+      Sfx4::Local::Base.connection_config[:mock_instance])
   end
 end
 
@@ -96,6 +120,19 @@ def assert_length(size, list)
   assert_equal size, list.length, "Expected size of #{size} for #{list}"
 end
 
+# We want to put assert_present and assert_blank back, they were
+# useful, why did minitest deprecate it?
+module ActiveSupport::Testing::Assertions
+  def assert_present(object, message=nil)
+    message ||= "#{object.inspect} is blank"
+    assert object.present?, message
+  end
+
+  def assert_blank(object, message=nil)
+    message ||= "#{object.inspect} is not blank"
+    assert object.blank?, message
+  end
+end
 
 # Methods you can use to make a mocked up Rails Request and corersponding Umlaut Request
 # Pass in a URL, absolute or partial, eg "/resolve?isbn=X"

data/test/unit/active_record_connection_pool_test.rb

@@ -1,35 +1,53 @@
-# Test that the bug in AR ConnectionPool is fixed, either becuase of a local
-# patch (temporarily in config/initializers/patch/connection_pool.rb)
-# or because of a future version of Rails. 
-# See https://github.com/rails/rails/issues/5330
-
 require 'test_helper'
+require 'minitest/unit'
 
-class ActiveRecordConnectionPoolTest < Test::Unit::TestCase
+class ActiveRecordConnectionPoolTest < ActiveSupport::TestCase
 
+  # Test that the bug in AR ConnectionPool is fixed, either becuase of a local
+  # patch (temporarily in config/initializers/patch/connection_pool.rb)
+  # or because of a future version of Rails. 
+  # See https://github.com/rails/rails/issues/5330
+  #
+  # This is fixed in current rails, but it's painful enough to debug that we're going
+  # to leave our own regression test in here 
   def test_threaded_with_connection
-        # Neccesary to have a checked out connection in thread
-        # other than one we will test, in order to trigger bug
-        # we are testing fix for.
-        main_thread_conn = ActiveRecord::Base.connection_pool.checkout
-
-        aThread = Thread.new do
-          ActiveRecord::Base.connection_pool.with_connection do
-            ActiveRecord::Base.connection # need to do something AR to trigger the checkout
-
-            reserved_thread_ids = ActiveRecord::Base.connection_pool.instance_variable_get(:@reserved_connections)
+    # Neccesary to have a checked out connection in thread
+    # other than one we will test, in order to trigger bug
+    # we are testing fix for.
+    main_thread_conn = ActiveRecord::Base.connection_pool.checkout
 
-            assert reserved_thread_ids.has_key?( Thread.current.object_id ), "thread should be in reserved connections"
-          end
-          reserved_thread_ids = ActiveRecord::Base.connection_pool.instance_variable_get(:@reserved_connections)
-          assert !reserved_thread_ids.has_key?( Thread.current.object_id ), "thread should not be in reserved connections"
-        end
-        aThread.join
-
-        ActiveRecord::Base.connection_pool.checkin main_thread_conn
+    aThread = Thread.new do
+      ActiveRecord::Base.connection_pool.with_connection do
+        ActiveRecord::Base.connection # need to do something AR to trigger the checkout
 
         reserved_thread_ids = ActiveRecord::Base.connection_pool.instance_variable_get(:@reserved_connections)
-        assert !reserved_thread_ids.has_key?( aThread.object_id ), "thread should not be in reserved connections"
+
+        assert reserved_thread_ids.keys.include?( Thread.current.object_id ), "thread should be in reserved connections"
+      end
+      reserved_thread_ids = ActiveRecord::Base.connection_pool.instance_variable_get(:@reserved_connections)
+      assert !reserved_thread_ids.keys.include?( Thread.current.object_id ), "thread should not be in reserved connections"
+    end
+    aThread.join
+
+    ActiveRecord::Base.connection_pool.checkin main_thread_conn
+
+    reserved_thread_ids = ActiveRecord::Base.connection_pool.instance_variable_get(:@reserved_connections)
+    assert !reserved_thread_ids.keys.include?( aThread.object_id ), "thread should not be in reserved connections"
+  end
+
+  # Our own monkey-patched behavior
+  def test_forbid_implicit_checkout
+    assert_raises(ActiveRecord::ImplicitConnectionForbiddenError) do      
+      t = Thread.new do
+        # Avoid warning to console for implicit checkout, we're doing it on
+        # purpose for testing. 
+        Thread.current[:ar_implicit_checkout_warning_silenced] = true
+        
+        ActiveRecord::Base.forbid_implicit_checkout_for_thread!
+        ActiveRecord::Base.connection
       end
+      t.join
+    end
+  end
   
 end