Skip to content

Commit

Permalink
mktemp: strict type and allow #run without chdir
Browse files Browse the repository at this point in the history
  • Loading branch information
cho-m committed Oct 16, 2024
1 parent af958b2 commit ff1f6ec
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 13 deletions.
14 changes: 11 additions & 3 deletions Library/Homebrew/formula.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2804,7 +2804,7 @@ def run_test(keep_tmp: false)

mktemp("#{name}-test") do |staging|
staging.retain! if keep_tmp
@testpath = staging.tmpdir
@testpath = T.must(staging.tmpdir)
test_env[:HOME] = @testpath
setup_home @testpath
begin
Expand Down Expand Up @@ -3125,8 +3125,16 @@ def eligible_kegs_for_cleanup(quiet: false)
# recursively delete the temporary directory. Passing `opts[:retain]`
# or calling `do |staging| ... staging.retain!` in the block will skip
# the deletion and retain the temporary directory's contents.
def mktemp(prefix = name, opts = {}, &block)
Mktemp.new(prefix, opts).run(&block)
sig {
params(
prefix: String,
retain: T::Boolean,
retain_in_cache: T::Boolean,
block: T.proc.params(arg0: Mktemp).void,
).void
}
def mktemp(prefix = name, retain: false, retain_in_cache: false, &block)
Mktemp.new(prefix, retain:, retain_in_cache:).run(&block)
end

# A version of `FileUtils.mkdir` that also changes to that folder in
Expand Down
39 changes: 29 additions & 10 deletions Library/Homebrew/mktemp.rb
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# typed: true # rubocop:todo Sorbet/StrictSigil
# typed: strict
# frozen_string_literal: true

# Performs {Formula#mktemp}'s functionality and tracks the results.
# Each instance is only intended to be used once.
# Can also be used to create a temporary directory with the brew instance's group.
class Mktemp
include FileUtils

# Path to the tmpdir used in this run, as a {Pathname}.
# Path to the tmpdir used in this run
sig { returns(T.nilable(Pathname)) }
attr_reader :tmpdir

def initialize(prefix, opts = {})
sig { params(prefix: String, retain: T::Boolean, retain_in_cache: T::Boolean).void }
def initialize(prefix, retain: false, retain_in_cache: false)
@prefix = prefix
@retain_in_cache = opts[:retain_in_cache]
@retain = opts[:retain] || @retain_in_cache
@quiet = false
@retain_in_cache = T.let(retain_in_cache, T::Boolean)
@retain = T.let(retain || @retain_in_cache, T::Boolean)
@quiet = T.let(false, T::Boolean)
@tmpdir = T.let(nil, T.nilable(Pathname))
end

# Instructs this {Mktemp} to retain the staged files.
Expand All @@ -23,11 +27,13 @@ def retain!
end

# True if the staged temporary files should be retained.
sig { returns(T::Boolean) }
def retain?
@retain
end

# True if the source files should be retained.
sig { returns(T::Boolean) }
def retain_in_cache?
@retain_in_cache
end
Expand All @@ -43,7 +49,8 @@ def to_s
"[Mktemp: #{tmpdir} retain=#{@retain} quiet=#{@quiet}]"
end

def run
sig { params(chdir: T::Boolean, _block: T.proc.params(arg0: Mktemp).void).void }
def run(chdir: true, &_block)
prefix_name = @prefix.tr "@", "AT"
@tmpdir = if retain_in_cache?
tmp_dir = HOMEBREW_CACHE/"Sources/#{prefix_name}"
Expand All @@ -66,13 +73,24 @@ def run
Process.gid
end
begin
chown(nil, group_id, @tmpdir)
@tmpdir.chown(nil, group_id)
rescue Errno::EPERM
opoo "Failed setting group \"#{T.must(Etc.getgrgid(group_id)).name}\" on #{@tmpdir}"
require "etc"
group_name = begin
Etc.getgrgid(group_id)&.name
rescue ArgumentError
# Cover for misconfigured NSS setups
nil
end
opoo "Failed setting group \"#{group_name || group_id}\" on #{@tmpdir}"
end

begin
Dir.chdir(tmpdir) { yield self }
if chdir
Dir.chdir(@tmpdir) { yield self }
else
yield self
end
ensure
ignore_interrupts { chmod_rm_rf(@tmpdir) } unless retain?
end
Expand All @@ -85,6 +103,7 @@ def run

private

sig { params(path: Pathname).void }
def chmod_rm_rf(path)
if path.directory? && !path.symlink?
chmod("u+rw", path) if path.owned? # Need permissions in order to see the contents
Expand Down

0 comments on commit ff1f6ec

Please sign in to comment.