inspec/lib/resources/xml.rb
Adam Leff 6c3ab70dd1
json resource (et. al.): allow inspec check to succeed when using command (#2317)
* json resource (et. al.): allow inspec check to succeed when using command

When using the `json` resource (or any of the resources that subclass
JsonConfig), `inspec check` would fail if the content was supplied with
the `command` option. This is because the `command` resource is mocked
and an empty string would be returned for `stdout`. That content would
be blindly passed to the `parse` method would which raise an exception
and cause `inspec check` to fail.

This change refactors JsonConfig to be a bit cleaner and use some helper
methods. Additionally, we use the new Exceptions to properly raise errors
which are naturally caught by Inspec::Profile, etc.

Signed-off-by: Adam Leff <adam@leff.co>

* Make `resource_base_name` method private

Signed-off-by: Adam Leff <adam@leff.co>
2017-11-27 11:13:02 -05:00

33 lines
800 B
Ruby

# encoding: utf-8
# author: Jonathan Morley
module Inspec::Resources
class XmlConfig < JsonConfig
name 'xml'
desc 'Use the xml InSpec resource to test configuration data in an XML file'
example "
describe xml('default.xml') do
its('key/sub_key') { should eq(['value']) }
end
"
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)
REXML::XPath.each(@params, key.first.to_s).map(&:text)
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