bson 5.0.2 → 5.1.0

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

@@ -0,0 +1,113 @@
+# 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.sub(/-arm$/, '')
+    end
+
+    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)
+        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'] == target_arch
+        end
+        unless dl
+          raise MissingDownloadUrl, "No download for #{arch} for #{version['version']}"
+        end
+        url = dl['archive']['url']
+      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/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

@@ -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,37 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mrss
+  module Utils
+    extend self
+
+    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

data/spec/shared/lib/tasks/candidate.rake

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative '../mrss/release/candidate'
+
+namespace :candidate do
+  desc 'Initialize a new product.yml file'
+  task :init do
+    Mrss::Release::ProductData.init!
+    puts "product.yml file created"
+  end
+
+  desc 'Print the release notes for the next candidate release'
+  task :preview do
+    Mrss::Release::Candidate.instance do |candidate|
+      # load the pending changes before bumping the version, since it
+      # depends on the value of the current version.
+      candidate.pending_changes
+      candidate.bump_version
+      puts candidate.release_notes
+    end
+  end
+
+  desc 'List the pull requests to be included in the next release'
+  task :prs do
+    Mrss::Release::Candidate.instance.decorated_prs.each do |pr|
+      print "\##{pr['number']}[#{pr['type-code']}] "
+      print "#{pr['jira']} " if pr['jira']
+      puts pr['short-title']
+    end
+  end
+
+  desc 'Create a new branch and pull request for the candidate'
+  task create: :check_branch_status do
+    Mrss::Release::Candidate.instance do |candidate|
+      origin = `git config get remote.origin.url`
+      match = origin.match(/:(.*?)\//) or raise "origin url is not in expected format: #{origin.inspect}"
+      user = match[1]
+
+      puts 'gathering candidate info and bumping version...'
+      candidate.bump_version!
+
+      puts 'writing release notes to /tmp/pr-body.md...'
+      File.write('/tmp/pr-body.md', candidate.release_notes)
+
+      sh 'git', 'checkout', '-b', candidate.branch_name
+      sh 'git', 'commit', '-am', "Bump version to #{candidate.product.version}"
+      sh 'git', 'push', 'origin', candidate.branch_name
+
+      sh 'gh', 'pr', 'create',
+           '--head', "#{user}:#{candidate.branch_name}",
+           '--base', candidate.product.base_branch,
+           '--title', "Release candidate for #{candidate.product.version}",
+           '--label', 'release-candidate',
+           '--body-file', '/tmp/pr-body.md'
+    end
+  end
+
+  # Ensures the current branch is up-to-date with no uncommitted changes
+  task :check_branch_status do
+    sh 'git pull >/dev/null', verbose: false
+    changes = `git status --short --untracked-files=no`.strip
+    abort "There are uncommitted changes. Commit (or revert) the changes and try again." if changes.length > 0
+  end
+end