mongoid 7.0.13 → 8.0.8

data/spec/shared/lib/mrss/event_subscriber.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+module Mrss
+  # Test event subscriber.
+  class EventSubscriber
+
+    # The mappings of event names to types.
+    MAPPINGS = {
+      'topology_opening_event' => Mongo::Monitoring::Event::TopologyOpening,
+      'topology_description_changed_event' => Mongo::Monitoring::Event::TopologyChanged,
+      'topology_closed_event' => Mongo::Monitoring::Event::TopologyClosed,
+      'server_opening_event' => Mongo::Monitoring::Event::ServerOpening,
+      'server_description_changed_event' => Mongo::Monitoring::Event::ServerDescriptionChanged,
+      'server_closed_event' => Mongo::Monitoring::Event::ServerClosed
+    }.freeze
+
+    attr_reader :all_events
+
+    attr_reader :started_events
+
+    attr_reader :succeeded_events
+
+    attr_reader :failed_events
+
+    attr_reader :published_events
+
+    # @param [ String ] name Optional name for the event subscriber.
+    def initialize(name: nil)
+      @mutex = Mutex.new
+      clear_events!
+      @name = name
+    end
+
+    def to_s
+      %Q`#<EventSubscriber:#{@name ? "\"#{@name}\"" : '%x' % object_id} \
+  started=#{started_events.length} \
+  succeeded=#{succeeded_events.length} \
+  failed=#{failed_events.length} \
+  published=#{published_events.length}>`
+    end
+
+    alias :inspect :to_s
+
+    # Event retrieval
+
+    def select_started_events(cls)
+      started_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    def select_succeeded_events(cls)
+      succeeded_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    def select_completed_events(*classes)
+      (succeeded_events + failed_events).select do |event|
+        classes.any? { |c| c === event }
+      end
+    end
+
+    def select_published_events(cls)
+      published_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    # Filters command started events for the specified command name.
+    def command_started_events(command_name)
+      started_events.select do |event|
+        event.command[command_name]
+      end
+    end
+
+    def non_auth_command_started_events
+      started_events.reject do |event|
+        %w(authenticate getnonce saslSstart saslContinue).any? do |cmd|
+          event.command[cmd]
+        end
+      end
+    end
+
+    # Locates command stated events for the specified command name,
+    # asserts that there is exactly one such event, and returns it.
+    def single_command_started_event(command_name, include_auth: false, database_name: nil)
+      events = if include_auth
+                 started_events
+               else
+                 non_auth_command_started_events
+               end
+      get_one_event(events, command_name, 'started', database_name: database_name)
+    end
+
+    # Locates command succeeded events for the specified command name,
+    # asserts that there is exactly one such event, and returns it.
+    def single_command_succeeded_event(command_name, database_name: nil)
+      get_one_event(succeeded_events, command_name, 'succeeded', database_name: database_name)
+    end
+
+    def get_one_event(events, command_name, kind, database_name: nil)
+      events = events.select do |event|
+        event.command_name == command_name and
+        database_name.nil? || database_name == event.database_name
+      end
+      if events.length != 1
+        raise "Expected a single '#{command_name}' #{kind} event#{database_name ? " for '#{database_name}'" : ''} but we have #{events.length}"
+      end
+      events.first
+    end
+
+    # Get the first succeeded event published for the name, and then delete it.
+    #
+    # @param [ String ] name The event name.
+    #
+    # @return [ Event ] The matching event.
+    def first_event(name)
+      cls = MAPPINGS[name]
+      if cls.nil?
+        raise ArgumentError, "Bogus event name #{name}"
+      end
+      matching = succeeded_events.find do |event|
+        cls === event
+      end
+      succeeded_events.delete(matching)
+      matching
+    end
+
+    # Event recording
+
+    # Cache the started event.
+    #
+    # @param [ Event ] event The event.
+    def started(event)
+      @mutex.synchronize do
+        started_events << event
+        all_events << event
+      end
+    end
+
+    # Cache the succeeded event.
+    #
+    # @param [ Event ] event The event.
+    def succeeded(event)
+      @mutex.synchronize do
+        succeeded_events << event
+        all_events << event
+      end
+    end
+
+    # Cache the failed event.
+    #
+    # @param [ Event ] event The event.
+    def failed(event)
+      @mutex.synchronize do
+        failed_events << event
+        all_events << event
+      end
+    end
+
+    def published(event)
+      @mutex.synchronize do
+        published_events << event
+        all_events << event
+      end
+    end
+
+    # Clear all cached events.
+    def clear_events!
+      @all_events = []
+      @started_events = []
+      @succeeded_events = []
+      @failed_events = []
+      @published_events = []
+      self
+    end
+  end
+  # Only handles succeeded events correctly.
+  class PhasedEventSubscriber < EventSubscriber
+    def initialize
+      super
+      @phase_events = {}
+    end
+
+    def phase_finished(phase_index)
+      @phase_events[phase_index] = succeeded_events
+      @succeeded_events = []
+    end
+
+    def phase_events(phase_index)
+      @phase_events[phase_index]
+    end
+
+    def event_count
+      @phase_events.inject(0) do |sum, event|
+        sum + event.length
+      end
+    end
+  end
+
+  class VerboseEventSubscriber < EventSubscriber
+    %w(started succeeded failed published).each do |meth|
+      define_method(meth) do |event|
+        puts event.summary
+        super(event)
+      end
+    end
+  end
+end

