inspec 1.51.15 → 1.51.18

data/docs/resources/rabbitmq_config.md.erb

@@ -1,40 +1,40 @@
----
-title: About the rabbitmq_config Resource
----
-
-# rabbitmq_config
-
-Use the `rabbitmq_config` InSpec audit resource to test configuration data for the RabbitMQ daemon located at `/etc/rabbitmq/rabbitmq.config` on Linux and Unix platforms.
-
-<br>
-
-## Syntax
-
-A `rabbitmq_config` resource block declares the RabbitMQ configuration data to be tested:
-
-    describe rabbitmq_config.params('rabbit', 'ssl_listeners') do
-      it { should cmp 5671 }
-    end
-
-where
-
-* `params` is the list of parameters configured in the RabbitMQ config file
-* `{ should cmp 5671 }` tests the value of `rabbit.ssl_listeners` as read from `rabbitmq.config` versus the value declared in the test
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the list of TCP listeners
-
-    describe rabbitmq_config.params('rabbit', 'tcp_listeners') do
-      it { should eq [5672] }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the rabbitmq_config Resource
+---
+
+# rabbitmq_config
+
+Use the `rabbitmq_config` InSpec audit resource to test configuration data for the RabbitMQ daemon located at `/etc/rabbitmq/rabbitmq.config` on Linux and Unix platforms.
+
+<br>
+
+## Syntax
+
+A `rabbitmq_config` resource block declares the RabbitMQ configuration data to be tested:
+
+    describe rabbitmq_config.params('rabbit', 'ssl_listeners') do
+      it { should cmp 5671 }
+    end
+
+where
+
+* `params` is the list of parameters configured in the RabbitMQ config file
+* `{ should cmp 5671 }` tests the value of `rabbit.ssl_listeners` as read from `rabbitmq.config` versus the value declared in the test
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the list of TCP listeners
+
+    describe rabbitmq_config.params('rabbit', 'tcp_listeners') do
+      it { should eq [5672] }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/registry_key.md.erb

