inspec 2.0.16 → 2.0.17

data/docs/resources/users.md.erb

@@ -1,127 +1,127 @@
----
-title: About the users Resource
-platform: os
----
-
-# users
-
-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:
-
-    describe users.where(uid: 0).entries do
-      it { should eq ['root'] }
-      its('uids') { should eq [1234] }
-      its('gids') { should eq [1234] }
-    end
-
-where
-
-* `gid`, `group`, `groups`, `home`, `maxdays`, `mindays`, `shell`, `uid`, and `warndays` are valid matchers for this resource
-* `where(uid: 0).entries` represents a filter that runs the test only against matching users
-
-For example:
-
-    describe users.where { username =~ /.*/ } do
-      it { should exist }
-    end
-
-or:
-
-    describe users.where { uid =~ /^S-1-5-[0-9-]+-501$/ } do
-      it { should exist }
-    end
-
-<br>
-
-## 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
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-The `exist` matcher tests if the named user exists:
-
-    it { should exist }
-
-### gid
-
-The `gid` matcher tests the group identifier:
-
-    its('gid') { should eq 1234 } }
-
-where `1234` represents the user identifier.
-
-### group
-
-The `group` matcher tests the group to which the user belongs:
-
-    its('group') { should eq 'root' }
-
-where `root` represents the group.
-
-### groups
-
-The `groups` matcher tests two (or more) groups to which the user belongs:
-
-    its('groups') { should eq ['root', 'other']}
-
-### home
-
-The `home` matcher tests the home directory path for the user:
-
-    its('home') { should eq '/root' }
-
-### maxdays
-
-The `maxdays` matcher tests the maximum number of days between password changes:
-
-    its('maxdays') { should eq 99 }
-
-where `99` represents the maximum number of days.
-
-### mindays
-
-The `mindays` matcher tests the minimum number of days between password changes:
-
-    its('mindays') { should eq 0 }
-
-where `0` represents the maximum number of days.
-
-### shell
-
-The `shell` matcher tests the path to the default shell for the user:
-
-    its('shell') { should eq '/bin/bash' }
-
-### uid
-
-The `uid` matcher tests the user identifier:
-
-    its('uid') { should eq 1234 } }
-
-where `1234` represents the user identifier.
-
-### warndays
-
-The `warndays` matcher tests the number of days a user is warned before a password must be changed:
-
-    its('warndays') { should eq 5 }
-
-where `5` represents the number of days a user is warned.
+---
+title: About the users Resource
+platform: os
+---
+
+# users
+
+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:
+
+    describe users.where(uid: 0).entries do
+      it { should eq ['root'] }
+      its('uids') { should eq [1234] }
+      its('gids') { should eq [1234] }
+    end
+
+where
+
+* `gid`, `group`, `groups`, `home`, `maxdays`, `mindays`, `shell`, `uid`, and `warndays` are valid matchers for this resource
+* `where(uid: 0).entries` represents a filter that runs the test only against matching users
+
+For example:
+
+    describe users.where { username =~ /.*/ } do
+      it { should exist }
+    end
+
+or:
+
+    describe users.where { uid =~ /^S-1-5-[0-9-]+-501$/ } do
+      it { should exist }
+    end
+
+<br>
+
+## 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
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exist
+
+The `exist` matcher tests if the named user exists:
+
+    it { should exist }
+
+### gid
+
+The `gid` matcher tests the group identifier:
+
+    its('gid') { should eq 1234 } }
+
+where `1234` represents the user identifier.
+
+### group
+
+The `group` matcher tests the group to which the user belongs:
+
+    its('group') { should eq 'root' }
+
+where `root` represents the group.
+
+### groups
+
+The `groups` matcher tests two (or more) groups to which the user belongs:
+
+    its('groups') { should eq ['root', 'other']}
+
+### home
+
+The `home` matcher tests the home directory path for the user:
+
+    its('home') { should eq '/root' }
+
+### maxdays
+
+The `maxdays` matcher tests the maximum number of days between password changes:
+
+    its('maxdays') { should eq 99 }
+
+where `99` represents the maximum number of days.
+
+### mindays
+
+The `mindays` matcher tests the minimum number of days between password changes:
+
+    its('mindays') { should eq 0 }
+
+where `0` represents the maximum number of days.
+
+### shell
+
+The `shell` matcher tests the path to the default shell for the user:
+
+    its('shell') { should eq '/bin/bash' }
+
+### uid
+
+The `uid` matcher tests the user identifier:
+
+    its('uid') { should eq 1234 } }
+
+where `1234` represents the user identifier.
+
+### warndays
+
+The `warndays` matcher tests the number of days a user is warned before a password must be changed:
+
+    its('warndays') { should eq 5 }
+
+where `5` represents the number of days a user is warned.

