umlaut 4.0.0.beta3 → 4.0.0.beta4

data/test/umlaut_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class UmlautTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, Umlaut
-  end
-end

data/test/unit/README.md

@@ -1,126 +0,0 @@
-# Testing Service Adaptors
-
-It's not you, testing service adaptors is _confusing_.
-
-Here are some basics to get you started.
-
-## Fixtures
-A key component of Umlaut is the
-[Request](/team-umlaut/umlaut/blob/master/app/models/request.rb).
-Requests tie together
-[Referents](/team-umlaut/umlaut/blob/master/app/models/referent.rb) 
-(basically, the desired citation), 
-[Dispatched Services](/team-umlaut/umlaut/blob/master/app/models/dispatched_service.rb)
-(the services that get kicked off), and
-[Service Responses](/team-umlaut/umlaut/blob/master/app/models/dispatched_service.rb)
-(the responses from those kicked off services).
-
-Since service adaptors handle Requests, in order to test that a service adaptor works
-correctly, we need to set up a request that will trigger the service.
-
-Setting up a Request is a bit of a pain, but here are the steps.
-
-1. Create a referent  
-   Add a [referent](/team-umlaut/umlaut/blob/master/test/fixtures/referents.yml),
-   which can have atitle, title, issn, isbn, year, volume
-   
-        coffeemakers:
-          atitle: "A blend of different tastes: the language of coffeemakers"
-          issn: 0265-8135
-          year: 1998
-          volume: 25
-
-2. Create referent values  
-   The meat of your citation will actually be stored as
-   [referent values](/team-umlaut/umlaut/blob/master/test/fixtures/referent_values.yml),
-   so we need to create those in order to handle pesky details like normalization.
-   Referent values can have referent, key\_name, value, normalized\_value,
-   metadata (flag), private_data(flag)
-   
-        coffeemakers1:
-          referent: coffeemakers
-          key_name: format
-          value: journal
-          normalized_value: journal
-          metadata: false
-          private_data: false
-          
-        coffeemakers2:
-          referent: coffeemakers
-          key_name: genre
-          value: article
-          normalized_value: article
-          metadata: true
-          private_data: false
-
-        coffeemakers3:
-          referent: coffeemakers
-          key_name: atitle
-          value: "A blend of different tastes: the language of coffeemakers"
-          normalized_value: "a blend of different tastes: the language of coffeemakers"
-          metadata: true
-          private_data: false
-
-        coffeemakers4:
-          referent: coffeemakers
-          key_name: issn
-          value: "0265-8135"
-          normalized_value: "0265-8135"
-          metadata: true
-          private_data: false
-
-        coffeemakers5:
-          referent: coffeemakers
-          key_name: volume
-          value: 25
-          normalized_value: 25
-          metadata: true
-          private_data: false
-
-3. Create the request  
-   Add an entry in the
-   [requests fixture YAML](/team-umlaut/umlaut/blob/master/test/fixtures/requests.yml)
-   and point it to the referent you just set up.
-   
-        coffeemakers:
-          referent: coffeemakers
-## Writing Your Tests
-Once you have your request defined, you can test your service.
-
-Assuming you've read the 
-[wiki section on testing](https://github.com/team-umlaut/umlaut/wiki/Developing#automated-testing),
-first you'll need to create a new service.
-The best way to do this is to pass a config Hash into the `new` method
-
-    bx_token = ENV['BX_TOKEN'] || 'BX_TOKEN'
-    config = { 
-      "service_id" => "Bx", 
-      "priority" => "1",
-      "token" => bx_token
-    }
-    @bx_service_adaptor = Bx.new(config)
-
-__Please note__ that `service_id` and `priority` are required by Umlaut.
-
-Then you'll want to get your request fixture and call the `handle` method on
-your service adaptor
-
-    # Get the relevant request fixture
-    coffeemakers_request = requests(:coffeemakers)
-
-    @bx_service_adaptor.handle(coffeemakers_request)
-
-After calling handle, you'll want to see if you got any responses back from your
-service adaptor.  Make sure to go back to the database to get the latest
-
-    # Refresh with the latest from the DB after handling the service.
-    coffeemakers_request.dispatched_services.reset
-    coffeemakers_request.service_responses.reset
-
-    # Get the returned 'similar' service responses
-    similars = coffeemakers_request.get_service_type('similar')
-
-And then test some stuff
-
-    # There should be 5 'similar' service responses
-    assert_equal(5, similars.length, "Ack. Similar responses have gone awry!")

data/test/unit/active_record_connection_pool_test.rb

@@ -1,53 +0,0 @@
-require 'test_helper'
-require 'minitest/unit'
-
-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)
-
-        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

data/test/unit/aws_product_sign_test.rb