@@ -1,157 +1,157 @@
----
-title: About the registry_key Resource
----
-
-# registry_key
-
-Use the `registry_key` InSpec audit resource to test key values in the Windows registry.
-
-<br>
-
-## Syntax
-
-A `registry_key` resource block declares the item in the Windows registry, the path to a setting under that item, and then one (or more) name/value pairs to be tested.
-
-Use a registry key name and path:
-
-    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule') do
-      its('Start') { should eq 2 }
-    end
-
-Use only a registry key path:
-
-    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule') do
-      its('Start') { should eq 2 }
-    end
-
-Or use a Ruby Hash:
-
-    describe registry_key({
-      name: 'Task Scheduler',
-      hive: 'HKEY_LOCAL_MACHINE',
-      key: '\SYSTEM\CurrentControlSet\services\Schedule'
-    }) do
-      its('Start') { should eq 2 }
-    end
-
-
-### Registry Key Path Separators
-
-A Windows registry key can be used as a string in Ruby code, such as when a registry key is used as the name of a recipe. In Ruby, when a registry key is enclosed in a double-quoted string (`" "`), the same backslash character (`\`) that is used to define the registry key path separator is also used in Ruby to define an escape character. Therefore, the registry key path separators must be escaped when they are enclosed in a double-quoted string. For example, the following registry key:
-
-    HKCU\SOFTWARE\Policies\Microsoft\Windows\CurrentVersion\Themes
-
-may be encloused in a single-quoted string with a single backslash:
-
-    'HKCU\SOFTWARE\path\to\key\Themes'
-
-or may be enclosed in a double-quoted string with an extra backslash as an escape character:
-
-    "HKCU\\SOFTWARE\\path\\to\\key\\Themes"
-
-
-<p class="warning">
-Please make sure that you use backslashes instead of forward slashes. Forward slashes will not work for registry keys.
-</p>
-
-    # The following will not work:
-    # describe registry_key('HKLM/SOFTWARE/Microsoft/NET Framework Setup/NDP/v4/Full/1033') do
-    #   its('Release') { should eq 378675 }
-    # end
-    # You should use:
-    describe registry_key('HKLM\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\1033') do
-      its('Release') { should eq 378675 }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the start time for the Schedule service
-
-    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\...\Schedule') do
-      its('Start') { should eq 2 }
-    end
-
-where `'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule'` is the full path to the setting.
-
-### Use a regular expression in responses
-
-    describe registry_key({
-      hive: 'HKEY_LOCAL_MACHINE',
-      key: 'SOFTWARE\Microsoft\Windows NT\CurrentVersion'
-    }) do
-      its('ProductName') { should match /^[a-zA-Z0-9\(\)\s]*2012\s[rR]2[a-zA-Z0-9\(\)\s]*$/ }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-
-### children
-
-The `children` matcher return all of the child items of a registry key. A regular expression may be used to filter child items:
-
-    describe registry_key('Key Name', '\path\to\key').children(regex)
-      ...
-    end
-
-For example, to get all child items for a registry key:
-
-    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet').children do
-      it { should_not eq [] }
-    end
-
-The following example shows how find a property that may exist against multiple registry keys, and then test that property for every registry key in which that property is located:
-
-    describe registry_key({
-      hive: 'HKEY_USERS'
-    }).children(/^S-1-5-21-[0-9]+-[0-9]+-[0-9]+-[0-9]{3,}\\Software\\Policies\\Microsoft\\Windows\\Installer/).each { |key|
-        describe registry_key(key) do
-          its('AlwaysInstallElevated') { should eq 'value' }
-        end
-      }
-
-### exist
-
-The `exist` matcher tests if the registry key is present:
-
-    it { should exist }
-
-### have_property
-
-The `have_property` matcher tests if a property exists for a registry key:
-
-    it { should have_property 'value' }
-
-### have\_property\_value
-
-The `have_property_value` matcher tests if a property value exists for a registry key:
-
-    it { should have_property_value 'value' }
-
-### have_value
-
-The `have_value` matcher tests if a value exists for a registry key:
-
-    it { should have_value 'value' }
-
-### name
-
-The `name` matcher tests the value for the specified registry setting:
-
-    its('name') { should eq 'value' }
-
-
-<p class="warning">
-Any name with a dot will not work as expected: <code>its('explorer.exe') { should eq 'test' }</code>. This issue is tracked in <a href="https://github.com/chef/inspec/issues/1281">https://github.com/chef/inspec/issues/1281</a>
-</p>
-
-    # instead of:
-    # its('explorer.exe') { should eq 'test' }
-    # use the following solution:
-    it { should have_property_value('explorer.exe', :string, 'test') }
+---
+title: About the registry_key Resource
+---
+
+# registry_key
+
+Use the `registry_key` InSpec audit resource to test key values in the Windows registry.
+
+<br>
+
+## Syntax
+
+A `registry_key` resource block declares the item in the Windows registry, the path to a setting under that item, and then one (or more) name/value pairs to be tested.
+
+Use a registry key name and path:
+
+    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule') do
+      its('Start') { should eq 2 }
+    end
+
+Use only a registry key path:
+
+    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule') do
+      its('Start') { should eq 2 }
+    end
+
+Or use a Ruby Hash:
+
+    describe registry_key({
+      name: 'Task Scheduler',
+      hive: 'HKEY_LOCAL_MACHINE',
+      key: '\SYSTEM\CurrentControlSet\services\Schedule'
+    }) do
+      its('Start') { should eq 2 }
+    end
+
+
+### Registry Key Path Separators
+
+A Windows registry key can be used as a string in Ruby code, such as when a registry key is used as the name of a recipe. In Ruby, when a registry key is enclosed in a double-quoted string (`" "`), the same backslash character (`\`) that is used to define the registry key path separator is also used in Ruby to define an escape character. Therefore, the registry key path separators must be escaped when they are enclosed in a double-quoted string. For example, the following registry key:
+
+    HKCU\SOFTWARE\Policies\Microsoft\Windows\CurrentVersion\Themes
+
+may be encloused in a single-quoted string with a single backslash:
+
+    'HKCU\SOFTWARE\path\to\key\Themes'
+
+or may be enclosed in a double-quoted string with an extra backslash as an escape character:
+
+    "HKCU\\SOFTWARE\\path\\to\\key\\Themes"
+
+
+<p class="warning">
+Please make sure that you use backslashes instead of forward slashes. Forward slashes will not work for registry keys.
+</p>
+
+    # The following will not work:
+    # describe registry_key('HKLM/SOFTWARE/Microsoft/NET Framework Setup/NDP/v4/Full/1033') do
+    #   its('Release') { should eq 378675 }
+    # end
+    # You should use:
+    describe registry_key('HKLM\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full\1033') do
+      its('Release') { should eq 378675 }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the start time for the Schedule service
+
+    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\...\Schedule') do
+      its('Start') { should eq 2 }
+    end
+
+where `'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule'` is the full path to the setting.
+
+### Use a regular expression in responses
+
+    describe registry_key({
+      hive: 'HKEY_LOCAL_MACHINE',
+      key: 'SOFTWARE\Microsoft\Windows NT\CurrentVersion'
+    }) do
+      its('ProductName') { should match /^[a-zA-Z0-9\(\)\s]*2012\s[rR]2[a-zA-Z0-9\(\)\s]*$/ }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### children
+
+The `children` matcher return all of the child items of a registry key. A regular expression may be used to filter child items:
+
+    describe registry_key('Key Name', '\path\to\key').children(regex)
+      ...
+    end
+
+For example, to get all child items for a registry key:
+
+    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet').children do
+      it { should_not eq [] }
+    end
+
+The following example shows how find a property that may exist against multiple registry keys, and then test that property for every registry key in which that property is located:
+
+    describe registry_key({
+      hive: 'HKEY_USERS'
+    }).children(/^S-1-5-21-[0-9]+-[0-9]+-[0-9]+-[0-9]{3,}\\Software\\Policies\\Microsoft\\Windows\\Installer/).each { |key|
+        describe registry_key(key) do
+          its('AlwaysInstallElevated') { should eq 'value' }
+        end
+      }
+
+### exist
+
+The `exist` matcher tests if the registry key is present:
+
+    it { should exist }
+
+### have_property
+
+The `have_property` matcher tests if a property exists for a registry key:
+
+    it { should have_property 'value' }
+
+### have\_property\_value
+
+The `have_property_value` matcher tests if a property value exists for a registry key:
+
+    it { should have_property_value 'value' }
+
+### have_value
+
+The `have_value` matcher tests if a value exists for a registry key:
+
+    it { should have_value 'value' }
+
+### name
+
+The `name` matcher tests the value for the specified registry setting:
+
+    its('name') { should eq 'value' }
+
+
+<p class="warning">
+Any name with a dot will not work as expected: <code>its('explorer.exe') { should eq 'test' }</code>. This issue is tracked in <a href="https://github.com/chef/inspec/issues/1281">https://github.com/chef/inspec/issues/1281</a>
+</p>
+
+    # instead of:
+    # its('explorer.exe') { should eq 'test' }
+    # use the following solution:
+    it { should have_property_value('explorer.exe', :string, 'test') }

data/docs/resources/runit_service.md.erb

@@ -1,56 +1,56 @@
----
-title: About the runit_service Resource
----
-
-# runit_service
-
-Use the `runit_service` InSpec audit resource to test a service using runit.
-
-<br>
-
-## Syntax
-
-A `runit_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
-
-    describe runit_service('service_name') do
-      it { should be_installed }
-      it { should be_enabled }
-      it { should be_running }
-    end
-
-where
-
-* `('service_name')` must specify a service name
-* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource; all matchers available to the `service` resource may be used
-
-The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
-
-    describe runit_service('service_name', '/path/to/control') do
-      it { should be_enabled }
-      it { should be_installed }
-      it { should be_running }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-
-### be_enabled
-
-The `be_enabled` matcher tests if the named service is enabled:
-
-    it { should be_enabled }
-
-### be_installed
-
-The `be_installed` matcher tests if the named service is installed:
-
-    it { should be_installed }
-
-### be_running
-
-The `be_running` matcher tests if the named service is running:
-
-    it { should be_running }
+---
+title: About the runit_service Resource
+---
+
+# runit_service
+
+Use the `runit_service` InSpec audit resource to test a service using runit.
+
+<br>
+
+## Syntax
+
+A `runit_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
+
+    describe runit_service('service_name') do
+      it { should be_installed }
+      it { should be_enabled }
+      it { should be_running }
+    end
+
+where
+
+* `('service_name')` must specify a service name
+* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource; all matchers available to the `service` resource may be used
+
+The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
+
+    describe runit_service('service_name', '/path/to/control') do
+      it { should be_enabled }
+      it { should be_installed }
+      it { should be_running }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
+### be_enabled
+
+The `be_enabled` matcher tests if the named service is enabled:
+
+    it { should be_enabled }
+
+### be_installed
+
+The `be_installed` matcher tests if the named service is installed:
+
+    it { should be_installed }
+
+### be_running
+
+The `be_running` matcher tests if the named service is running:
+
+    it { should be_running }