hyrax 1.1.1 → 2.0.0.beta1

data/spec/services/hyrax/workflow/status_list_service_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Hyrax::Workflow::StatusListService do
   describe "#each" do
     let(:user) { create(:user) }
@@ -20,12 +18,12 @@ RSpec.describe Hyrax::Workflow::StatusListService do
     end
     let(:workflow_role) { instance_double(Sipity::Role, name: 'approving') }
     let(:workflow_roles) { [instance_double(Sipity::WorkflowRole, role: workflow_role)] }
+    let(:results) { service.each.to_a }
+
     before do
       ActiveFedora::SolrService.add([document, ability], commit: true)
     end
 
-    let(:results) { service.each.to_a }
-
     context "when user has roles" do
       before do
         allow(Hyrax::Workflow::PermissionQuery).to receive(:scope_processing_workflow_roles_for_user_and_workflow).and_return(workflow_roles)

data/spec/services/hyrax/workflow/workflow_factory_spec.rb

@@ -8,6 +8,7 @@ RSpec.describe Hyrax::Workflow::WorkflowFactory do
     let(:attributes) { {} }
     let(:user) { create(:user) }
     let(:deposit_action) { Sipity::WorkflowAction.create!(workflow: workflow, name: 'start') }
+
     subject { described_class.create(work, attributes, user) }
 
     it 'creates a Sipity::Entity, assign entity specific responsibility (but not to the full workflow) then runs the WorkflowActionService' do
@@ -18,7 +19,7 @@ RSpec.describe Hyrax::Workflow::WorkflowFactory do
         expect do
           subject
         end.to change { Sipity::Entity.count }.by(1)
-          .and change { Sipity::EntitySpecificResponsibility.count }.by(1)
+                                              .and change { Sipity::EntitySpecificResponsibility.count }.by(1)
       end.not_to change { Sipity::WorkflowResponsibility.count }
     end
   end

data/spec/services/hyrax/workflow/workflow_importer_spec.rb

@@ -21,17 +21,20 @@ RSpec.describe Hyrax::Workflow::WorkflowImporter do
   end
   let(:validator) { double(call: true) }
   let(:importer) { described_class.new(data: {}, permission_template: permission_template, validator: validator) }
+
   subject { importer }
 
   before { described_class.clear_load_errors! }
 
   describe '#default_validator' do
     subject { importer.send(:default_validator) }
+
     it { is_expected.to respond_to(:call) }
   end
 
   describe '#default_schema' do
     subject { importer.send(:default_schema) }
+
     it { is_expected.to respond_to(:call) }
   end
 
@@ -80,6 +83,7 @@ RSpec.describe Hyrax::Workflow::WorkflowImporter do
 
     describe 'with very invalid schema' do
       let(:data) { { workflows: [{ name: '' }] } }
+
       it 'logs the output' do
         expect(logger).to receive(:error).with(kind_of(String))
         expect { importer }.to raise_error(RuntimeError)
@@ -129,6 +133,7 @@ RSpec.describe Hyrax::Workflow::WorkflowImporter do
 
       context 'that includes a workflow_name changes' do
         let(:workflow_name) { "awsome workflow" }
+
         it "creates a new workflow (preserving the old)" do
           expect(workflow2).not_to eq(workflow1)
           expect(Sipity::Workflow.count).to eq(2)
@@ -139,6 +144,7 @@ RSpec.describe Hyrax::Workflow::WorkflowImporter do
 
       context "that keeps the same workflow_name name" do
         let(:workflow_name) { "ulra_submission" }
+
         it "preserves state names identified in actions > transition_to and actions> from_states > names hash key" do
           expect(workflow2.label).not_to eq(workflow1.label)
           expect(workflow2).to eq(workflow1)
@@ -172,6 +178,7 @@ RSpec.describe Hyrax::Workflow::WorkflowImporter do
           end
           let(:workflow_state) { workflow1.reload.workflow_states.find_by(name: 'declined') }
           let!(:entity) { Sipity::Entity.create(workflow_state: workflow_state, proxy_for_global_id: "abc123", workflow_id: workflow1.id) }
+
           it "reports an error and does not update the WorkflowStates" do
             expect do
               expect do

data/spec/services/hyrax/workflow/workflow_permissions_generator_spec.rb

@@ -10,6 +10,7 @@ module Hyrax
           { role: "etd_reviewing" }
         ]
       end
