path: root/Rakefile

# frozen_string_literal: true

$:.unshift File.expand_path("../lib", __FILE__)
require "benchmark"

require_relative "spec/support/rubygems_ext"

# Benchmark task execution
module Rake
  class Task
    alias_method :real_invoke, :invoke

    def invoke(*args)
      time = Benchmark.measure(@name) do
        real_invoke(*args)
      end
      puts "#{@name} ran for #{time}"
    end
  end
end

desc "Run specs"
task :spec do
  sh("bin/rspec")
end

namespace :spec do
  def safe_task(&block)
    yield
    true
  rescue StandardError
    false
  end

  desc "Ensure spec dependencies are installed"
  task :deps do
    Spec::Rubygems.dev_setup
  end

  namespace :travis do
    task :deps do
      # Give the travis user a name so that git won't fatally error
      system "sudo sed -i 's/1000::/1000:Travis:/g' /etc/passwd"
      # Strip secure_path so that RVM paths transmit through sudo -E
      system "sudo sed -i '/secure_path/d' /etc/sudoers"
      # Refresh packages index that the ones we need can be installed
      sh "sudo apt-get update"
      # Install groff so ronn can generate man/help pages
      sh "sudo apt-get install groff-base=1.22.3-10 -y"
      # Install graphviz so that the viz specs can run
      sh "sudo apt-get install graphviz -y"

      # Install the gems with a consistent version of RubyGems
      sh "gem update --system 3.0.6"

      # Install the other gem deps, etc
      Rake::Task["spec:deps"].invoke
    end
  end

  task :clean do
    rm_rf "tmp"
  end

  desc "Run the real-world spec suite"
  task :realworld => %w[set_realworld spec]

  namespace :realworld do
    desc "Re-record cassettes for the realworld specs"
    task :record => %w[set_record realworld]

    task :set_record do
      ENV["BUNDLER_SPEC_FORCE_RECORD"] = "TRUE"
    end
  end

  task :set_realworld do
    ENV["BUNDLER_REALWORLD_TESTS"] = "1"
  end

  desc "Run the spec suite with the sudo tests"
  task :sudo => %w[set_sudo spec]

  task :set_sudo do
    ENV["BUNDLER_SUDO_TESTS"] = "1"
  end

  # RubyGems specs by version
  namespace :rubygems do
    # When editing this list, also edit .travis.yml!
    branches = %w[master]
    releases = %w[v2.5.2 v2.6.14 v2.7.10 v3.0.6]
    (branches + releases).each do |rg|
      desc "Run specs with RubyGems #{rg}"
      task "parallel_#{rg}" do
        sh("bin/parallel_rspec spec/")
      end

      task rg do
        sh("bin/rspec --format progress")
      end

      # Create tasks like spec:rubygems:v1.8.3:sudo to run the sudo specs
      namespace rg do
        task :sudo => ["set_sudo", rg]
        task :realworld => ["set_realworld", rg]
      end

      task "set_#{rg}" do
        ENV["RGV"] = rg
      end

      task rg => ["set_#{rg}"]
      task "rubygems:all" => rg
    end

    desc "Run specs under a RubyGems checkout (set RGV=path)"
    task "co" do
      sh("bin/parallel_rspec spec/")
    end

    namespace "co" do
      task :sudo => ["set_sudo", "co"]
      task :realworld => ["set_realworld", "co"]
    end

    task "setup_co" do
      ENV["RGV"] = if `git -C "#{File.expand_path("..")}" remote --verbose 2> #{IO::NULL}` =~ /rubygems/i
        File.expand_path("..")
      else
        File.expand_path("tmp/rubygems")
      end
    end

    task "co" => "setup_co"
    task "rubygems:all" => "co"
  end

  desc "Run the tests on Travis CI against a RubyGem version (using ENV['RGV'])"
  task :travis do
    rg = ENV["RGV"] || raise("RubyGems version is required on Travis!")

    rg = "co" if File.directory?(File.expand_path(ENV["RGV"]))

    # disallow making network requests on CI
    ENV["BUNDLER_SPEC_PRE_RECORDED"] = "TRUE"

    puts "\n\e[1;33m[Travis CI] Running bundler specs against RubyGems #{rg}\e[m\n\n"
    specs = safe_task { Rake::Task["spec:rubygems:#{rg}"].invoke }

    Rake::Task["spec:rubygems:#{rg}"].reenable

    puts "\n\e[1;33m[Travis CI] Running bundler sudo specs against RubyGems #{rg}\e[m\n\n"
    sudos = system("sudo -E rake spec:rubygems:#{rg}:sudo")
    # clean up by chowning the newly root-owned tmp directory back to the travis user
    system("sudo chown -R #{ENV["USER"]} #{File.join(File.dirname(__FILE__), "tmp")}")

    Rake::Task["spec:rubygems:#{rg}"].reenable

    puts "\n\e[1;33m[Travis CI] Running bundler real world specs against RubyGems #{rg}\e[m\n\n"
    realworld = safe_task { Rake::Task["spec:rubygems:#{rg}:realworld"].invoke }

    { "specs" => specs, "sudo" => sudos, "realworld" => realworld }.each do |name, passed|
      if passed
        puts "\e[0;32m[Travis CI] #{name} passed\e[m"
      else
        puts "\e[0;31m[Travis CI] #{name} failed\e[m"
      end
    end

    unless specs && sudos && realworld
      raise "Spec run failed, please review the log for more information"
    end
  end