@@ -1,95 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper'
-
-require 'aws_product_sign'
-
-# Example used for testing is from
-# http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/rest-signature.html
-# Although that example itself has some bugs as of 12 may 09 doh.
-# it's output isn't actually valid.
-#
-class AwsProductSignTest < ActiveSupport::TestCase
-
-  def setup
-    @example_params = {
-      "Service" => "AWSECommerceService",      
-      "Operation"=>"ItemLookup",
-      "ItemId"=>"0679722769",
-      "ResponseGroup"=>"ItemAttributes,Offers,Images,Reviews",
-      "Version" => "2009-01-06",
-      "Timestamp" => "2009-05-13T10:43:28-04:00" # fixed timestamp so we can test output
-    }
-    @access_key = "00000000000000000000"
-    @secret_key = "1234567890"
-
-    @test_obj = AwsProductSign.new(:secret_key => @secret_key, :access_key => @access_key)
-  end
-
-  
-  def test_url_encoding
-    # Make sure it doesn't encode what it shouldn't.
-    reserved_chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_.~"
-    assert_equal(reserved_chars, 
-      @test_obj.url_encode(reserved_chars),
-      "Reserved chars are not encoded")
-
-    # Space better be %20 not plus.
-    assert_equal("%20", @test_obj.url_encode(" "), "Space is encoded as %20")
-
-    # Try a sample UTF-8 char, e acute.
-    assert_equal("%C3%A9", 
-      @test_obj.url_encode("\xC3\xA9"),
-      "Encodes a UTF-8 char properly")
-    
-    # Make sure it does escape a few other sample chars, although we won't
-    # try every possible char!
-    chars_to_escape = "%:,/+=" # that last one is a utf-8 e acute.
-
-    assert_equal( "%25%3A%2C%2F%2B%3D", 
-     @test_obj.url_encode(chars_to_escape),
-     "Some other chars are encoded properly")
-  end
-
-  def test_canonical_query_order
-      ordered_keys = 
-       @test_obj.canonical_querystring(@example_params).split("&").collect { |kv| kv.split("=")[0] }
-
-      # should be sorted byte-ordered
-      assert_equal(ordered_keys, 
-        ["ItemId", "Operation", "ResponseGroup", "Service", "Timestamp", "Version"])            
-  end
-
-  def test_add_signature
-    new_params = @test_obj.add_signature( @example_params )
-
-    refute_nil( new_params["Timestamp"], "Adds timestamp" )
-    assert_equal( @access_key, new_params["AWSAccessKeyId"], "Adds access key")
-    assert_equal("F3xmBlY91rML36hkQTZn/N2Bk3ABIVB8NI+e/JCYpDQ=" ,     
-        new_params["Signature"],
-        "Adds correct signature")
-
-    assert( @example_params != new_params, "Does not mutate input")    
-  end
-
-  def test_add_signature_mutate
-    params = Hash[@example_params]
-
-    @test_obj.add_signature!(params)
-
-    refute_nil( params["Signature"], "Mutates input")
-    
-  end
-
-  def test_query_string
-    require 'cgi'
-    params = @test_obj.add_signature(@example_params)
-    query_string = @test_obj.query_with_signature(params)
-
-    re_parsed = CGI.parse(query_string)
-    # cgi puts everything in an array, flatten it please. 
-    re_parsed.each {|k,v| re_parsed[k] = v.first} 
-
-    assert_equal( params, re_parsed, "query string generated" )
-    
-  end
-  
-end

data/test/unit/bx_test.rb

@@ -1,39 +0,0 @@
-# Bx Recommender Service Adaptor Test
-# To inject your bX token into the testing environment, use
-#     export BX_TOKEN=yourtoken
-# but this isn't really necessary or useful, since this test
-# will just use VCR anyway
-require 'test_helper'
-class BxTest < ActiveSupport::TestCase
-  extend TestWithCassette
-  fixtures :requests, :referents, :referent_values
-
-  def setup
-    bx_token = ENV['BX_TOKEN'] || 'BX_TOKEN'
-    config = { 
-      "service_id" => "Bx", 
-      "priority" => "1",
-      "token" => bx_token
-    }
-    @bx_service_adaptor = Bx.new(config)
-  end
-
-  # This test has recorded a Bx request via VCR
-  # It has recommendations
-  # Ignore ctx_time in the URL for VCR matching purposes
-  test_with_cassette("article that has recommendations", :bx, :match_requests_on => [:method, :uri_without_ctx_tim]) do
-    # Get the relevant request fixture
-    coffeemakers_request = requests(:coffeemakers)
-    @bx_service_adaptor.handle(coffeemakers_request)
-
-    # Refresh with the latest from the DB after handling the service.
-    coffeemakers_request.dispatched_services.reset
-    coffeemakers_request.service_responses.reset
-
-    # Get the returned 'similar' service responses
-    similars = coffeemakers_request.get_service_type('similar')
-
-    # There should be 5 'similar' service responses
-    assert_equal(5, similars.length, "Ack. Similar responses have gone awry!")
-  end
-end

