mktemp: move to Formula and compat.
Move this method away from FileUtils as it doesn't need to be on that class.
This commit is contained in:
parent
a4a976b7f7
commit
0a76c9f02e
15
Library/Homebrew/compat/fileutils.rb
Normal file
15
Library/Homebrew/compat/fileutils.rb
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
require "fileutils"
|
||||||
|
|
||||||
|
module FileUtils
|
||||||
|
module Compat
|
||||||
|
def mktemp(prefix = name, opts = {})
|
||||||
|
# odeprecated("FileUtils.mktemp", "mktemp")
|
||||||
|
Mktemp.new(prefix, opts).run do |staging|
|
||||||
|
yield staging
|
||||||
|
end
|
||||||
|
end
|
||||||
|
module_function :mktemp
|
||||||
|
end
|
||||||
|
|
||||||
|
prepend Compat
|
||||||
|
end
|
@ -4,84 +4,6 @@ require "etc"
|
|||||||
# Homebrew extends Ruby's `FileUtils` to make our code more readable.
|
# Homebrew extends Ruby's `FileUtils` to make our code more readable.
|
||||||
# @see https://ruby-doc.org/stdlib-2.0.0/libdoc/fileutils/rdoc/FileUtils.html Ruby's FileUtils API
|
# @see https://ruby-doc.org/stdlib-2.0.0/libdoc/fileutils/rdoc/FileUtils.html Ruby's FileUtils API
|
||||||
module FileUtils
|
module FileUtils
|
||||||
# Create a temporary directory then yield. When the block returns,
|
|
||||||
# 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 = {})
|
|
||||||
Mktemp.new(prefix, opts).run do |staging|
|
|
||||||
yield staging
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
module_function :mktemp
|
|
||||||
|
|
||||||
# Performs mktemp's functionality, and tracks the results.
|
|
||||||
# Each instance is only intended to be used once.
|
|
||||||
class Mktemp
|
|
||||||
include FileUtils
|
|
||||||
|
|
||||||
# Path to the tmpdir used in this run, as a Pathname.
|
|
||||||
attr_reader :tmpdir
|
|
||||||
|
|
||||||
def initialize(prefix = name, opts = {})
|
|
||||||
@prefix = prefix
|
|
||||||
@retain = opts[:retain]
|
|
||||||
@quiet = false
|
|
||||||
end
|
|
||||||
|
|
||||||
# Instructs this Mktemp to retain the staged files
|
|
||||||
def retain!
|
|
||||||
@retain = true
|
|
||||||
end
|
|
||||||
|
|
||||||
# True if the staged temporary files should be retained
|
|
||||||
def retain?
|
|
||||||
@retain
|
|
||||||
end
|
|
||||||
|
|
||||||
# Instructs this Mktemp to not emit messages when retention is triggered
|
|
||||||
def quiet!
|
|
||||||
@quiet = true
|
|
||||||
end
|
|
||||||
|
|
||||||
def to_s
|
|
||||||
"[Mktemp: #{tmpdir} retain=#{@retain} quiet=#{@quiet}]"
|
|
||||||
end
|
|
||||||
|
|
||||||
def run
|
|
||||||
@tmpdir = Pathname.new(Dir.mktmpdir("#{@prefix}-", HOMEBREW_TEMP))
|
|
||||||
|
|
||||||
# Make sure files inside the temporary directory have the same group as the
|
|
||||||
# brew instance.
|
|
||||||
#
|
|
||||||
# Reference from `man 2 open`
|
|
||||||
# > When a new file is created, it is given the group of the directory which
|
|
||||||
# contains it.
|
|
||||||
group_id = if HOMEBREW_BREW_FILE.grpowned?
|
|
||||||
HOMEBREW_BREW_FILE.stat.gid
|
|
||||||
else
|
|
||||||
Process.gid
|
|
||||||
end
|
|
||||||
begin
|
|
||||||
chown(nil, group_id, tmpdir)
|
|
||||||
rescue Errno::EPERM
|
|
||||||
opoo "Failed setting group \"#{Etc.getgrgid(group_id).name}\" on #{tmpdir}"
|
|
||||||
end
|
|
||||||
|
|
||||||
begin
|
|
||||||
Dir.chdir(tmpdir) { yield self }
|
|
||||||
ensure
|
|
||||||
ignore_interrupts { rm_rf(tmpdir) } unless retain?
|
|
||||||
end
|
|
||||||
ensure
|
|
||||||
if retain? && !@tmpdir.nil? && !@quiet
|
|
||||||
ohai "Kept temporary files"
|
|
||||||
puts "Temporary files retained at #{@tmpdir}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# @private
|
# @private
|
||||||
alias old_mkdir mkdir
|
alias old_mkdir mkdir
|
||||||
|
|
||||||
|
@ -17,6 +17,7 @@ require "linkage_checker"
|
|||||||
require "extend/ENV"
|
require "extend/ENV"
|
||||||
require "language/python"
|
require "language/python"
|
||||||
require "tab"
|
require "tab"
|
||||||
|
require "mktemp"
|
||||||
|
|
||||||
# A formula provides instructions and metadata for Homebrew to install a piece
|
# A formula provides instructions and metadata for Homebrew to install a piece
|
||||||
# of software. Every Homebrew formula is a {Formula}.
|
# of software. Every Homebrew formula is a {Formula}.
|
||||||
@ -1688,7 +1689,7 @@ class Formula
|
|||||||
|
|
||||||
ENV.clear_sensitive_environment!
|
ENV.clear_sensitive_environment!
|
||||||
|
|
||||||
mktemp("#{name}-test") do |staging|
|
Formula.mktemp("#{name}-test") do |staging|
|
||||||
staging.retain! if ARGV.keep_tmp?
|
staging.retain! if ARGV.keep_tmp?
|
||||||
@testpath = staging.tmpdir
|
@testpath = staging.tmpdir
|
||||||
test_env[:HOME] = @testpath
|
test_env[:HOME] = @testpath
|
||||||
@ -2464,6 +2465,16 @@ class Formula
|
|||||||
@pour_bottle_check.instance_eval(&block)
|
@pour_bottle_check.instance_eval(&block)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Create a temporary directory then yield. When the block returns,
|
||||||
|
# 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 = {})
|
||||||
|
Mktemp.new(prefix, opts).run do |staging|
|
||||||
|
yield staging
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# @private
|
# @private
|
||||||
def link_overwrite(*paths)
|
def link_overwrite(*paths)
|
||||||
paths.flatten!
|
paths.flatten!
|
||||||
|
65
Library/Homebrew/mktemp.rb
Normal file
65
Library/Homebrew/mktemp.rb
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
# Performs `Formula.mktemp`'s functionality, and tracks the results.
|
||||||
|
# Each instance is only intended to be used once.
|
||||||
|
class Mktemp
|
||||||
|
include FileUtils
|
||||||
|
|
||||||
|
# Path to the tmpdir used in this run, as a Pathname.
|
||||||
|
attr_reader :tmpdir
|
||||||
|
|
||||||
|
def initialize(prefix = name, opts = {})
|
||||||
|
@prefix = prefix
|
||||||
|
@retain = opts[:retain]
|
||||||
|
@quiet = false
|
||||||
|
end
|
||||||
|
|
||||||
|
# Instructs this Mktemp to retain the staged files
|
||||||
|
def retain!
|
||||||
|
@retain = true
|
||||||
|
end
|
||||||
|
|
||||||
|
# True if the staged temporary files should be retained
|
||||||
|
def retain?
|
||||||
|
@retain
|
||||||
|
end
|
||||||
|
|
||||||
|
# Instructs this Mktemp to not emit messages when retention is triggered
|
||||||
|
def quiet!
|
||||||
|
@quiet = true
|
||||||
|
end
|
||||||
|
|
||||||
|
def to_s
|
||||||
|
"[Mktemp: #{tmpdir} retain=#{@retain} quiet=#{@quiet}]"
|
||||||
|
end
|
||||||
|
|
||||||
|
def run
|
||||||
|
@tmpdir = Pathname.new(Dir.mktmpdir("#{@prefix}-", HOMEBREW_TEMP))
|
||||||
|
|
||||||
|
# Make sure files inside the temporary directory have the same group as the
|
||||||
|
# brew instance.
|
||||||
|
#
|
||||||
|
# Reference from `man 2 open`
|
||||||
|
# > When a new file is created, it is given the group of the directory which
|
||||||
|
# contains it.
|
||||||
|
group_id = if HOMEBREW_BREW_FILE.grpowned?
|
||||||
|
HOMEBREW_BREW_FILE.stat.gid
|
||||||
|
else
|
||||||
|
Process.gid
|
||||||
|
end
|
||||||
|
begin
|
||||||
|
chown(nil, group_id, tmpdir)
|
||||||
|
rescue Errno::EPERM
|
||||||
|
opoo "Failed setting group \"#{Etc.getgrgid(group_id).name}\" on #{tmpdir}"
|
||||||
|
end
|
||||||
|
|
||||||
|
begin
|
||||||
|
Dir.chdir(tmpdir) { yield self }
|
||||||
|
ensure
|
||||||
|
ignore_interrupts { rm_rf(tmpdir) } unless retain?
|
||||||
|
end
|
||||||
|
ensure
|
||||||
|
if retain? && !@tmpdir.nil? && !@quiet
|
||||||
|
ohai "Kept temporary files"
|
||||||
|
puts "Temporary files retained at #{@tmpdir}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -1,6 +1,7 @@
|
|||||||
require "download_strategy"
|
require "download_strategy"
|
||||||
require "checksum"
|
require "checksum"
|
||||||
require "version"
|
require "version"
|
||||||
|
require "mktemp"
|
||||||
|
|
||||||
# Resource is the fundamental representation of an external resource. The
|
# Resource is the fundamental representation of an external resource. The
|
||||||
# primary formula download, along with other declared resources, are instances
|
# primary formula download, along with other declared resources, are instances
|
||||||
@ -195,6 +196,12 @@ class Resource
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def mktemp(prefix)
|
||||||
|
Mktemp.new(prefix).run do |staging|
|
||||||
|
yield staging
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
class Go < Resource
|
class Go < Resource
|
||||||
def stage(target)
|
def stage(target)
|
||||||
super(target/name)
|
super(target/name)
|
||||||
|
@ -10,7 +10,7 @@ describe AbstractDownloadStrategy do
|
|||||||
let(:args) { %w[foo bar baz] }
|
let(:args) { %w[foo bar baz] }
|
||||||
|
|
||||||
specify "#source_modified_time" do
|
specify "#source_modified_time" do
|
||||||
FileUtils.mktemp "mtime" do
|
Mktemp.new("mtime") do
|
||||||
FileUtils.touch "foo", mtime: Time.now - 10
|
FileUtils.touch "foo", mtime: Time.now - 10
|
||||||
FileUtils.touch "bar", mtime: Time.now - 100
|
FileUtils.touch "bar", mtime: Time.now - 100
|
||||||
FileUtils.ln_s "not-exist", "baz"
|
FileUtils.ln_s "not-exist", "baz"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user