end

desc "Run RuboCop"
task :rubocop do
  sh("bin/rubocop --parallel")
end

namespace :man do
  if RUBY_ENGINE == "jruby"
    task(:build) {}
  else
    begin
      Spec::Rubygems.gem_require("ronn")
    rescue Gem::LoadError => e
      task(:build) { abort "We couln't activate ronn (#{e.requirement}). Try `gem install ronn:'#{e.requirement}'` to be able to build the help pages" }
    else
      directory "man"

      index = []
      sources = Dir["man/*.ronn"].map {|f| File.basename(f, ".ronn") }
      sources.map do |basename|
        ronn = "man/#{basename}.ronn"
        manual_section = ".1" unless basename =~ /\.(\d+)\Z/
        roff = "man/#{basename}#{manual_section}"

        index << [ronn, File.basename(roff)]

        file roff => ["man", ronn] do
          sh "bin/ronn --roff --pipe --date #{Time.now.strftime("%Y-%m-%d")} #{ronn} > #{roff}"
        end

        file "#{roff}.txt" => roff do
          sh "groff -Wall -mtty-char -mandoc -Tascii #{roff} | col -b > #{roff}.txt"
        end

        task :build_all_pages => "#{roff}.txt"
      end

      file "index.txt" do
        index.map! do |(ronn, roff)|
          [File.read(ronn).split(" ").first, roff]
        end
        index = index.sort_by(&:first)
        justification = index.map {|(n, _f)| n.length }.max + 4
        File.open("man/index.txt", "w") do |f|
          index.each do |name, filename|
            f << name.ljust(justification) << filename << "\n"
          end
        end
      end
      task :build_all_pages => "index.txt"

      desc "Remove all built man pages"
      task :clean do
        leftovers = Dir["man/*"].reject do |f|
          File.extname(f) == ".ronn"
        end
        rm leftovers if leftovers.any?
      end

      desc "Build the man pages"
      task :build => ["man:clean", "man:build_all_pages"]

      desc "Verify man pages are in sync"
      task :check => :build do
        sh("git diff --quiet --ignore-all-space man") do |outcome, _|
          if outcome
            puts
            puts "Manpages are in sync!"
            puts
          else
            sh("GIT_PAGER=cat git diff --ignore-all-space man")

            puts
            puts "Man pages are out of sync. Above you can see the diff that got generated from rebuilding them. Please review and commit the results."
            puts

            exit(1)
          end
        end
      end
    end
  end
end

