Class: Puppet::Transaction::ResourceHarness

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/vendor/puppet/transaction/resource_harness.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transaction) ⇒ ResourceHarness

Returns a new instance of ResourceHarness.



153
154
155
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 153

def initialize(transaction)
  @transaction = transaction
end

Instance Attribute Details

#transaction ⇒ Object (readonly)

Returns the value of attribute transaction.



7
8
9
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 7

def transaction
  @transaction
end

Instance Method Details

#allow_changes?(resource) ⇒ Boolean

Returns:

  • (Boolean) 


9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 9

def allow_changes?(resource)
  if resource.purging? and resource.deleting? and deps = relationship_graph.dependents(resource) \
          and ! deps.empty? and deps.detect { |d| ! d.deleting? }
    deplabel = deps.collect { |r| r.ref }.join(",")
    plurality = deps.length > 1 ? "":"s"
    resource.warning "#{deplabel} still depend#{plurality} on me -- not purging"
    false
  else
    true
  end
end

#apply_parameter(property, current_value, do_audit, historical_value) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 101

def apply_parameter(property, current_value, do_audit, historical_value)
  event = create_change_event(property, current_value, do_audit, historical_value)

  if do_audit && historical_value && historical_value != current_value
    brief_audit_message = " (previously recorded value was #{property.is_to_s(historical_value)})"
  else
    brief_audit_message = ""
  end

  if property.noop
    event.message = "current_value #{property.is_to_s(current_value)}, should be #{property.should_to_s(property.should)} (noop)#{brief_audit_message}"
    event.status = "noop"
  else
    property.sync
    event.message = [ property.change_to_s(current_value, property.should), brief_audit_message ].join
    event.status = "success"
  end
  event
rescue => detail
  puts detail.backtrace if Puppet[:trace]
  event.status = "failure"

  event.message = "change from #{property.is_to_s(current_value)} to #{property.should_to_s(property.should)} failed: #{detail}"
  event
ensure
  event.send_log
end

#cache(resource, name, value) ⇒ Object

Used mostly for scheduling and auditing at this point.



27
28
29
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 27

def cache(resource, name, value)
  Puppet::Util::Storage.cache(resource)[name] = value
end

#cached(resource, name) ⇒ Object

Used mostly for scheduling and auditing at this point.



22
23
24
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 22

def cached(resource, name)
  Puppet::Util::Storage.cache(resource)[name]
end

#create_change_event(property, current_value, do_audit, historical_value) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 84

def create_change_event(property, current_value, do_audit, historical_value)
  event = property.event
  event.previous_value = current_value
  event.desired_value = property.should
  event.historical_value = historical_value

  if do_audit
    event.audited = true
    event.status = "audit"
    if historical_value != current_value
      event.message = "audit change: previously recorded value #{property.is_to_s(historical_value)} has been changed to #{property.is_to_s(current_value)}"
    end
  end

  event
end

#evaluate(resource) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 129

def evaluate(resource)
  start = Time.now
  status = Puppet::Resource::Status.new(resource)

  perform_changes(resource).each do |event|
    status << event
  end

  if status.changed? && ! resource.noop?
    cache(resource, :synced, Time.now)
    resource.flush if resource.respond_to?(:flush)
  end

  return status
rescue => detail
  resource.fail "Could not create resource status: #{detail}" unless status
  puts detail.backtrace if Puppet[:trace]
  resource.err "Could not evaluate: #{detail}"
  status.failed = true
  return status
ensure
  (status.evaluation_time = Time.now - start) if status
end

#perform_changes(resource) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 31

def perform_changes(resource)
  current = resource.retrieve_resource

  cache resource, :checked, Time.now

  return [] if ! allow_changes?(resource)

  current_values = current.to_hash
  historical_values = Puppet::Util::Storage.cache(resource).dup
  desired_values = {}
  resource.properties.each do |property|
    desired_values[property.name] = property.should
  end
  audited_params = (resource[:audit] || []).map { |p| p.to_sym }
  synced_params = []

  # Record the current state in state.yml.
  audited_params.each do |param|
    cache(resource, param, current_values[param])
  end

  # Update the machine state & create logs/events
  events = []
  ensure_param = resource.parameter(:ensure)
  if desired_values[:ensure] && !ensure_param.safe_insync?(current_values[:ensure])
    events << apply_parameter(ensure_param, current_values[:ensure], audited_params.include?(:ensure), historical_values[:ensure])
    synced_params << :ensure
  elsif current_values[:ensure] != :absent
    work_order = resource.properties # Note: only the resource knows what order to apply changes in
    work_order.each do |param|
      if desired_values[param.name] && !param.safe_insync?(current_values[param.name])
        events << apply_parameter(param, current_values[param.name], audited_params.include?(param.name), historical_values[param.name])
        synced_params << param.name
      end
    end
  end

  # Add more events to capture audit results
  audited_params.each do |param_name|
    if historical_values.include?(param_name)
      if historical_values[param_name] != current_values[param_name] && !synced_params.include?(param_name)
        event = create_change_event(resource.parameter(param_name), current_values[param_name], true, historical_values[param_name])
        event.send_log
        events << event
      end
    else
      resource.property(param_name).notice "audit change: newly-recorded value #{current_values[param_name]}"
    end
  end

  events
end

#schedule(resource) ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 169

def schedule(resource)
  unless resource.catalog
    resource.warning "Cannot schedule without a schedule-containing catalog"
    return nil
  end

  return nil unless name = resource[:schedule]
  resource.catalog.resource(:schedule, name) || resource.fail("Could not find schedule #{name}")
end

#scheduled?(status, resource) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/vendor/puppet/transaction/resource_harness.rb', line 157

def scheduled?(status, resource)
  return true if Puppet[:ignoreschedules]
  return true unless schedule = schedule(resource)

  # We use 'checked' here instead of 'synced' because otherwise we'll
  # end up checking most resources most times, because they will generally
  # have been synced a long time ago (e.g., a file only gets updated
  # once a month on the server and its schedule is daily; the last sync time
  # will have been a month ago, so we'd end up checking every run).
  schedule.match?(cached(resource, :checked).to_i)
end