mirror of
https://github.com/inspec/inspec
synced 2024-11-27 07:00:39 +00:00
bc2458bf5a
The `yaml` resource documentation was missing many clues that users need to successfully use the resource. Signed-off-by: Adam Leff <adam@leff.co>
39 lines
900 B
Ruby
39 lines
900 B
Ruby
# encoding: utf-8
|
|
# author: Christoph Hartmann
|
|
# author: Dominik Richter
|
|
|
|
require 'yaml'
|
|
|
|
# Parses a yaml document
|
|
# Usage:
|
|
# describe yaml('.kitchen.yaml') do
|
|
# its('driver.name') { should eq('vagrant') }
|
|
# end
|
|
module Inspec::Resources
|
|
class YamlConfig < JsonConfig
|
|
name 'yaml'
|
|
desc 'Use the yaml InSpec audit resource to test configuration data in a YAML file.'
|
|
example "
|
|
describe yaml('config.yaml') do
|
|
its(['driver', 'name']) { should eq 'vagrant' }
|
|
end
|
|
|
|
describe yaml({ command: 'retrieve_data.py --yaml' }) do
|
|
its('state') { should eq 'open' }
|
|
end
|
|
|
|
describe yaml({ content: \"key1: value1\nkey2: value2\" }) do
|
|
its('key2') { should cmp 'value2' }
|
|
end
|
|
"
|
|
|
|
# override file load and parse hash from yaml
|
|
def parse(content)
|
|
YAML.load(content)
|
|
end
|
|
|
|
def to_s
|
|
"YAML #{@path}"
|
|
end
|
|
end
|
|
end
|