Module: Chef::Util::DSC::LocalConfigurationManager::Parser

Defined in:
lib/chef/util/dsc/lcm_output_parser.rb

Class Method Summary collapse

Class Method Details

.parse(lcm_output, test_dsc_configuration) ⇒ Object

Parses the output from LCM and returns a list of Chef::Util::DSC::ResourceInfo objects that describe how the resources affected the system

Example for WhatIfParser:

parse <<-EOF
What if: [Machine]: LCM: [Start Set      ]
What if: [Machine]: LCM: [Start Resource ] [[File]FileToNotBeThere]
What if: [Machine]: LCM: [Start Set      ] [[File]FileToNotBeThere]
What if:                                   [C:\ShouldNotExist.txt] removed
What if: [Machine]: LCM: [End Set        ] [[File]FileToNotBeThere] in 0.1 seconds
What if: [Machine]: LCM: [End Resource   ] [[File]FileToNotBeThere]
What if: [Machine]: LCM: [End Set        ]
EOF

would return

[
  Chef::Util::DSC::ResourceInfo.new(
    '[[File]FileToNotBeThere]',
    true,
    [
      '[[File]FileToNotBeThere]',
      '[C:\Shouldnotexist.txt]',
      '[[File]FileToNotBeThere] in 0.1 seconds'
    ]
  )
]

Example for TestDSCParser:

parse <<-EOF
InDesiredState            : False
ResourcesInDesiredState   :
ResourcesNotInDesiredState: {[Environment]texteditor}
ReturnValue               : 0
PSComputerName            : .
EOF

would return

[
  Chef::Util::DSC::ResourceInfo.new(
    '{[Environment]texteditor}',
    true,
    [
    ]
  )
]



77
78
79
80
 
# File 'lib/chef/util/dsc/lcm_output_parser.rb', line 77

def self.parse(lcm_output, test_dsc_configuration)
  lcm_output = String(lcm_output).split("\n")
  test_dsc_configuration ? test_dsc_parser(lcm_output) : what_if_parser(lcm_output)
end

.test_dsc_parser(lcm_output) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/chef/util/dsc/lcm_output_parser.rb', line 82

def self.test_dsc_parser(lcm_output)
  current_resource = {}

  resources = []
  lcm_output.each do |line|
    op_action , op_value = line.strip.split(":")
    op_action&.strip!
    case op_action
    when "InDesiredState"
      current_resource[:skipped] = op_value.strip == "True" ? true : false
    when "ResourcesInDesiredState", "ResourcesNotInDesiredState"
      current_resource[:name] = op_value.strip if op_value
    when "ReturnValue"
      current_resource[:context] = nil
    end
  end
  if current_resource[:name]
    resources.push(current_resource)
  end

  if resources.length > 0
    build_resource_info(resources)
  else
    raise Chef::Exceptions::LCMParser, "Could not parse:\n#{lcm_output}"
  end
end

.what_if_parser(lcm_output) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/chef/util/dsc/lcm_output_parser.rb', line 109

def self.what_if_parser(lcm_output)
  current_resource = {}

  resources = []
  lcm_output.each do |line|
    op_action, op_type, info = parse_line(line)

    case op_action
    when :start
      case op_type
      when :set
        if current_resource[:name]
          current_resource[:context] = :logging
          current_resource[:logs] = [info]
        end
      when :resource
        if current_resource[:name]
          resources.push(current_resource)
        end
        current_resource = { name: info }
      else
        Chef::Log.trace("Ignoring op_action #{op_action}: Read line #{line}")
      end
    when :end
      # Make sure we log the last line
      if current_resource[:context] == :logging && info.include?(current_resource[:name])
        current_resource[:logs].push(info)
      end
      current_resource[:context] = nil
    when :skip
      current_resource[:skipped] = true
    when :info
      if current_resource[:context] == :logging
        current_resource[:logs].push(info)
      end
    end
  end

  if current_resource[:name]
    resources.push(current_resource)
  end

  if resources.length > 0
    build_resource_info(resources)
  else
    raise Chef::Exceptions::LCMParser, "Could not parse:\n#{lcm_output}"
  end
end