mktemp: strict type and allow #run without chdir

This commit is contained in:
Michael Cho 2024-10-13 18:48:01 -04:00
parent af958b2540
commit ff1f6ecc63
No known key found for this signature in database
GPG Key ID: 55E85E28A7CD1E85
2 changed files with 40 additions and 13 deletions

View File

@ -2804,7 +2804,7 @@ class Formula
mktemp("#{name}-test") do |staging| mktemp("#{name}-test") do |staging|
staging.retain! if keep_tmp staging.retain! if keep_tmp
@testpath = staging.tmpdir @testpath = T.must(staging.tmpdir)
test_env[:HOME] = @testpath test_env[:HOME] = @testpath
setup_home @testpath setup_home @testpath
begin begin
@ -3125,8 +3125,16 @@ class Formula
# recursively delete the temporary directory. Passing `opts[:retain]` # recursively delete the temporary directory. Passing `opts[:retain]`
# or calling `do |staging| ... staging.retain!` in the block will skip # or calling `do |staging| ... staging.retain!` in the block will skip
# the deletion and retain the temporary directory's contents. # the deletion and retain the temporary directory's contents.
def mktemp(prefix = name, opts = {}, &block) sig {
Mktemp.new(prefix, opts).run(&block) 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 end
# A version of `FileUtils.mkdir` that also changes to that folder in # A version of `FileUtils.mkdir` that also changes to that folder in

View File

@ -1,19 +1,23 @@
# typed: true # rubocop:todo Sorbet/StrictSigil # typed: strict
# frozen_string_literal: true # frozen_string_literal: true
# Performs {Formula#mktemp}'s functionality and tracks the results. # Performs {Formula#mktemp}'s functionality and tracks the results.
# Each instance is only intended to be used once. # 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 class Mktemp
include FileUtils 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 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 @prefix = prefix
@retain_in_cache = opts[:retain_in_cache] @retain_in_cache = T.let(retain_in_cache, T::Boolean)
@retain = opts[:retain] || @retain_in_cache @retain = T.let(retain || @retain_in_cache, T::Boolean)
@quiet = false @quiet = T.let(false, T::Boolean)
@tmpdir = T.let(nil, T.nilable(Pathname))
end end
# Instructs this {Mktemp} to retain the staged files. # Instructs this {Mktemp} to retain the staged files.
@ -23,11 +27,13 @@ class Mktemp
end end
# True if the staged temporary files should be retained. # True if the staged temporary files should be retained.
sig { returns(T::Boolean) }
def retain? def retain?
@retain @retain
end end
# True if the source files should be retained. # True if the source files should be retained.
sig { returns(T::Boolean) }
def retain_in_cache? def retain_in_cache?
@retain_in_cache @retain_in_cache
end end
@ -43,7 +49,8 @@ class Mktemp
"[Mktemp: #{tmpdir} retain=#{@retain} quiet=#{@quiet}]" "[Mktemp: #{tmpdir} retain=#{@retain} quiet=#{@quiet}]"
end 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" prefix_name = @prefix.tr "@", "AT"
@tmpdir = if retain_in_cache? @tmpdir = if retain_in_cache?
tmp_dir = HOMEBREW_CACHE/"Sources/#{prefix_name}" tmp_dir = HOMEBREW_CACHE/"Sources/#{prefix_name}"
@ -66,13 +73,24 @@ class Mktemp
Process.gid Process.gid
end end
begin begin
chown(nil, group_id, @tmpdir) @tmpdir.chown(nil, group_id)
rescue Errno::EPERM 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 end
begin begin
Dir.chdir(tmpdir) { yield self } if chdir
Dir.chdir(@tmpdir) { yield self }
else
yield self
end
ensure ensure
ignore_interrupts { chmod_rm_rf(@tmpdir) } unless retain? ignore_interrupts { chmod_rm_rf(@tmpdir) } unless retain?
end end
@ -85,6 +103,7 @@ class Mktemp
private private
sig { params(path: Pathname).void }
def chmod_rm_rf(path) def chmod_rm_rf(path)
if path.directory? && !path.symlink? if path.directory? && !path.symlink?
chmod("u+rw", path) if path.owned? # Need permissions in order to see the contents chmod("u+rw", path) if path.owned? # Need permissions in order to see the contents