bson 5.0.2 → 5.1.0

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

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mrss
+  module LiteConstraints
+
+    # Constrain tests that use TimeoutInterrupt to MRI (and Unix).
+    def require_mri
+      before(:all) do
+        unless SpecConfig.instance.mri?
+          skip "MRI required, we have #{SpecConfig.instance.platform}"
+        end
+      end
+    end
+
+    def require_jruby
+      before(:all) do
+        unless BSON::Environment.jruby?
+          skip "JRuby required, we have #{SpecConfig.instance.platform}"
+        end
+      end
+    end
+
+    # This is for marking tests that fail on JRuby that should
+    # in principle work (as opposed to being fundamentally incompatible
+    # with JRuby).
+    # Often times these failures happen only in Evergreen.
+    def fails_on_jruby(version=nil)
+      before(:all) do
+        if BSON::Environment.jruby?
+          if version
+            min_parts = version.split('.').map(&:to_i)
+            actual_parts = JRUBY_VERSION.split('.').map(&:to_i)[0...min_parts.length]
+            actual = actual_parts.join('.')
+            if actual <= version
+              skip "Fails on jruby through #{version}"
+            end
+          else
+            skip "Fails on jruby"
+          end
+        end
+      end
+    end
+
+    # Indicates that the respective test uses the internet in some capacity,
+    # for example the test resolves SRV DNS records.
+    def require_external_connectivity
+      before(:all) do
+        if ENV['EXTERNAL_DISABLED']
+          skip "Test requires external connectivity"
+        end
+      end
+    end
+
+    def require_mongo_kerberos
+      before(:all) do
+        # TODO Use a more generic environment variable name if/when
+        # Mongoid tests get Kerberos configurations.
+        unless %w(1 yes true).include?(ENV['MONGO_RUBY_DRIVER_KERBEROS']&.downcase)
+          skip 'Set MONGO_RUBY_DRIVER_KERBEROS=1 in environment to run Kerberos unit tests'
+        end
+        require 'mongo_kerberos'
+      end
+    end
+
+    def require_linting
+      before(:all) do
+        unless Mongo::Lint.enabled?
+          skip "Linting is not enabled"
+        end
+      end
+    end
+
+    # Some tests will fail if linting is enabled:
+    # 1. Tests that pass invalid options to client, etc. which the linter
+    #    rejects.
+    # 2. Tests that set expectations on topologies, server descriptions, etc.
+    #    (since setting expectations requires mutating said objects, and when
+    #    linting is on those objects are frozen).
+    def require_no_linting
+      before(:all) do
+        if Mongo::Lint.enabled?
+          skip "Linting is enabled"
+        end
+      end
+    end
+
+    def require_libmongocrypt
+      before(:all) do
+        # 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']
+          skip 'Test requires libmongocrypt to not be configured'
+        end
+      end
+    end
+
+    def require_aws_auth
+      before(:all) do
+        unless (ENV['AUTH'] || '') =~ /^aws/
+          skip 'This test requires AUTH=aws* and an appropriately configured runtime environment'
+        end
+      end
+    end
+
+    def require_ec2_host
+      before(:all) do
+        if $have_aws.nil?
+          $have_aws = begin
+            require 'open-uri'
+            begin
+              Timeout.timeout(3.81) do
+                URI.parse('http://169.254.169.254/latest/meta-data/profile').open.read
+              end
+              true
+            # When trying to use the EC2 metadata endpoint on ECS:
+            # Errno::EINVAL: Failed to open TCP connection to 169.254.169.254:80 (Invalid argument - connect(2) for "169.254.169.254" port 80)
+            rescue Timeout::Error, Errno::ETIMEDOUT, Errno::EINVAL, OpenURI::HTTPError => $aws_error
+              false
+            end
+          end
+        end
+        unless $have_aws
+          skip "EC2 instance metadata is not available - assuming not running on an EC2 instance: #{$aws_error.class}: #{$aws_error}"
+        end
+      end
+    end
+
+    def require_stress
+      before(:all) do
+        if !SpecConfig.instance.stress?
+          skip 'Set STRESS=1 in environment to run stress tests'
+        end
+      end
+    end
+
+    def require_fork
+      before(:all) do
+        if !SpecConfig.instance.fork?
+          skip 'Set FORK=1 in environment to run fork tests'
+        end
+      end
+    end
+
+    def require_ocsp
+      before(:all) do
+        if !SpecConfig.instance.ocsp?
+          skip 'Set OCSP=1 in environment to run OCSP tests'
+        end
+      end
+    end
+
+    def require_ocsp_verifier
+      before(:all) do
+        if !SpecConfig.instance.ocsp_verifier?
+          skip 'Set OCSP_VERIFIER=1 in environment to run OCSP verifier tests'
+        end
+      end
+    end
+
+    def require_ocsp_connectivity
+      before(:all) do
+        if !SpecConfig.instance.ocsp_connectivity?
+          skip 'Set OCSP_CONNECTIVITY=pass or OCSP_CONNECTIVITY=fail in environment to run OCSP connectivity tests'
+        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
+
+    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/release/candidate.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative 'product_data'
+
+module Mrss
+  module Release
+    class Candidate
+      # Release note section titles, by pr type
+      SECTION_TITLE = {
+        bcbreak: "Breaking Changes",
+        feature: "New Features",
+        bug: "Bug Fixes",
+      }.freeze
+
+      # GitHub labels
+      BCBREAK = 'bcbreak'
+      FEATURE = 'feature'
+      BUG = 'bug'
+      PATCH = 'patch'
+
+      def self.instance
+        @instance ||= new
+
+        yield @instance if block_given?
+
+        @instance
+      end
+
+      def product
+        @product ||= ProductData.new
+      end
+
+      def bump_version
+        product.bump_version(release_type)
+      end
+
+      def bump_version!
+        product.bump_version!(release_type)
+      end
+
+      def branch_name
+        @branch_name ||= "rc-#{product.version}"
+      end
+
+      # return a string of commit names since the last release
+      def pending_changes
+        @changes ||= begin
+                       range = product.tag_exists? ? "#{product.tag_name}.." : ""
+                       `git log --pretty=format:"%s" #{range}`
+                     end
+      end
+
+      # return a list of PR numbers since the last release
+      def pending_pr_numbers
+        @pending_pr_numbers ||= pending_changes.
+          lines.
+          map { |line| line.match(/\(#(\d+)\)$/).then { |m| m && m[1] } }.
+          compact.
+          sort.reverse
+      end
+
+      # return a JSON string of PR data
+      def pending_pr_dump
+        @pending_pr_dump ||= `gh pr list --state all --limit 256 --json number,title,labels,url,body --jq 'map(select([.number] | inside([#{pending_pr_numbers.join(',')}]))) | sort_by(.number)'`
+      end
+
+      # return a list of PR data since the last release
+      def pending_prs
+        @pending_prs ||= JSON.parse(pending_pr_dump)
+      end
+
+      # return a list of pending prs with additional attributes (summary,
+      # short title, jira issue number).
+      def decorated_prs
+        @decorated_prs ||= pending_prs.map do |pr|
+                             jira_issue, pr_title = split_pr_title(pr)
+                             summary = extract_summary(pr)
+                             type = pr_type(pr)
+                             type_code = pr_type_code(type)
+                             patch_flag = pr_patch_flag?(pr)
+
+                             pr.merge('jira' => jira_issue,
+                                      'short-title' => pr_title,
+                                      'summary' => summary,
+                                      'type' => type,
+                                      'type-code' => type_code,
+                                      'patch' => patch_flag)
+                           end
+      end
+
+      # return a hash of decorated prs grouped by :bcbreak, :feature, or :bug
+      def prs_by_type
+        @prs_by_type ||= decorated_prs.group_by { |pr| pr['type'] }
+      end
+
+      # returns 'major', 'minor', or 'patch', depending on the presence of
+      # (respectively) :bcbreak, :feature, or :bug labels.
+      #
+      # If the RELEASE environment variable is set, its value will be used
+      # directly, ignoring whatever PR labels might exist.
+      def release_type
+        @release_type ||= if ENV['RELEASE']
+                            ENV['RELEASE']
+                          elsif prs_by_type[:bcbreak]
+                            'major'
+                          elsif prs_by_type[:feature] && prs_by_type[:feature].any? { |pr| !pr['patch'] }
+                            'minor'
+                          else
+                            'patch'
+                          end
+      end
+
+      # returns the generated release notes as a string
+      def release_notes
+        @release_notes ||= release_notes_intro +
+          %i[ bcbreak feature bug ].
+            flat_map { |type| release_notes_for_type(type) }.join("\n")
+      end
+
+      private
+
+      # returns an array of strings, each string representing a single line
+      # in the release notes for the PR's of the given type.
+      def release_notes_for_type(type)
+        return [] unless prs_by_type[type]
+
+        [].tap do |lines|
+          lines << "\# #{SECTION_TITLE[type]}"
+          lines << ''
+
+          prs = prs_by_type[type]
+          summarized, unsummarized = prs.partition { |pr| pr['summary'] }
+
+          summarized.each do |pr|
+            header = [ '### ' ]
+            header << "[#{pr['jira']}](#{jira_url(pr['jira'])}) " if pr['jira']
+            header << "#{pr['short-title']} ([PR](#{pr['url']}))"
+            lines << header.join
+            lines << ''
+            lines << pr['summary']
+            lines << ''
+          end
+
+          if summarized.any? && unsummarized.any?
+            lines << ''
+            lines << [ '### Other ', SECTION_TITLE[type] ].join
+            lines << ''
+          end
+
+          unsummarized.each do |pr|
+            line = [ '* ' ]
+            line << "[#{pr['jira']}](#{jira_url(pr['jira'])}) " if pr['jira']
+            line << "#{pr['short-title']} ([PR](#{pr['url']}))"
+
+            lines << line.join
+          end
+
+          lines << ''
+        end
+      end
+
+      # returns the URL of for the given jira issue
+      def jira_url(issue)
+        "https://jira.mongodb.org/browse/#{issue}"
+      end
+
+      # assumes a pr title in the format of "JIRA-1234 PR Title (#1234)",
+      # returns a tuple of [ jira-issue, title ], where jira-issue may be
+      # blank (if no jira issue is in the title).
+      def split_pr_title(pr)
+        title = pr['title'].gsub(/\(#\d+\)/, '').strip
+
+        if title =~ /^(\w+-\d+) (.*)$/
+          [ $1, $2 ]
+        else
+          [ nil, title ]
+        end
+      end
+
+      # extracts the summary section from the pr and returns it (or returns nil
+      # if no summary section is detected)
+      def extract_summary(pr)
+        summary = []
+        accumulating = false
+        level = nil
+
+        pr['body'].lines.each do |line|
+          # a header of any level titled "summary" will begin the summary
+          if !accumulating && line =~ /^(\#+)\s+summary\s+$/i
+            accumulating = true
+            level = $1.length
+
+          # a header of any level less than or equal to the summary header's
+          # level will end the summary
+          elsif accumulating && line =~ /^\#{1,#{level}}\s+/
+            break
+
+          # otherwise, the line is part of the summary
+          elsif accumulating
+            summary << line
+          end
+        end
+
+        summary.any? ? summary.join.strip : nil
+      end
+
+      # Returns a symbol (:bcbreak, :feature, or :bug) that identifies the
+      # type of this PR that would most strongly influence what type of release
+      # it requires.
+      def pr_type(pr)
+        if pr['labels'].any? { |l| l['name'] == BCBREAK }
+          :bcbreak
+        elsif pr['labels'].any? { |l| l['name'] == FEATURE }
+          :feature
+        elsif pr['labels'].any? { |l| l['name'] == BUG }
+          :bug
+        else
+          nil
+        end
+      end
+
+      # `true` if the `patch` label is applied to the PR. This is used to
+      # indicate that a "feature" PR should be treated as a patch, for
+      # determining the release type only.
+      def pr_patch_flag?(pr)
+        pr['labels'].any? { |l| l['name'] == PATCH }
+      end
+
+      def pr_type_code(type)
+        case type
+        when :bcbreak then 'x'
+        when :feature then 'f'
+        when :bug     then 'b'
+        else '?'
+        end
+      end
+
+      def series
+        major, minor, = product.version_parts
+
+        case release_type
+        when 'minor' then 
+          "#{major}.x"
+        when 'patch' then
+          "#{major}.#{minor}.x"
+        end
+      end
+
+      # Return a string containing the markdown-formatted intro block for
+      # the release notes of this candidate.
+      def release_notes_intro
+        release_description = case release_type
+                              when 'major' then 'major release'
+                              when 'minor' then "minor release in the #{series} series"
+                              when 'patch' then "patch release in the #{series} series"
+                              end
+
+        <<~INTRO
+          The MongoDB Ruby team is pleased to announce version #{product.version}
+          of the `#{product.package}` gem - #{product.description}.
+          This is a new #{release_description} of #{product.name}.
+
+          Install this release using [RubyGems](https://rubygems.org/) via the command line as follows: 
+
+          ~~~
+          gem install -v #{product.version} #{product.package}
+          ~~~
+
+          Or simply add it to your `Gemfile`:
+
+          ~~~
+          gem '#{product.package}', '#{product.version}'
+          ~~~
+
+          Have any feedback? Click on through to MongoDB's JIRA and
+          [open a new ticket](#{product.jira_project_url}) to let us know what's on your mind 🧠.
+
+        INTRO
+      end
+    end
+  end
+end

data/spec/shared/lib/mrss/release/product_data.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Mrss
+  module Release
+    class ProductData
+      FILE_PATH = 'product.yml'
+
+      def self.init!
+        if File.exist?(FILE_PATH)
+          raise "#{FILE_PATH} already exists; refusing to overwrite it"
+        end
+
+        initial_data = {
+          'name' => 'Product Name',
+          'description' => 'a very short description of the product',
+          'package' => 'product_package',
+          'jira' => 'https://url.to.jira/project',
+          'version' => { 'number' => '1.0.0',
+                         'file' => 'path/to/version.rb' }
+        }
+
+        File.write(FILE_PATH, initial_data.to_yaml)
+      end
+
+      def initialize
+        @hash = YAML.load_file(FILE_PATH)
+      end
+
+      def save_product_file!
+        File.write(FILE_PATH, @hash.to_yaml)
+      end
+
+      def rewrite_version_file!
+        version_module = File.read(version_file)
+        new_module = version_module.
+          sub(/^(\s*)(VERSION\s*=\s*).*$/) { "#{$1}#{$2}#{quoted_version}" }
+        File.write(version_file, new_module)
+      end
+
+      def version
+        @hash['version']['number']
+      end
+
+      def quoted_version
+        if version.include?("'")
+          version.inspect
+        else
+          "'#{version}'"
+        end
+      end
+
+      def version=(number)
+        @hash['version']['number'] = number
+      end
+
+      # returns an array of [ major, minor, patch, suffix ].
+      #
+      # each element will be returned as a String.
+      def version_parts
+        version.split(/\./, 4)
+      end
+
+      # bump the version according to the given release type:
+      #
+      #  'major' -> increment major component, zero the others
+      #  'minor' -> increment minor component, zero the patch
+      #  'patch' -> increment the patch component
+      def bump_version(release)
+        major, minor, patch, suffix = version_parts
+
+        case release
+        when 'major' then
+          major = major.to_i + 1
+          minor = patch = 0
+        when 'minor'
+          minor = minor.to_i + 1
+          patch = 0
+        when 'patch'
+          patch = patch.to_i + 1
+        else
+          raise ArgumentError, "invalid release type: #{release.inspect}"
+        end
+
+        self.version = [ major, minor, patch ].join('.')
+      end
+
+      # Invokes `#bump_version`, and then saves the new version to the
+      # product.yml file and to the version.rb file.
+      def bump_version!(release)
+        bump_version(release)
+        save_product_file!
+        rewrite_version_file!
+      end
+
+      def version_file
+        @hash['version']['file']
+      end
+
+      def name
+        @hash['name']
+      end
+
+      # The description is intended to be used in places where it can be
+      # appended to the end of a sentence, e.g.
+      #
+      #   "We just released #{product.name} - #{product.description}!"
+      #
+      # Markdown formatting is allowed (even expected).
+      def description
+        @hash['description']
+      end
+
+      def package
+        @hash['package']
+      end
+
+      def jira_project_url
+        @hash['jira']
+      end
+
+      def tag_name
+        "v#{version}"
+      end
+
+      def tag_exists?(tag = tag_name)
+        `git tag -l #{tag}`.strip == tag
+      end
+
+      def branch_exists?(branch)
+        `git branch -l #{branch}`.strip == branch
+      end
+
+      def base_branch
+        @base_branch ||= begin
+                           major, minor, = version_parts
+                           branch = "#{major}.#{minor}-stable"
+                           branch_exists?(branch) ? branch : 'master'
+                         end
+      end
+    end
+  end
+end