Class: Puppet::Application::Filebucket

Inherits:

Puppet::Application

• Object
• Puppet::Application
• Puppet::Application::Filebucket

Defined in:

lib/puppet/application/filebucket.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Instance Attribute Summary

• #args ⇒ Object readonly

  Returns the value of attribute args.

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary

• #backup ⇒ Object
• #diff ⇒ Object
• #get ⇒ Object
• #help ⇒ Object
• #list ⇒ Object
• #restore ⇒ Object
• #run_command ⇒ Object
• #setup ⇒ Object
• #summary ⇒ Object

Methods inherited from Puppet::Application

[], #app_defaults, available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, #deprecate, #deprecated?, exit, find, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #main, #name, option, option_parser_commands, #parse_options, #preinit, restart!, restart_requested?, #run, run_mode, #set_log_level, #setup_logs, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, safe_posix_fork, set_env, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.

# File 'lib/puppet/application/filebucket.rb', line 13

def args
  @args
end

Instance Method Details

#backup ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 172

def backup
  raise _("You must specify a file to back up") unless args.length > 0

  args.each do |file|
    unless Puppet::FileSystem.exist?(file)
      $stderr.puts _("%{file}: no such file") % { file: file }
      next
    end
    unless FileTest.readable?(file)
      $stderr.puts _("%{file}: cannot read file") % { file: file }
      next
    end
    md5 = @client.backup(file)
    puts "#{file}: #{md5}"
  end
end

#diff ⇒ Object

Raises:

• (Puppet::Error)

# File 'lib/puppet/application/filebucket.rb', line 202

def diff
  raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>") unless args.count == 2
  left = args.shift
  right = args.shift
  if Puppet::FileSystem.exist?(left)
    # It's a file
    file_a = left
    checksum_a = nil
  else
    file_a = nil
    checksum_a = left
  end
  if Puppet::FileSystem.exist?(right)
    # It's a file
    file_b = right
    checksum_b = nil
  else
    file_b = nil
    checksum_b = right
  end
  if (checksum_a || file_a) && (checksum_b || file_b)
    Puppet.info(_("Comparing %{checksum_a} %{checksum_b} %{file_a} %{file_b}") % { checksum_a: checksum_a, checksum_b: checksum_b, file_a: file_a, file_b: file_b })
    print @client.diff(checksum_a, checksum_b, file_a, file_b)
  else
    raise Puppet::Error, _("Need exactly two arguments: filebucket diff <file_a> <file_b>")
  end
end

#get ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 166

def get
  md5 = args.shift
  out = @client.getfile(md5)
  print out
end

#help ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 19

def help
  <<-HELP

puppet-filebucket(8) -- #{summary}
========

SYNOPSIS
--------
A stand-alone Puppet filebucket client.


USAGE
-----
puppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]
[-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]
[-f|--fromdate <date>] [-t|--todate <date>] [-b|--bucket <directory>]
<file> <file> ...

Puppet filebucket can operate in three modes, with only one mode per call:

backup:
Send one or more files to the specified file bucket. Each sent file is
printed with its resulting md5 sum.

get:
Return the text associated with an md5 sum. The text is printed to
stdout, and only one file can be retrieved at a time.

restore:
Given a file path and an md5 sum, store the content associated with
the sum into the specified file path. You can specify an entirely new
path to this argument; you are not restricted to restoring the content
to its original location.

diff:
Print a diff in unified format between two checksums in the filebucket
or between a checksum and its matching file.

list:
List all files in the current local filebucket. Listing remote
filebuckets is not allowed.

DESCRIPTION
-----------
This is a stand-alone filebucket client for sending files to a local or
central filebucket.

Note that 'filebucket' defaults to using a network-based filebucket
available on the server named 'puppet'. To use this, you'll have to be
running as a user with valid Puppet certificates. Alternatively, you can
use your local file bucket by specifying '--local'.


OPTIONS
-------
Note that any setting that's valid in the configuration
file is also a valid long argument. For example, 'ssldir' is a valid
setting, so you can specify '--ssldir <directory>' as an
argument.

See the configuration file documentation at
https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
'--genconfig'.

* --debug:
Enable full debugging.

* --fromdate:
(list only) Select bucket files from 'fromdate'

* --help:
Print this help message

* --local:
Use the local filebucket. This will use the default configuration
information.

* --remote:
Use a remote filebucket. This will use the default configuration
information.

* --server:
The server to send the file to, instead of locally.

* --todate:
(list only) Select bucket files until 'todate'

* --verbose:
Print extra information.

* --version:
Print version information.


EXAMPLE
-------
  $ puppet filebucket backup /etc/passwd
  /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
  $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
  ## Diff between two files in the filebucket
  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
  1a2
  > again
  ## Diff between the file in the filebucket and the current one
  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
  1a2
  > again
  $ puppet filebucket -l list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  $ echo again >> /tmp/TestFile
  $ puppet filebucket -l backup /tmp/TestFile
  /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
  $ puppet filebucket -l  list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
  $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list
  <Empty Output>
  $ puppet filebucket -l -f 2015-05-10 list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
  $ puppet filebucket -l -f "2015-05-11 09:30:00" list
  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
  $ puppet filebucket -l -t "2015-05-11 09:30:00" list
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile

AUTHOR
------
Luke Kanies


COPYRIGHT
---------
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License

  HELP
end

#list ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 189

def list
  fromdate = options[:fromdate]
  todate = options[:todate]
  out = @client.list(fromdate, todate)
  print out
end

#restore ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 196

def restore
  file = args.shift
  md5 = args.shift
  @client.restore(file, md5)
end

#run_command ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 159

def run_command
  @args = command_line.args
  command = args.shift
  return send(command) if %w{get backup restore diff list}.include? command
  help
end

#setup ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 230

def setup
  Puppet::Log.newdestination(:console)

  @client = nil
  @server = nil

  Signal.trap(:INT) do
    $stderr.puts _("Cancelling")
    exit(1)
  end

  if options[:debug]
    Puppet::Log.level = :debug
  elsif options[:verbose]
    Puppet::Log.level = :info
  end

    exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?

  require 'puppet/file_bucket/dipper'
  begin
    if options[:local] or options[:bucket]
      path = options[:bucket] || Puppet[:bucketdir]
      @client = Puppet::FileBucket::Dipper.new(:Path => path)
    else
      @client = Puppet::FileBucket::Dipper.new(:Server => Puppet[:server])
    end
  rescue => detail
    Puppet.log_exception(detail)
    exit(1)
  end
end

#summary ⇒ Object

# File 'lib/puppet/application/filebucket.rb', line 15

def summary
  _("Store and retrieve files in a filebucket")
end