mirror of
https://github.com/inspec/inspec
synced 2024-11-23 05:03:07 +00:00
ea7c0c493e
When SimpleConfig parses a config file that has sections, such as a mysqld
config file, the values within that section are returned via a Hash. However,
we do not provide an easy way to write tests for those deep hash values:
```
describe mysql_conf('/tmp/my.cnf') do
its('mysqld.expire_logs_days') { should cmp 10 }
end
MySQL Configuration
∅ undefined method `expire_logs_days' for #<Hash:0x007fe463795a00>
```
This change provides a method-based accessor for Hashes that are built via
SimpleConfig.
```
describe mysql_conf('/tmp/my.cnf') do
its('mysqld.expire_logs_days') { should cmp 10 }
end
MySQL Configuration
✔ mysqld.expire_logs_days should cmp == 10
```
Fixes #1541 by changing the way the attributes are fetched.
Signed-off-by: Adam Leff <adam@leff.co>
121 lines
3.2 KiB
Ruby
121 lines
3.2 KiB
Ruby
# encoding: utf-8
|
|
# copyright: 2015, Dominik Richter
|
|
# license: All rights reserved
|
|
# author: Dominik Richter
|
|
# author: Christoph Hartmann
|
|
|
|
require 'utils/parser'
|
|
|
|
class SimpleConfig
|
|
include CommentParser
|
|
|
|
attr_reader :params, :groups
|
|
def initialize(raw_data, opts = {})
|
|
parse(raw_data, opts)
|
|
end
|
|
|
|
# Parse some data
|
|
# quotes: quoting characters, which are parsed, so everything inside
|
|
# it will be part of a string
|
|
# multiline: allow quoted text to span multiple lines
|
|
# comment_char: char which identifies comments
|
|
# standalone_comments: comments must appear alone in a line; if set to true,
|
|
# no comments can be added to the end of an assignment/statement line
|
|
def parse(raw_data, opts = nil)
|
|
@params = {}
|
|
@groups = []
|
|
@vals = @params
|
|
options = default_options.merge(opts || {})
|
|
return if raw_data.nil?
|
|
|
|
# prepare raw data if required
|
|
if !options[:line_separator].nil?
|
|
raw_data = raw_data.tr(options[:line_separator], "\n")
|
|
end
|
|
rest = raw_data
|
|
rest = parse_rest(rest, options) until rest.empty?
|
|
end
|
|
|
|
private
|
|
|
|
def parse_values(match, values)
|
|
start_idx = 2
|
|
i = 0
|
|
count = values - 1
|
|
return match[start_idx] if values == 1
|
|
|
|
# iterate over expected parameters
|
|
values = []
|
|
loop do
|
|
values.push(match[start_idx + i])
|
|
i += 1
|
|
break if i > count
|
|
end
|
|
values
|
|
end
|
|
|
|
def parse_params_line(line, opts)
|
|
# now line contains what we are interested in parsing
|
|
# check if it is an assignment
|
|
m = opts[:assignment_re].match(line)
|
|
return nil if m.nil?
|
|
|
|
if opts[:multiple_values]
|
|
@vals[m[1]] ||= []
|
|
@vals[m[1]].push(parse_values(m, opts[:key_vals]))
|
|
else
|
|
@vals[m[1]] = parse_values(m, opts[:key_vals])
|
|
end
|
|
end
|
|
|
|
def parse_group_line(line, opts)
|
|
return nil if opts[:group_re].nil?
|
|
m = opts[:group_re].match(line)
|
|
return nil if m.nil?
|
|
@groups.push(m[1])
|
|
|
|
# We use a Hashie::Mash to provide method syntax for retrieving
|
|
# values. For configs that have keys whose values may be hashes
|
|
# (such as a mysql config that has [sections]), providing
|
|
# a hash whose values are accessible via methods provide
|
|
# a better user experience with `its` blocks.
|
|
@vals = @params[m[1]] = Hashie::Mash.new
|
|
end
|
|
|
|
def parse_implicit_assignment_line(line, opts)
|
|
return nil if is_empty_line(line)
|
|
if opts[:multiple_values]
|
|
@vals[line.strip] ||= []
|
|
else
|
|
@vals[line.strip] = ''
|
|
end
|
|
end
|
|
|
|
def parse_rest(rest, opts)
|
|
line, idx_nl = parse_comment_line(rest, opts)
|
|
parse_params_line(line, opts) or
|
|
parse_group_line(line, opts) or
|
|
parse_implicit_assignment_line(line, opts)
|
|
|
|
# return whatever is left
|
|
rest[(idx_nl + 1)..-1] || ''
|
|
end
|
|
|
|
def is_empty_line(l)
|
|
l =~ /^\s*$/
|
|
end
|
|
|
|
def default_options
|
|
{
|
|
quotes: '',
|
|
multiline: false,
|
|
comment_char: '#',
|
|
line_separator: nil, # uses this char to seperate lines before parsing
|
|
assignment_re: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/,
|
|
group_re: /\[([^\]]+)\]\s*$/,
|
|
key_vals: 1, # default for key=value, may require for 'key val1 val2 val3'
|
|
standalone_comments: false,
|
|
multiple_values: false,
|
|
}
|
|
end
|
|
end
|