Class: Puppet::Resource::Status Private

Inherits:
Object
  • Object
show all
Includes:
Network::FormatSupport, Util::PsychSupport, Util::Tagging
Defined in:
lib/puppet/resource/status.rb

Overview

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

This class represents the result of evaluating a given resource. It contains file and line information about the source, events generated while evaluating the resource, timing information, and the status of the resource evaluation.

API:

  • private

Constant Summary collapse

STATES =

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

Boolean status types set while evaluating ‘@real_resource`.

API:

  • private

[:skipped, :failed, :failed_to_restart, :restarted, :changed, :out_of_sync, :scheduled, :corrective_change]
YAML_ATTRIBUTES =

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

A list of instance variables that should be serialized with this object when converted to YAML.

API:

  • private

%w{@resource @file @line @evaluation_time @change_count
                   @out_of_sync_count @tags @time @events @out_of_sync
                   @changed @resource_type @title @skipped @failed
                   @containment_path}.
map(&:to_sym)

Constants included from Util::Tagging

Util::Tagging::ValidTagRegex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Network::FormatSupport

included, #mime, #render, #support_format?, #to_json, #to_msgpack, #to_pson

Methods included from Util::Tagging

#merge_into, #merge_tags, #raw_tagged?, #set_tags, #tag, #tag_if_valid, #tagged?, #tags, #tags=

Methods included from Util::PsychSupport

#encode_with, #init_with

Constructor Details

#initialize(resource) ⇒ Status

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 a new instance of Status.

API:

  • private



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/puppet/resource/status.rb', line 152

def initialize(resource)
  @real_resource = resource
  @source_description = resource.path
  @containment_path = resource.pathbuilder
  @resource = resource.to_s
  @change_count = 0
  @out_of_sync_count = 0
  @changed = false
  @out_of_sync = false
  @skipped = false
  @failed = false
  @corrective_change = false

  @file = resource.file
  @line = resource.line

  tag(*resource.tags)
  @time = Time.now
  @events = []
  @resource_type = resource.type.to_s.capitalize
  @title = resource.title
end

Instance Attribute Details

#change_count ⇒ Object (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.

API:

  • private



64
65
66
 
# File 'lib/puppet/resource/status.rb', line 64

def change_count
  @change_count
end

#containment_path ⇒ Object (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.

API:

  • private



51
52
53
 
# File 'lib/puppet/resource/status.rb', line 51

def containment_path
  @containment_path
end

#corrective_change ⇒ Object (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.

API:

  • private



88
89
90
 
# File 'lib/puppet/resource/status.rb', line 88

def corrective_change
  @corrective_change
end

#evaluation_time ⇒ Float

Returns The time elapsed in sections while evaluating ‘@real_resource`. measured in seconds.

Returns:

  • The time elapsed in sections while evaluating ‘@real_resource`. measured in seconds.



30
31
32
 
# File 'lib/puppet/resource/status.rb', line 30

def evaluation_time
  @evaluation_time
end

#events ⇒ Object (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.

API:

  • private



84
85
86
 
# File 'lib/puppet/resource/status.rb', line 84

def events
  @events
end

#failed_dependencies ⇒ Array<Puppet::Resource>

dependencies of this resource that failed to apply.

Returns:

  • A cache of all



93
94
95
 
# File 'lib/puppet/resource/status.rb', line 93

def failed_dependencies
  @failed_dependencies
end

#file ⇒ String

Returns The file where ‘@real_resource` was defined.

Returns:

  • The file where ‘@real_resource` was defined.



21
22
23
 
# File 'lib/puppet/resource/status.rb', line 21

def file
  @file
end

#line ⇒ Integer

Returns The line number in the file where ‘@real_resource` was defined.

