brew/Library/Homebrew/test/messages_spec.rb

# frozen_string_literal: true

require "messages"
require "spec_helper"

describe Messages do
  let(:messages) { described_class.new }
  let(:test_formula) { formula("foo") { url("https://brew.sh/foo-0.1.tgz") } }
  let(:elapsed_time) { 1.1 }

  describe "#record_caveats" do
    it "adds a caveat" do
      expect {
        messages.record_caveats(test_formula, "Zsh completions were installed")
      }.to change { messages.caveats.count }.by(1)
    end
  end

  describe "#formula_installed" do
    it "increases the formula count" do
      expect {
        messages.formula_installed(test_formula, elapsed_time)
      }.to change(messages, :formula_count).by(1)
    end

    it "adds to install_times" do
      expect {
        messages.formula_installed(test_formula, elapsed_time)
      }.to change { messages.install_times.count }.by(1)
    end
  end

  describe "#display_messages" do
    context "when formula_count is less than two" do
      before do
        messages.record_caveats(test_formula, "Zsh completions were installed")
        messages.formula_installed(test_formula, elapsed_time)
      end

      it "doesn't print caveat details" do
        expect { messages.display_messages }.not_to output.to_stdout
      end
    end

    context "when caveats is empty" do
      before do
        messages.formula_installed(test_formula, elapsed_time)
      end

      it "doesn't print caveat details" do
        expect { messages.display_messages }.not_to output.to_stdout
      end
    end

    context "when formula_count is greater than one and caveats are present" do
      let(:test_formula2) { formula("bar") { url("https://brew.sh/bar-0.1.tgz") } }

      before do
        messages.record_caveats(test_formula, "Zsh completions were installed")
        messages.formula_installed(test_formula, elapsed_time)
        messages.formula_installed(test_formula2, elapsed_time)
      end

      it "prints caveat details" do
        expect { messages.display_messages }.to output(
          <<~EOS,
            ==> Caveats
            ==> foo
            Zsh completions were installed
          EOS
        ).to_stdout
      end
    end

    # Homebrew.args OpenStruct usage cannot use verified doubles.
    # rubocop:disable RSpec/VerifiedDoubles
    context "when the --display-times argument is present" do
      before do
        allow(Homebrew).to receive(:args).and_return \
          double(display_times?: true, flags_only: ["--display-times"])
      end

      context "when install_times is empty" do
        it "doesn't print any output" do
          expect { messages.display_messages }.not_to output.to_stdout
        end
      end

      context "when install_times is present" do
        before do
          messages.formula_installed(test_formula, elapsed_time)
        end

        it "prints installation times" do
          expect { messages.display_messages }.to output(
            <<~EOS,
              ==> Installation times
              foo                       1.100 s
            EOS
          ).to_stdout
        end
      end
    end

    context "when the --display-times argument isn't present" do
      before do
        allow(Homebrew).to receive(:args).and_return(double(display_times?: false))
      end

      it "doesn't print installation times" do
        expect { messages.display_messages }.not_to output.to_stdout
      end
    end
    # rubocop:enable RSpec/VerifiedDoubles
  end
end