Rakefile

# frozen_string_literal: true

require 'bundler'
require 'rspec/core/rake_task'

load 'spec/shared/lib/tasks/candidate.rake' if File.exist?('./spec/shared/lib/tasks/candidate.rake')

ROOT = File.expand_path(File.join(File.dirname(__FILE__)))

$LOAD_PATH << File.join(ROOT, 'spec/shared/lib')

# rubocop:disable Style/RegexpLiteral
CLASSIFIERS = [
  [ %r{^mongo/server}, :unit_server ],
  [ %r{^mongo}, :unit ],
  [ %r{^kerberos}, :unit ],
  [ %r{^integration/sdam_error_handling}, :sdam_integration ],
  [ %r{^integration/cursor_reaping}, :cursor_reaping ],
  [ %r{^integration/query_cache}, :query_cache ],
  [ %r{^integration/transactions_examples}, :tx_examples ],
  [ %r{^(atlas|integration)}, :integration ],
  [ %r{^spec_tests/sdam_integration}, :spec_sdam_integration ],
  [ %r{^spec_tests}, :spec ],
].freeze
# rubocop:enable Style/RegexpLiteral

RUN_PRIORITY = (ENV['RUN_PRIORITY'] || %(
  tx_examples
  unit unit_server
  integration sdam_integration cursor_reaping query_cache
  spec spec_sdam_integration
)).split.map(&:to_sym).freeze

def spec_organizer
  require 'mrss/spec_organizer'

  Mrss::SpecOrganizer.new(
    root: ROOT,
    classifiers: CLASSIFIERS,
    priority_order: RUN_PRIORITY
  )
end

RSpec::Core::RakeTask.new(:spec) do |t|
  # t.rspec_opts = '--profile 5' if ENV['CI']
end

task default: [ 'spec:prepare', :spec ]

desc 'Build the gem'
task :build do
  command = %w[ gem build ]
  command << "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
  command << (ENV['GEMSPEC'] || 'mongo.gemspec')
  system(*command)
end

# `rake version` is used by the deployment system to get the release version
# of the product being deployed. It must do nothing more than just print the
# product version number.
#
# See the mongodb-labs/driver-github-tools/ruby/publish GitHub action.
desc 'Print the current value of Mongo::VERSION'
task :version do
  require 'mongo/version'

  puts Mongo::VERSION
end

# overrides the default Bundler-provided `release` task, which also
# builds the gem. Our release process assumes the gem has already
# been built (and signed via GPG), so we just need `rake release` to
# push the gem to rubygems.
desc 'Push the built gem to RubyGems. This should only be invoked from the Driver Release GitHub action.'
task :release do
  require 'mongo/version'

  if ENV['GITHUB_ACTION'].nil?
    abort <<~WARNING
      `rake release` must be invoked from the `Driver Release` GitHub action,
      and must not be invoked locally. This ensures the gem is properly signed
      and distributed by the appropriate user.

      Note that it is the `rubygems/release-gem@v1` step in the `Driver Release`
      action that invokes this task. Do not rename or remove this task, or the
      release-gem step will fail. Reimplement this task with caution.

      mongo-#{Mongo::VERSION}.gem was NOT pushed to RubyGems.
    WARNING
  end

  system 'gem', 'push', "mongo-#{Mongo::VERSION}.gem"
end

desc 'Load the MongoDB Ruby driver. This is a prerequisite for many other tasks.'
task :mongo do
  require 'mongo'
end

RUBOCOPABLE = %w[ bin examples gemfiles profile lib spec mongo.gemspec Gemfile Rakefile upload-api-docs ].freeze

desc 'Run rubocop on the codebase'
task rubocop: %w[ rubocop:run ]

namespace :rubocop do
  desc 'Run rubocop on the codebase'
  task :run do
    sh 'bundle', 'exec', 'rubocop', *RUBOCOPABLE, verbose: false
  end

  desc 'Add a git pre-commit hook that runs rubocop'
  task :install_hook do
    hook_path = File.join('.git', 'hooks', 'pre-commit')
    hook_script = <<~HOOK
      #!/usr/bin/env bash
      set -e

      echo "Running rubocop..."
      rake rubocop
    HOOK

    File.write(hook_path, hook_script)
    FileUtils.chmod('+x', hook_path)

    puts "Git pre-commit hook installed at #{hook_path}."
  end
end

namespace :spec do
  desc 'Creates necessary user accounts in the cluster'
  task prepare: :mongo do
    $LOAD_PATH << File.join(File.dirname(__FILE__), 'spec')

    require 'support/utils'
    require 'support/spec_setup'
    SpecSetup.new.run
  end

  desc 'Waits for sessions to be available in the deployment'
  task wait_for_sessions: :mongo do
    $LOAD_PATH << File.join(File.dirname(__FILE__), 'spec')

    require 'support/utils'
    require 'support/spec_config'
    require 'support/client_registry'

    client = ClientRegistry.instance.global_client('authorized')
    client.database.command(ping: 1)
    deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 300
    loop do
      client.cluster.validate_session_support!
      break
    rescue Mongo::Error::SessionsNotSupported
      if Process.clock_gettime(Process::CLOCK_MONOTONIC) >= deadline
        raise 'Sessions did not become supported in 300 seconds'
      end

      client.cluster.scan!
    end
  end

  desc 'Prints configuration used by the test suite'
  task config: :mongo do
    $LOAD_PATH << File.join(File.dirname(__FILE__), 'spec')

    # Since this task is usually used for troubleshooting of test suite
    # configuration, leave driver log level at the default of debug to
    # have connection diagnostics printed during handshakes and such.
    require 'support/utils'
    require 'support/spec_config'
    require 'support/client_registry'
    SpecConfig.instance.print_summary
  end

  task ci: [ 'spec:prepare' ] do
    spec_organizer.run
  end

  desc 'Show test buckets'
  task :buckets do
    spec_organizer.ordered_buckets.each do |category, paths|
      puts "#{category || 'remaining'}: #{paths&.join(' ') || '<none>'}"
    end
  end
end
desc 'Build and validate the evergreen config'
task eg: %w[ eg:build eg:validate ]

# 'eg' == 'evergreen', but evergreen is too many letters for convenience
namespace :eg do
  desc 'Builds the .evergreen/config.yml file from the templates'
  task :build do
    ruby '.evergreen/update-evergreen-configs'
  end

  desc 'Validates the .evergreen/config.yml file'
  task :validate do
    system 'evergreen validate --project mongo-ruby-driver .evergreen/config.yml'
  end

  desc 'Updates the evergreen executable to the latest available version'
  task :update do
    system 'evergreen get-update --install'
  end

  desc 'Runs the current branch as an evergreen patch'
  task :patch do
    system 'evergreen patch --uncommitted --project mongo-ruby-driver --browse --auto-description --yes'
  end
end

desc 'Generate all documentation'
task docs: 'docs:yard'

namespace :docs do
  desc 'Generate yard documentation'
  task :yard do
    out = File.join('yard-docs', Mongo::VERSION)
    FileUtils.rm_rf(out)
    system "yardoc -o #{out} --title mongo-#{Mongo::VERSION}"
  end
end

load 'profile/driver_bench/rake/tasks.rake'