Class: Bolt::Inventory::Target

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

Overview

This class represents the active state of a target within the inventory.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_data, inventory) ⇒ Target

Returns a new instance of Target.


11
12
13
14
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
# File 'lib/bolt/inventory/target.rb', line 11

def initialize(target_data, inventory)
  unless target_data['name'] || target_data['uri']
    raise Bolt::Inventory::ValidationError.new("Target must have either a name or uri", nil)
  end

  @logger = Bolt::Logger.logger(inventory)

  # If the target isn't mentioned by any groups, it won't have a uri or
  # name and we will use the target_name as both
  @uri = target_data['uri']
  @uri_obj = self.class.parse_uri(@uri)

  # If the target has a name, use that as the safe name. Otherwise, turn
  # the uri into a safe name by omitting the password.
  if target_data['name']
    @name = target_data['name']
    @safe_name = target_data['name']
  else
    @name = @uri
    @safe_name = @uri_obj.omit(:password).to_str.sub(%r{^//}, '')
  end

  if @name == 'localhost'
    default = { 'config' => { 'transport' => 'local' } }
    target_data = Bolt::Util.deep_merge(default, target_data)
  end

  @config = target_data['config'] || {}
  @vars = target_data['vars'] || {}
  @facts = target_data['facts'] || {}
  @features = target_data['features'] || Set.new
  @plugin_hooks = target_data['plugin_hooks'] || {}
  # When alias is specified in a plan, the key will be `target_alias`, when
  # alias is specified in inventory the key will be `alias`.
  @target_alias = target_data['target_alias'] || target_data['alias'] || []
  @resources = {}

  @inventory = inventory

  validate
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name.


9
10
11
# File 'lib/bolt/inventory/target.rb', line 9

def name
  @name
end

#resourcesObject (readonly)

Returns the value of attribute resources.


9
10
11
# File 'lib/bolt/inventory/target.rb', line 9

def resources
  @resources
end

#safe_nameObject (readonly)

Returns the value of attribute safe_name.


9
10
11
# File 'lib/bolt/inventory/target.rb', line 9

def safe_name
  @safe_name
end

#target_aliasObject (readonly)

Returns the value of attribute target_alias.


9
10
11
# File 'lib/bolt/inventory/target.rb', line 9

def target_alias
  @target_alias
end

#uriObject (readonly)

Returns the value of attribute uri.


9
10
11
# File 'lib/bolt/inventory/target.rb', line 9

def uri
  @uri
end

Class Method Details

.parse_uri(string) ⇒ Object


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/bolt/inventory/target.rb', line 264

def self.parse_uri(string)
  require 'addressable/uri'
  if string.nil?
    Addressable::URI.new
  # Forbid empty uri
  elsif string.empty?
    raise Bolt::ParseError, "Could not parse target URI: URI is empty string"
  elsif string =~ %r{^[^:]+://}
    Addressable::URI.parse(string)
  else
    # Initialize with an empty scheme to ensure we parse the hostname correctly
    Addressable::URI.parse("//#{string}")
  end
rescue Addressable::URI::InvalidURIError => e
  raise Bolt::ParseError, "Could not parse target URI: #{e.message}"
end

Instance Method Details

#add_facts(new_facts = {}) ⇒ Object


94
95
96
97
# File 'lib/bolt/inventory/target.rb', line 94

def add_facts(new_facts = {})
  validate_fact_names(new_facts)
  @facts = Bolt::Util.deep_merge(@facts, new_facts)
end

#configObject


233
234
235
# File 'lib/bolt/inventory/target.rb', line 233

def config
  Bolt::Util.deep_merge(group_cache['config'], @config)
end

#factsObject

rubocop:enable Naming/AccessorMethodName


90
91
92
# File 'lib/bolt/inventory/target.rb', line 90

def facts
  Bolt::Util.deep_merge(group_cache['facts'], @facts)
end

#featuresObject


99
100
101
# File 'lib/bolt/inventory/target.rb', line 99

def features
  group_cache['features'] + @features
end

#group_cacheObject


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/bolt/inventory/target.rb', line 237

def group_cache
  if @group_cache.nil?
    group_data = @inventory.group_data_for(@name)

    unless group_data && group_data['config']
      @logger.debug("Did not find config for #{self} in inventory")
    end

    group_data ||= {
      'config' => {},
      'vars' => {},
      'facts' => {},
      'features' => Set.new,
      'plugin_hooks' => {},
      'target_alias' => []
    }

    @group_cache = group_data
  end

  @group_cache
end

#hostObject


175
176
177
# File 'lib/bolt/inventory/target.rb', line 175

def host
  @uri_obj.hostname || transport_config['host']
end

#invalidate_config_cache!Object


141
142
143
144
# File 'lib/bolt/inventory/target.rb', line 141

def invalidate_config_cache!
  @transport = nil
  @transport_config = nil
end

#invalidate_group_cache!Object


135
136
137
138
139
# File 'lib/bolt/inventory/target.rb', line 135

def invalidate_group_cache!
  @group_cache = nil
  # The config cache depends on the group cache, so invalidate it as well
  invalidate_config_cache!
end

#passwordObject


217
218
219
# File 'lib/bolt/inventory/target.rb', line 217

def password
  Addressable::URI.unencode_component(@uri_obj.password) || transport_config['password']
end

#plugin_hooksObject


115
116
117
118
119
# File 'lib/bolt/inventory/target.rb', line 115

def plugin_hooks
  # Merge plugin_hooks from the config file with any defined by the group
  # or assigned dynamically to the target
  @inventory.plugins.plugin_hooks.merge(group_cache['plugin_hooks']).merge(@plugin_hooks)
end

#portObject


179
180
181
# File 'lib/bolt/inventory/target.rb', line 179

def port
  @uri_obj.port || transport_config['port']
end

#protocolObject

For remote targets, protocol is the value of the URI scheme. For non-remote targets, there is no protocol.


185
186
187
188
189
# File 'lib/bolt/inventory/target.rb', line 185

def protocol
  if remote?
    @uri_obj.scheme
  end
end

#remote?Boolean

Returns:

  • (Boolean)

209
210
211
# File 'lib/bolt/inventory/target.rb', line 209

def remote?
  transport == 'remote'
end

#resource(type, title) ⇒ Object


111
112
113
# File 'lib/bolt/inventory/target.rb', line 111

def resource(type, title)
  resources[Bolt::ResourceInstance.format_reference(type, title)]
end

#set_config(key_or_key_path, value) ⇒ Object


121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/bolt/inventory/target.rb', line 121

def set_config(key_or_key_path, value)
  if key_or_key_path.empty?
    @config = value
  else
    *path, key = Array(key_or_key_path)
    location = path.inject(@config) do |working_object, p|
      working_object[p] ||= {}
    end
    location[key] = value
  end

  invalidate_config_cache!
end

#set_feature(feature, value = true) ⇒ Object


103
104
105
106
107
108
109
# File 'lib/bolt/inventory/target.rb', line 103

def set_feature(feature, value = true)
  if value
    @features << feature
  else
    @features.delete(feature)
  end
end

#set_local_defaultsObject


53
54
55
56
57
58
59
60
61
62
63
# File 'lib/bolt/inventory/target.rb', line 53

def set_local_defaults
  return if @set_local_default
  defaults = {
    'local' => { 'interpreters' => { '.rb' => RbConfig.ruby } }
  }
  old_config = @config
  @config = Bolt::Util.deep_merge(defaults, @config)
  invalidate_config_cache! if old_config != @config
  set_feature('puppet-agent')
  @set_local_default = true
end

#set_resource(resource) ⇒ Object

rubocop:disable Naming/AccessorMethodName


66
67
68
69
70
71
72
73
74
75
# File 'lib/bolt/inventory/target.rb', line 66

def set_resource(resource)
  if (existing_resource = resources[resource.reference])
    existing_resource.overwrite_state(resource.state)
    existing_resource.overwrite_desired_state(resource.desired_state)
    existing_resource.events = existing_resource.events + resource.events
    existing_resource
  else
    @resources[resource.reference] = resource
  end
end

#set_var(var_hash) ⇒ Object

This method isn't actually an accessor and we want the name to correspond to the Puppet function rubocop:disable Naming/AccessorMethodName


85
86
87
# File 'lib/bolt/inventory/target.rb', line 85

def set_var(var_hash)
  @vars.merge!(var_hash)
end

#to_sObject


260
261
262
# File 'lib/bolt/inventory/target.rb', line 260

def to_s
  @safe_name
end

#transportObject

For remote targets, the transport is always 'remote'. Otherwise, it will be either the URI scheme or set explicitly.


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/bolt/inventory/target.rb', line 193

def transport
  if @transport.nil?
    config_transport = @config['transport'] ||
                       group_cache.dig('config', 'transport') ||
                       @inventory.transport

    @transport = if @uri_obj.scheme == 'remote' || config_transport == 'remote'
                   'remote'
                 else
                   @uri_obj.scheme || config_transport
                 end
  end

  @transport
end

#transport_configObject

We only want to look up transport config keys for the configured transport


223
224
225
226
227
228
229
230
231
# File 'lib/bolt/inventory/target.rb', line 223

def transport_config
  if @transport_config.nil?
    config = @inventory.config[transport]
                       .merge(group_cache.dig('config', transport), @config[transport])
    @transport_config = config
  end

  @transport_config
end

#userObject


213
214
215
# File 'lib/bolt/inventory/target.rb', line 213

def user
  Addressable::URI.unencode_component(@uri_obj.user) || transport_config['user']
end

#validateObject

Validate the target. This implicitly also primes the group and config caches and resolves any config references in the target's groups.


148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/bolt/inventory/target.rb', line 148

def validate
  unless name.ascii_only?
    raise Bolt::Inventory::ValidationError.new("Target name must be ASCII characters: #{@name}", nil)
  end

  unless transport.nil? || Bolt::TRANSPORTS.include?(transport.to_sym)
    raise Bolt::UnknownTransportError.new(transport, uri)
  end

  validate_fact_names(facts)

  transport_config
end

#varsObject

rubocop:enable Naming/AccessorMethodName


78
79
80
# File 'lib/bolt/inventory/target.rb', line 78

def vars
  group_cache['vars'].merge(@vars)
end