mongoid 5.4.1 → 7.4.0

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+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,
+      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|
+          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
+      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 = []
+
+      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
+      if randomize?
+        cmd += %W(--order rand:#{seed})
+      end
+
+      begin
+        puts "Running #{cmd.join(' ')}"
+        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')
+      # 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
+      # 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/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,339 @@
+# 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)$/, '')
+
+# When changing, also update the hash in shlib/set_env.sh.
+TOOLCHAIN_VERSION='219833abad4d9d3bf43c0fef101a8ca082ac4ae9'
+
+def ruby_toolchain_url(ruby)
+  "http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-driver/#{TOOLCHAIN_VERSION}/#{distro}/#{ruby}.tar.xz"
+end
+
+#ruby_toolchain_url = "https://s3.amazonaws.com//mciuploads/mongo-ruby-toolchain/#{distro}/#{TOOLCHAIN_VERSION}/mongo_ruby_driver_toolchain_#{distro.gsub('-', '_')}_patch_#{TOOLCHAIN_VERSION}_#{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-jdk-headless
+  # Server dependencies: libsnmp30 libcurl3/libcurl4
+  # Determining OS we are running on: lsb-release
+  # Load balancer testing: haproxy
+  # 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)
+  # Test suite: procps for ps (to kill JRubies)
+  #
+  # 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(
+    procps lsb-release bzip2 curl zsh
+    git make gcc libyaml-0-2 libgmp-dev zlib1g-dev libsnappy-dev
+    krb5-user krb5-kdc krb5-admin-server libsasl2-dev libsasl2-modules-gssapi-mit
+    haproxy
+    python3-pip
+    tzdata shared-mime-info
+  ) %>
+
+  <% if distro =~ /ubuntu1404/ %>
+    # For building python & setuptools
+    <% packages += %w(libssl-dev unzip) %>
+  <% end %>
+
+  <% if distro !~ /ubuntu2004/ %>
+    <% packages += %w(python2.7-dev) %>
+  <% end %>
+
+  <% if distro =~ /ubuntu2004/ %>
+    <% packages << 'libsnmp35' %>
+  <% else %>
+    <% packages << 'libsnmp30' %>
+  <% end %>
+
+  <% if distro !~ /ubuntu2004/ %>
+    <% packages << 'python-pip' %>
+  <% end %>
+
+  <% if distro =~ /debian10/ %>
+    <% packages << 'openjdk-11-jdk-headless' %>
+  <% elsif distro =~ /ubuntu1404/ %>
+    # Ubuntu 14.04 only has openjdk 7, this is too old to be useful
+  <% else %>
+    <% packages << 'openjdk-8-jdk-headless' %>
+  <% end %>
+
+  # ubuntu1404, ubuntu1604: libcurl3
+  # ubuntu1804, ubuntu2004, debian10: libcurl4
+  <% if distro =~ /ubuntu1804|ubuntu2004|debian10/ %>
+    <% packages << 'libcurl4' %>
+  <% else %>
+    <% packages << 'libcurl3' %>
+  <% end %>
+
+  <% if distro =~ /ubuntu1804/ %>
+    <% packages << 'nodejs' %>
+  <% end %>
+
+  <% if distro =~ /ubuntu2004/ %>
+    <% packages += %w(ruby ruby2.7 bundler python2 python2-dev) %>
+  <% end %>
+
+  RUN apt-get update && apt-get install -y <%= packages.join(' ') %>
+<% else %>
+
+  <% if distro =~ /rhel6/ %>
+  
+    # CentOS 6 is dead - to use it retrieve the packages from vault:
+    # https://stackoverflow.com/questions/53562691/error-cannot-retrieve-repository-metadata-repomd-xml-for-repository-base-pl
+  
+    <%
+      
+      cfg = <<-CFG
+[base]
+name=CentOS-$releasever - Base
+#mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=os
+#baseurl=http://mirror.centos.org/centos/$releasever/os/$basearch/
+baseurl=http://vault.centos.org/6.10/os/x86_64/
+gpgcheck=1
+gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-6
+CFG
+
+    %>
+  
+    RUN printf "<%= cfg.gsub("\n", "\\n") %>" >/etc/yum.repos.d/CentOS-Base.repo
+  
+  <% end %>
+  
+  # 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 python3
+
+  <% 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? %>
+
+  <% if distro =~ /ubuntu1404/ %>
+    
+    # I couldn't find a prebuilt package of anything more recent than 2.7.6
+    # for 14.04.
+    RUN curl --retry 3 -fL https://www.python.org/ftp/python/2.7.16/Python-2.7.16.tar.xz | \
+      tar xfJ - && \
+      cd Python-2.7.16 && \
+      ./configure && \
+      nice make -j4 && \
+      make install && \
+      cd .. && rm -rf Python-2.7.16
+      
+    ENV PATH=/usr/local/bin:$PATH
+    
+    RUN curl --retry 3 -fL -o setuptools-44.1.1.zip https://files.pythonhosted.org/packages/b2/40/4e00501c204b457f10fe410da0c97537214b2265247bc9a5bc6edd55b9e4/setuptools-44.1.1.zip && \
+      unzip setuptools-44.1.1.zip && \
+      cd setuptools-44.1.1 && \
+      python setup.py install && \
+      cd .. && rm -rf setuptools-44.1.1
+
+  <% end%>
+
+  <% if true || 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 | python2
+
+  <% end %>
+
+  # Current virtualenv fails with
+  # https://github.com/pypa/virtualenv/issues/1630
+  <% if distro =~ /ubuntu2004/ %>
+    RUN python3 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]'
+  <% else %>
+    RUN python2 -m pip install 'virtualenv<20' 'mtools-legacy[mlaunch]'
+  <% end %>
+
+  RUN pip --version && \
+    pip install mtools-legacy[mlaunch]
+
+  <% if @env.fetch('MONGODB_VERSION') >= '4.4' %>
+    # ubuntu1604 installs MarkupSafe 0.0.0 here instead of 2.0.0+
+    # as specified by dependencies, causing OCSP mock to not work.
+    RUN python3 -mpip install asn1crypto oscrypto flask --upgrade
+  <% end %>
+
+  # FLE is tested against 4.0+ servers.
+  <% if @env.fetch('MONGODB_VERSION') >= '4.0' %>
+    # Requirements in drivers-evergreen-tools:
+    # boto3~=1.19 cryptography~=3.4.8 pykmip~=0.10.0
+    # cryptography does not install due to lacking setuptools_rust
+    # (either that version or anything that isn't part of system packages)
+    RUN python3 -mpip install boto3~=1.19 cryptography pykmip~=0.10.0
+  <% end %>
+
+  <% unless ruby_head? || system_ruby? %>
+
+    RUN curl --retry 3 -fL <%= ruby_toolchain_url(ruby) %> |tar -xC /opt -Jf -
+    ENV PATH=/opt/rubies/<%= ruby %>/bin:$PATH \
+      USE_OPT_TOOLCHAIN=1
+    #ENV PATH=/opt/rubies/python/3/bin:$PATH
+
+  <% 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 %>
+
+<% if distro =~ /debian|ubuntu/ %>
+  # mkdir was moved from /usr/bin to /bin and MongoDB's distros
+  # apparently keep using the old location.
+  # This definitely affects debian10.
+  # https://stackoverflow.com/questions/64653051/make-usr-bin-mkdir-command-not-found-during-gem-install-nokogiri-in-ubuntu
+  RUN test -f /usr/bin/mkdir || ln -s /bin/mkdir /usr/bin/mkdir
+<% 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
+  <% if system_ruby? %>
+    # Running under docker with root access
+    RUN .evergreen/patch-debuggers /var/lib/gems
+  <% else %>
+    RUN .evergreen/patch-debuggers /opt/rubies
+  <% end %>
+
+<% end %>
+
+<% if fle? %>
+  RUN curl --retry 3 -fL "https://s3.amazonaws.com/mciuploads/libmongocrypt/all/master/latest/libmongocrypt-all.tar.gz" |tar zxf -
+
+  <%= "ENV LIBMONGOCRYPT_PATH #{libmongocrypt_path}" %>
+<% end %>
+
+<% if preload? %>
+  ENV DOCKER_PRELOAD=1
+<% 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 %>

