inspec 1.40.0 → 1.41.0

data/docs/resources/sysv_service.md.erb

@@ -6,6 +6,8 @@ title: About the sysv_service Resource
 
 Use the `sysv_service` InSpec audit resource to test a service using SystemV.
 
+<br>
+
 ## Syntax
 
 A `sysv_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/upstart_service.md.erb

@@ -6,6 +6,8 @@ title: About the upstart_service Resource
 
 Use the `upstart_service` InSpec audit resource to test a service using Upstart.
 
+<br>
+
 ## Syntax
 
 An `upstart_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/user.md.erb

@@ -6,6 +6,8 @@ title: About the user Resource
 
 Use the `user` InSpec audit resource to test user profiles for a single, known/expected local user, including the groups to which that user belongs, the frequency of required password changes, and the directory paths to home and shell.
 
+<br>
+
 ## Syntax
 
 A `user` resource block declares a user name, and then one (or more) matchers:
@@ -29,21 +31,40 @@ where
 * `it { should exist }` tests if the user exists
 * `gid`, `group`, `groups`, `home`, `maxdays`, `mindays`, `shell`, `uid`, and `warndays` are valid matchers for this resource
 
-## Matchers
+<br>
+## Examples
 
-This InSpec audit resource has the following matchers:
+The following examples show how to use this InSpec audit resource.
 
-### be
+### Verify available users for the MySQL server
 
-<%= partial "/shared/matcher_be" %>
+    describe user('root') do
+      it { should exist }
+      it { should belong_to_group 'root' }
+      its('uid') { should eq 0 }
+      its('groups') { should eq ['root'] }
+    end
 
-### cmp
+    describe user('mysql') do
+     it { should_not exist }
+    end
 
-<%= partial "/shared/matcher_cmp" %>
+### Test users on multiple platforms
 
-### eq
+The `nginx` user is typically `www-data`, but on CentOS it's `nginx`. The following example shows how to test for the `nginx` user with a single test, but accounting for all platforms:
+
+    web_user = 'www-data'
+    web_user = 'nginx' if os[:family] == 'centos'
+
+    describe user(web_user) do
+      it { should exist }
+    end
+
+<br>
+
+## Matchers
 
-<%= partial "/shared/matcher_eq" %>
+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/).
 
 ### exist
 
@@ -79,14 +100,6 @@ The `home` matcher tests the home directory path for the user:
 
     its('home') { should eq '/root' }
 
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### maxdays
 
 The `maxdays` matcher tests the maximum number of days between password changes:
@@ -124,31 +137,3 @@ The `warndays` matcher tests the number of days a user is warned before a passwo
     its('warndays') { should eq 5 }
 
 where `5` represents the number of days a user is warned.
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Verify available users for the MySQL server
-
-    describe user('root') do
-      it { should exist }
-      it { should belong_to_group 'root' }
-      its('uid') { should eq 0 }
-      its('groups') { should eq ['root'] }
-    end
-
-    describe user('mysql') do
-     it { should_not exist }
-    end
-
-### Test users on multiple platforms
-
-The `nginx` user is typically `www-data`, but on CentOS it's `nginx`. The following example shows how to test for the `nginx` user with a single test, but accounting for all platforms:
-
-    web_user = 'www-data'
-    web_user = 'nginx' if os[:family] == 'centos'
-
-    describe user(web_user) do
-      it { should exist }
-    end

data/docs/resources/users.md.erb

@@ -6,6 +6,8 @@ title: About the users Resource
 
 Use the `users` InSpec audit resource to look up all local users available on the system, and then test specific properties of those users. This resource does not return information about users that may be located on other systems, such as LDAP or Active Directory.
 
+<br>
+
 ## Syntax
 
 A `users` resource block declares a user name, and then one (or more) matchers:
@@ -33,21 +35,23 @@ or:
       it { should exist }
     end
 
-## Matchers
+<br>
 
-This InSpec audit resource has the following matchers:
+## Examples
 
-### be
+The following examples show how to use this InSpec audit resource.
 
-<%= partial "/shared/matcher_be" %>
+### Use a regular expression to find users
 
