Sha256: 10fe8cf3992e9df1fc41e3ca1bf4fd4dbfd3562fbbbfff60e8dcb928d689f79b
Contents?: true
Size: 1.11 KB
Versions: 10
Compression:
Stored size: 1.11 KB
Contents
module Facter
module Util
##
# {Facter::Util::FileRead} is a utility module intended to provide easily
# mockable methods that delegate to simple file read methods. The intent is to
# avoid the need to execute the `cat` system command or `File.read` directly in
# Ruby, as mocking these behaviors can have wide-ranging effects.
#
# All Facter facts are encouraged to use this method instead of File.read or
# Facter::Util::Resolution.exec('cat ...')
#
# @api public
module FileRead
##
# read returns the raw content of a file as a string. If the file does not
# exist, or the process does not have permission to read the file then nil is
# returned.
#
# @api public
#
# @return [String] the raw contents of the file at {path} or {nil} if the
# file cannot be read because it does not exist or the process does not have
# permission to read the file.
def self.read(path)
File.read(path)
rescue Errno::ENOENT, Errno::EACCES => detail
Facter.debug "Could not read #{path}: #{detail.message}"
nil
end
def self.read_binary(path)
File.open(path, "rb") { |contents| contents.read }
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems