hyrax 2.9.6 → 3.0.0.pre.beta1

data/spec/spec_helper.rb

@@ -0,0 +1,294 @@
+ENV["RAILS_ENV"] ||= 'test'
+require "bundler/setup"
+
+def coverage_needed?
+  ENV['COVERAGE'] || ENV['TRAVIS']
+end
+
+def ci_build?
+  ENV['TRAVIS'] || ENV['CIRCLE']
+end
+
+if coverage_needed?
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.root(File.expand_path('../..', __FILE__))
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start('rails') do
+    add_filter '/.internal_test_app'
+    add_filter '/lib/generators'
+    add_filter '/spec'
+    add_filter '/tasks'
+    add_filter '/lib/hyrax/version.rb'
+    add_filter '/lib/hyrax/engine.rb'
+  end
+  SimpleCov.command_name 'spec'
+end
+
+require 'factory_bot'
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'devise'
+require 'devise/version'
+require 'mida'
+require 'rails-controller-testing'
+require 'rspec/rails'
+require 'rspec/its'
+require 'rspec/matchers'
+require 'rspec/active_model/mocks'
+require 'capybara/rspec'
+require 'capybara/rails'
+require 'selenium-webdriver'
+require 'equivalent-xml'
+require 'equivalent-xml/rspec_matchers'
+require 'database_cleaner'
+
+unless ENV['SKIP_MALEFICENT']
+  # See https://github.com/jeremyf/capybara-maleficent
+  # Wrap Capybara matchers with sleep intervals to reduce fragility of specs.
+  require 'capybara/maleficent/spindle'
+
+  Capybara::Maleficent.configure do |c|
+    # Quieting down maleficent's logging
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    c.logger = logger
+  end
+end
+
+# Require supporting ruby files from spec/support/ and subdirectories.  Note: engine, not Rails.root context.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+require 'i18n/debug' if ENV['I18N_DEBUG']
+require 'byebug' unless ci_build?
+
+# @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux
+#       container build environments to mitigate Meltdown/Spectre
+#       vulnerabilities, at which point Hyrax could no longer use the
+#       Capybara-provided :selenium_chrome_headless driver (which does not
+#       include the `--no-sandbox` argument).
+Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
+  browser_options.args << '--headless'
+  browser_options.args << '--disable-gpu'
+  browser_options.args << '--no-sandbox'
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
+
+Capybara.default_driver = :rack_test # This is a faster driver
+Capybara.javascript_driver = :selenium_chrome_headless_sandboxless # This is slower
+
+ActiveJob::Base.queue_adapter = :test
+
+# require 'http_logger'
+# HttpLogger.logger = Logger.new(STDOUT)
+# HttpLogger.ignore = [/localhost:8983\/solr/]
+# HttpLogger.colorize = false
+
+if defined?(ClamAV)
+  ClamAV.instance.loaddb
+else
+  class ClamAV
+    include Singleton
+    def scanfile(_f)
+      0
+    end
+
+    def loaddb
+      nil
+    end
+  end
+end
+
+class JsonStrategy
+  def initialize
+    @strategy = FactoryBot.strategy_by_name(:create).new
+  end
+
+  delegate :association, to: :@strategy
+
+  def result(evaluation)
+    @strategy.result(evaluation).to_json
+  end
+end
+
+FactoryBot.register_strategy(:json, JsonStrategy)
+FactoryBot.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryBot.find_definitions
+
+module EngineRoutes
+  def self.included(base)
+    base.routes { Hyrax::Engine.routes }
+  end
+
+  def main_app
+    Rails.application.class.routes.url_helpers
+  end
+end
+
+require 'shoulda/matchers'
+require 'shoulda/callback/matchers'
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
+
+require 'active_fedora/cleaner'
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.include Shoulda::Matchers::ActiveRecord, type: :model
+  config.include Shoulda::Matchers::ActiveModel, type: :form
+  config.include Shoulda::Callback::Matchers::ActiveModel
+  config.full_backtrace = true if ci_build?
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = File.expand_path("../fixtures", __FILE__)
+
+  config.use_transactional_fixtures = false
+
+  config.before :suite do
+    DatabaseCleaner.clean_with(:truncation)
+    # Noid minting causes extra LDP requests which slow the test suite.
+    Hyrax.config.enable_noids = false
+  end
+
+  config.before do |example|
+    if example.metadata[:type] == :feature && Capybara.current_driver != :rack_test
+      DatabaseCleaner.strategy = :truncation
+    else
+      DatabaseCleaner.strategy = :transaction
+      DatabaseCleaner.start
+    end
+
+    if example.metadata[:type] == :view
+      # View tests should not hit any services. This ensures the tests are unit
+      # testing only the views and run fast.
+      WebMock.disable_net_connect!(allow_localhost: false)
+    else
+      WebMock.disable_net_connect!(allow_localhost: true)
+    end
+    # using :workflow is preferable to :clean_repo, use the former if possible
+    # It's important that this comes after DatabaseCleaner.start
+    ensure_deposit_available_for(user) if example.metadata[:workflow]
+    if example.metadata[:clean_repo]
+      ActiveFedora::Cleaner.clean!
+      # The JS is executed in a different thread, so that other thread
+      # may think the root path has already been created:
+      ActiveFedora.fedora.connection.send(:init_base_path) if example.metadata[:js]
+    end
+    Hyrax.config.nested_relationship_reindexer = if example.metadata[:with_nested_reindexing]
+                                                   # Use the default relationship reindexer (and the cascading reindexing of child documents)
+                                                   Hyrax.config.default_nested_relationship_reindexer
+                                                 else
+                                                   # Don't use the nested relationship reindexer. This slows everything down quite a bit.
+                                                   ->(id:, extent:) {}
+                                                 end
+  end
+
+  config.include(ControllerLevelHelpers, type: :view)
+  config.before(:each, type: :view) { initialize_controller_helpers(view) }
+
+  config.before(:all, type: :feature) do
+    # Assets take a long time to compile. This causes two problems:
+    # 1) the profile will show the first feature test taking much longer than it
+    #    normally would.
+    # 2) The first feature test will trigger rack-timeout
+    #
+    # Precompile the assets to prevent these issues.
+    visit "/assets/application.css"
+    visit "/assets/application.js"
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.include Shoulda::Matchers::Independent
+
+  if Devise::VERSION >= '4.2'
+    config.include Devise::Test::ControllerHelpers, type: :controller
+  else
+    config.include Devise::TestHelpers, type: :controller
+  end
+
+  config.include EngineRoutes, type: :controller
+  config.include Warden::Test::Helpers, type: :request
+  config.include Warden::Test::Helpers, type: :feature
+  config.after(:each, type: :feature) do
+    Warden.test_reset!
+    Capybara.reset_sessions!
+    page.driver.reset!
+  end
+
+  config.include Capybara::RSpecMatchers, type: :input
+  config.include InputSupport, type: :input
+  config.include FactoryBot::Syntax::Methods
+  config.include OptionalExample
+
+  config.infer_spec_type_from_file_location!
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.formatter = 'LoggingFormatter'
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  config.profile_examples = 10
+
+  # Use this example metadata when you want to perform jobs inline during testing.
+  #
+  #   describe '#my_method`, :perform_enqueued do
+  #     ...
+  #   end
+  #
+  # If you pass an `Array` of job classes, they will be treated as the filter list.
+  #
+  #   describe '#my_method`, perform_enqueued: [MyJobClass] do
+  #     ...
+  #   end
+  #
+  # Limit to specific job classes with:
+  #
+  #   ActiveJob::Base.queue_adapter.filter = [JobClass]
+  #
+  config.before(:example, :perform_enqueued) do |example|
+    ActiveJob::Base.queue_adapter.filter =
+      example.metadata[:perform_enqueued].try(:to_a)
+
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = true
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+  end
+
+  config.after(:example, :perform_enqueued) do
+    ActiveJob::Base.queue_adapter.filter         = nil
+    ActiveJob::Base.queue_adapter.enqueued_jobs  = []
+    ActiveJob::Base.queue_adapter.performed_jobs = []
+
+    ActiveJob::Base.queue_adapter.perform_enqueued_jobs    = false
+    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = false
+  end
+end