data/spec/shared/share/haproxy-1.conf

@@ -0,0 +1,16 @@
+# Modeled after
+# https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/run-load-balancer.sh
+
+defaults
+  mode tcp
+  timeout connect 7s
+  timeout client 55s
+  timeout server 55s
+
+frontend mongos_frontend
+  bind *:27017
+  use_backend mongos_backend
+
+backend mongos_backend
+  mode tcp
+  server mongos_one 127.0.0.1:27117 check

data/spec/shared/share/haproxy-2.conf

@@ -0,0 +1,17 @@
+# Modeled after
+# https://github.com/mongodb-labs/drivers-evergreen-tools/blob/master/.evergreen/run-load-balancer.sh
+
+defaults
+  mode tcp
+  timeout connect 7s
+  timeout client 55s
+  timeout server 55s
+
+frontend mongos_frontend
+  bind *:27017
+  use_backend mongos_backend
+
+backend mongos_backend
+  mode tcp
+  server mongos_one 127.0.0.1:27117 check
+  server mongos_two 127.0.0.1:27118 check

data/spec/shared/shlib/distro.sh

@@ -0,0 +1,74 @@
+detected_distro=
+
+host_distro() {
+  if test -z "$detected_distro"; then
+    detected_distro=`_detect_distro`
+  fi
+  echo "$detected_distro"
+}
+
+_detect_distro() {
+  local distro
+  distro=
+  if test -f /etc/debian_version; then
+    # Debian or Ubuntu
+    if test "`uname -m`" = aarch64; then
+      release=`lsb_release -rs |tr -d .`
+      distro="ubuntu$release"-arm
+    elif lsb_release -is |grep -q Debian; then
+      release=`lsb_release -rs |tr -d .`
+      # In docker, release is something like 9.11.
+      # In evergreen, release is 9.2.
+      release=`echo $release |sed -e 's/^9.*/92/'`
+      distro="debian$release"
+    elif lsb_release -is |grep -q Ubuntu; then
+      if test "`uname -m`" = ppc64le; then
+        release=`lsb_release -rs |tr -d .`
+        distro="ubuntu$release-ppc"
+      else
+        release=`lsb_release -rs |tr -d .`
+        distro="ubuntu$release"
+      fi
+    else
+      echo 'Unknown Debian flavor' 1>&2
+      exit 1
+    fi
+  elif lsb_release -is |grep -qi suse; then
+    if test "`uname -m`" = s390x; then
+      release=`lsb_release -rs |sed -e 's/\..*//'`
+      distro="suse$release-s390x"
+    else
+      echo 'Unknown Suse arch' 1>&2
+      exit 1
+    fi
+  elif test -f /etc/redhat-release; then
+    # RHEL or CentOS
+    if test "`uname -m`" = s390x; then
+      distro=rhel72-s390x
+    elif test "`uname -m`" = ppc64le; then
+      distro=rhel71-ppc
+    elif lsb_release >/dev/null 2>&1; then
+      if lsb_release -is |grep -q RedHat; then
+        release=`lsb_release -rs |tr -d .`
+        distro="rhel$release"
+      elif lsb_release -is |grep -q CentOS; then
+        release=`lsb_release -rs |cut -c 1 |sed -e s/7/70/ -e s/6/62/ -e s/8/80/`
+        distro="rhel$release"
+      else
+        echo 'Unknown RHEL flavor' 1>&2
+        exit 1
+      fi
+    else
+      echo lsb_release missing, using /etc/redhat-release 1>&2
+      release=`grep -o 'release [0-9]' /etc/redhat-release |awk '{print $2}'`
+      release=`echo $release |sed -e s/7/70/ -e s/6/62/ -e s/8/80/`
+      distro=rhel$release
+    fi
+  else
+    lsb_release -a
+    echo 'Unknown distro' 1>&2
+    exit 1
+  fi
+  echo "Detected distro: $distro" 1>&2
+  echo $distro
+}