+
       before do
         workflow_permissions_configuration.each do |config|
           Sipity::Role.find_or_create_by!(name: config.fetch(:role))
@@ -22,6 +23,7 @@ module Hyrax
       end
 
       subject { described_class.new(workflow: workflow, workflow_permissions_configuration: workflow_permissions_configuration) }
+
       it 'will create groups and assign permissions accordingly' do
         allow_any_instance_of(PermissionGenerator).to receive(:call)
         subject.call

data/spec/services/hyrax/workflow/workflow_schema_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 module Hyrax
   module Workflow
     RSpec.describe 'WorkflowSchema', no_clean: true do
@@ -64,6 +62,7 @@ module Hyrax
       describe 'notification names' do
         context 'with an uninitialized constant' do
           let(:notification_name) { 'FooBar' }
+
           it 'is invalid' do
             expect(WorkflowSchema.call(valid_data).messages).not_to be_empty
           end
@@ -76,6 +75,7 @@ module Hyrax
           end
           after { Hyrax::Workflow.send(:remove_const, :DoTheThing) }
           let(:notification_name) { 'Hyrax::Workflow::DoTheThing' }
+
           it 'returns an empty message because valid' do
             expect(WorkflowSchema.call(valid_data).messages).to be_empty
           end

data/spec/services/hyrax/working_directory_spec.rb

@@ -1,12 +1,12 @@
-require 'spec_helper'
-
-describe Hyrax::WorkingDirectory do
+RSpec.describe Hyrax::WorkingDirectory do
   let(:path1) { described_class.send(:full_filename, 'abcdefghijklmnop1', 'foo.tif') }
   let(:path2) { described_class.send(:full_filename, 'abcdefghijklmnop2', 'foo.tif') }
 
   describe "#full_filename" do
     it "generates unique filenames for different files" do
       expect(path1).not_to eq(path2)
+      expect(path1).to match(/\/tmp\/uploads\/ab\/cd\/ef\/gh\/abcdefghijklmnop1\/foo.tif$/)
+      expect(path2).to match(/\/tmp\/uploads\/ab\/cd\/ef\/gh\/abcdefghijklmnop2\/foo.tif$/)
     end
   end
 end

data/spec/spec_helper.rb

@@ -21,57 +21,49 @@ if coverage_needed?
   SimpleCov.command_name 'spec'
 end
 
-require 'factory_bot'
+require 'factory_girl'
 require 'engine_cart'
 EngineCart.load_application!
 
 require 'devise'
 require 'devise/version'
 require 'mida'
-require 'active_fedora/noid/rspec'
 require 'rails-controller-testing'
 require 'rspec/rails'
 require 'rspec/its'
 require 'rspec/matchers'
 require 'rspec/active_model/mocks'
-require 'capybara/poltergeist'
 require 'capybara/rspec'
 require 'capybara/rails'
+require 'selenium-webdriver'
 require 'equivalent-xml'
 require 'equivalent-xml/rspec_matchers'
 require 'database_cleaner'
-require 'support/controller_level_helpers'
-require 'support/features'
-require 'support/factory_helpers'
-require 'support/rake'
-require 'support/matchers/api_responses'
-require 'support/matchers/response_matchers'
-require 'support/input_support'
-require 'support/speedup'
+
+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.config 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 ENV['TRAVIS']
 
-Capybara.default_driver = :rack_test      # This is a faster driver
-Capybara.javascript_driver = :poltergeist # This is slower
-Capybara.default_max_wait_time = ENV['TRAVIS'] ? 30 : 15
-# Adding the below to deal with random Capybara-related timeouts in CI.
-# Found in this thread: https://github.com/teampoltergeist/poltergeist/issues/375
-poltergeist_options = {
-  js_errors: true,
-  timeout: 60,
-  logger: nil,
-  phantomjs_logger: StringIO.new,
-  phantomjs_options: [
-    '--load-images=no',
-    '--ignore-ssl-errors=yes'
-  ]
-}
-Capybara.register_driver(:poltergeist) do |app|
-  Capybara::Poltergeist::Driver.new(app, poltergeist_options)
-end
+Capybara.default_driver = :rack_test # This is a faster driver
+Capybara.javascript_driver = :selenium_chrome_headless # This is slower
 
 ActiveJob::Base.queue_adapter = :inline
 
