Module: Puppet::FileSystem

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

Overview

API:

  • public

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:

  • when path is not of the expected type

API:

  • public



354
355
356
 
# File 'lib/puppet/file_system.rb', line 354

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

.basename(path) ⇒ Object

Returns the name of the file as a opaque handle.

Returns:

  • the name of the file as a opaque handle

API:

  • public



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

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

.basename_string(path) ⇒ String

Returns the name of the file.

Returns:

  • the name of the file

API:

  • public



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

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

.binread(path) ⇒ String

Returns The binary contents of the file.

Returns:

  • The binary contents of the file

API:

  • public



147
148
149
 
# File 'lib/puppet/file_system.rb', line 147

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 ...

Returns:

  • references to all of the children of the given directory path, excluding . and ...

API:

  • public



219
220
221
 
# File 'lib/puppet/file_system.rb', line 219

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.

Parameters:

  • The mode to apply to the file if it is created

  • The path to the file, can also accept [PathName]

Raises:

  • : path doesn’t exist

API:

  • public



389
390
391
 
# File 'lib/puppet/file_system.rb', line 389

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.

Parameters:

  • The stream to compare the contents against

Returns:

  • Whether the contents were the same

API:

  • public



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

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.

Returns:

  • The directory of this file as an opaque handle

API:

  • public



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

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

.dir_exist?(path) ⇒ Boolean

Returns Does the directory of the given path exist?.

Returns:

  • Does the directory of the given path exist?

API:

  • public



58
59
60
 
# File 'lib/puppet/file_system.rb', line 58

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

API:

  • public



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

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.

Returns:

  • The directory of this file as a String

API:

  • public



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

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

.directory?(path) ⇒ Boolean

Determines if a file is a directory.

Returns:

  • true if the given file is a directory.

API:

  • public



167
168
169
 
# File 'lib/puppet/file_system.rb', line 167

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

API:

  • public



118
119
120
 
# File 'lib/puppet/file_system.rb', line 118

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:

  • path already exists.

See Also:

  • open

API:

  • public



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

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.

Parameters:

  • the path to the file to operate on

  • The mode to apply to the file if it is created

  • (defaults to: 'r')

    Extra file operation mode information to use (defaults to read-only mode)

  • (defaults to: 300)

    Number of seconds to wait for the lock (defaults to 300)

Yields:

  • The file handle, in read-write mode

Returns:

Raises:

  • If the timeout is exceeded while waiting to acquire the lock

API:

  • public



110
111
112
 
# File 'lib/puppet/file_system.rb', line 110

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.

Returns:

  • true if this file can be executed

API:

  • public



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

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.

Returns:

  • true if the named file exists.

API:

  • public



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

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

Parameters:

  • a path handle produced by #pathname

Returns:

  • a string representation of the path

API:

  • public



344
345
346
 
# File 'lib/puppet/file_system.rb', line 344

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.

Returns:

  • true if the given file is a file.

API:

  • public



176
177
178
 
# File 'lib/puppet/file_system.rb', line 176

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

.lstat(path) ⇒ File::Stat

link. Instead, reports on the link itself.

Returns:

  • Same as stat, but does not follow the last symbolic

API:

  • public



304
305
306
 
# File 'lib/puppet/file_system.rb', line 304

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

.mkpath(path) ⇒ Object

Creates directories for all parts of the given path.

API:

  • public



212
213
214
 
# File 'lib/puppet/file_system.rb', line 212

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

.open(path, mode, options, &block) ⇒ Object

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

API:

  • public



37
38
39
 
# File 'lib/puppet/file_system.rb', line 37

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).

Parameters:

  • the files to have available

API:

  • private



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.

Parameters:

  • a path handle produced by #pathname

Returns:

  • a string representation of the path

API:

  • public



363
364
365
 
# File 'lib/puppet/file_system.rb', line 363

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

Parameters:

  • The string representation of the path

Returns:

  • An opaque path handle on which no operations should be directly performed

API:

  • public



329
330
331
 
# File 'lib/puppet/file_system.rb', line 329

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

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

Returns The contents of the file.

Returns:

  • The contents of the file

API:

  • public



126
127
128
 
# File 'lib/puppet/file_system.rb', line 126

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.

Returns:

  • The contents of the file

API:

  • public



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

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.

Returns:

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

API:

  • public



266
267
268
 
# File 'lib/puppet/file_system.rb', line 266

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

.size(path) ⇒ Integer

Returns the size of the file.

Returns:

  • the size of the file

API:

  • public



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

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

.stat(path) ⇒ File::Stat

Returns object for the named file.

Returns:

  • object for the named file.

API:

  • public



287
288
289
 
# File 'lib/puppet/file_system.rb', line 287

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

Parameters:

  • The path to create the new symlink at

  • (defaults to: {})

    the options to create the symlink with

Options Hash (options):

  • :force (Boolean) —

    overwrite dest

  • :noop (Boolean) —

    do not perform the operation

  • :verbose (Boolean) —

    verbose output

Returns:

  • 0

Raises:

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

API:

  • public



250
251
252
 
# File 'lib/puppet/file_system.rb', line 250

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.

Returns:

  • true if the file is a symbolic link.

API:

  • public



258
259
260
 
# File 'lib/puppet/file_system.rb', line 258

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.

API:

  • public



204
205
206
 
# File 'lib/puppet/file_system.rb', line 204

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.

Returns:

  • the number of paths passed as arguments

Raises:

  • an exception on any error.

API:

  • public



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

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.

Returns:

  • Whether the file is writable by the current process

API:

  • public



196
197
198
 
# File 'lib/puppet/file_system.rb', line 196

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