data/spec/strategies/hyrax/strategies/yaml_strategy_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Hyrax::Strategies::YamlStrategy do
+  subject { described_class.new(config: "test_file") }
+
+  context "when given a YAML file" do
+    let(:content) do
+      {
+        "assign_admin_set" => {
+          "enabled" => false
+        }
+      }
+    end
+
+    before do
+      allow(YAML).to receive(:load_file).with("test_file").and_return(content)
+      allow(File).to receive(:exist?).with("test_file").and_return(true)
+    end
+    it "tests for features based on an enabled key" do
+      expect(subject.enabled?(:assign_admin_set)).to eq false
+    end
+    it "returns nil for unknown features" do
+      expect(subject.enabled?(:unknown_Feature)).to be_nil
+    end
+  end
+
+  context "when given a non-existent file" do
+    it "returns nil for everything" do
+      expect(subject.enabled?(:assign_admin_set)).to be_nil
+    end
+  end
+end

data/spec/support/controller_level_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ControllerLevelHelpers
+  # This provides some common mock methods for view tests.
+  # These are normally provided by the controller.
+  module ControllerViewHelpers
+    def search_state
+      @search_state ||= CatalogController.search_state_class.new(params, blacklight_config, controller)
+    end
+
+    # This allows you to set the configuration
+    # @example: view.blacklight_config = Blacklight::Configuration.new
+    attr_writer :blacklight_config
+
+    def blacklight_config
+      @blacklight_config ||= CatalogController.blacklight_config
+    end
+
+    def blacklight_configuration_context
+      @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(controller)
+    end
+  end
+
+  def initialize_controller_helpers(helper)
+    helper.extend ControllerViewHelpers
+  end
+end

