mongoid 7.1.0 → 7.1.6

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

@@ -0,0 +1,149 @@
+autoload :JSON, 'json'
+autoload :FileUtils, 'fileutils'
+autoload :Find, 'find'
+
+module Mrss
+
+  autoload :ChildProcessHelper, 'mrss/child_process_helper'
+
+  # Organizes and runs all of the tests in the test suite in batches.
+  #
+  # Organizing the tests in batches serves two purposes:
+  #
+  # 1. This allows running unit tests before integration tests, therefore
+  #    in theory revealing failures quicker on average.
+  # 2. This allows running some tests that have high intermittent failure rate
+  #    in their own test process.
+  #
+  # This class aggregates RSpec results after the test runs.
+  class SpecOrganizer
+
+    class BucketsNotPrioritized < StandardError
+    end
+
+    def initialize(root: nil, classifiers:, priority_order:,
+      spec_root: nil, rspec_json_path: nil, rspec_all_json_path: nil
+    )
+      @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')
+    end
+
+    attr_reader :spec_root, :classifiers, :priority_order
+    attr_reader :rspec_json_path, :rspec_all_json_path
+
+    def buckets
+      @buckets ||= {}.tap do |buckets|
+        Find.find(spec_root) do |path|
+          next unless File.file?(path)
+          next unless path =~ /_spec\.rb\z/
+          rel_path = path[(spec_root.length + 1)..path.length]
+
+          found = false
+          classifiers.each do |(regexp, category)|
+            if regexp =~ rel_path
+              buckets[category] ||= []
+              buckets[category] << File.join('spec', rel_path)
+              found = true
+              break
+            end
+          end
+
+          unless found
+            buckets[nil] ||= []
+            buckets[nil] << File.join('spec', rel_path)
+          end
+        end
+      end.freeze
+    end
+
+    def ordered_buckets
+      @ordered_buckets ||= {}.tap do |ordered_buckets|
+        buckets = self.buckets.dup
+        priority_order.each do |category|
+          files = buckets.delete(category)
+          ordered_buckets[category] = files
+        end
+
+        if files = buckets.delete(nil)
+          ordered_buckets[nil] = files
+        end
+
+        unless buckets.empty?
+          raise BucketsNotPrioritized, "Some buckets were not prioritized: #{buckets.keys.map(&:to_s).join(', ')}"
+        end
+      end.freeze
+    end
+
+    def run
+      FileUtils.rm_f(rspec_all_json_path)
+
+      failed = []
+      buckets = self.buckets.dup
+
+      priority_order.each do |category|
+        if files = buckets.delete(category)
+          unless run_files(category, files)
+            failed << category
+          end
+        end
+      end
+      if files = buckets.delete(nil)
+        unless run_files('remaining', files)
+          failed << 'remaining'
+        end
+      end
+
+      unless buckets.empty?
+        raise "Some buckets were not executed: #{buckets.keys.map(&:to_s).join(', ')}"
+      end
+
+      if failed.any?
+        raise "The following buckets failed: #{failed.map(&:to_s).join(', ')}"
+      end
+    end
+
+    def run_files(category, paths)
+      puts "Running #{category.to_s.gsub('_', ' ')} tests"
+      FileUtils.rm_f(rspec_json_path)
+      cmd = %w(rspec) + paths
+
+      begin
+        ChildProcessHelper.check_call(cmd)
+      ensure
+        if File.exist?(rspec_json_path)
+          if File.exist?(rspec_all_json_path)
+            merge_rspec_results
+          else
+            FileUtils.cp(rspec_json_path, rspec_all_json_path)
+          end
+        end
+      end
+
+      true
+    rescue ChildProcessHelper::SpawnError
+      false
+    end
+
+    def merge_rspec_results
+      all = JSON.parse(File.read(rspec_all_json_path))
+      new = JSON.parse(File.read(rspec_json_path))
+      all['examples'] += new.delete('examples')
+      new.delete('summary').each do |k, v|
+        all['summary'][k] += v
+      end
+      new.delete('version')
+      new.delete('summary_line')
+      unless new.empty?
+        raise "Unhandled rspec results keys: #{new.keys.join(', ')}"
+      end
+      # We do not merge summary lines, delete them from aggregated results
+      all.delete('summary_line')
+      File.open(rspec_all_json_path, 'w') do |f|
+        f << JSON.dump(all)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -31,6 +31,7 @@ end
 
 require 'support/authorization'
 require 'support/expectations'
