Module: Puppet::FileSystem

Defined in:
lib/puppet/file_system.rb,
lib/puppet/file_system/path_pattern.rb

Defined Under Namespace

Classes: AbsolutePathPattern, FileImpl, MemoryFile, MemoryImpl, PathPattern, Posix, RelativePathPattern, Uniquefile, Windows

Class Method Summary collapse

Class Method Details

.assert_path(path) ⇒ Object

Asserts that the given path is of the expected type produced by #pathname

Raises:

  • (ArgumentError) —

    when path is not of the expected type



366
367
368
 
# File 'lib/puppet/file_system.rb', line 366

def self.assert_path(path)
  @impl.assert_path(path)
end

.basename(path) ⇒ Object

Returns the name of the file as a opaque handle.



80
81
82
 
# File 'lib/puppet/file_system.rb', line 80

def self.basename(path)
  @impl.basename(assert_path(path))
end

.basename_string(path) ⇒ String

Returns the name of the file.



88
89
90
 
# File 'lib/puppet/file_system.rb', line 88

def self.basename_string(path)
  @impl.path_string(@impl.basename(assert_path(path)))
end

.binread(path) ⇒ String

Returns The binary contents of the file.



159
160
161
 
# File 'lib/puppet/file_system.rb', line 159

def self.binread(path)
  @impl.binread(assert_path(path))
end

.children(path) ⇒ Array<Object>

