Class: Facter::Util::Resolution

Inherits:
Object
  • Object
show all
Extended by:
Core::Execution
Includes:
LegacyFacter::Core::Resolvable, LegacyFacter::Core::Suitable
Defined in:
lib/facter/custom_facts/util/resolution.rb

Overview

Since:

  • 2.0.0

Instance Attribute Summary collapse

Attributes included from LegacyFacter::Core::Resolvable

#logger, #timeout

Instance Method Summary collapse

Methods included from Core::Execution

absolute_path?, exec, execute, execute_command, expand_command, impl, search_paths, which, with_env

Methods included from LegacyFacter::Core::Suitable

#confine, #has_weight, #suitable?, #weight

Methods included from LegacyFacter::Core::Resolvable

#flush, #limit, #on_flush, #value

Constructor Details

#initialize(name, fact) ⇒ Facter::Util::Resolution

Create a new resolution mechanism.

Parameters:

  • name (String) —

    The name of the resolution.

  • fact (Facter::Fact) —

    The fact to which this resolution will be added.

Since:

  • 2.0.0



65
66
67
68
69
70
71
72
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 65

def initialize(name, fact)
  @name = name
  @fact = fact
  @confines = []
  @value = nil
  @timeout = 0
  @weight = nil
end

Instance Attribute Details

#code ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



16
17
18
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 16

def code
  @code
end

#fact ⇒ Facter::Util::Fact (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Associated fact with this resolution.

Returns:



54
55
56
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 54

def fact
  @fact
end

#fact_type ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



16
17
18
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 16

def fact_type
  @fact_type
end

#file ⇒ Facter::Util::Fact (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Associated fact with this resolution.

Returns:

Since:

  • 2.0.0



54
55
56
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 54

def file
  @file
end

#last_evaluated ⇒ Facter::Util::Fact (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Associated fact with this resolution.

Returns:

Since:

  • 2.0.0



54
55
56
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 54

def last_evaluated
  @last_evaluated
end

#name ⇒ String

The name of this resolution. The resolution name should be unique with

respect to the given fact.

Returns:

  • (String) 


47
48
49
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 47

def name
  @name
end

#value=(value) ⇒ Object (writeonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



19
20
21
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 19

def value=(value)
  @value = value
end

Instance Method Details

#<=>(other) ⇒ bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Comparison is done based on weight and fact type.

The greater the weight, the higher the priority.
If weights are equal, we consider external facts greater than custom facts.

Returns:

  • (bool) —

    Weight comparison result

Since:

  • 2.0.0



166
167
168
169
170
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 166

def <=>(other)
  return compare_equal_weights(other) if weight == other.weight
  return 1 if weight > other.weight
  return -1 if weight < other.weight
end

#evaluate(&block) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Evaluate the given block in the context of this resolution. If a block has already been evaluated emit a warning to that effect.

Returns:

  • (String) —

    Result of the block’s evaluation

Since:

  • 2.0.0



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 89

def evaluate(&block)
  if @last_evaluated
    msg = "Already evaluated #{@name}"
    msg << " at #{@last_evaluated}" if msg.is_a? String
    msg << ', reevaluating anyways'
    log.warn msg
  end

  instance_eval(&block)

  # Ruby 1.9+ provides the source location of procs which can provide useful
  # debugging information if a resolution is being evaluated twice. Since 1.8
  # doesn't support this we opportunistically provide this information.
  @last_evaluated = if block.respond_to? :source_location
                      block.source_location.join(':')
                    else
                      true
                    end
end

#options(options) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets options for the aggregate fact

Returns:

  • (nil)

Raises:

  • (ArgumentError)

Since:

  • 2.0.0



114
115
116
117
118
119
120
121
122
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 114

def options(options)
  accepted_options = %i[name value timeout weight fact_type file is_env]

  accepted_options.each do |option_name|
    instance_variable_set("@#{option_name}", options.delete(option_name)) if options.key?(option_name)
  end

  raise ArgumentError, "Invalid resolution options #{options.keys.inspect}" unless options.keys.empty?
end

#resolution_type ⇒ Symbol

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the fact’s resolution type

Returns:

  • (Symbol) —

    The fact’s type

Since:

  • 2.0.0



79
80
81
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 79

def resolution_type
  :simple
end

#setcode(string) ⇒ Facter::Util::Resolution #setcode(&block) ⇒ Facter::Util::Resolution

Sets the code block or external program that will be evaluated to get the value of the fact.

Overloads:

  • #setcode(string) ⇒ Facter::Util::Resolution

    Sets an external program to call to get the value of the resolution

    Parameters:

    • string (String) —

      the external program to run to get the value

  • #setcode(&block) ⇒ Facter::Util::Resolution

    Sets the resolution’s value by evaluating a block at runtime

    Parameters:

    • block (Proc) —

      The block to determine the resolution’s value. This block is run when the fact is evaluated. Errors raised from inside the block are rescued and printed to stderr.

Returns:

Since:

  • 2.0.0



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/facter/custom_facts/util/resolution.rb', line 141

def setcode(string = nil, &block)
  if string
    @code = proc do
      output = Facter::Core::Execution.execute(string, on_fail: nil)
      if output.nil? || output.empty?
        nil
      else
        output
      end
    end
  elsif block_given?
    @code = block
  else
    raise ArgumentError, 'You must pass either code or a block'
  end
  self
end