+require 'support/helpers'
 require 'support/macros'
 require 'support/cluster_config'
 require 'support/constraints'
@@ -76,37 +77,6 @@ CONFIG = {
   }
 }
 
-def non_legacy_server?
-  Mongoid::Clients.default.cluster.servers.first.features.write_command_enabled?
-end
-
-def testing_replica_set?
-  Mongoid::Clients.default.cluster.replica_set?
-end
-
-def collation_supported?
-  Mongoid::Clients.default.cluster.next_primary.features.collation_enabled?
-end
-alias :decimal128_supported? :collation_supported?
-
-def array_filters_supported?
-  Mongoid::Clients.default.cluster.next_primary.features.array_filters_enabled?
-end
-alias :sessions_supported? :array_filters_supported?
-
-def transactions_supported?
-  features = Mongoid::Clients.default.cluster.next_primary.features
-  features.respond_to?(:transactions_enabled?) && features.transactions_enabled?
-end
-
-def testing_transactions?
-  transactions_supported? && if Gem::Version.new(ClusterConfig.instance.fcv_ish) >= Gem::Version.new('4.2')
-    %i(replica_set sharded).include?(ClusterConfig.instance.topology)
-  else
-    ClusterConfig.instance.topology == :replica_set
-  end
-end
-
 # Set the database that the spec suite connects to.
 Mongoid.configure do |config|
   config.load_configuration(CONFIG)
@@ -156,6 +126,7 @@ end
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
+  config.include(Helpers)
   config.include(Mongoid::Expectations)
   config.extend(Constraints)
   config.extend(Mongoid::Macros)

data/spec/support/child_process_helper.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+autoload :ChildProcess, 'childprocess'
+autoload :Tempfile, 'tempfile'
+
+module ChildProcessHelper
+  module_function def call(cmd, env: nil, cwd: nil)
+    process = ChildProcess.new(*cmd)
+    process.io.inherit!
+    if cwd
+      process.cwd = cwd
+    end
+    if env
+      env.each do |k, v|
+        process.environment[k.to_s] = v
+      end
+    end
+    process.start
+    process.wait
+    process
+  end
+
+  module_function def check_call(cmd, env: nil, cwd: nil)
+    process = call(cmd, env: env, cwd: cwd)
+    unless process.exit_code == 0
+      raise "Failed to execute: #{cmd}"
+    end
+  end
+
+  module_function def get_output(cmd, env: nil, cwd: nil)
+    process = ChildProcess.new(*cmd)
+    process.io.inherit!
+    if cwd
+      process.cwd = cwd
+    end
+    if env
+      env.each do |k, v|
+        process.environment[k.to_s] = v
+      end
+    end
+
+    output = ''
+    r, w = IO.pipe
+
+    begin
+      process.io.stdout = w
+      process.start
+      w.close
+
+      thread = Thread.new do
+        begin
+          loop do
+            output << r.readpartial(16384)
+          end
+        rescue EOFError
+        end
+      end
+
+      process.wait
+      thread.join
+    ensure
+      r.close
+    end
+
+    [process, output]
+  end
+
+  module_function def check_output(*args)
+    process, output = get_output(*args)
+    unless process.exit_code == 0
+      raise "Failed to execute: #{args}"
+    end
+    output
+  end
+end

data/spec/support/cluster_config.rb

@@ -99,7 +99,7 @@ class ClusterConfig
         if topology == :sharded
           shards = client.use(:admin).command(listShards: 1).first
           shard = shards['shards'].first
