mirror of
https://github.com/inspec/inspec
synced 2024-12-24 03:53:15 +00:00
113 lines
2.7 KiB
Text
113 lines
2.7 KiB
Text
---
|
|
title: About the parse_config Resource
|
|
platform: os
|
|
---
|
|
|
|
# parse_config
|
|
|
|
Use the `parse_config` InSpec audit resource to test arbitrary configuration files.
|
|
|
|
<br>
|
|
|
|
## Availability
|
|
|
|
### Installation
|
|
|
|
This resource is distributed along with InSpec itself. You can use it automatically.
|
|
|
|
### Version
|
|
|
|
This resource first became available in v1.0.0 of InSpec.
|
|
|
|
## Syntax
|
|
|
|
A `parse_config` resource block declares the location of the configuration setting to be tested, and then what value is to be tested. Because this resource relies on arbitrary configuration files, the test itself is often arbitrary and relies on custom Ruby code:
|
|
|
|
output = command('some-command').stdout
|
|
|
|
describe parse_config(output, { data_config_option: value } ) do
|
|
its('setting') { should eq 1 }
|
|
end
|
|
|
|
or:
|
|
|
|
audit = command('/sbin/auditctl -l').stdout
|
|
options = {
|
|
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
|
multiple_values: true
|
|
}
|
|
|
|
describe parse_config(audit, options) do
|
|
its('setting') { should eq 1 }
|
|
end
|
|
|
|
where each test
|
|
|
|
* Must declare the location of the configuration file to be tested
|
|
* Must declare one (or more) settings to be tested
|
|
* May run a command to `stdout`, and then run the test against that output
|
|
* May use options to define how configuration data is to be parsed
|
|
|
|
<br>
|
|
|
|
## Matchers
|
|
|
|
For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
|
|
|
|
### assignment_regex
|
|
|
|
Use `assignment_regex` to test a key value using a regular expression:
|
|
|
|
'key = value'
|
|
|
|
may be tested using the following regular expression, which determines assignment from key to value:
|
|
|
|
assignment_regex: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/
|
|
|
|
### comment_char
|
|
|
|
Use `comment_char` to test for comments in a configuration file:
|
|
|
|
comment_char: '#'
|
|
|
|
### key_values
|
|
|
|
Use `key_values` to test how many values a key contains:
|
|
|
|
key = a b c
|
|
|
|
contains three values. To test that value to ensure it only contains one, use:
|
|
|
|
key_values: 1
|
|
|
|
### multiple_values
|
|
|
|
Use `multiple_values` if the source file uses the same key multiple times. All values will be aggregated in an array:
|
|
|
|
# # file structure:
|
|
# key = a
|
|
# key = b
|
|
# key2 = c
|
|
params['key'] = ['a', 'b']
|
|
params['key2'] = ['c']
|
|
|
|
To use plain key value mapping, use `multiple_values: false`:
|
|
|
|
# # file structure:
|
|
# key = a
|
|
# key = b
|
|
# key2 = c
|
|
params['key'] = 'b'
|
|
params['key2'] = 'c'
|
|
|
|
### standalone_comments
|
|
|
|
Use `standalone_comments` to parse comments as a line, otherwise inline comments are allowed:
|
|
|
|
'key = value # comment'
|
|
params['key'] = 'value # comment'
|
|
|
|
Use `standalone_comments: false`, to parse the following:
|
|
|
|
'key = value # comment'
|
|
params['key'] = 'value'
|