{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
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.
# File lib/facter/util/file_read.rb, line 24 def self.read(path) File.read(path) rescue Errno::ENOENT, Errno::EACCES => detail Facter.debug "Could not read #{path}: #{detail.message}" nil end
Generated with the Darkfish Rdoc Generator 2.