-          address_str = shard['host'].sub(/^.*\//, '').sub(/,.*/, '')
+          address_str = shard['host'].sub(/\A.*\//, '').sub(/,.*/, '')
           client = ClusterTools.instance.direct_client(address_str,
             SpecConfig.instance.test_options.merge(SpecConfig.instance.auth_options).merge(connect: :direct))
         end
@@ -133,8 +133,8 @@ class ClusterConfig
 
     @topology ||= begin
       topology = client.cluster.topology.class.name.sub(/.*::/, '')
-      topology = topology.gsub(/([A-Z])/) { |match| '_' + match.downcase }.sub(/^_/, '')
-      if topology =~ /^replica_set/
+      topology = topology.gsub(/([A-Z])/) { |match| '_' + match.downcase }.sub(/\A_/, '')
+      if topology =~ /\Areplica_set/
         topology = 'replica_set'
       end
       topology.to_sym

data/spec/support/constraints.rb

@@ -5,11 +5,11 @@ module Constraints
   RAILS_VERSION = ActiveSupport.version.to_s.split('.')[0..1].join('.').freeze
 
   def min_rails_version(version)
-    unless version =~ /^\d+\.\d+$/
+    unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"
     end
 
-    before do
+    before(:all) do
       if version > RAILS_VERSION
         skip "Rails version #{version} or higher required, we have #{RAILS_VERSION}"
       end
@@ -17,11 +17,11 @@ module Constraints
   end
 
   def max_rails_version(version)
-    unless version =~ /^\d+\.\d+$/
+    unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"
     end
 
-    before do
+    before(:all) do
       if version < RAILS_VERSION
         skip "Rails version #{version} or lower required, we have #{RAILS_VERSION}"
       end
@@ -29,11 +29,11 @@ module Constraints
   end
 
   def min_server_version(version)
-    unless version =~ /^\d+\.\d+$/
+    unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"
     end
 
-    before do
+    before(:all) do
       if version > ClusterConfig.instance.server_version
         skip "Server version #{version} or higher required, we have #{ClusterConfig.instance.server_version}"
       end
@@ -41,11 +41,11 @@ module Constraints
   end
 
   def max_server_version(version)
-    unless version =~ /^\d+\.\d+$/
+    unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"
     end
 
-    before do
+    before(:all) do
       if version < ClusterConfig.instance.short_server_version
         skip "Server version #{version} or lower required, we have #{ClusterConfig.instance.server_version}"
       end
@@ -54,9 +54,11 @@ module Constraints
 
   def require_topology(*topologies)
     invalid_topologies = topologies - [:single, :replica_set, :sharded]
+
     unless invalid_topologies.empty?
       raise ArgumentError, "Invalid topologies requested: #{invalid_topologies.join(', ')}"
     end
+
     before(:all) do
       unless topologies.include?(topology = ClusterConfig.instance.topology)
         skip "Topology #{topologies.join(' or ')} required, we have #{topology}"
@@ -73,8 +75,22 @@ module Constraints
   end
 
   def require_transaction_support
-    min_server_fcv '4.0'
-    require_topology :replica_set
+    before(:all) do
+      case ClusterConfig.instance.topology
+      when :single
+        skip 'Transactions tests require a replica set (4.0+) or a sharded cluster (4.2+)'
+      when :replica_set
+        unless ClusterConfig.instance.server_version >= '4.0'
+          skip 'Transactions tests in a replica set topology require server 4.0+'
+        end
+      when :sharded
+        unless ClusterConfig.instance.server_version >= '4.2'
+          skip 'Transactions tests in a sharded cluster topology require server 4.2+'
+        end
+      else
+        raise NotImplementedError
+      end
+    end
   end
 
   def require_tls

data/spec/support/expectations.rb

@@ -14,14 +14,16 @@ module Mongoid
     end
 
     def expect_query(number)
+      rv = nil
       RSpec::Mocks.with_temporary_scope do
         if number > 0
           expect_any_instance_of(connection_class).to receive(:command_started).exactly(number).times.and_call_original
         else
           expect_any_instance_of(connection_class).not_to receive(:command_started)
         end
-        yield
+        rv = yield
       end
+      rv
     end
 
     def expect_no_queries(&block)

data/spec/support/helpers.rb

@@ -0,0 +1,11 @@
+module Helpers
+  # Reloads the specified model class.
+  #
+  # @param [ String | Symbol ] name Class name to reload.
+  def reload_model(name)
+    Object.class_eval do
+      remove_const(name)
+    end
+    load "spec/app/models/#{name.to_s.underscore}.rb"
+  end
+end

data/spec/support/session_registry.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+
+module Mongo
+  class Client
+    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
+
+  class Session
+    alias :end_session_without_tracking :end_session
+
+    def end_session
+      SessionRegistry.instance.unregister(self)
+      end_session_without_tracking
+    end
+  end
+end
+
+
+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)
+  end
+
+  def verify_sessions_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