data/spec/support/factory_helpers.rb

@@ -0,0 +1,24 @@
+module Hyrax
+  module FactoryHelpers
+    module_function
+
+    def mock_file_factory(opts = {})
+      mock_model('MockOriginal',
+                 mime_type:         opts.fetch(:mime_type, 'text/plain'),
+                 content:           opts.fetch(:content, 'content'),
+                 file_size:         opts.fetch(:file_size, []),
+                 format_label:      opts.fetch(:format_label, []),
+                 height:            opts.fetch(:height, []),
+                 width:             opts.fetch(:width, []),
+                 filename:          opts.fetch(:filename, []),
+                 well_formed:       opts.fetch(:well_formed, []),
+                 page_count:        opts.fetch(:page_count, []),
+                 file_title:        opts.fetch(:file_title, []),
+                 last_modified:     opts.fetch(:last_modified, []),
+                 original_checksum: opts.fetch(:original_checksum, []),
+                 digest:            opts.fetch(:digest, []),
+                 duration:          opts.fetch(:duration, []),
+                 sample_rate:       opts.fetch(:sample_rate, []))
+    end
+  end
+end

data/spec/support/fakes/fake_authority.rb

@@ -0,0 +1,13 @@
+class FakeAuthority
+  def initialize(map)
+    @map = map
+  end
+
+  def all
+    @map
+  end
+
+  def find(id)
+    @map.detect { |item| item[:id] == id }
+  end
+end

data/spec/support/features/batch_edit_actions.rb

@@ -0,0 +1,28 @@
+def batch_edit_fields
+  # skipping based_near because it's a select2 field, which is hard to test via capybara
+  [
+    "creator", "contributor", "description", "keyword", "publisher", "date_created",
+    "subject", "language", "identifier", "related_url"
+  ]
+end
+
+def fill_in_batch_edit_fields_and_verify!
+  batch_edit_fields.each do |field_id|
+    within "#form_#{field_id}" do
+      batch_edit_expand(field_id)
+      page.find("#generic_work_#{field_id}") # Ensuring that the element is on the page before we fill it
+      fill_in "generic_work_#{field_id}", with: "NEW #{field_id}"
+
+      find("##{field_id}_save").click
+      # This was `expect(page).to have_content 'Changes Saved'`, however in debugging,
+      # the `have_content` check was ignoring the `within` scoping and finding
+      # "Changes Saved" for other field areas
+      find('.status', text: 'Changes Saved', wait: 5)
+    end
+  end
+end
+
+def batch_edit_expand(field)
+  find("#expand_link_#{field}").click
+  yield if block_given?
+end

data/spec/support/features/session_helpers.rb

@@ -0,0 +1,14 @@
+# spec/support/features/session_helpers.rb
+module Features
+  module SessionHelpers
+    def sign_in(who = :user)
+      logout
+      user = who.is_a?(User) ? who : build(:user).tap(&:save!)
+      visit new_user_session_path
+      fill_in 'Email', with: user.email
+      fill_in 'Password', with: user.password
+      click_button 'Log in'
+      expect(page).not_to have_text 'Invalid email or password.'
+    end
+  end
+end

data/spec/support/features/workflow.rb

@@ -0,0 +1,9 @@
+def ensure_deposit_available_for(user)
+  template = create(:permission_template, with_admin_set: true, with_workflows: true)
+  # Grant the user access to deposit into an admin set.
+  create(:permission_template_access,
+         :deposit,
+         permission_template: template,
+         agent_type: 'user',
+         agent_id: user.user_key)
+end

data/spec/support/features.rb

@@ -0,0 +1,10 @@
+# spec/support/features.rb
+require File.expand_path('../features/session_helpers', __FILE__)
+require File.expand_path('../features/workflow', __FILE__)
+require File.expand_path('../features/batch_edit_actions', __FILE__)
+require File.expand_path('../selectors', __FILE__)
+require File.expand_path('../statistic_helper', __FILE__)
+
+RSpec.configure do |config|
+  config.include Features::SessionHelpers, type: :feature
+end

data/spec/support/input_support.rb

@@ -0,0 +1,11 @@
+module InputSupport
+  extend ActiveSupport::Concern
+
+  include RSpec::Rails::HelperExampleGroup
+
+  def input_for(object, attribute_name, options = {})
+    helper.simple_form_for object, url: '' do |f|
+      f.input attribute_name, options
+    end
+  end
+end

data/spec/support/logging_formatter.rb

@@ -0,0 +1,66 @@
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+class LoggingFormatter < RSpec::Core::Formatters::ProgressFormatter
+  RSpec::Core::Formatters.register self, :example_started, :example_passed, :dump_profile
+  def initialize(output)
+    @profile = []
+    reset!
+    ActiveSupport::Notifications.subscribe("http.ldp", method(:record_request))
+    super
+  end
+
+  def record_request(*_unused, data)
+    @request_count += 1
+    @request_count_by_name[data[:name]] += 1
+  end
+
+  def example_passed(passed)
+    super
+    @profile << { description: passed.example.full_description,
+                  count: @request_count,
+                  location: passed.example.location,
+                  count_by_name: @request_count_by_name }
+  end
+
+  def example_started(_passed)
+    reset!
+  end
+
+  def reset!
+    @request_count = 0
+    @request_count_by_name = { 'HEAD' => 0,
+                               'GET' => 0,
+                               'POST' => 0,
+                               'DELETE' => 0,
+                               'PUT' => 0,
+                               'PATCH' => 0 }
+  end
+
+  def dump_profile(profile)
+    dump_most_ldp_exampes(profile)
+    output.puts ""
+    dump_slowest_examples(profile)
+  end
+
+  private
+
+    def dump_most_ldp_exampes(_prof)
+      output.puts "Examples with the most LDP requests"
+      top = @profile.sort_by { |hash| hash[:count] }.last(10)
+      top.each do |hash|
+        result = hash[:count_by_name].select { |_, v| v.positive? }
+        next if result.empty?
+        output.puts "  #{hash[:description]}"
+        output.puts "    #{hash[:location]}"
+        output.puts "    Total LDP: #{hash[:count]} #{result}"
+      end
+    end
+
+    def dump_slowest_examples(profile)
+      output.puts "Slowest examples"
+      profile.slowest_examples.each do |slowest_example|
+        output.puts "  #{slowest_example.full_description}"
+        output.puts "    #{slowest_example.location}"
+        output.puts "    #{slowest_example.execution_result.run_time} seconds"
+      end
+    end
+end

