mongoid 7.2.0 → 7.3.0

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

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'optparse'
+require 'erb'
+autoload :Dotenv, 'dotenv'
+
+module Mrss
+  autoload :ServerVersionRegistry, 'mrss/server_version_registry'
+
+  class DockerRunner
+    def initialize(**opts)
+      # These options are required:
+      opts.fetch(:image_tag)
+      opts.fetch(:dockerfile_path)
+      opts.fetch(:default_script)
+      opts.fetch(:project_lib_subdir)
+
+      @options = opts
+    end
+
+    attr_reader :options
+
+    def run
+      process_arguments
+      unless @options[:exec_only]
+        create_dockerfile
+        create_image
+      end
+      if @options[:mongo_only]
+        run_deployment
+      else
+        run_tests
+      end
+    end
+
+    private
+
+    def process_arguments
+      #@options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: test-on-docker [-d distro] [evergreen_key=value ...]"
+
+        opts.on("-a", "--add-env=PATH", "Load environment variables from PATH in .env format") do |path|
+          @options[:extra_env] ||= {}
+          unless File.exist?(path)
+            raise "-a option references nonexistent file #{path}"
+          end
+          Dotenv.parse(path).each do |k, v|
+            @options[:extra_env][k] = v
+          end
+        end
+
+        opts.on("-d", "--distro=DISTRO", "Distro to use") do |v|
+          @options[:distro] = v
+        end
+
+        opts.on('-e', '--exec-only', 'Execute tests using existing Dockerfile (for offline user)') do |v|
+          @options[:exec_only] = v
+        end
+
+        opts.on('-m', '--mongo-only=PORT', 'Start the MongoDB deployment and expose it to host on ports starting with PORT') do |v|
+          @options[:mongo_only] = v.to_i
+        end
+
+        opts.on('-p', '--preload', 'Preload Ruby toolchain and server binaries in docker') do |v|
+          @options[:preload] = v
+        end
+
+        opts.on('-s', '--script=SCRIPT', 'Test script to invoke') do |v|
+          @options[:script] = v
+        end
+
+        opts.on('-i', '--interactive', 'Interactive mode - disable per-test timeouts') do |v|
+          @options[:interactive] = v
+        end
+      end.parse!
+
+      @env = Hash[ARGV.map do |arg|
+        arg.split('=', 2)
+      end]
+
+      @env['RVM_RUBY'] ||= 'ruby-2.7'
+      unless ruby =~ /^j?ruby-/
+        raise "RVM_RUBY option is not in expected format: #{ruby}"
+      end
+
+      @env['MONGODB_VERSION'] ||= '4.4'
+    end
+
+    def create_dockerfile
+      template_path = File.join(File.dirname(__FILE__), '../../share/Dockerfile.erb')
+      result = ERB.new(File.read(template_path)).result(binding)
+      File.open(dockerfile_path, 'w') do |f|
+        f << result
+      end
+    end
+
+    def image_tag
+      options.fetch(:image_tag)
+    end
+
+    def dockerfile_path
+      options.fetch(:dockerfile_path)
+    end
+
+    def create_image
+      run_command(['docker', 'build',
+        '-t', image_tag,
+        '-f', dockerfile_path,
+        '.'])
+    end
+
+    BASE_TEST_COMMAND = %w(docker run -i --tmpfs /tmpfs:exec).freeze
+
+    def run_tests
+      run_command(BASE_TEST_COMMAND + tty_arg + extra_env + [image_tag] +
+        script.split(/\s+/))
+    end
+
+    def run_deployment
+      run_command(BASE_TEST_COMMAND + tty_arg + extra_env + [
+        '-e', %q`TEST_CMD=watch -x bash -c "ps awwxu |egrep 'mongo|ocsp'"`,
+        '-e', 'BIND_ALL=true',
+      ] + port_forwards + [image_tag] + script.split(/\s+/))
+    end
+
+    def tty_arg
+      tty = File.open('/dev/stdin') do |f|
+        f.isatty
+      end
+      if tty
+        %w(-t --init)
+      else
+        []
+      end
+    end
+
+    def extra_env
+      if @options[:extra_env]
+        @options[:extra_env].map do |k, v|
+          # Here the value must not be escaped
+          ['-e', "#{k}=#{v}"]
+        end.flatten
+      else
+        []
+      end
+    end
+
+    def port_forwards
+      args = (0...num_exposed_ports).map do |i|
+        host_port = @options[:mongo_only] + i
+        container_port = 27017 + i
+        ['-p', "#{host_port}:#{container_port}"]
+      end.flatten
+
+      if @env['OCSP_ALGORITHM'] && !@env['OCSP_VERIFIER']
+        args += %w(-p 8100:8100)
+      end
+
+      args
+    end
+
+    def run_command(cmd)
+      if pid = fork
+        Process.wait(pid)
+        unless $?.exitstatus == 0
+          raise "Process exited with code #{$?.exitstatus}"
+        end
+      else
+        exec(*cmd)
+      end
+    end
+
+    def distro
+      @options[:distro] || 'ubuntu1604'
+    end
+
+    BASE_IMAGES = {
+      'debian81' => 'debian:jessie',
+      'debian92' => 'debian:stretch',
+      'ubuntu1404' => 'ubuntu:trusty',
+      'ubuntu1604' => 'ubuntu:xenial',
+      'ubuntu1804' => 'ubuntu:bionic',
+      'rhel62' => 'centos:6',
+      'rhel70' => 'centos:7',
+    }.freeze
+
+    def base_image
+      BASE_IMAGES[distro] or raise "Unknown distro: #{distro}"
+    end
+
+    def ruby
+      @env['RVM_RUBY']
+    end
+
+    def ruby_head?
+      ruby == 'ruby-head'
+    end
+
+    def server_version
+      @env['MONGODB_VERSION']
+    end
+
+    def script
+      @options[:script] || options.fetch(:default_script)
+    end
+
+    def debian?
+      distro =~ /debian|ubuntu/
+    end
+
+    def preload?
+      !!@options[:preload]
+    end
+
+    def interactive?
+      !!@options[:interactive]
+    end
+
+    def project_lib_subdir
+      options.fetch(:project_lib_subdir)
+    end
+
+    def server_download_url
+      @server_download_url ||= ServerVersionRegistry.new(server_version, distro).download_url
+    end
+
+    def libmongocrypt_path
+      case distro
+      when /ubuntu1604/
+        "./ubuntu1604/nocrypto/lib64/libmongocrypt.so"
+      when /ubuntu1804/
+        "./ubuntu1804-64/nocrypto/lib64/libmongocrypt.so"
+      when /debian92/
+        "./debian92/nocrypto/lib64/libmongocrypt.so"
+      else
+        raise "This script does not support running FLE tests on #{distro}. Use ubuntu1604, ubuntu1804 or debian92 instead"
+      end
+    end
+
+    def expose?
+      !!@options[:mongo_only]
+    end
+
+    def fle?
+      %w(1 true yes).include?(@env['FLE']&.downcase)
+    end
+
+    def num_exposed_ports
+      case @env['TOPOLOGY'] || 'standalone'
+      when 'standalone'
+        1
+      when 'replica-set'
+        3
+      when 'sharded-cluster'
+        if @env['SINGLE_MONGOS']
+          1
+        else
+          2
+        end
+      end
+    end
+  end
+end

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

