Class: Puppet::Indirector::Indirection

Inherits:
Object
  • Object
show all
Includes:
Util::Docs
Defined in:
lib/puppet/indirector/indirection.rb

Overview

The class that connects functional classes with their different collection back-ends. Each indirection has a set of associated terminus classes, each of which is a subclass of Puppet::Indirector::Terminus.

Constant Summary collapse

@@indirections = 
[]

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Instance Attribute Summary collapse

Attributes included from Util::Docs

#nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Constructor Details

#initialize(model, name, doc: nil, indirected_class: nil, cache_class: nil, terminus_class: nil, terminus_setting: nil, extend: nil) ⇒ Indirection

Returns a new instance of Indirection.

Raises:

  • (ArgumentError) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/puppet/indirector/indirection.rb', line 100

def initialize(model, name, doc: nil, indirected_class: nil, cache_class: nil, terminus_class: nil, terminus_setting: nil, extend: nil)
  @model = model
  @name = name
  @termini = {}

  @doc = doc

  raise(ArgumentError, _("Indirection %{name} is already defined") % { name: @name }) if @@indirections.find { |i| i.name == @name }

  @@indirections << self

  @indirected_class = indirected_class
  self.extend(extend) if extend

  # Setting these depend on the indirection already being installed so they have to be at the end
  set_global_setting(:cache_class, cache_class)
  set_global_setting(:terminus_class, terminus_class)
  set_global_setting(:terminus_setting, terminus_setting)
end

Instance Attribute Details

#model ⇒ Object

Returns the value of attribute model.



15
16
17
 
# File 'lib/puppet/indirector/indirection.rb', line 15

def model
  @model
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/puppet/indirector/indirection.rb', line 15

def name
  @name
end

#termini ⇒ Object (readonly)

Returns the value of attribute termini.



16
17
18
 
# File 'lib/puppet/indirector/indirection.rb', line 16

def termini
  @termini
end

Class Method Details

.instance(name) ⇒ Object

Find an indirection by name. This is provided so that Terminus classes can specifically hook up with the indirections they are associated with.



22
23
24
 
# File 'lib/puppet/indirector/indirection.rb', line 22

def self.instance(name)
  @@indirections.find { |i| i.name == name }
end

.instances ⇒ Object

Return a list of all known indirections. Used to generate the reference.



28
29
30
 
# File 'lib/puppet/indirector/indirection.rb', line 28

def self.instances
  @@indirections.collect(&:name)
end

.model(name) ⇒ Object

Find an indirected model by name. This is provided so that Terminus classes can specifically hook up with the indirections they are associated with.



34
35
36
37
38
39
 
# File 'lib/puppet/indirector/indirection.rb', line 34

def self.model(name)
  match = @@indirections.find { |i| i.name == name }
  return nil unless match

  match.model
end

Instance Method Details

#allow_remote_requests? ⇒ Boolean

Returns:

  • (Boolean) 


212
213
214
 
# File 'lib/puppet/indirector/indirection.rb', line 212

def allow_remote_requests?
  terminus.allow_remote_requests?
end

#cache ⇒ Object

Create and return our cache terminus.

Raises:



42
43
44
45
46
 
# File 'lib/puppet/indirector/indirection.rb', line 42

def cache
  raise Puppet::DevError, _("Tried to cache when no cache class was set") unless cache_class

  terminus(cache_class)
end

#cache? ⇒ Boolean

Should we use a cache?

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/puppet/indirector/indirection.rb', line 49

def cache?
  cache_class ? true : false
end

#cache_class ⇒ Object 



53
54
55
 
# File 'lib/puppet/indirector/indirection.rb', line 53

def cache_class
  @cache_class.value
end

#cache_class=(class_name) ⇒ Object

Define a terminus class to be used for caching.



58
59
60
61
 
# File 'lib/puppet/indirector/indirection.rb', line 58

def cache_class=(class_name)
  validate_terminus_class(class_name) if class_name
  @cache_class.value = class_name
end

#delete ⇒ Object

This is only used for testing.



64
65
66
 
# File 'lib/puppet/indirector/indirection.rb', line 64

def delete
  @@indirections.delete(self) if @@indirections.include?(self)
end

#destroy(key, options = {}) ⇒ Object

Remove something via the terminus.



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/puppet/indirector/indirection.rb', line 286

def destroy(key, options = {})
  request = request(:destroy, key, nil, options)
  terminus = prepare(request)

  result = terminus.destroy(request)

  if cache? and cache.find(request(:find, key, nil, options))
    # Reuse the existing request, since it's equivalent.
    cache.destroy(request)
  end

  result