-### cmp
+    describe users.where { uid =~ /S\-1\-5\-21\-\d+\-\d+\-\d+\-500/ } do
+      it { should exist }
+    end
 
-<%= partial "/shared/matcher_cmp" %>
+<br>
 
-### eq
+## Matchers
 
-<%= partial "/shared/matcher_eq" %>
+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/).
 
 ### exist
 
@@ -83,14 +87,6 @@ The `home` matcher tests the home directory path for the user:
 
     its('home') { should eq '/root' }
 
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### maxdays
 
 The `maxdays` matcher tests the maximum number of days between password changes:
@@ -128,13 +124,3 @@ The `warndays` matcher tests the number of days a user is warned before a passwo
     its('warndays') { should eq 5 }
 
 where `5` represents the number of days a user is warned.
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Use a regular expression to find users
-
-    describe users.where { uid =~ /S\-1\-5\-21\-\d+\-\d+\-\d+\-500/ } do
-      it { should exist }
-    end

data/docs/resources/vbscript.md.erb

@@ -6,6 +6,8 @@ title: About the vbscript Resource
 
 Use the `vbscript` InSpec audit resource to test a VBScript on the Windows platform.
 
+<br>
+
 ## Syntax
 
 A `vbscript` resource block tests the output of a VBScript on the Windows platform:
@@ -19,30 +21,7 @@ where
 * `'script_name'` is the name of the VBScript to test
 * `('output')` is the expected output of the VBScript
 
-
-## 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
 
@@ -67,3 +46,9 @@ and tested for whitespace removal from standard output:
     describe vbscript(script) do
       its('strip') { should eq "hello" }
     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/virtualization.md.erb

@@ -6,6 +6,8 @@ title: About the virtualization Resource
 
 Use the `virtualization` InSpec audit resource to test the virtualization platform on which the system is running.
 
+<br>
+
 ## Syntax
 
 An `virtualization` resource block declares the virtualization platform that should be tested:
@@ -20,29 +22,7 @@ where
 * `MATCHER` is a valid matcher for this resource
 * `'value'` is the value to be tested
 
-## 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
 
@@ -69,3 +49,8 @@ The following examples show how to use this InSpec audit resource.
       end
     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/windows_feature.md.erb

@@ -6,6 +6,8 @@ title: About the windows_feature Resource
 
 Use the `windows_feature` InSpec audit resource to test features on Windows via the `Get-WindowsFeature` cmdlet.
 
+<br>
+
 ## Syntax
 
 A `windows_feature` resource block declares the name of the Windows feature, tests if that feature is installed, and then returns information about that feature:
@@ -19,36 +21,7 @@ where
 * `('feature_name')` must specify a Windows feature name, such as `DHCP Server` or `IIS-Webserver`
 * `be_installed` is a valid matcher for this resource
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_installed
-
-The `be_installed` matcher tests if the named Windows feature is installed:
-
-    it { should be_installed }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -59,3 +32,15 @@ The following examples show how to use this InSpec audit resource.
     describe windows_feature('DHCP Server') do
       it{ should be_installed }
     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_installed
+
+The `be_installed` matcher tests if the named Windows feature is installed:
+
+    it { should be_installed }

data/docs/resources/windows_hotfix.md.erb

@@ -4,6 +4,8 @@ title: About the windows_hotfix Resource
 
 Use the `windows_hotfix` InSpec audit resource to test if the hotfix has been installed on a Windows system.
 
+<br>
+
 ## Syntax
 
 A `windows_hotfix` resource block declares a hotfix to validate:
@@ -17,15 +19,7 @@ where
 * `('name')` must specify the name of a hotfix, such as `'KB4012213'`
 * `be_installed` is a valid matcher for this resource
 
-## Matcher
-
-This InSpec audit resource has the following matcher:
-
-### be_installed
-
-The `be_installed` matcher tests if the named hotfix is installed on the system:
-
-    it { should be_installed }
+<br>
 
 ## Examples
 
@@ -42,3 +36,15 @@ The following examples show how to use this InSpec audit resource.
     describe windows_hotfix('KB9999999') do
       it { should_not be_installed }
     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_installed
+
+The `be_installed` matcher tests if the named hotfix is installed on the system:
+
+    it { should be_installed }