Sha256: 52d6e9d698d9ba5873c720c8e5b2035addc9ddbf09069672b6ac8df31860f5ee

Contents?: true

Size: 1.04 KB

Versions: 32

Compression:

Stored size: 1.04 KB

Contents

# frozen_string_literal: true

# Read a file on localhost and return its contents using ruby's `File.read`. This will
# only read files on the machine you run Bolt on.
Puppet::Functions.create_function(:'file::read', Puppet::Functions::InternalFunction) do
  # @param filename Absolute path or Puppet file path.
  # @return The file's contents.
  # @example Read a file from disk
  #   file::read('/tmp/i_dumped_this_here')
  # @example Read a file from the modulepath
  #   file::read('example/VERSION')
  dispatch :read do
    scope_param
    required_param 'String', :filename
    return_type 'String'
  end

  def read(scope, filename)
    # Send Analytics Report
    Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)

    found = Puppet::Parser::Files.find_file(filename, scope.compiler.environment)
    unless found && Puppet::FileSystem.exist?(found)
      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
        Puppet::Pops::Issues::NO_SUCH_FILE_OR_DIRECTORY, file: filename
      )
    end

    File.read(found)
  end
end

Version data entries

32 entries across 32 versions & 1 rubygems

Version Path
bolt-2.26.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.25.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.24.1 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.24.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.23.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.22.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.21.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.20.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.19.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.18.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.17.0 bolt-modules/file/lib/puppet/functions/file/read.rb
bolt-2.16.0 bolt-modules/file/lib/puppet/functions/file/read.rb