data/spec/shared/lib/mrss/lite_constraints.rb

@@ -87,12 +87,25 @@ module Mrss
 
     def require_libmongocrypt
       before(:all) do
-        unless ENV['LIBMONGOCRYPT_PATH']
+        # If FLE is set in environment, the entire test run is supposed to
+        # include FLE therefore run the FLE tests.
+        if (ENV['LIBMONGOCRYPT_PATH'] || '').empty? && (ENV['FLE'] || '').empty?
           skip 'Test requires path to libmongocrypt to be specified in LIBMONGOCRYPT_PATH env variable'
         end
       end
     end
 
+    def min_libmongocrypt_version(version)
+      require_libmongocrypt
+      before(:all) do
+        actual_version = Utils.parse_version(Mongo::Crypt::Binding.mongocrypt_version(nil))
+        min_version = Utils.parse_version(version)
+        unless actual_version >= min_version
+          skip "libmongocrypt version #{min_version} required, but version #{actual_version} is available"
+        end
+      end
+    end
+
     def require_no_libmongocrypt
       before(:all) do
         if ENV['LIBMONGOCRYPT_PATH']
@@ -187,5 +200,39 @@ module Mrss
         end
       end
     end
+
+    def require_fallbacks
+      before(:all) do
+        unless %w(yes true 1).include?((ENV['TEST_I18N_FALLBACKS'] || '').downcase)
+          skip 'Set TEST_I18N_FALLBACKS=1 environment variable to run these tests'
+        end
+      end
+    end
+
+    def require_no_fallbacks
+      before(:all) do
+        if %w(yes true 1).include?((ENV['TEST_I18N_FALLBACKS'] || '').downcase)
+          skip 'Set TEST_I18N_FALLBACKS=0 environment variable to run these tests'
+        end
+      end
+    end
+
+    # This is a macro for retrying flaky tests on CI that occasionally fail.
+    # Note that the tests will only be retried on CI.
+    #
+    # @param [ Integer ] :tries The number of times to retry.
+    # @param [ Integer ] :sleep The number of seconds to sleep in between retries.
+    #   If nothing, or nil, is passed, we won't wait in between retries.
+    def retry_test(tries: 3, sleep: nil)
+      if %w(1 yes true).include?(ENV['CI'])
+        around do |example|
+          if sleep
+            example.run_with_retry retry: tries, retry_wait: sleep
+          else
+            example.run_with_retry retry: tries
+          end
+        end
+      end
+    end
   end
 end

