Class: Puppet::Transaction::Event Private

Inherits:
Object
  • Object
show all
Includes:
Network::FormatSupport, Util::Logging, Util::MethodHelper, Util::Tagging
Defined in:
lib/puppet/transaction/event.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.

A simple struct for storing what happens on the system.

API:

  • private

Constant Summary collapse

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.

API:

  • private

[:name, :resource, :property, :previous_value, :desired_value, :historical_value, :status, :message, :file, :line, :source_description, :audited, :invalidate_refreshes, :redacted, :corrective_change]
EVENT_STATUSES =

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.

API:

  • private

%w{noop success failure audit}

Constants included from Util::Logging

Util::Logging::FILE_AND_LINE, Util::Logging::FILE_NO_LINE, Util::Logging::MM, Util::Logging::NO_FILE_LINE

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::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, setup_facter_logging!, #warn_once

Methods included from Util::Tagging

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

Methods included from Util::MethodHelper

#requiredopts, #set_options, #symbolize_options

Constructor Details

#initialize(options = {}) ⇒ Event

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 Event.

API:

  • private



27
28
29
30
31
32
33
34
 
# File 'lib/puppet/transaction/event.rb', line 27

def initialize(options = {})
  @audited = false
  @redacted = false
  @corrective_change = false

  set_options(options)
  @time = Time.now
end

Instance Attribute Details

#default_log_level ⇒ 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



17
18
19
 
# File 'lib/puppet/transaction/event.rb', line 17

def default_log_level
  @default_log_level
end

#time ⇒ 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



16
17
18
 
# File 'lib/puppet/transaction/event.rb', line 16

def time
  @time
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



21
22
23
24
25
 
# File 'lib/puppet/transaction/event.rb', line 21

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

Instance Method Details

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

Calculate and set the corrective_change parameter, based on the old_system_value of the property.

Parameters:

  • system_value from last transaction

Returns:

  • true if this is a corrective_change

API:

  • private



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/puppet/transaction/event.rb', line 115

def calculate_corrective_change(old_system_value)
  # Only idempotent properties, and cases where we have an old system_value
  # are corrective_changes.
  if @property_instance.idempotent? &&
     !@property_instance.sensitive &&
     !old_system_value.nil?

    # If the values aren't insync, we have confirmed a corrective_change
    insync = @property_instance.insync_values?(old_system_value, previous_value)

    # Preserve the nil state, but flip true/false
    @corrective_change = insync.nil? ? nil : !insync
  else
    @corrective_change = false
  end
end

#eql?(event) ⇒ Boolean Also known as: ==

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



36
37
38
 
# File 'lib/puppet/transaction/event.rb', line 36

def eql?(event)
  self.class == event.class && ATTRIBUTES.all? { |attr| send(attr).eql?(event.send(attr)) }
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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/puppet/transaction/event.rb', line 41

def initialize_from_hash(data)
  data = Puppet::Pops::Serialization::FromDataConverter.convert(data, {
    :allow_unresolved => true,
    :loader => Puppet::Pops::Loaders.static_loader
  })
  @audited = data['audited']
  @property = data['property']
  @previous_value = data['previous_value']
  @desired_value = data['desired_value']
  @historical_value = data['historical_value']
  @message = data['message']
  @name = data['name'].intern if data['name']
  @status = data['status']
  @time = data['time']
  @time = Time.parse(@time) if @time.is_a? String
  @redacted = data.fetch('redacted', false)
  @corrective_change = data['corrective_change']
end

#inspect ⇒ 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



108
109
110
 
# File 'lib/puppet/transaction/event.rb', line 108

def inspect
  %Q(#<#{self.class.name} @name="#{@name.inspect}" @message="#{@message.inspect}">)
end

#property=(prop) ⇒ 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



83
84
85
86
 
# File 'lib/puppet/transaction/event.rb', line 83

def property=(prop)
  @property_instance = prop
  @property = prop.to_s
end

#resource=(res) ⇒ 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



88
89
90
91
92
93
 
# File 'lib/puppet/transaction/event.rb', line 88

def resource=(res)
  if res.respond_to?(:[]) and level = res[:loglevel]
    @default_log_level = level
  end
  @resource = res.to_s
end

#send_log ⇒ 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



95
96
97
 
# File 'lib/puppet/transaction/event.rb', line 95

def send_log
  super(log_level, message)
end

#status=(value) ⇒ 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.

Raises:

API:

  • private



99
100
101
102
 
# File 'lib/puppet/transaction/event.rb', line 99

def status=(value)
  raise ArgumentError, _("Event status can only be %{statuses}") % { statuses: EVENT_STATUSES.join(', ') } unless EVENT_STATUSES.include?(value)
  @status = value
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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/puppet/transaction/event.rb', line 60

def to_data_hash
  hash = {
    'audited' => @audited,
    'property' => @property,
    'previous_value' => @previous_value,
    'desired_value' => @desired_value,
    'historical_value' => @historical_value,
    'message' => @message,
    'name' => @name.nil? ? nil : @name.to_s,
    'status' => @status,
    'time' => @time.iso8601(9),
    'redacted' => @redacted,
    'corrective_change' => @corrective_change,
  }
  Puppet::Pops::Serialization::ToDataConverter.convert(hash, {
    :rich_data => true,
    :symbol_as_string => true,
    :local_reference => false,
    :type_by_reference => true,
    :message_prefix => 'Event'
  })
end

#to_s ⇒ 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



104
105
106
 
# File 'lib/puppet/transaction/event.rb', line 104

def to_s
  message
end