Class: Bolt::Applicator

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/applicator.rb

Instance Method Summary collapse

Constructor Details

#initialize(inventory, executor, modulepath, plugin_dirs, pdb_client, hiera_config, max_compiles) ⇒ Applicator

Returns a new instance of Applicator.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/bolt/applicator.rb', line 17

def initialize(inventory, executor, modulepath, plugin_dirs, pdb_client, hiera_config, max_compiles)
  @inventory = inventory
  @executor = executor
  @modulepath = modulepath
  @plugin_dirs = plugin_dirs
  @pdb_client = pdb_client
  @hiera_config = hiera_config ? validate_hiera_config(hiera_config) : nil

  @pool = Concurrent::ThreadPoolExecutor.new(max_threads: max_compiles)
  @logger = Logging.logger[self]
  @plugin_tarball = Concurrent::Delay.new do
    build_plugin_tarball do |mod|
      search_dirs = []
      search_dirs << mod.plugins if mod.plugins?
      search_dirs << mod.pluginfacts if mod.pluginfacts?
      search_dirs << mod.files if mod.files?
      search_dirs
    end
  end
end

Instance Method Details

#apply(args, apply_body, scope) ⇒ Object

Raises:

  • (ArgumentError) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bolt/applicator.rb', line 127

def apply(args, apply_body, scope)
  raise(ArgumentError, 'apply requires a TargetSpec') if args.empty?
  type0 = Puppet.lookup(:pal_script_compiler).type('TargetSpec')
  Puppet::Pal.assert_type(type0, args[0], 'apply targets')

  @executor.report_function_call('apply')

  options = {}
  if args.count > 1
    type1 = Puppet.lookup(:pal_script_compiler).type('Hash[String, Data]')
    Puppet::Pal.assert_type(type1, args[1], 'apply options')
    options = args[1]
  end

  # collect plan vars and merge them over target vars
  plan_vars = scope.to_hash
  %w[trusted server_facts facts].each { |k| plan_vars.delete(k) }

  targets = @inventory.get_targets(args[0])

  apply_ast(apply_body, targets, options, plan_vars)
end

#apply_ast(raw_ast, targets, options, plan_vars = {}) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/bolt/applicator.rb', line 162

def apply_ast(raw_ast, targets, options, plan_vars = {})
  ast = Puppet::Pops::Serialization::ToDataConverter.convert(raw_ast, rich_data: true, symbol_to_string: true)

  notify = proc { |_| nil }

  r = @executor.log_action('apply catalog', targets) do
    futures = targets.map do |target|
      Concurrent::Future.execute(executor: @pool) do
        @executor.with_node_logging("Compiling manifest block", [target]) do
          compile(target, ast, plan_vars)
        end
      end
    end

    result_promises = targets.zip(futures).flat_map do |target, future|
      @executor.queue_execute([target]) do |transport, batch|
        @executor.with_node_logging("Applying manifest block", batch) do
          catalog = future.value
          raise future.reason if future.rejected?

          arguments = {
            'catalog' => Puppet::Pops::Types::PSensitiveType::Sensitive.new(catalog),
            'plugins' => Puppet::Pops::Types::PSensitiveType::Sensitive.new(plugins),
            '_noop' => options['_noop']
          }

          results = transport.batch_task(batch, catalog_apply_task, arguments, options, &notify)
          Array(results).map { |result| ApplyResult.from_task_result(result) }
        end
      end
    end

    @executor.await_results(result_promises)
  end

  # Allow for report to exclude event metrics (apply_result doesn't require it to be present)
  resource_counts = r.ok_set.map { |result| result.event_metrics&.fetch('total') }.compact
  @executor.report_apply(count_statements(raw_ast), resource_counts)

  if !r.ok && !options['_catch_errors']
    raise Bolt::ApplyFailure, r
  end
  r
end

#build_plugin_tarball ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/bolt/applicator.rb', line 212

def build_plugin_tarball
  start_time = Time.now
  sio = StringIO.new
  output = Minitar::Output.new(Zlib::GzipWriter.new(sio))

  Puppet.lookup(:current_environment).override_with(modulepath: @plugin_dirs).modules.each do |mod|
    search_dirs = yield mod

    parent = Pathname.new(mod.path).parent
    files = Find.find(*search_dirs).select { |file| File.file?(file) }

    files.each do |file|
      tar_path = Pathname.new(file).relative_path_from(parent)
      @logger.debug("Packing plugin #{file} to #{tar_path}")
      stat = File.stat(file)
      content = File.binread(file)
      output.tar.add_file_simple(
        tar_path.to_s,
        data: content,
        size: content.size,
        mode: stat.mode & 0o777,
        mtime: stat.mtime
      )
    end
  end

  duration = Time.now - start_time
  @logger.debug("Packed plugins in #{duration * 1000} ms")

  output.close
  Base64.encode64(sio.string)