end

#doc ⇒ Object

Generate the full doc string.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/puppet/indirector/indirection.rb', line 87

def doc
  text = ''.dup

  text << scrub(@doc) << "\n\n" if @doc

  text << "* **Indirected Class**: `#{@indirected_class}`\n";
  if terminus_setting
    text << "* **Terminus Setting**: #{terminus_setting}\n"
  end

  text
end

#expiration ⇒ Object

Calculate the expiration date for a returned instance.



82
83
84
 
# File 'lib/puppet/indirector/indirection.rb', line 82

def expiration
  Time.now + ttl
end

#expire(key, options = {}) ⇒ Object

Expire a cached object, if one is cached. Note that we don’t actually remove it, we expire it and write it back out to disk. This way people can still use the expired object if they want.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/puppet/indirector/indirection.rb', line 196

def expire(key, options = {})
  request = request(:expire, key, nil, options)

  return nil unless cache? && !request.ignore_cache_save?

  instance = cache.find(request(:find, key, nil, options))
  return nil unless instance

  Puppet.info _("Expiring the %{cache} cache of %{instance}") % { cache: name, instance: instance.name }

  # Set an expiration date in the past
  instance.expiration = Time.now - 60

  cache.save(request(:save, nil, instance, options))
end

#find(key, options = {}) ⇒ Object

Search for an instance in the appropriate terminus, caching the results if caching is configured..



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
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/puppet/indirector/indirection.rb', line 218

def find(key, options = {})
  request = request(:find, key, nil, options)
  terminus = prepare(request)

  result = find_in_cache(request)
  if !result.nil?
    result
  elsif request.ignore_terminus?
    nil
  else
    # Otherwise, return the result from the terminus, caching if
    # appropriate.
    result = terminus.find(request)
    unless result.nil?
      result.expiration ||= expiration if result.respond_to?(:expiration)
      if cache? && !request.ignore_cache_save?
        Puppet.info _("Caching %{indirection} for %{request}") % { indirection: name, request: request.key }
        begin
          cache.save request(:save, key, result, options)
        rescue => detail
          Puppet.log_exception(detail)
          raise detail
        end
      end

      filtered = result
      if terminus.respond_to?(:filter)
        Puppet::Util::Profiler.profile(_("Filtered result for %{indirection} %{request}") % { indirection: name, request: request.key }, [:indirector, :filter, name, request.key]) do
          filtered = terminus.filter(result)
        rescue Puppet::Error => detail
          Puppet.log_exception(detail)
          raise detail
        end
      end
      filtered
    end
  end
end

#find_in_cache(request) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/puppet/indirector/indirection.rb', line 268

def find_in_cache(request)
  # See if our instance is in the cache and up to date.
  cached = cache.find(request) if cache? && !request.ignore_cache?
  return nil unless cached

  if cached.expired?
    Puppet.info _("Not using expired %{indirection} for %{request} from cache; expired at %{expiration}") % { indirection: name, request: request.key, expiration: cached.expiration }
    return nil
  end

  Puppet.debug { "Using cached #{name} for #{request.key}" }
  cached
rescue => detail
  Puppet.log_exception(detail, _("Cached %{indirection} for %{request} failed: %{detail}") % { indirection: name, request: request.key, detail: detail })
  nil
end

#head(key, options = {}) ⇒ Object

Search for an instance in the appropriate terminus, and return a boolean indicating whether the instance was found.



259
260
261
262
263
264
265
266
 
# File 'lib/puppet/indirector/indirection.rb', line 259

def head(key, options = {})
  request = request(:head, key, nil, options)
  terminus = prepare(request)

  # Look in the cache first, then in the terminus.  Force the result
  # to be a boolean.
  !!(find_in_cache(request) || terminus.head(request))
end

#request(*args) ⇒ Object

Set up our request object.



137
138
139
 
# File 'lib/puppet/indirector/indirection.rb', line 137

def request(*args)
  Puppet::Indirector::Request.new(name, *args)
end

#reset_terminus_class ⇒ Object 



171
172
173
 
# File 'lib/puppet/indirector/indirection.rb', line 171

def reset_terminus_class
  @terminus_class.value = nil
end

#save(instance, key = nil, options = {}) ⇒ Object

Save the instance in the appropriate terminus. This method is normally an instance method on the indirected class.



