mirror of
https://github.com/inspec/inspec
synced 2024-11-14 00:47:10 +00:00
4f2b66302d
When attempting to access array values via the `json` resource:
```
describe json('/tmp/test.json') do
its(['array',0]) { should eq "zero" }
end
```
... the resulting data would be an array of the size of the original array
with all the values replaced with nils:
```
expected: "zero"
got: [nil, nil, nil]
```
This was due to a bug in the ObjectTraverser mixin that mapped array values
back through `extract_value` rather than properly handling the passed-in
key(s). This worked fine for the specific data format created by the `csv`
resource but did not work `json` or any other resource that subclassed the
`JsonConfig` resource.
This change fixes the logic when dealing with an array when it's encountered,
and fixes up the `csv` resource with its own `value` method.
This change also adds tests for ObjectTraverser.
Signed-off-by: Adam Leff <adam@leff.co>
52 lines
1.6 KiB
Ruby
52 lines
1.6 KiB
Ruby
# encoding: utf-8
|
|
# author: Christoph Hartmann
|
|
# author: Dominik Richter
|
|
|
|
# Parses a csv document
|
|
# This implementation was inspired by a blog post
|
|
# @see http://technicalpickles.com/posts/parsing-csv-with-ruby
|
|
module Inspec::Resources
|
|
class CsvConfig < JsonConfig
|
|
name 'csv'
|
|
desc 'Use the csv InSpec audit resource to test configuration data in a CSV file.'
|
|
example "
|
|
describe csv('example.csv') do
|
|
its('name') { should eq(['John', 'Alice']) }
|
|
end
|
|
"
|
|
|
|
# override the parse method from JsonConfig
|
|
# Assuming a header row of name,col1,col2, it will output an array of hashes like so:
|
|
# [
|
|
# { 'name' => 'row1', 'col1' => 'value1', 'col2' => 'value2' },
|
|
# { 'name' => 'row2', 'col1' => 'value3', 'col2' => 'value4' }
|
|
# ]
|
|
def parse(content)
|
|
require 'csv'
|
|
|
|
# convert empty field to nil
|
|
CSV::Converters[:blank_to_nil] = lambda do |field|
|
|
field && field.empty? ? nil : field
|
|
end
|
|
|
|
# implicit conversion of values
|
|
csv = CSV.new(content, headers: true, converters: [:all, :blank_to_nil])
|
|
|
|
# convert to hash
|
|
csv.to_a.map(&:to_hash)
|
|
end
|
|
|
|
# override the value method from JsonConfig
|
|
# The format of the CSV hash as created by #parse is very different
|
|
# than what the YAML, JSON, and INI resources create, so using the
|
|
# #value method from JsonConfig (which uses ObjectTraverser.extract_value)
|
|
# doesn't make sense here.
|
|
def value(key)
|
|
@params.map { |x| x[key.first.to_s] }.compact
|
|
end
|
|
|
|
def to_s
|
|
"Csv #{@path}"
|
|
end
|
|
end
|
|
end
|