begin
  Spec::Rubygems.gem_require("automatiek")
rescue Gem::LoadError => e
  msg = "We couldn't activate automatiek (#{e.requirement}). Try `gem install automatiek:'#{e.requirement}'` to be able to vendor gems"

  namespace :vendor do
    desc "Vendor a specific version of molinillo"
    task(:molinillo) { abort msg }

    desc "Vendor a specific version of fileutils"
    task(:fileutils) { abort msg }

    desc "Vendor a specific version of thor"
    task(:thor) { abort msg }

    desc "Vendor a specific version of net-http-persistent"
    task(:"net-http-persistent") { abort msg }

    desc "Vendor a specific version of connection_pool"
    task(:connection_pool) { abort msg }
  end
else
  desc "Vendor a specific version of molinillo"
  Automatiek::RakeTask.new("molinillo") do |lib|
    lib.download = { :github => "https://github.com/CocoaPods/Molinillo" }
    lib.namespace = "Molinillo"
    lib.prefix = "Bundler"
    lib.vendor_lib = "lib/bundler/vendor/molinillo"
  end

  # We currently cherry-pick changes to use `require_relative` internally
  # instead of regular `require`. They are already in thor's master branch but
  # still need to be released.
  desc "Vendor a specific version of thor"
  Automatiek::RakeTask.new("thor") do |lib|
    lib.download = { :github => "https://github.com/erikhuda/thor" }
    lib.namespace = "Thor"
    lib.prefix = "Bundler"
    lib.vendor_lib = "lib/bundler/vendor/thor"
  end

  # We currently cherry-pick changes to use `require_relative` internally
  # instead of regular `require`. They are already in fileutils' master branch
  # but still need to be released.
  desc "Vendor a specific version of fileutils"
  Automatiek::RakeTask.new("fileutils") do |lib|
    lib.download = { :github => "https://github.com/ruby/fileutils" }
    lib.namespace = "FileUtils"
    lib.prefix = "Bundler"
    lib.vendor_lib = "lib/bundler/vendor/fileutils"
  end

  # Currently `net-http-persistent` and it's dependency `connection_pool` are
  # vendored separately, but `connection_pool` references inside the vendored
  # copy of `net-http-persistent` are not properly updated to refer to the
  # vendored copy of `connection_pool`, so they need to be manually updated.
  # This will be automated once https://github.com/segiddins/automatiek/pull/3
  # is included in `automatiek` and we start using the new API for vendoring
  # subdependencies.
  # Besides that, we currently cherry-pick changes to use `require_relative`
  # internally instead of regular `require`. They are pending review at
  # https://github.com/drbrain/net-http-persistent/pull/106
  desc "Vendor a specific version of net-http-persistent"
  Automatiek::RakeTask.new("net-http-persistent") do |lib|
    lib.download = { :github => "https://github.com/drbrain/net-http-persistent" }
    lib.namespace = "Net::HTTP::Persistent"
    lib.prefix = "Bundler::Persistent"
    lib.vendor_lib = "lib/bundler/vendor/net-http-persistent"
  end

  desc "Vendor a specific version of connection_pool"
  Automatiek::RakeTask.new("connection_pool") do |lib|
    lib.download = { :github => "https://github.com/mperham/connection_pool" }
    lib.namespace = "ConnectionPool"
    lib.prefix = "Bundler"
    lib.vendor_lib = "lib/bundler/vendor/connection_pool"
  end
end

task :override_version do
  next unless version = ENV["BUNDLER_SPEC_SUB_VERSION"]
  version_file = File.expand_path("../lib/bundler/version.rb", __FILE__)
  contents = File.read(version_file)
  unless contents.sub!(/(^\s+VERSION\s*=\s*)"#{Gem::Version::VERSION_PATTERN}"/, %(\\1"#{version}"))
    abort("Failed to change bundler version")
  end
  File.open(version_file, "w") {|f| f << contents }
end

task :default => :spec

Dir["task/*.rake"].each(&method(:load))