Returns references to all of the children of the given directory path, excluding ‘.` and `..`.



231
232
233
 
# File 'lib/puppet/file_system.rb', line 231

def self.children(path)
  @impl.children(assert_path(path))
end

.chmod(mode, path) ⇒ Object

Changes permission bits on the named path to the bit pattern represented by mode.

Raises:

  • (Errno::ENOENT) —

    : path doesn’t exist



401
402
403
 
# File 'lib/puppet/file_system.rb', line 401

def self.chmod(mode, path)
  @impl.chmod(mode, path)
end

.compare_stream(path, stream) ⇒ Boolean

Compares the contents of this file against the contents of a stream.



327
328
329
 
# File 'lib/puppet/file_system.rb', line 327

def self.compare_stream(path, stream)
  @impl.compare_stream(assert_path(path), stream)
end

.dir(path) ⇒ Object

Returns The directory of this file as an opaque handle.



54
55
56
 
# File 'lib/puppet/file_system.rb', line 54

def self.dir(path)
  @impl.dir(assert_path(path))
end

.dir_exist?(path) ⇒ Boolean 



67
68
69
 
# File 'lib/puppet/file_system.rb', line 67

def self.dir_exist?(path)
  @impl.exist?(@impl.dir(assert_path(path)))
end

.dir_mkpath(path) ⇒ Object

Creates all directories down to (inclusive) the dir of the given path



72
73
74
 
# File 'lib/puppet/file_system.rb', line 72

def self.dir_mkpath(path)
  @impl.mkpath(@impl.dir(assert_path(path)))
end

.dir_string(path) ⇒ String

Returns The directory of this file as a String.



62
63
64
 
# File 'lib/puppet/file_system.rb', line 62

def self.dir_string(path)
  @impl.path_string(@impl.dir(assert_path(path)))
end

.directory?(path) ⇒ Boolean

Determines if a file is a directory.



179
180
181
 
# File 'lib/puppet/file_system.rb', line 179

def self.directory?(path)
  @impl.directory?(assert_path(path))
end

.each_line(path, &block) ⇒ Object

Processes each line of the file by yielding it to the given block



130
131
132
 
# File 'lib/puppet/file_system.rb', line 130

def self.each_line(path, &block)
  @impl.each_line(assert_path(path), &block)
end

.exclusive_create(path, mode, &block) ⇒ Object

Create and open a file for write only if it doesn’t exist.

Raises:

  • (Errno::EEXIST) —

    path already exists.

See Also:

  • open


387
388
389
 
# File 'lib/puppet/file_system.rb', line 387

def self.exclusive_create(path, mode, &block)
  @impl.exclusive_create(assert_path(path), mode, &block)
end

.exclusive_open(path, mode, options = 'r', timeout = 300) { ... } ⇒ Void

Allows exclusive updates to a file to be made by excluding concurrent access using flock. This means that if the file is on a filesystem that does not support flock, this method will provide no protection.

While polling to acquire the lock the process will wait ever increasing amounts of time in order to prevent multiple processes from wasting resources.

Yields:

  • The file handle, in the mode given by options, else read-write mode

Raises:

  • (Timeout::Error) —

    If the timeout is exceeded while waiting to acquire the lock



122
123
124
 
# File 'lib/puppet/file_system.rb', line 122

def self.exclusive_open(path, mode, options = 'r', timeout = 300, &block)
  @impl.exclusive_open(assert_path(path), mode, options, timeout, &block)
end

.executable?(path) ⇒ Boolean

TODO:

Should this take into account extensions on the windows platform?

Determines if a file is executable.



200
201
202
 
# File 'lib/puppet/file_system.rb', line 200

def self.executable?(path)
  @impl.executable?(assert_path(path))
end

.exist?(path) ⇒ Boolean

Determines if a file exists by verifying that the file can be stat’d. Will follow symlinks and verify that the actual target path exists.



170
171
172
 
# File 'lib/puppet/file_system.rb', line 170

def self.exist?(path)
  @impl.exist?(assert_path(path))
end

.expand_path(path, dir_string = nil) ⇒ String

Produces a string representation of the opaque path handle, with expansions performed on ~. For Windows, this means that C:UsersAdmini~1AppData will be expanded to C:UsersAdministratorAppData. On POSIX filesystems, the value ~ will be expanded to something like /Users/Foo

This method exists primarlily to resolve a Ruby deficiency where File.expand_path doesn’t handle ~ in each segment on a Windows path



356
357
358
 
# File 'lib/puppet/file_system.rb', line 356

def self.expand_path(path, dir_string = nil)
  @impl.expand_path(path, dir_string)
end

.file?(path) ⇒ Boolean

Determines if a file is a file.



188
189
190
 
# File 'lib/puppet/file_system.rb', line 188

def self.file?(path)
  @impl.file?(assert_path(path))
end

.lstat(path) ⇒ File::Stat

link. Instead, reports on the link itself.



316
317
318
 
# File 'lib/puppet/file_system.rb', line 316

def self.lstat(path)
  @impl.lstat(assert_path(path))
end

.mkpath(path) ⇒ Object

Creates directories for all parts of the given path.



224
225
226
 
# File 'lib/puppet/file_system.rb', line 224

def self.mkpath(path)
  @impl.mkpath(assert_path(path))
end

.open(path, mode, options) { ... } ⇒ Void

Opens the given path with given mode, and options and optionally yields it to the given block.

Yields:

  • The file handle, in the mode given by options, else read-write mode



46
47
48
 
# File 'lib/puppet/file_system.rb', line 46

def self.open(path, mode, options, &block)
  @impl.open(assert_path(path), mode, options, &block)
end

.overlay(*files, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allows overriding the filesystem for the duration of the given block. The filesystem will only contain the given file(s).



25
26
27
28
29
30
31
 
# File 'lib/puppet/file_system.rb', line 25

def self.overlay(*files, &block)
  old_impl = @impl
  @impl = Puppet::FileSystem::MemoryImpl.new(*files)
  yield
ensure
  @impl = old_impl
end

.path_string(path) ⇒ String

Produces a string representation of the opaque path handle.



375
376
377
 
# File 'lib/puppet/file_system.rb', line 375

def self.path_string(path)
  @impl.path_string(path)
end

.pathname(path) ⇒ Object

Produces an opaque pathname “handle” object representing the given path. Different implementations of the underlying file system may use different runtime objects. The produced “handle” should be used in all other operations that take a “path”. No operation should be directly invoked on the returned opaque object



341
342
343
 
# File 'lib/puppet/file_system.rb', line 341

def self.pathname(path)
  @impl.pathname(path)
end

.read(path, opts = {}) ⇒ String

Returns The contents of the file.



138
139
140
 
# File 'lib/puppet/file_system.rb', line 138

def self.read(path, opts = {})
  @impl.read(assert_path(path), opts)
end

.read_preserve_line_endings(path) ⇒ String

Read a file keeping the original line endings intact. This attempts to open files using binary mode using some encoding overrides and falling back to IO.read when none of the encodings are valid.



151
152
153
 
# File 'lib/puppet/file_system.rb', line 151

def self.read_preserve_line_endings(path)
  @impl.read_preserve_line_endings(assert_path(path))
end

.readlink(path) ⇒ String

Returns the name of the file referenced by the given link.



278
279
280
 
# File 'lib/puppet/file_system.rb', line 278

def self.readlink(path)
  @impl.readlink(assert_path(path))
end

.size(path) ⇒ Integer

Returns the size of the file.



96
97
98
 
# File 'lib/puppet/file_system.rb', line 96

def self.size(path)
  @impl.size(assert_path(path))
end

.stat(path) ⇒ File::Stat

Returns object for the named file.



299
300
301
 
# File 'lib/puppet/file_system.rb', line 299

def self.stat(path)
  @impl.stat(assert_path(path))
end

.symlink(path, dest, options = {}) ⇒ Integer

Creates a symbolic link dest which points to the current file. If dest already exists:

  • and is a file, will raise Errno::EEXIST

  • and is a directory, will return 0 but perform no action

  • and is a symlink referencing a file, will raise Errno::EEXIST

  • and is a symlink referencing a directory, will return 0 but perform no action

With the :force option set to true, when dest already exists:

  • and is a file, will replace the existing file with a symlink (DANGEROUS)

  • and is a directory, will return 0 but perform no action

  • and is a symlink referencing a file, will modify the existing symlink

  • and is a symlink referencing a directory, will return 0 but perform no action

Options Hash (options):

  • :force (Boolean) —

    overwrite dest

  • :noop (Boolean) —

    do not perform the operation

  • :verbose (Boolean) —

    verbose output

Raises:

  • (Errno::EEXIST) —

    dest already exists as a file and, :force is not set



262
263
264
 
# File 'lib/puppet/file_system.rb', line 262

def self.symlink(path, dest, options = {})
  @impl.symlink(assert_path(path), dest, options)
end

.symlink?(path) ⇒ Boolean

Returns true if the file is a symbolic link.



270
271
272
 
# File 'lib/puppet/file_system.rb', line 270

def self.symlink?(path)
  @impl.symlink?(assert_path(path))
end

.touch(path) ⇒ Object

Touches the file. On most systems this updates the mtime of the file.



216
217
218
 
# File 'lib/puppet/file_system.rb', line 216

def self.touch(path)
  @impl.touch(assert_path(path))
end

.unlink(*paths) ⇒ Integer

Deletes the given paths, returning the number of names passed as arguments. See also Dir::rmdir.

Raises:

  • an exception on any error.



291
292
293
 
# File 'lib/puppet/file_system.rb', line 291

def self.unlink(*paths)
  @impl.unlink(*(paths.map {|p| assert_path(p) }))
end

.writable?(path) ⇒ Boolean

Returns Whether the file is writable by the current process.



208
209
210
 
# File 'lib/puppet/file_system.rb', line 208

def self.writable?(path)
  @impl.writable?(assert_path(path))
end