@@ -80,20 +72,6 @@ ActiveJob::Base.queue_adapter = :inline
 # HttpLogger.ignore = [/localhost:8983\/solr/]
 # HttpLogger.colorize = false
 
-if ENV['TRAVIS']
-  # Monkey-patches the FITS runner to return the PDF FITS fixture
-  module Hydra::Works
-    class CharacterizationService
-      def self.run(_, _)
-        raise "FITS!!!"
-        # return unless file_set.original_file.has_content?
-        # filename = ::File.expand_path("../fixtures/pdf_fits.xml", __FILE__)
-        # file_set.characterization.ng_xml = ::File.read(filename)
-      end
-    end
-  end
-end
-
 if defined?(ClamAV)
   ClamAV.instance.loaddb
 else
@@ -111,7 +89,7 @@ end
 
 class JsonStrategy
   def initialize
-    @strategy = FactoryBot.strategy_by_name(:create).new
+    @strategy = FactoryGirl.strategy_by_name(:create).new
   end
 
   delegate :association, to: :@strategy
@@ -121,9 +99,9 @@ class JsonStrategy
   end
 end
 
-FactoryBot.register_strategy(:json, JsonStrategy)
-FactoryBot.definition_file_paths = [File.expand_path("../factories", __FILE__)]
-FactoryBot.find_definitions
+FactoryGirl.register_strategy(:json, JsonStrategy)
+FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryGirl.find_definitions
 
 module EngineRoutes
   def self.included(base)
@@ -144,8 +122,7 @@ end
 
 require 'active_fedora/cleaner'
 RSpec.configure do |config|
-  include ActiveFedora::Noid::RSpec
-
+  config.disable_monkey_patching!
   config.include Shoulda::Matchers::ActiveRecord, type: :model
 
   config.expect_with :rspec do |c|
@@ -159,17 +136,8 @@ RSpec.configure do |config|
 
   config.before :suite do
     DatabaseCleaner.clean_with(:truncation)
-    disable_production_minter!
-  end
-
-  config.after :suite do
-    enable_production_minter!
-  end
-
-  config.before :each do |example|
-    unless example.metadata[:type] == :view || example.metadata[:no_clean]
-      ActiveFedora::Cleaner.clean!
-    end
+    # Noid minting causes extra LDP requests which slow the test suite.
+    Hyrax.config.enable_noids = false
   end
 
   config.before :each do |example|
@@ -179,6 +147,11 @@ RSpec.configure do |config|
       DatabaseCleaner.strategy = :transaction
       DatabaseCleaner.start
     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]
+    ActiveFedora::Cleaner.clean! if example.metadata[:clean_repo]
   end
 
   config.include(ControllerLevelHelpers, type: :view)
@@ -222,7 +195,7 @@ RSpec.configure do |config|
 
   config.include Capybara::RSpecMatchers, type: :input
   config.include InputSupport, type: :input
-  config.include FactoryBot::Syntax::Methods
+  config.include FactoryGirl::Syntax::Methods
 
   config.infer_spec_type_from_file_location!
 
@@ -230,6 +203,7 @@ RSpec.configure do |config|
     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

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

@@ -1,7 +1,6 @@
-require 'spec_helper'
-
 RSpec.describe Hyrax::Strategies::YamlStrategy do
   subject { described_class.new(config: "test_file") }
+
   context "when given a YAML file" do
     let(:content) do
       {
@@ -10,6 +9,7 @@ RSpec.describe Hyrax::Strategies::YamlStrategy do
         }
       }
     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)

data/spec/support/controller_level_helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ControllerLevelHelpers
   # This provides some common mock methods for view tests.
   # These are normally provided by the controller.

data/spec/support/features.rb

@@ -1,8 +1,8 @@
 # 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('../proxies', __FILE__)
-require File.expand_path('../locations', __FILE__)
 require File.expand_path('../statistic_helper', __FILE__)
 
 RSpec.configure do |config|

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')
+    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

@@ -3,7 +3,7 @@ module Features
   module SessionHelpers
     def sign_in(who = :user)
       logout
-      user = who.is_a?(User) ? who : FactoryBot.build(:user).tap(&:save!)
+      user = who.is_a?(User) ? who : FactoryGirl.build(:user).tap(&:save!)
       visit new_user_session_path
       fill_in 'Email', with: user.email
       fill_in 'Password', with: user.password

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/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 > 0 }
+        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