ensure
  output&.close
end

#catalog_apply_task ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/bolt/applicator.rb', line 51

def catalog_apply_task
  @catalog_apply_task ||= begin
    path = File.join(libexec, 'apply_catalog.rb')
    file = { 'name' => 'apply_catalog.rb', 'path' => path }
    metadata = { 'supports_noop' => true, 'input_method' => 'stdin' }
    Bolt::Task.new(name: 'apply_helpers::apply_catalog', files: [file], metadata: metadata)
  end
end

#compile(target, ast, plan_vars) ⇒ Object

Raises:



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
 
# File 'lib/bolt/applicator.rb', line 69

def compile(target, ast, plan_vars)
  trusted = Puppet::Context::TrustedInformation.new('local', target.host, {})

  catalog_input = {
    code_ast: ast,
    modulepath: @modulepath,
    pdb_config: @pdb_client.config.to_hash,
    hiera_config: @hiera_config,
    target: {
      name: target.host,
      facts: @inventory.facts(target),
      variables: @inventory.vars(target).merge(plan_vars),
      trusted: trusted.to_h
    },
    inventory: @inventory.data_hash
  }

  bolt_catalog_exe = File.join(libexec, 'bolt_catalog')
  old_path = ENV['PATH']
  ENV['PATH'] = "#{RbConfig::CONFIG['bindir']}#{File::PATH_SEPARATOR}#{old_path}"
  out, err, stat = Open3.capture3('ruby', bolt_catalog_exe, 'compile', stdin_data: catalog_input.to_json)
  ENV['PATH'] = old_path

  # stderr may contain formatted logs from Puppet's logger or other errors.
  # Print them in order, but handle them separately. Anything not a formatted log is assumed
  # to be an error message.
  logs = err.lines.map do |l|
    begin
      JSON.parse(l)
    rescue StandardError
      l
    end
  end
  logs.each do |log|
    if log.is_a?(String)
      @logger.error(log.chomp)
    else
      log.map { |k, v| [k.to_sym, v] }.each do |level, msg|
        bolt_level = Bolt::Util::PuppetLogLevel::MAPPING[level]
        @logger.send(bolt_level, "#{target.name}: #{msg.chomp}")
      end
    end
  end

  raise(ApplyError, target.name) unless stat.success?
  JSON.parse(out)
end

#count_statements(ast) ⇒ Object

Count the number of top-level statements in the AST.



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/bolt/applicator.rb', line 151

def count_statements(ast)
  case ast
  when Puppet::Pops::Model::Program
    count_statements(ast.body)
  when Puppet::Pops::Model::BlockExpression
    ast.statements.count
  else
    1
  end
end

#custom_facts_task ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/bolt/applicator.rb', line 42

def custom_facts_task
  @custom_facts_task ||= begin
    path = File.join(libexec, 'custom_facts.rb')
    file = { 'name' => 'custom_facts.rb', 'path' => path }
    metadata = { 'supports_noop' => true, 'input_method' => 'stdin' }
    Bolt::Task.new(name: 'apply_helpers::custom_facts', files: [file], metadata: metadata)
  end
end

#plugins ⇒ Object 



207
208
209
210
 
# File 'lib/bolt/applicator.rb', line 207

def plugins
  @plugin_tarball.value ||
    raise(Bolt::Error.new("Failed to pack module plugins: #{@plugin_tarball.reason}", 'bolt/plugin-error'))
end

#query_resources_task ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/bolt/applicator.rb', line 60

def query_resources_task
  @query_resources_task ||= begin
    path = File.join(libexec, 'query_resources.rb')
    file = { 'name' => 'query_resources.rb', 'path' => path }
    metadata = { 'supports_noop' => true, 'input_method' => 'stdin' }
    Bolt::Task.new(name: 'apply_helpers::query_resources', files: [file], metadata: metadata)
  end
end

#validate_hiera_config(hiera_config) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/bolt/applicator.rb', line 117

def validate_hiera_config(hiera_config)
  if File.exist?(File.path(hiera_config))
    data = File.open(File.path(hiera_config), "r:UTF-8") { |f| YAML.safe_load(f.read, [Symbol]) }
    unless data['version'] == 5
      raise Bolt::ParseError, "Hiera v5 is required, found v#{data['version'] || 3} in #{hiera_config}"
    end
    hiera_config
  end
end