Class: Puppet::Node::Facts

Inherits:
Object show all
Extended by:
Indirector
Includes:
Util::PsychSupport
Defined in:
lib/puppet/node/facts.rb

Overview

Manage a given node's facts. This either accepts facts and stores them, or returns facts for a given node.

Defined Under Namespace

Modules: NodeExpirer Classes: Facter, Json, Memory, NetworkDevice, Rest, StoreConfigs, Yaml

Constant Summary

Constants included from Indirector

Indirector::BadNameRegexp

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods included from Util::PsychSupport

#encode_with, #init_with

Constructor Details

#initialize(name, values = {}) ⇒ Facts

Returns a new instance of Facts.


35
36
37
38
39
40
 
# File 'lib/puppet/node/facts.rb', line 35

def initialize(name, values = {})
  @name = name
  @values = values

  add_timestamp
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.


27
28
29
 
# File 'lib/puppet/node/facts.rb', line 27

def name
  @name
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.


27
28
29
 
# File 'lib/puppet/node/facts.rb', line 27

def timestamp
  @timestamp
end

#values ⇒ Object

Returns the value of attribute values.


27
28
29
 
# File 'lib/puppet/node/facts.rb', line 27

def values
  @values
end

Class Method Details

.from_data_hash(data) ⇒ Object 


84
85
86
87
88
 
# File 'lib/puppet/node/facts.rb', line 84

def self.from_data_hash(data)
  new_facts = allocate
  new_facts.initialize_from_hash(data)
  new_facts
end

Instance Method Details

#==(other) ⇒ Object 


79
80
81
82
 
# File 'lib/puppet/node/facts.rb', line 79

def ==(other)
  return false unless self.name == other.name
  values == other.values
end

#add_extra_values(extra_values) ⇒ 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.

Add extra values, such as facts given to lookup on the command line. The extra values will override existing values.

Parameters:

  • extra_values (Hash{String=>Object}) —

    the values to add


66
67
68
69
 
# File 'lib/puppet/node/facts.rb', line 66

def add_extra_values(extra_values)
  @values.merge!(extra_values)
  nil
end

#add_local_facts ⇒ Object 


29
30
31
32
33
 
# File 'lib/puppet/node/facts.rb', line 29

def add_local_facts
  values["clientcert"] = Puppet.settings[:certname]
  values["clientversion"] = Puppet.version.to_s
  values["clientnoop"] = Puppet.settings[:noop]
end

#add_timestamp ⇒ Object 


115
116
117
 
# File 'lib/puppet/node/facts.rb', line 115

def add_timestamp
  @timestamp = Time.now
end

#initialize_from_hash(data) ⇒ Object 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/puppet/node/facts.rb', line 42

def initialize_from_hash(data)
  @name = data['name']
  @values = data['values']
  # Timestamp will be here in YAML, e.g. when reading old reports
  timestamp = @values.delete('_timestamp')
  # Timestamp will be here in JSON
  timestamp ||= data['timestamp']

  if timestamp.is_a? String
    @timestamp = Time.parse(timestamp)
  else
    @timestamp = timestamp
  end

  self.expiration = data['expiration']
  if expiration.is_a? String
    self.expiration = Time.parse(expiration)
  end
end

#sanitize ⇒ Object

Sanitize fact values by converting everything not a string, Boolean numeric, array or hash into strings.


73
74
75
76
77
 
# File 'lib/puppet/node/facts.rb', line 73

def sanitize
  values.each do |fact, value|
    values[fact] = sanitize_fact value
  end
end

#to_data_hash ⇒ Object 


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/puppet/node/facts.rb', line 90

def to_data_hash
  result = {
    'name' => name,
    'values' => values
  }

  if @timestamp
    if @timestamp.is_a? Time
      result['timestamp'] = @timestamp.iso8601(9)
    else
      result['timestamp'] = @timestamp
    end
  end

  if expiration
    if expiration.is_a? Time
      result['expiration'] = expiration.iso8601(9)
    else
      result['expiration'] = expiration
    end
  end

  result
end

#to_yaml ⇒ Object 


119
120
121
122
 
# File 'lib/puppet/node/facts.rb', line 119

def to_yaml
  facts_to_display = Psych.parse_stream(YAML.dump(self))
  quote_special_strings(facts_to_display)
end