data/spec/shared/lib/mrss/server_version_registry.rb

@@ -24,6 +24,21 @@ module Mrss
 
     attr_reader :desired_version, :arch
 
+    def target_arch
+      # can't use RbConfig::CONFIG["arch"] because JRuby doesn't
+      # return anything meaningful there.
+      #
+      # also, need to use `uname -a` instead of (e.g.) `uname -p`
+      # because debian (at least) does not return anything meaningful
+      # for `uname -p`.
+      uname = `uname -a`.strip
+      @target_arch ||= case uname
+        when /aarch/ then "aarch64"
+        when /x86/   then "x86_64"
+        else raise "unsupported architecture #{uname.inspect}"
+        end
+    end
+
     def download_url
       @download_url ||= begin
         version, version_ok = detect_version(current_catalog)
@@ -40,30 +55,13 @@ module Mrss
         end
         dl = version['downloads'].detect do |dl|
           dl['archive']['url'].index("enterprise-#{arch}") &&
-          dl['arch'] == 'x86_64'
+          dl['arch'] == target_arch
         end
         unless dl
           raise MissingDownloadUrl, "No download for #{arch} for #{version['version']}"
         end
         url = dl['archive']['url']
       end
-    rescue MissingDownloadUrl
-      if %w(4.7 4.7.0).include?(desired_version)
-        # 4.7.0 has no advertised downloads but it is downloadable and
-        # we do need it. Dirty hack below.
-        registry = self.class.new('4.4.3', arch)
-        registry.download_url.sub('4.4.3', '4.7.0').tap do |url|
-          # Sanity check - ensure the URL we hacked up is a valid one
-          io = uri_open(url)
-          begin
-            io.read(1)
-          ensure
-            io.close
-          end
-        end
-      else
-        raise
-      end
     end
 
     private

data/spec/shared/lib/mrss/session_registry.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'singleton'
+
+module Mrss
+
+  def self.patch_mongo_for_session_registry
+
+    Mongo::Client.class_eval do
+      alias :get_session_without_tracking :get_session
+
+      def get_session(options = {})
+        get_session_without_tracking(options).tap do |session|
+          SessionRegistry.instance.register(session) if session&.materialized?
+        end
+      end
+    end
+
+    Mongo::Session.class_eval do
+      alias :end_session_without_tracking :end_session
+
+      def end_session
+        SessionRegistry.instance.unregister(self)
+        end_session_without_tracking
+      end
+
+      alias :materialize_if_needed_without_tracking :materialize_if_needed
+
+      def materialize_if_needed
+        materialize_if_needed_without_tracking.tap do
+          SessionRegistry.instance.register(self)
+        end
+      end
+    end
+  end
+end
+
+module Mrss
+  class SessionRegistry
+    include Singleton
+
+    def initialize
+      @registry = {}
+    end
+
+    def register(session)
+      @registry[session.session_id] = session if session
+    end
+
+    def unregister(session)
+      return if session.ended? || !session.materialized?
+      @registry.delete(session.session_id)
+    end
+
+    def verify_sessions_ended!
+      @registry.delete_if { |_, session| session.ended? }
+
+      unless @registry.empty?
+        sessions = @registry.map { |_, session| session }
+        raise "Session registry contains live sessions: #{sessions.join(', ')}"
+      end
+    end
+
+    def clear_registry
+      @registry = {}
+    end
+  end
+end

