spec_helper.rb

# frozen_string_literal: true
# rubocop:todo all

require 'lite_spec_helper'

MODELS = File.join(File.dirname(__FILE__), "support/models")
$LOAD_PATH.unshift(MODELS)

require "action_controller"
require 'rspec/retry'

if SpecConfig.instance.client_debug?
  Mongoid.logger.level = Logger::DEBUG
  Mongo::Logger.logger.level = Logger::DEBUG
else
  Mongoid.logger.level = Logger::INFO
  Mongo::Logger.logger.level = Logger::INFO
end

# When testing locally we use the database named mongoid_test. However when
# tests are running in parallel in a CI environment we need to use different
# database names for each process running since we do not have transactions
# and want a clean slate before each spec run.
def database_id
  "mongoid_test"
end

def database_id_alt
  "mongoid_test_alt"
end

begin
  require 'mrss/cluster_config'
  require 'support/client_registry'
  require 'mrss/constraints'
  require 'mrss/event_subscriber'
rescue LoadError => exc
  raise LoadError.new <<~MSG.strip
    The test suite requires shared tooling to be installed.
    Please refer to spec/README.md for instructions.
    #{exc.class}: #{exc}
  MSG
end

ClusterConfig = Mrss::ClusterConfig

require 'support/authorization'
require 'support/expectations'
require 'support/helpers'
require 'support/macros'
require 'support/constraints'
require 'support/crypt'

use_ssl = %w[ ssl 1 true ].include?(ENV['SSL'])
ssl_options = { ssl: use_ssl }.freeze

# Give MongoDB servers time to start up in CI environments
if SpecConfig.instance.ci?
  starting = true
  client = Mongo::Client.new(SpecConfig.instance.addresses, ssl_options)
  while starting
    begin
      client.command(ping: 1)
      break
    rescue Mongo::Error::OperationFailure => e
      sleep(2)
      client.cluster.scan!
    end
  end
end

CONFIG = {
  clients: {
    default: {
      database: database_id,
      hosts: SpecConfig.instance.addresses,
      options: ssl_options.merge(
        server_selection_timeout: 3.42,
        wait_queue_timeout: 1,
        max_pool_size: 5,
        heartbeat_frequency: 180,
        user: SpecConfig.instance.uri.client_options[:user] || MONGOID_ROOT_USER.name,
        password: SpecConfig.instance.uri.client_options[:password] || MONGOID_ROOT_USER.password,
        auth_source: Mongo::Database::ADMIN
      )
    }
  },
  options: {
    belongs_to_required_by_default: false,
    log_level: if SpecConfig.instance.client_debug?
      :debug
    else
      :info
    end,
  }
}

# Set the database that the spec suite connects to.
Mongoid.configure do |config|
  config.load_configuration(CONFIG)
end

# Autoload every model for the test suite that sits in spec/support/models.
Dir[ File.join(MODELS, "*.rb") ].sort.each do |file|
  name = File.basename(file, ".rb")
  autoload name.camelize.to_sym, name
end

module Mongoid
  class Query
    include Mongoid::Criteria::Queryable
  end
end

ActiveSupport::Inflector.inflections do |inflect|
  inflect.irregular("canvas", "canvases")
  inflect.singular("address_components", "address_component")
end

Time.zone = 'UTC'

I18n.config.enforce_available_locales = false

if %w(yes true 1).include?((ENV['TEST_I18N_FALLBACKS'] || '').downcase)
  require "i18n/backend/fallbacks"
end

unless SpecConfig.instance.atlas?
  # The user must be created before any of the tests are loaded, until
  # https://jira.mongodb.org/browse/MONGOID-4827 is implemented.
  client = Mongo::Client.new(SpecConfig.instance.addresses, server_selection_timeout: 3.03)
  begin
    # Create the root user administrator as the first user to be added to the
    # database. This user will need to be authenticated in order to add any
    # more users to any other databases.
    client.database.users.create(MONGOID_ROOT_USER)
  rescue Mongo::Error::OperationFailure => e
  ensure
    client.close
  end
end

RSpec.configure do |config|
  config.raise_errors_for_deprecations!
  config.include(Helpers)
  config.include(Mongoid::Expectations)
  config.extend(Mrss::Constraints)
  config.extend(Constraints)
  config.extend(Mongoid::Macros)

  config.before(:suite) do
    Mongoid.purge!
  end

  # Drop all collections and clear the identity map before each spec.
  config.before(:each) do
    cluster = Mongoid.default_client.cluster
    # Older drivers do not have a #connected? method
    if cluster.respond_to?(:connected?) && !cluster.connected?
      Mongoid.default_client.reconnect
    end
    Mongoid.default_client.collections.each do |coll|
      coll.delete_many
    end
  end
end

# A subscriber to be used with the Ruby driver for testing.
class EventSubscriber

  # The started events.
  attr_reader :started_events

  # The succeeded events.
  attr_reader :succeeded_events

  # The failed events.
  attr_reader :failed_events

  # Create the test event subscriber.
  #
  # @example Create the subscriber
  #   EventSubscriber.new
  def initialize
    @started_events = []
    @succeeded_events = []
    @failed_events = []
  end

  # Cache the succeeded event.
  #
  # @param [ Event ] event The event.
  def succeeded(event)
    @succeeded_events.push(event)
  end

  # Cache the started event.
  #
  # @param [ Event ] event The event.
  def started(event)
    @started_events.push(event)
  end

  # Cache the failed event.
  #
  # @param [ Event ] event The event.
  def failed(event)
    @failed_events.push(event)
  end

  # Clear all cached events.
  def clear_events!
    @started_events = []
    @succeeded_events = []
    @failed_events = []
  end
end