inspec 2.1.81 → 2.1.83

data/docs/resources/parse_config.md.erb

@@ -1,103 +1,103 @@
----
-title: About the parse_config Resource
-platform: os
----
-
-# parse_config
-
-Use the `parse_config` InSpec audit resource to test arbitrary configuration files.
-
-<br>
-
-## 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'
+---
+title: About the parse_config Resource
+platform: os
+---
+
+# parse_config
+
+Use the `parse_config` InSpec audit resource to test arbitrary configuration files.
+
+<br>
+
+## 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'

data/docs/resources/parse_config_file.md.erb

@@ -1,138 +1,138 @@
----
-title: About the parse_config_file Resource
-platform: os
----
-
-# parse\_config\_file
-
-Use the `parse_config_file` InSpec audit resource to test arbitrary configuration files. It works in the same way as `parse_config`. Instead of using a command output, this resource works with files.
-
-<br>
-
-## Syntax
-
-A `parse_config_file` InSpec audit resource block declares the location of the configuration file to be tested, and then which settings in that file are to be tested.
-
-    describe parse_config_file('/path/to/file', { data_config_option: value } ) do
-      its('setting') { should eq 1 }
-    end
-
-or:
-
-    options = {
-      assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
-      multiple_values: true
-    }
-
-    describe parse_config_file('path/to/file', 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>
-
-## Options
-
-This resource supports the following options for parsing configuration data. Use them in an `options` block stated outside of (and immediately before) the actual test:
-
-    options = {
-        assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
-        multiple_values: true
-      }
-    describe parse_config_file('path/to/file',  options) do
-      its('setting') { should eq 1 }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a configuration setting
-
-    describe parse_config_file('/path/to/file.conf') do
-     its('PARAM_X') { should eq 'Y' }
-    end
-
-### Use options, and then test a configuration setting
-
-    describe parse_config_file('/path/to/file.conf', { multiple_values: true }) do
-     its('PARAM_X') { should include 'Y' }
-    end
-
-### Test a file with an ini-like structure (such as a yum.conf)
-
-    describe parse_config_file('/path/to/yum.conf') do
-     its('main') { should include('gpgcheck' => '1') }
-    end
-
-<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'
+---
+title: About the parse_config_file Resource
+platform: os
+---
+
+# parse\_config\_file
+
+Use the `parse_config_file` InSpec audit resource to test arbitrary configuration files. It works in the same way as `parse_config`. Instead of using a command output, this resource works with files.
+
+<br>
+
+## Syntax
+
+A `parse_config_file` InSpec audit resource block declares the location of the configuration file to be tested, and then which settings in that file are to be tested.
+
+    describe parse_config_file('/path/to/file', { data_config_option: value } ) do
+      its('setting') { should eq 1 }
+    end
+
+or:
+
+    options = {
+      assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+      multiple_values: true
+    }
+
+    describe parse_config_file('path/to/file', 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>
+
+## Options
+
+This resource supports the following options for parsing configuration data. Use them in an `options` block stated outside of (and immediately before) the actual test:
+
+    options = {
+        assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+        multiple_values: true
+      }
+    describe parse_config_file('path/to/file',  options) do
+      its('setting') { should eq 1 }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a configuration setting
+
+    describe parse_config_file('/path/to/file.conf') do
+     its('PARAM_X') { should eq 'Y' }
+    end
+
+### Use options, and then test a configuration setting
+
+    describe parse_config_file('/path/to/file.conf', { multiple_values: true }) do
+     its('PARAM_X') { should include 'Y' }
+    end
+
+### Test a file with an ini-like structure (such as a yum.conf)
+
+    describe parse_config_file('/path/to/yum.conf') do
+     its('main') { should include('gpgcheck' => '1') }
+    end
+
+<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'