data/spec/support/matchers/api_responses.rb

@@ -0,0 +1,26 @@
+# RSpec matchers for API default JSON responses.
+# Creates a matcher like respond_forbidden or respond_not_found corresponding to each of the Api::V1.default_responses
+# Accepts optional overrides to the expected response body.
+# @example Override the description expected in the JSON body of a :forbidden response
+#   expect(response).to respond_forbidden(description:"You can't create for that identity")
+::Hyrax::API.default_responses.each_pair do |response_type, default_response_body|
+  RSpec::Matchers.define "respond_#{response_type}".to_sym do |expectation_options|
+    match do |response|
+      @expected_response_body = expectation_options.nil? ? default_response_body : default_response_body.merge(expectation_options)
+      expect(response.body).not_to be_empty
+      json = JSON.parse(response.body)
+      expect(response.code).to eq(@expected_response_body[:code].to_s)
+      @expected_response_body.each_pair do |key, value|
+        expect(json[key.to_s]).to eq(value.as_json)
+      end
+    end
+
+    failure_message do |actual|
+      "expected #{default_response_body[:code]} status code. Got #{actual.code} status code.\n" \
+      "expected an Authentication Required response like this:\n" \
+      " #{@expected_response_body.to_json} \ngot\n #{actual.body}\n" \
+      "To override expectations about the response body, provide a Hash of overrides in " \
+      "your call to :respond_#{response_type} "
+    end
+  end
+end

data/spec/support/matchers/collection_type_property_matchers.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :require_membership do
+  match do |actual|
+    actual&.require_membership?
+  end
+end
+
+RSpec::Matchers.define :allow_multiple_membership do
+  match do |actual|
+    actual&.allow_multiple_membership?
+  end
+end
+
+RSpec::Matchers.define :assign_visibility do
+  match do |actual|
+    actual&.assigns_visibility?
+  end
+end
+
+RSpec::Matchers.define :assign_workflow do
+  match do |actual|
+    actual&.assigns_workflow?
+  end
+end
+
+RSpec::Matchers.define :have_collections do
+  match do |actual|
+    actual&.collections?
+  end
+end

data/spec/support/matchers/response_matchers.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :fail_redirect_and_flash do |path, flash_message|
+  match do |response|
+    expect(response.status).to eq 302
+    expect(response).to redirect_to(path)
+    expect(flash[:alert]).to eq flash_message
+  end
+end

data/spec/support/optional_example.rb

@@ -0,0 +1,16 @@
+module OptionalExample
+  RSpec.configure do |config|
+    config.after do |example|
+      if example.metadata[:optional] && (RSpec::Core::Pending::PendingExampleFixedError === example.display_exception) # rubocop:disable Style/CaseEquality
+        ex = example.display_exception
+        example.display_exception = nil
+        example.execution_result.pending_exception = ex
+      end
+    end
+  end
+
+  def optional(message)
+    RSpec.current_example.metadata[:optional] = true
+    pending(message)
+  end
+end

data/spec/support/rake.rb

@@ -0,0 +1,41 @@
+require 'rake'
+
+module RakeHelper
+  def load_rake_environment(files)
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake::Task.define_task(:environment)
+    files.each { |file| load file }
+  end
+
+  def run_task(task, arg = nil)
+    capture_stdout_stderr do
+      @rake[task].invoke(arg)
+    end
+  end
+
+  # saves original $stdout in variable
+  # set $stdout as local instance of StringIO
+  # yields to code execution
+  # returns the local instance of StringIO
+  # resets $stdout to original value
+  def capture_stdout_stderr
+    out = StringIO.new
+    err = StringIO.new
+    $stdout = out
+    $stderr = err
+    begin
+      yield
+    rescue SystemExit => e
+      puts "error = #{e.inspect}"
+    end
+    return "Output: #{out.string}\n Errors:#{err.string}"
+  ensure
+    $stdout = STDOUT
+    $stdout = STDERR
+  end
+
+  RSpec.configure do |config|
+    config.include RakeHelper
+  end
+end