Class: Puppet::Application::Filebucket

Inherits:
Puppet::Application show all
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 collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], #app_defaults, available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, 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_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) 



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

def args
  @args
end

Instance Method Details

#backup ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/puppet/application/filebucket.rb', line 168

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"
      next
    end
    unless FileTest.readable?(file)
      $stderr.puts "#{file}: cannot read file"
      next
    end
    md5 = @client.backup(file)
    puts "#{file}: #{md5}"
  end
end

#diff ⇒ Object

Raises:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/puppet/application/filebucket.rb', line 198

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}")
    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 



162
163
164
165
166
 
# File 'lib/puppet/application/filebucket.rb', line 162

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

#help ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/puppet/application/filebucket.rb', line 15

def help
  "\npuppet-filebucket(8) -- Store and retrieve files in a filebucket\n========\n\nSYNOPSIS\n--------\nA stand-alone Puppet filebucket client.\n\n\nUSAGE\n-----\npuppet filebucket <mode> [-h|--help] [-V|--version] [-d|--debug]\n[-v|--verbose] [-l|--local] [-r|--remote] [-s|--server <server>]\n[-f|--fromdate <date>] [-t|--todate <date>] [-b|--bucket <directory>]\n<file> <file> ...\n\nPuppet filebucket can operate in three modes, with only one mode per call:\n\nbackup:\nSend one or more files to the specified file bucket. Each sent file is\nprinted with its resulting md5 sum.\n\nget:\nReturn the text associated with an md5 sum. The text is printed to\nstdout, and only one file can be retrieved at a time.\n\nrestore:\nGiven a file path and an md5 sum, store the content associated with\nthe sum into the specified file path. You can specify an entirely new\npath to this argument; you are not restricted to restoring the content\nto its original location.\n\ndiff:\nPrint a diff in unified format between two checksums in the filebucket\nor between a checksum and its matching file.\n\nlist:\nList all files in the current local filebucket. Listing remote\nfilebuckets is not allowed.\n\nDESCRIPTION\n-----------\nThis is a stand-alone filebucket client for sending files to a local or\ncentral filebucket.\n\nNote that 'filebucket' defaults to using a network-based filebucket\navailable on the server named 'puppet'. To use this, you'll have to be\nrunning as a user with valid Puppet certificates. Alternatively, you can\nuse your local file bucket by specifying '--local'.\n\n\nOPTIONS\n-------\nNote that any setting that's valid in the configuration\nfile is also a valid long argument. For example, 'ssldir' is a valid\nsetting, so you can specify '--ssldir <directory>' as an\nargument.\n\nSee the configuration file documentation at\nhttps://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the\nfull list of acceptable parameters. A commented list of all\nconfiguration options can also be generated by running puppet with\n'--genconfig'.\n\n* --debug:\nEnable full debugging.\n\n* --fromdate:\n(list only) Select bucket files from 'fromdate'\n\n* --help:\nPrint this help message\n\n* --local:\nUse the local filebucket. This will use the default configuration\ninformation.\n\n* --remote:\nUse a remote filebucket. This will use the default configuration\ninformation.\n\n* --server:\nThe server to send the file to, instead of locally.\n\n* --todate:\n(list only) Select bucket files until 'todate'\n\n* --verbose:\nPrint extra information.\n\n* --version:\nPrint version information.\n\n\nEXAMPLE\n-------\n  $ puppet filebucket backup /etc/passwd\n  /etc/passwd: 429b225650b912a2ee067b0a4cf1e949\n  $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949\n  ## Diff between two files in the filebucket\n  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef\n  1a2\n  > again\n  ## Diff between the file in the filebucket and the current one\n  $ puppet filebucket -l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile\n  1a2\n  > again\n  $ puppet filebucket -l list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  $ echo again >> /tmp/TestFile\n  $ puppet filebucket -l backup /tmp/TestFile\n  /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef\n  $ puppet filebucket -l  list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n  $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list\n  <Empty Output>\n  $ puppet filebucket -l -f 2015-05-10 list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n  $ puppet filebucket -l -f \"2015-05-11 09:30:00\" list\n  7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile\n  $ puppet filebucket -l -t \"2015-05-11 09:30:00\" list\n  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile\n\nAUTHOR\n------\nLuke Kanies\n\n\nCOPYRIGHT\n---------\nCopyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License\n\n  HELP\nend\n"

#list ⇒ Object 



185
186
187
188
189
190
 
# File 'lib/puppet/application/filebucket.rb', line 185

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

#restore ⇒ Object 



192
193
194
195
196
 
# File 'lib/puppet/application/filebucket.rb', line 192

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

#run_command ⇒ Object 



155
156
157
158
159
160
 
# File 'lib/puppet/application/filebucket.rb', line 155

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 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/puppet/application/filebucket.rb', line 226

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