data/docs/resources/vbscript.md.erb

@@ -1,55 +1,55 @@
----
-title: About the vbscript Resource
-platform: windows
----
-
-# vbscript
-
-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:
-
-    describe vbscript('script contents') do
-      its('stdout') { should eq 'output' }
-    end
-
-where
-
-* `'script_name'` is the name of the VBScript to test
-* `('output')` is the expected output of the VBScript
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a VBScript
-
-A VBScript file similar to:
-
-    script = <<-EOH
-      WScript.Echo "hello"
-    EOH
-
-may be tested for multiple lines:
-
-    describe vbscript(script) do
-      its('stdout') { should eq "hello\r\n" }
-    end
-
-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/).
+---
+title: About the vbscript Resource
+platform: windows
+---
+
+# vbscript
+
+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:
+
+    describe vbscript('script contents') do
+      its('stdout') { should eq 'output' }
+    end
+
+where
+
+* `'script_name'` is the name of the VBScript to test
+* `('output')` is the expected output of the VBScript
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a VBScript
+
+A VBScript file similar to:
+
+    script = <<-EOH
+      WScript.Echo "hello"
+    EOH
+
+may be tested for multiple lines:
+
+    describe vbscript(script) do
+      its('stdout') { should eq "hello\r\n" }
+    end
+
+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

@@ -1,57 +1,57 @@
----
-title: About the virtualization Resource
-platform: linux
----
-
-# virtualization
-
-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:
-
-    describe virtualization do
-      its('system') { should MATCHER 'value' }
-    end
-
-where
-
-* `('system')` is the name of the system information of the virtualization platform (e.g. docker, lxc, vbox, kvm, etc)
-* `MATCHER` is a valid matcher for this resource
-* `'value'` is the value to be tested
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test for Docker
-
-    describe virtualization do
-      its('system') { should eq 'docker' }
-    end
-
-### Test for VirtualBox
-
-    describe virtualization do
-      its('system') { should eq 'vbox' }
-      its('role') { should eq 'guest' }
-    end
-
-### Detect the virtualization platform
-
-    if virtualization.system == 'vbox'
-      describe package('name') do
-        it { should be_installed }
-      end
-    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 virtualization Resource
+platform: linux
+---
+
+# virtualization
+
+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:
+
+    describe virtualization do
+      its('system') { should MATCHER 'value' }
+    end
+
+where
+
+* `('system')` is the name of the system information of the virtualization platform (e.g. docker, lxc, vbox, kvm, etc)
+* `MATCHER` is a valid matcher for this resource
+* `'value'` is the value to be tested
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test for Docker
+
+    describe virtualization do
+      its('system') { should eq 'docker' }
+    end
+
+### Test for VirtualBox
+
+    describe virtualization do
+      its('system') { should eq 'vbox' }
+      its('role') { should eq 'guest' }
+    end
+
+### Detect the virtualization platform
+
+    if virtualization.system == 'vbox'
+      describe package('name') do
+        it { should be_installed }
+      end
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).