data/spec/shared/lib/mrss/session_registry_legacy.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'singleton'
+
+module Mrss
+
+  def self.patch_mongo_for_session_registry
+
+    Mongo::Client.class_eval do
+      alias :get_session_without_tracking :get_session
+
+      def get_session(options = {})
+        get_session_without_tracking(options).tap do |session|
+          SessionRegistry.instance.register(session)
+        end
+      end
+    end
+
+    Mongo::Session.class_eval do
+      alias :end_session_without_tracking :end_session
+
+      def end_session
+        SessionRegistry.instance.unregister(self)
+        end_session_without_tracking
+      end
+    end
+  end
+end
+
+module Mrss
+  class SessionRegistry
+    include Singleton
+
+    def initialize
+      @registry = {}
+    end
+
+    def register(session)
+      @registry[session.session_id] = session if session
+    end
+
+    def unregister(session)
+      @registry.delete(session.session_id) unless session.ended?
+    end
+
+    def verify_sessions_ended!
+      @registry.delete_if { |_, session| session.ended? }
+
+      unless @registry.empty?
+        sessions = @registry.map { |_, session| session }
+        raise "Session registry contains live sessions: #{sessions.join(', ')}"
+      end
+    end
+
+    def clear_registry
+      @registry = {}
+    end
+  end
+end

data/spec/shared/lib/mrss/spec_organizer.rb

@@ -25,18 +25,28 @@ module Mrss
     end
 
     def initialize(root: nil, classifiers:, priority_order:,
-      spec_root: nil, rspec_json_path: nil, rspec_all_json_path: nil
+      spec_root: nil, rspec_json_path: nil, rspec_all_json_path: nil,
+      randomize: false
     )
       @spec_root = spec_root || File.join(root, 'spec')
       @classifiers = classifiers
       @priority_order = priority_order
       @rspec_json_path = rspec_json_path || File.join(root, 'tmp/rspec.json')
       @rspec_all_json_path = rspec_all_json_path || File.join(root, 'tmp/rspec-all.json')
+      @randomize = !!randomize
     end
 
     attr_reader :spec_root, :classifiers, :priority_order
     attr_reader :rspec_json_path, :rspec_all_json_path
 
+    def randomize?
+      @randomize
+    end
+
+    def seed
+      @seed ||= (rand * 100_000).to_i
+    end
+
     def buckets
       @buckets ||= {}.tap do |buckets|
         Find.find(spec_root) do |path|
@@ -122,8 +132,12 @@ module Mrss
       puts "Running #{category.to_s.gsub('_', ' ')} tests"
       FileUtils.rm_f(rspec_json_path)
       cmd = %w(rspec) + paths
+      if randomize?
+        cmd += %W(--order rand:#{seed})
+      end
 
       begin
+        puts "Running #{cmd.join(' ')}"
         ChildProcessHelper.check_call(cmd)
       ensure
         if File.exist?(rspec_json_path)
@@ -149,6 +163,9 @@ module Mrss
       end
       new.delete('version')
       new.delete('summary_line')
+      # The spec organizer runs all buckets with the same seed, hence
+      # we can drop the seed from new results.
+      new.delete('seed')
       unless new.empty?
         raise "Unhandled rspec results keys: #{new.keys.join(', ')}"
       end

data/spec/shared/lib/mrss/utils.rb

@@ -3,13 +3,35 @@
 
 module Mrss
   module Utils
+    extend self
 
-    module_function def print_backtrace(dest=STDERR)
-      begin
-        hello world
-      rescue => e
-        dest.puts e.backtrace.join("\n")
-      end
+    def print_backtrace(dest=STDERR)
+      raise
+    rescue => e
+      dest.puts e.backtrace.join("\n")
+    end
+
+    # Parses the given version string, accounting for suffix information that
+    # Gem::Version cannot successfully parse.
+    #
+    # @param [ String ] version the version to parse
+    #
+    # @return [ Gem::Version ] the parsed version
+    #
+    # @raise [ ArgumentError ] if the string cannot be parsed.
+    def parse_version(version)
+      Gem::Version.new(version)
+    rescue ArgumentError
+      match = version.match(/\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)?(-[A-Za-z\+\d]+)?\z/)
+      raise ArgumentError.new("Malformed version number string #{version}") if match.nil?
+
+      Gem::Version.new(
+        [
+          match[:major],
+          match[:minor],
+          match[:patch]
+        ].join('.')
+      )
     end
   end
 end