inspec 1.40.0 → 1.41.0

data/docs/resources/powershell.md.erb

@@ -6,6 +6,8 @@ title: About the powershell Resource
 
 Use the `powershell` InSpec audit resource to test a Powershell script on the Windows platform.
 
+<br>
+
 ## Syntax
 
 A `powershell` resource block declares a Powershell script to be tested, and then compares the output of that command to the matcher in the test:
@@ -24,48 +26,7 @@ where
 * `'matcher'` is one of `exit_status`, `stderr`, or `stdout`
 * `'output'` tests the output of the command run on the system versus the output value stated in the test
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### exit_status
-
-The `exit_status` matcher tests the exit status for the command:
-
-    its('exit_status') { should eq 123 }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### stderr
-
-The `stderr` matcher tests results of the command as returned in standard error (stderr):
-
-    its('stderr') { should eq 'error' }
-
-### stdout
-
-The `stdout` matcher tests results of the command as returned in standard output (stdout):
-
-    its('stdout') { should eq '/^1$/' }
+<br>
 
 ## Examples
 
@@ -114,3 +75,27 @@ No newline:
       its('stdout') { should eq 'hello' }
       its('stderr') { should eq '' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exit_status
+
+The `exit_status` matcher tests the exit status for the command:
+
+    its('exit_status') { should eq 123 }
+
+### stderr
+
+The `stderr` matcher tests results of the command as returned in standard error (stderr):
+
+    its('stderr') { should eq 'error' }
+
+### stdout
+
+The `stdout` matcher tests results of the command as returned in standard output (stdout):
+
+    its('stdout') { should eq '/^1$/' }

data/docs/resources/processes.md.erb

@@ -6,6 +6,8 @@ title: About the processes Resource
 
 Use the `processes` InSpec audit resource to test properties for programs that are running on the system.
 
+<br>
+
 ## Syntax
 
 A `processes` resource block declares the name of the process to be tested, and then declares one (or more) property/value pairs:
@@ -16,39 +18,10 @@ A `processes` resource block declares the name of the process to be tested, and
 
 where
 
-* `processes('process_name')` specifies the name of a process to check. If this is a string, it will be converted to a Regexp. For more specificity, pass a Regexp directly.
+* `processes('process_name')` specifies the name of a process to check. If this is a string, it will be converted to a Regexp. For more specificity, pass a Regexp directly. If left blank, all processes will be returned.
 * `property_name` may be used to test user (`its('users')`) and state properties (`its('states')`)
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### property_name
-
-The `property_name` matcher tests the named property for the specified value:
-
-    its('property_name') { should eq ['property_value'] }
+<br>
 
 ## Examples
 
@@ -100,9 +73,9 @@ needed.
 ### Notes for auditing Windows systems
 
 Sometimes with system properties there isn't a direct comparison between different operating systems.
-Most of the `property_name`'s do align between the different OS's.  
+Most of the `property_name`'s do align between the different OS's.
 
-There are however some exception's, for example, within linux `states` offers multiple properties. 
+There are however some exception's, for example, within linux `states` offers multiple properties.
 Windows doesn't have direct comparison that is a single property so instead `states` is mapped to the property of `Responding`, This is a boolean true/false flag to help determine if the process is hung.
 
 Below is a mapping table to help you understand what property the unix field maps to the windows `Get-Process` Property
@@ -121,3 +94,14 @@ Below is a mapping table to help you understand what property the unix field map
 |time             |TotalProcessorTime|
 |users            |UserName|
 |commands         |Path|
+
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### property_name
+
+The `property_name` matcher tests the named property for the specified value:
+
+    its('property_name') { should eq ['property_value'] }

data/docs/resources/rabbitmq_config.md.erb

@@ -6,6 +6,8 @@ title: About the rabbitmq_config Resource
 
 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:
@@ -19,30 +21,7 @@ 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
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -53,3 +32,9 @@ The following examples show how to use this InSpec audit resource.
     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

@@ -6,6 +6,8 @@ title: About the registry_key Resource
 
 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.
@@ -61,13 +63,34 @@ Please make sure that you use backslashes instead of forward slashes. Forward sl
       its('Release') { should eq 378675 }
     end
 
-## Matchers
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the start time for the Schedule service
 
-This InSpec audit resource has the following matchers:
+    describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\...\Schedule') do
+      its('Start') { should eq 2 }
+    end
 
-### be
+where `'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule'` is the full path to the setting.
 
-<%= partial "/shared/matcher_be" %>
+### 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
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### children
 
@@ -93,14 +116,6 @@ The following example shows how find a property that may exist against multiple
         end
       }
 
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
 ### exist
 
 The `exist` matcher tests if the registry key is present:
