inspec/lib/resources/xml.rb
Lynn Frank 2857d07151 Fixes resource examples
The opening and closing mechanic varied between all the various
resources. This changes them all to use a HEREDOC with a tilde
to remove leading whitespace. This removes the need for the
special method to trim the `#print_example` method from shell.

Signed-off-by: Franklin Webber <franklin.webber@gmail.com>
2019-03-19 11:25:41 -05:00

48 lines
1.4 KiB
Ruby

# encoding: utf-8
module Inspec::Resources
class XmlConfig < JsonConfig
name 'xml'
supports platform: 'unix'
supports platform: 'windows'
desc 'Use the xml InSpec resource to test configuration data in an XML file'
example <<~EXAMPLE
describe xml('default.xml') do
its('key/sub_key') { should eq(['value']) }
its(['root/name.with.a.period']) { should cmp 'so_many_dots' }
end
EXAMPLE
def parse(content)
require 'rexml/document'
REXML::Document.new(content)
rescue => e
raise Inspec::Exceptions::ResourceFailed, "Unable to parse XML: #{e.message}"
end
def value(key)
output = []
REXML::XPath.each(@params, key.first.to_s) do |element|
if element.is_a?(REXML::Attribute)
output.push(element.to_s)
elsif element.is_a?(REXML::Element)
output.push(element.text)
elsif element.is_a?(Integer) || element.is_a?(TrueClass) || element.is_a?(FalseClass) || element.is_a?(String)
output.push(element)
else
raise Inspec::Exceptions::ResourceFailed, "Unknown XML object received (#{element.class}): #{element}"
end
end
output
end
private
# used by JsonConfig to build up a full to_s method
# based on whether a file path, content, or command was supplied.
def resource_base_name
'XML'
end
end
end