@@ -171,5 +171,21 @@ module Mrss
         end
       end
     end
+
+    def require_active_support
+      before(:all) do
+        if !SpecConfig.instance.active_support?
+          skip 'This test requires ActiveSupport; set WITH_ACTIVE_SUPPORT=1 in environment'
+        end
+      end
+    end
+
+    def no_active_support
+      before(:all) do
+        if SpecConfig.instance.active_support?
+          skip 'This test requires no ActiveSupport; unset WITH_ACTIVE_SUPPORT in environment'
+        end
+      end
+    end
   end
 end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+autoload :JSON, 'json'
+require 'open-uri'
+
+module Mrss
+  class ServerVersionRegistry
+    class Error < StandardError
+    end
+
+    class UnknownVersion < Error
+    end
+
+    class MissingDownloadUrl < Error
+    end
+
+    class BrokenDownloadUrl < Error
+    end
+
+    def initialize(desired_version, arch)
+      @desired_version, @arch = desired_version, arch
+    end
+
+    attr_reader :desired_version, :arch
+
+    def download_url
+      @download_url ||= begin
+        version, version_ok = detect_version(current_catalog)
+        if version.nil?
+          version, full_version_ok = detect_version(full_catalog)
+          version_ok ||= full_version_ok
+        end
+        if version.nil?
+          if version_ok
+            raise MissingDownloadUrl, "No downloads for version #{desired_version}"
+          else
+            raise UnknownVersion, "No version #{desired_version}"
+          end
+        end
+        dl = version['downloads'].detect do |dl|
+          dl['archive']['url'].index("enterprise-#{arch}") &&
+          dl['arch'] == 'x86_64'
+        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
+
+    def uri_open(*args)
+      if RUBY_VERSION < '2.5'
+        open(*args)
+      else
+        URI.open(*args)
+      end
+    end
+
+    def detect_version(catalog)
+      candidate_versions = catalog['versions'].select do |version|
+        version['version'].start_with?(desired_version) &&
+        !version['version'].include?('-')
+      end
+      version_ok = !candidate_versions.empty?
+      # Sometimes the download situation is borked and there is a release
+      # with no downloads... skip those.
+      version = candidate_versions.detect do |version|
+        !version['downloads'].empty?
+      end
+      # Allow RC releases if there isn't a GA release.
+      if version.nil?
+        candidate_versions = catalog['versions'].select do |version|
+          version['version'].start_with?(desired_version)
+        end
+        version_ok ||= !candidate_versions.empty?
+        version = candidate_versions.detect do |version|
+          !version['downloads'].empty?
+        end
+      end
+      [version, version_ok]
+    end
+
+    def current_catalog
+      @current_catalog ||= begin
+        JSON.load(uri_open('http://downloads.mongodb.org/current.json').read)
+      end
+    end
+
+    def full_catalog
+      @full_catalog ||= begin
+        JSON.load(uri_open('http://downloads.mongodb.org/full.json').read)
+      end
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 autoload :JSON, 'json'
 autoload :FileUtils, 'fileutils'
 autoload :Find, 'find'