@@ -125,14 +140,6 @@ The `have_value` matcher tests if a value exists for a registry key:
 
     it { should have_value 'value' }
 
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### name
 
 The `name` matcher tests the value for the specified registry setting:
@@ -148,25 +155,3 @@ Any name with a dot will not work as expected: <code>its('explorer.exe') { shoul
     # its('explorer.exe') { should eq 'test' }
     # use the following solution:
     it { should have_property_value('explorer.exe', :string, 'test') }
-
-
-## 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

data/docs/resources/runit_service.md.erb

@@ -6,6 +6,8 @@ title: About the runit_service Resource
 
 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:
@@ -29,13 +31,11 @@ The path to the service manager's control may be specified for situations where
       it { should be_running }
     end
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
+<br>
 
-### be
+## Matchers
 
-<%= partial "/shared/matcher_be" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### be_enabled
 
@@ -54,23 +54,3 @@ The `be_installed` matcher tests if the named service is installed:
 The `be_running` matcher tests if the named service is running:
 
     it { should be_running }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-None.

data/docs/resources/security_policy.md.erb

@@ -6,6 +6,8 @@ title: About the security_policy Resource
 
 Use the `security_policy` InSpec audit resource to test security policies on the Windows platform.
 
+<br>
+
 ## Syntax
 
 A `security_policy` resource block declares the name of a security policy and the value to be tested:
@@ -19,43 +21,26 @@ where
 * `'policy_name'` must specify a security policy
 * `{ should eq 'value' }` tests the value of `policy_name` against the value declared in the test
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
+## Examples
 
-### eq
+The following examples show how to use this InSpec audit resource.
 
-<%= partial "/shared/matcher_eq" %>
+### Verify that only the Administrators group has remote access
 
-### include
+    describe security_policy do
+      its('SeRemoteInteractiveLogonRight') { should eq '*S-1-5-32-544' }
+    end
 
-<%= partial "/shared/matcher_include" %>
+<br>
 
-### match
+## Matchers
 
-<%= partial "/shared/matcher_match" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### policy_name
 
 The `policy_name` matcher must be the name of a security policy:
 
     its('SeNetworkLogonRight') { should eq '*S-1-5-11' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Verify that only the Administrators group has remote access
-
-    describe security_policy do
-      its('SeRemoteInteractiveLogonRight') { should eq '*S-1-5-32-544' }
-    end

data/docs/resources/service.md.erb

@@ -8,6 +8,8 @@ Use the `service` InSpec audit resource to test if the named service is installe
 
 Under some circumstances, it may be necessary to specify the service manager by using one of the following service manager-specific resources: `bsd_service`, `launchd_service`, `runit_service`, `systemd_service`, `sysv_service`, or `upstart_service`. These resources are based on the `service` resource.
 
+<br>
+
 ## Syntax
 
 A `service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
@@ -23,48 +25,7 @@ where
 * `('service_name')` must specify a service name
 * `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### 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 }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -133,3 +94,27 @@ This is also possible with `systemd_service`, `runit_service`, `sysv_service`, `
       it { should be_installed }
       it { should be_running }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following 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 }