brew/Library/Homebrew/test/cask/artifact/binary_spec.rb

# typed: false
# frozen_string_literal: true

RSpec.describe Cask::Artifact::Binary, :cask do
  let(:cask) do
    Cask::CaskLoader.load(cask_path("with-binary")).tap do |cask|
      InstallHelper.install_without_artifacts(cask)
    end
  end
  let(:artifacts) { cask.artifacts.grep(described_class) }
  let(:binarydir) { cask.config.binarydir }
  let(:expected_path) { binarydir.join("binary") }

  around do |example|
    binarydir.mkpath

    example.run
  ensure
    FileUtils.rm_f expected_path
    FileUtils.rmdir binarydir
  end

  context "when --no-binaries is specified" do
    let(:cask) do
      Cask::CaskLoader.load(cask_path("with-binary"))
    end

    it "doesn't link the binary when --no-binaries is specified" do
      Cask::Installer.new(cask, binaries: false).install
      expect(expected_path).not_to exist
    end
  end

  it "links the binary to the proper directory" do
    artifacts.each do |artifact|
      artifact.install_phase(command: NeverSudoSystemCommand, force: false)
    end

    expect(expected_path).to be_a_symlink
    expect(expected_path.readlink).to exist
  end

  context "when the binary is not executable" do
    let(:cask) do
      Cask::CaskLoader.load(cask_path("with-non-executable-binary")).tap do |cask|
        InstallHelper.install_without_artifacts(cask)
      end
    end

    let(:expected_path) { cask.config.binarydir.join("naked_non_executable") }

    it "makes the binary executable" do
      expect(FileUtils).to receive(:chmod)
        .with("+x", cask.staged_path.join("naked_non_executable")).and_call_original

      artifacts.each do |artifact|
        artifact.install_phase(command: NeverSudoSystemCommand, force: false)
      end

      expect(expected_path).to be_a_symlink
      expect(expected_path.readlink).to be_executable
    end
  end

  it "avoids clobbering an existing binary by linking over it" do
    FileUtils.touch expected_path

    expect do
      artifacts.each do |artifact|
        artifact.install_phase(command: NeverSudoSystemCommand, force: false)
      end
    end.to raise_error(Cask::CaskError)

    expect(expected_path).not_to be :symlink?
  end

  it "avoids clobbering an existing symlink" do
    expected_path.make_symlink("/tmp")

    expect do
      artifacts.each do |artifact|
        artifact.install_phase(command: NeverSudoSystemCommand, force: false)
      end
    end.to raise_error(Cask::CaskError)

    expect(File.readlink(expected_path)).to eq("/tmp")
  end

  it "skips linking when the target is already a symlink to the source" do
    artifact = artifacts.first
    expected_path.make_symlink(artifact.source)

    expect do
      artifact.install_phase(command: NeverSudoSystemCommand, force: false)
    end.to output(/is already linked/).to_stdout

    expect(expected_path.readlink).to eq(artifact.source)
  end

  it "raises a clean error when the target symlink cannot be resolved" do
    artifact = artifacts.first
    expected_path.make_symlink(artifact.source)
    allow(artifact.target).to receive(:realpath).and_raise(Errno::EACCES)

    expect do
      artifact.install_phase(command: NeverSudoSystemCommand, force: false)
    end.to raise_error(Cask::CaskError, /already a Binary/)
  end

  it "creates parent directory if it doesn't exist" do
    FileUtils.rmdir binarydir

    artifacts.each do |artifact|
      artifact.install_phase(command: NeverSudoSystemCommand, force: false)
    end

    expect(expected_path.exist?).to be true
  end

  context "when the binary is inside an app package" do
    let(:cask) do
      Cask::CaskLoader.load(cask_path("with-embedded-binary")).tap do |cask|
        InstallHelper.install_without_artifacts(cask)
      end
    end

    it "links the binary to the proper directory" do
      cask.artifacts.grep(Cask::Artifact::App).each do |artifact|
        artifact.install_phase(command: NeverSudoSystemCommand, force: false)
      end
      artifacts.each do |artifact|
        artifact.install_phase(command: NeverSudoSystemCommand, force: false)
      end

      expect(expected_path).to be_a_symlink
      expect(expected_path.readlink).to exist
    end
  end
end