Returns:

  • The line number in the file where ‘@real_resource` was defined.



25
26
27
 
# File 'lib/puppet/resource/status.rb', line 25

def line
  @line
end

#out_of_sync_count ⇒ Object (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.

API:

  • private



69
70
71
 
# File 'lib/puppet/resource/status.rb', line 69

def out_of_sync_count
  @out_of_sync_count
end

#resource ⇒ Object (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.

API:

  • private



59
60
61
 
# File 'lib/puppet/resource/status.rb', line 59

def resource
  @resource
end

#resource_type ⇒ Object (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.

API:

  • private



75
76
77
 
# File 'lib/puppet/resource/status.rb', line 75

def resource_type
  @resource_type
end

#source_description ⇒ Object (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.

API:

  • private



42
43
44
 
# File 'lib/puppet/resource/status.rb', line 42

def source_description
  @source_description
end

#time ⇒ Object (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.

API:

  • private



55
56
57
 
# File 'lib/puppet/resource/status.rb', line 55

def time
  @time
end

#title ⇒ Object (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.

API:

  • private



79
80
81
 
# File 'lib/puppet/resource/status.rb', line 79

def title
  @title
end

Class Method Details

.from_data_hash(data) ⇒ 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.

API:

  • private



107
108
109
110
111
 
# File 'lib/puppet/resource/status.rb', line 107

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

Instance Method Details

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

API:

  • private



120
121
122
123
 
# File 'lib/puppet/resource/status.rb', line 120

def <<(event)
  add_event(event)
  self
end

#add_event(event) ⇒ 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.

API:

  • private



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/puppet/resource/status.rb', line 125

def add_event(event)
  @events << event
  if event.status == 'failure'
    self.failed = true
  elsif event.status == 'success'
    @change_count += 1
    @changed = true
  end
  if event.status != 'audit'
    @out_of_sync_count += 1
    @out_of_sync = true
  end
  if event.corrective_change
    @corrective_change = true
  end
end

#dependency_failed? ⇒ Boolean

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:

API:

  • private



95
96
97
 
# File 'lib/puppet/resource/status.rb', line 95

def dependency_failed?
  failed_dependencies && !failed_dependencies.empty?
end

#failed_because(detail) ⇒ 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.

API:

  • private



142
143
144
145
146
147
148
149
150
 
# File 'lib/puppet/resource/status.rb', line 142

def failed_because(detail)
  @real_resource.log_exception(detail, "Could not evaluate: #{detail}")
  failed = true
  # There's a contract (implicit unfortunately) that a status of failed
  # will always be accompanied by an event with some explanatory power.  This
  # is useful for reporting/diagnostics/etc.  So synthesize an event here
  # with the exception detail as the message.
  add_event(@real_resource.event(:name => :resource_error, :status => "failure", :message => detail.to_s))
end

#initialize_from_hash(data) ⇒ 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.

API:

  • private



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/puppet/resource/status.rb', line 175

def initialize_from_hash(data)
  @resource_type = data['resource_type']
  @title = data['title']
  @resource = data['resource']
  @containment_path = data['containment_path']
  @file = data['file']
  @line = data['line']
  @evaluation_time = data['evaluation_time']
  @change_count = data['change_count']
  @out_of_sync_count = data['out_of_sync_count']
  @tags = Puppet::Util::TagSet.new(data['tags'])
  @time = data['time']
  @time = Time.parse(@time) if @time.is_a? String
  @out_of_sync = data['out_of_sync']
  @changed = data['changed']
  @skipped = data['skipped']
  @failed = data['failed']
  @corrective_change = data['corrective_change']
  @events = data['events'].map do |event|
    # in YAML (for reports) we serialize this as an object, but
    # in PSON it becomes a hash. Depending on where we came from
    # we might not need to deserialize it.
    if event.class == Puppet::Transaction::Event
      event
    else
      Puppet::Transaction::Event.from_data_hash(event)
    end
  end
end

#to_data_hash ⇒ 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.

API:

  • private



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/puppet/resource/status.rb', line 205

def to_data_hash
  {
    'title' => @title,
    'file' => @file,
    'line' => @line,
    'resource' => @resource,
    'resource_type' => @resource_type,
    'containment_path' => @containment_path,
    'evaluation_time' => @evaluation_time,
    'tags' => @tags.to_a,
    'time' => @time.iso8601(9),
    'failed' => @failed,
    'changed' => @changed,
    'out_of_sync' => @out_of_sync,
    'skipped' => @skipped,
    'change_count' => @change_count,
    'out_of_sync_count' => @out_of_sync_count,
    'events' => @events,
    'corrective_change' => @corrective_change,
  }
end

#to_yaml_properties ⇒ 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.

API:

  • private



227
228
229
 
# File 'lib/puppet/resource/status.rb', line 227

def to_yaml_properties
  YAML_ATTRIBUTES & super
end