320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/puppet/indirector/indirection.rb', line 320

def save(instance, key = nil, options = {})
  request = request(:save, key, instance, options)
  terminus = prepare(request)

  result = terminus.save(request) unless request.ignore_terminus?

  # If caching is enabled, save our document there
  cache.save(request) if cache? && !request.ignore_cache_save?

  result
end

#search(key, options = {}) ⇒ Object

Search for more than one instance. Should always return an array.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/puppet/indirector/indirection.rb', line 301

def search(key, options = {})
  request = request(:search, key, nil, options)
  terminus = prepare(request)

  result = terminus.search(request)
  if result
    raise Puppet::DevError, _("Search results from terminus %{terminus_name} are not an array") % { terminus_name: terminus.name } unless result.is_a?(Array)

    result.each do |instance|
      next unless instance.respond_to? :expiration

      instance.expiration ||= expiration
    end
    result
  end
end

#set_global_setting(setting, value) ⇒ Object

Use this to set indirector settings globally across threads.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/puppet/indirector/indirection.rb', line 121

def set_global_setting(setting, value)
  case setting
  when :cache_class
    validate_terminus_class(value) unless value.nil?
    @cache_class = Puppet::ThreadLocal.new(value)
  when :terminus_class
    validate_terminus_class(value) unless value.nil?
    @terminus_class = Puppet::ThreadLocal.new(value)
  when :terminus_setting
    @terminus_setting = Puppet::ThreadLocal.new(value)
  else
    raise(ArgumentError, _("The setting %{setting} is not a valid indirection setting.") % { setting: setting })
  end
end

#terminus(terminus_name = nil) ⇒ Object

Return the singleton terminus for this indirection.

Raises:



142
143
144
145
146
147
 
# File 'lib/puppet/indirector/indirection.rb', line 142

def terminus(terminus_name = nil)
  # Get the name of the terminus.
  raise Puppet::DevError, _("No terminus specified for %{name}; cannot redirect") % { name: name } unless terminus_name ||= terminus_class

  termini[terminus_name] ||= make_terminus(terminus_name)
end

#terminus_class ⇒ Object

Determine the terminus class.



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/puppet/indirector/indirection.rb', line 159

def terminus_class
  unless @terminus_class.value
    setting = terminus_setting
    if setting
      self.terminus_class = Puppet.settings[setting]
    else
      raise Puppet::DevError, _("No terminus class nor terminus setting was provided for indirection %{name}") % { name: name }
    end
  end
  @terminus_class.value
end

#terminus_class=(klass) ⇒ Object

Specify the terminus class to use.



176
177
178
179
 
# File 'lib/puppet/indirector/indirection.rb', line 176

def terminus_class=(klass)
  validate_terminus_class(klass)
  @terminus_class.value = klass
end

#terminus_setting ⇒ Object

These can be used to select the terminus class.



150
151
152
 
# File 'lib/puppet/indirector/indirection.rb', line 150

def terminus_setting
  @terminus_setting.value
end

#terminus_setting=(setting) ⇒ Object 



154
155
156
 
# File 'lib/puppet/indirector/indirection.rb', line 154

def terminus_setting=(setting)
  @terminus_setting.value = setting
end

#ttl ⇒ Object

Default to the runinterval for the ttl.



77
78
79
 
# File 'lib/puppet/indirector/indirection.rb', line 77

def ttl
  @ttl ||= Puppet[:runinterval]
end

#ttl=(value) ⇒ Object

Set the time-to-live for instances created through this indirection.

Raises:

  • (ArgumentError) 


69
70
71
72
73
74
 
# File 'lib/puppet/indirector/indirection.rb', line 69

def ttl=(value)
  # TRANSLATORS "TTL" stands for "time to live" and refers to a duration of time
  raise ArgumentError, _("Indirection TTL must be an integer") unless value.is_a?(Integer)

  @ttl = value
end

#validate_terminus_class(terminus_class) ⇒ Object

This is used by terminus_class= and cache=.



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/puppet/indirector/indirection.rb', line 182

def validate_terminus_class(terminus_class)
  unless terminus_class and terminus_class.to_s != ""
    raise ArgumentError, _("Invalid terminus name %{terminus_class}") % { terminus_class: terminus_class.inspect }
  end

  unless Puppet::Indirector::Terminus.terminus_class(name, terminus_class)
    raise ArgumentError, _("Could not find terminus %{terminus_class} for indirection %{name}") %
                         { terminus_class: terminus_class, name: name }
  end
end