@@ -78,10 +81,20 @@ module Mrss
     end
 
     def run
+      run_buckets(*buckets.keys)
+    end
+
+    def run_buckets(*buckets)
       FileUtils.rm_f(rspec_all_json_path)
 
+      buckets.each do |bucket|
+        if bucket && !self.buckets[bucket]
+          raise "Unknown bucket #{bucket}"
+        end
+      end
+      buckets = Hash[self.buckets.select { |k, v| buckets.include?(k) }]
+
       failed = []
-      buckets = self.buckets.dup
 
       priority_order.each do |category|
         if files = buckets.delete(category)

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mrss
+  module Utils
+
+    module_function def print_backtrace(dest=STDERR)
+      begin
+        hello world
+      rescue => e
+        dest.puts e.backtrace.join("\n")
+      end
+    end
+  end
+end

data/spec/shared/share/Dockerfile.erb

@@ -0,0 +1,231 @@
+# Python toolchain as of this writing is available on rhel62, debian92 and
+# ubuntu1604.
+#
+# To run rhel62 in docker, host system must be configured to emulate syscalls:
+# https://github.com/CentOS/sig-cloud-instance-images/issues/103
+
+<%
+
+python_toolchain_url = "https://s3.amazonaws.com//mciuploads/mongo-python-driver-toolchain/#{distro}/ba92de2700c04ee2d4f82c3ffdfc33105140cb04/mongo_python_driver_toolchain_#{distro.gsub('-', '_')}_ba92de2700c04ee2d4f82c3ffdfc33105140cb04_19_11_14_15_33_33.tar.gz"
+server_version = '4.3.3'
+server_url = "http://downloads.10gen.com/linux/mongodb-linux-x86_64-enterprise-#{distro}-#{server_version}.tgz"
+server_archive_basename = File.basename(server_url)
+server_extracted_dir = server_archive_basename.sub(/\.(tar\.gz|tgz)$/, '')
+
+toolchain_upper='291ba4a4e8297f142796e70eee71b99f333e35e1'
+
+ruby_toolchain_url = "http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-driver/ruby-toolchain-#{distro}-#{toolchain_upper}.tar.xz"
+#ruby_toolchain_url = "https://s3.amazonaws.com//mciuploads/mongo-ruby-toolchain/#{distro}/#{toolchain_upper}/mongo_ruby_driver_toolchain_#{distro.gsub('-', '_')}_patch_#{toolchain_upper}_#{toolchain_lower}.tar.gz"
+
+%>
+
+FROM <%= base_image %>
+
+<% if debian? %>
+
+  ENV DEBIAN_FRONTEND=noninteractive
+
+<% else %>
+
+  RUN echo assumeyes=1 |tee -a /etc/yum.conf
+
+<% end %>
+
+<% if ruby_head? %>
+
+  # To use current versions of mlaunch, Python 3.6+ is required.
+  # Most distros ship with older Pythons, therefore we need to install
+  # a newer Python from somewhere. This section installs the Python
+  # toolhcain which comes with recent Pythons.
+  # Alternatively, Ruby toolchain compiles its own copy of Python 3 but
+  # this is currently incomplete in that on older distros with old OpenSSL,
+  # the built Python has no ssl module and hence practically is unusable.
+  # Currently Ruby driver uses mtools-legacy which supports Python 2,
+  # avoiding this entire issue for the time being.
+
+  #RUN curl --retry 3 -fL <%= python_toolchain_url %> -o python-toolchain.tar.gz
+  #RUN tar -xC /opt -zf python-toolchain.tar.gz
+
+<% end %>
+
+<% if debian? %>
+
+  # zsh is not required for any scripts but it is a better interactive shell
+  # than bash.
+  # Ruby runtime dependencies: libyaml-0-2
+  # Compiling ruby libraries: gcc make
+  # Compiling pyhton packages: python2.7-dev
+  # JRuby: openjdk-8-jre-headless
+  # Server dependencies: libsnmp30 libcurl3/libcurl4
+  # Determining OS we are running on: lsb-release
+  # Kerberos testing: krb5-user
+  # Local Kerberos server: krb5-kdc krb5-admin-server
+  # Installing mlaunch from git: git
+  # ruby-head archive: bzip2
+  # nio4r on JRuby: libgmp-dev
+  # Snappy compression: libsnappy-dev
+  # nokogiri: zlib1g-dev
+  # Mongoid testing: tzdata shared-mime-info
+  # Mongoid application testing: nodejs (8.x or newer)
+  #
+  # We currently use Python 2-compatible version of mtools, which
+  # is installable via pip (which uses Python 2). All of the MongoDB
+  # distros have pip installed (but none as of this writing have pip3)
+  # therefore install python-pip in all configurations here.
+
+  <% packages = %w(
+    lsb-release bzip2 curl zsh
+    git make gcc libyaml-0-2 libgmp-dev zlib1g-dev libsnappy-dev
+    libsnmp30
+    krb5-user krb5-kdc krb5-admin-server libsasl2-dev libsasl2-modules-gssapi-mit
+    python-pip python2.7-dev python3-pip
+    tzdata shared-mime-info
+  ) %>
+
+  # ubuntu1404 only has openjdk-7-jre-headless
+  <% if distro !~ /ubuntu1404/ %>
+    <% packages << 'openjdk-8-jre-headless' %>
+  <% end %>
+
+  # ubuntu1404, ubuntu1604: libcurl3
+  # ubuntu1804: libcurl4
+  <% if distro =~ /ubuntu1804/ %>
+    <% packages << 'libcurl4' %>
+  <% else %>
+    <% packages << 'libcurl3' %>
+  <% end %>
+
+  <% if distro =~ /ubuntu1804/ %>
+    <% packages << 'nodejs' %>
+  <% end %>
+
+  RUN apt-get update && apt-get install -y <%= packages.join(' ') %>
+<% else %>
+
+  # Enterprise server: net-snmp
+  # lsb_release: redhat-lsb-core
+  # our runner scripts: which
+  # Ruby dependency: libyaml
+  # compiling python packages: gcc python-devel
+  # Kerberos tests: krb5-workstation + cyrus-sasl-devel to build the
+  # mongo_kerberos gem + cyrus-sasl-gssapi for authentication to work
+  # Local Kerberos server: krb5-server
+  # JRuby: java-1.8.0-openjdk
+  #
+  # Note: lacking cyrus-sasl-gssapi produces a cryptic message
+  # "SASL(-4): no mechanism available: No worthy mechs found"
+  # https://github.com/farorm/python-ad/issues/10
+
+  RUN yum install -y redhat-lsb-core which git gcc libyaml krb5-server \
+    krb5-workstation cyrus-sasl-devel cyrus-sasl-gssapi java-1.8.0-openjdk \
+    net-snmp
+
+  <% if distro =~ /rhel6/ %>
+
+    # RHEL 6 ships with Python 2.6.
+
+    RUN yum install -y centos-release-scl && \
+      yum install -y python27-python python27-python-devel
+    ENV PATH=/opt/rh/python27/root/usr/bin:$PATH \
+      LD_LIBRARY_PATH=/opt/rh/python27/root/usr/lib64
+
+  <% else %>
+
+    RUN yum install -y python-devel
+
+  <% end %>
+
+<% end %>
+
+<% if preload? %>
+
+  # Current virtualenv fails with
+  # https://github.com/pypa/virtualenv/issues/1630
+  RUN python2 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]'
+
+  RUN pip --version && \
+    pip install mtools-legacy[mlaunch]
+
+  <% if @env.fetch('MONGODB_VERSION') >= '4.4' %>
+    RUN python3 -mpip install asn1crypto oscrypto flask
+  <% end %>
+
+  <% unless ruby_head? %>
+
+    RUN curl --retry 3 -fL <%= ruby_toolchain_url %> |tar -xC /opt -Jf -
+    ENV PATH=/opt/rubies/<%= ruby %>/bin:$PATH \
+      USE_OPT_TOOLCHAIN=1
+    #ENV PATH=/opt/rubies/python/3/bin:$PATH
+
+  <% end %>
+
+  <% if distro =~ /rhel|ubuntu1604/ %>
+
+    # Ubuntu 12.04 ships pip 1.0 which is ancient and does not work.
+    #
+    # Ubuntu 16.04 apparently also ships a pip that does not work:
+    # https://stackoverflow.com/questions/37495375/python-pip-install-throws-typeerror-unsupported-operand-types-for-retry
+    # Potentially this only affects environments with less than ideal
+    # connectivity (or, perhaps, when python package registry is experiencing
+    # availability issues) when pip must retry to install packages.
+    #
+    # rhel apparently does not package pip at all in core repoitories,
+    # therefore install it the manual way.
+    #
+    # https://pip.pypa.io/en/stable/installing/
+    RUN curl --retry 3 -fL https://bootstrap.pypa.io/pip/2.7/get-pip.py | python
+
+  <% end %>
+
+  RUN curl --retry 3 -fL <%= server_download_url %> |tar xzf - && \
+    mv mongo*/ /opt/mongodb
+  ENV USE_OPT_MONGODB=1 USE_SYSTEM_PYTHON_PACKAGES=1
+
+<% end %>
+
+WORKDIR /app
+
+<% if preload? && !ruby_head? %>
+
+  COPY Gemfile .
+  COPY gemfiles gemfiles
+  COPY *.gemspec .
+  COPY lib/<%= project_lib_subdir %>/version.rb lib/<%= project_lib_subdir %>/version.rb
+  RUN bundle install
+  COPY .evergreen/patch-debuggers .evergreen/patch-debuggers
+  RUN .evergreen/patch-debuggers /opt/rubies
+
+<% end %>
+
+<% if fle? %>
+  RUN curl --retry 3 -fLo libmongocrypt-all.tar.gz "https://s3.amazonaws.com/mciuploads/libmongocrypt/all/master/latest/libmongocrypt-all.tar.gz"
+  RUN tar xf libmongocrypt-all.tar.gz
+
+  <%= "ENV LIBMONGOCRYPT_PATH #{libmongocrypt_path}" %>
+<% end %>
+
+ENV MONGO_ORCHESTRATION_HOME=/tmpfs \
+  PROJECT_DIRECTORY=/app \
+  <%= @env.map { |k, v| %Q`#{k}="#{v.gsub('$', "\\$").gsub('"', "\\\"")}"` }.join(" \\\n  ") %>
+
+<% if interactive? %>
+  ENV INTERACTIVE=1
+<% end %>
+
+COPY . .
+
+<% if expose? %>
+
+  <% ports = [] %>
+
+  <% 0.upto(num_exposed_ports-1) do |i| %>
+    <% ports << 27017 + i %>
+  <% end %>
+
+  <% if @env['OCSP_ALGORITHM'] %>
+    <% ports << 8100 %>
+  <% end %>
+
+  EXPOSE <%= ports.map(&:to_s).join(' ') %>
+
+<% end %>