data/test/unit/collection_test.rb

@@ -1,111 +0,0 @@
-require 'test_helper'
-
-class CollectionTest < ActiveSupport::TestCase
-    self.use_transactional_fixtures = false
-    extend TestWithCassette
-
-
-
-
-    fixtures :requests, :referents, :referent_values, :sfx_urls
-     
-    def setup
-      # will get from ./config/services.yml. You want to test a different
-      # set of services? Have to set em in ServiceStore too, as in general
-      # things passed to new Collection are expected to be in ServiceStore
-      @services = ServiceStore.config["default"]["services"]
-      @request = requests(:simple)
-    end
-    
-    def test_collection_instantiate
-      collection = Collection.new(@request , @services)
-
-      new_services = collection.instantiate_services!
-
-      assert_not_nil new_services
-      assert new_services.length > 0, "no services returned"
-      new_services.each do |s|
-        assert_kind_of Service, s
-      end
-    end
-
-    def test_instantiate_creates_new
-      collection = Collection.new(@request , @services)
-      
-      s1 = collection.instantiate_services!
-      s2 = collection.instantiate_services!
-
-      assert_equal 0, (s1 & s2).length, "instantiate_services! must create new services each time, not re-use objects."
-      
-    end
-
-    def test_service_level
-
-      collection = Collection.new(@request , @services)
-
-      services = collection.instantiate_services!(:level => 'c')
-      
-      assert services.find {|s| s.service_id == "UlrichsCover"}, "UlrichsCover not included in instantiate_services!(:level =>'c')"
-    end
-
-    def test_requests_set
-      collection = Collection.new(@request , @services)
-
-      services = collection.instantiate_services!(:level => 'c')
-
-      services.each do |s|
-        assert_not_nil s.request, "umlaut request not set in service."
-      end
-    end
-
-    def test_get_single_service
-      collection = Collection.new(@request , @services)
-
-      service = collection.instantiate_services!(:ids => ["UlrichsCover"]).first
-
-      assert_not_nil service, "Service for UlrichsCover not returned"
-      assert_not_nil service.request, "Service for UlrichsCover does not have request set."      
-    end
-
-    def test_get_nonexisting_task
-      collection = Collection.new(@request , @services)
-
-      null_services = collection.instantiate_services!(:task => :no_such_task)
-
-      assert_equal [], null_services
-
-      null_services = collection.instantiate_services!(:task => :no_such_task, :level => 1)
-
-      assert_equal [], null_services      
-    end
-
-    # Allowing new episodes because some of our outgoing requests in current
-    # demo config are to non-existing hostnames, which VCR can't properly record. 
-    test_with_cassette("live dispatch", :collection, :record => :new_episodes, :match_requests_on => [:method, :uri_without_ctx_tim]) do        
-      request = fake_umlaut_request('/resolve?sid=google&auinit=S&aulast=Madsbad&atitle=Mechanisms+of+changes+in+glucose+metabolism+and+bodyweight+after+bariatric+surgery&id=doi:10.1016/S2213-8587(13)70218-3&title=The+Lancet+Diabetes+%26+Endocrinology&volume=2&issue=2&date=2014&spage=152&issn=2213-8587')
-
-      collection = Collection.new(request , @services)
-      # We don't care about exceptions for now
-      collection.forward_background_exceptions = false
-
-      bg_thread = collection.dispatch_services!
-
-      # some are still in background
-      bg_thread.join
-
-      # Check to make sure all services were recorded as
-      # dispatched, and with a completion status. We don't care
-      # if they were succesful or not, we're not testing the actual
-      # services, and some may have failed lacking api keys etc. We just
-      # care they are registered as finished. 
-
-      @services.each do |service|
-        dispatch = request.dispatched_services.to_a.find {|ds| ds.service_id = service[0]}
-
-        assert_present dispatch, "Dispatch not recorded for #{service[0]}"
-
-        assert dispatch.completed?, "Dispatch status '#{dispatch.status}' is not a finished status for #{service[0]}"
-      end
-    end   
-
-end

data/test/unit/determine_services_test.rb

@@ -1,163 +0,0 @@
-require 'test_helper'
-
-
-# ServiceStore.determine_services
-# 
-# Loads service definitions into a Collection object, based on services configuration
-# and current &umlaut.service_group param. Tests.
-class DetermineServicesTest <  ActiveSupport::TestCase
-  setup :set_custom_service_store
-
-  def set_custom_service_store
-    dummy = {"type" => "DummyService", "priority" => 3}
-
-    # This would normally be loaded as YAML, we're going to set it
-    # directly.
-    service_declerations = {
-      "default" => {
-        "services" => {
-          "default_a"         => dummy.clone,
-          "default_b"         => dummy.clone,
-          "default_disabled"  => dummy.clone.merge("disabled" => true)
-        }
-      },
-
-      "group1" => {
-        "services" => {
-          "group1_a"        => dummy.clone,
-          "group1_b"        => dummy.clone,
-          "group1_disabled"  => dummy.clone.merge("disabled" => true)
-        }
-      },
-
-      "group2" => {
-        "services" => {
-          "group2_a"        => dummy.clone,
-          "group2_b"        => dummy.clone,
-          "group2_disabled"  => dummy.clone.merge("disabled" => true)
-        }
-      }
-    }
-
-    @service_store = ServiceStore.new
-    @service_store.config = service_declerations
-  end
-
-  def test_basic
-    service_list = @service_store.determine_services
-
-    # default group services
-    assert service_list.keys.include? "default_a"
-    assert service_list.keys.include? "default_b"
-
-    # but not the disabled one
-    refute service_list.keys.include? "default_disabled"
-
-    # No group1 or group2
-    assert_nil service_list.keys.find {|key| key.start_with? "group1"}
-    assert_nil service_list.keys.find {|key| key.start_with? "group2"}
-  end
-
-  def test_add_groups
-    service_list = @service_store.determine_services %w[group2 group1]
-
-    ["default_a", "default_b", "group1_a", "group1_b", "group2_a", "group2_b"].each do |service_id|
-      assert service_list.keys.include? service_id
-    end
-
-    ["default_disabled", "group1_disabled", "group2_disabled"].each do |service_id|
-      refute service_list.keys.include? service_id
-    end
-  end
-
-  def test_add_group_no_default
-    service_list = @service_store.determine_services %w{group1 -default}
-
-    # does not include default ones
-    assert_nil service_list.keys.find {|id| id.start_with? "default_"}
-
-    # does include group1 ones
-    assert service_list.keys.include? "group1_a"
-    assert service_list.keys.include? "group1_b"
-  end
-
-  # Should this raise a clear error instead? For now, we ignore.
-  def test_missing_service_group_ignored
-    # Not raise
-    service_list = @service_store.determine_services %w{non_existing_group}
-  end
-
-  def test_multi_default_groups
-    store = multi_default_group_store
-
-    service_list = store.determine_services
-
-    assert service_list.keys.include? "default_a"
-    assert service_list.keys.include? "other_default_a"
-  end
-
-  def test_multi_default_disable
-    store = multi_default_group_store
-
-    service_list = store.determine_services %w{-other_default}
-
-    assert service_list.keys.include? "default_a"
-    refute service_list.keys.include? "other_default_a"
-  end
-
-
-  # A terrible way and place to test this, but our legacy code is tricky, currently
-  # consider this better than nothing. =
-  #
-  # the Request.co_params_fingerprint must take account of new "umlaut.service_group", to make sure
-  # a cached request same but for different umlaut.service_group is NOT re-used
-  def test_params_fingerprint_includes_service_group
-
-    req_string = "/?issn=12345678&"
-    req     = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string)
-    req_sg1 = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string + "&umlaut.service_group[]=group1")
-    req_sg2 = ActionDispatch::TestRequest.new Rack::MockRequest.env_for(req_string + "&umlaut.service_group[]=groupother")
-
-    fingerprint     = Request.co_params_fingerprint(  Request.context_object_params req  )
-    fingerprint_sg1 = Request.co_params_fingerprint(  Request.context_object_params req_sg1  )
-    fingerprint_sg2 = Request.co_params_fingerprint(  Request.context_object_params req_sg2  )
-
-    assert_not_equal fingerprint, fingerprint_sg1
-    assert_not_equal fingerprint, fingerprint_sg2
-    assert_not_equal fingerprint_sg1, fingerprint_sg2
-  end
-
-
-  def multi_default_group_store
-    dummy = {"type" => "DummyService", "priority" => 3}
-
-    service_declerations = {
-      "default" => {
-        "services" => {
-          "default_a"         => dummy.clone,
-          "default_b"         => dummy.clone,
-          "default_disabled"  => dummy.clone.merge("disabled" => true)
-        }
-      },
-
-      "other_default" => {
-        "default"  => true,
-        "services" => {
-          "other_default_a"        => dummy.clone
-        }
-      },
-
-      "extra_group" => {
-        "services" => {
-          "extra_group_a"        => dummy.clone,
-        }
-      }
-    }
-
-    store = ServiceStore.new
-    store.config = service_declerations
-
-    return store
-  end
-
-end