inspec 1.31.0 → 1.45.9

data/docs/resources/group.md.erb

@@ -6,6 +6,8 @@ title: About the group Resource
 
 Use the `group` InSpec audit resource to test groups on the system.
 
+<br>
+
 ## Syntax
 
 A `group` resource block declares a group, and then the details to be tested, such as if the group is a local group, the group identifier, or if the group exists:
@@ -20,27 +22,30 @@ where
 * `'group_name'` must specify the name of a group on the system
 * `exist` and `'gid'` are valid matchers for this resource
 
-## 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" %>
+### Test the group identifier for the root group
 
-### be_local
+    describe group('root') do
+      it { should exist }
+      its('gid') { should eq 0 }
+    end
 
-The `be_local` matcher tests if the group is a local group:
+<br>
 
-    it { should be_local }
+## Matchers
 
-### cmp
+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/).
 
-<%= partial "/shared/matcher_cmp" %>
+### be_local
 
-### eq
+The `be_local` matcher tests if the group is a local group:
 
-<%= partial "/shared/matcher_eq" %>
+    it { should be_local }
 
 ### exist
 
@@ -53,22 +58,3 @@ The `exist` matcher tests if the named user exists:
 The `gid` matcher tests the named group identifier:
 
     its('gid') { should eq 1234 }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the group identifier for the root group
-
-    describe group('root') do
-      it { should exist }
-      its('gid') { should eq 0 }
-    end

data/docs/resources/grub_conf.md.erb

@@ -6,6 +6,8 @@ title: About the grub_conf Resource
 
 Grub is a boot loader on the Linux platform used to load and then transfer control to an operating system kernel, after which that kernel initializes the rest of the operating system. Use the `grub_conf` InSpec audit resource to test boot loader configuration settings that are defined in the `grub.conf` configuration file.
 
+<br>
+
 ## Syntax
 
 A `grub_conf` resource block declares a list of settings in a `grub.conf` file:
@@ -28,30 +30,7 @@ where
 * `'kernel'` specifies the default kernel (by using `'default'`) or a specific kernel; `'default'` defines the position in the list of kernels at which the default kernel is defined, i.e. `should eq '0'` for the first kernel listed or `'path', 'default'` to use the default kernel as specified in the `grub.conf` file
 * `'value'` is the value that is expected
 
-
-## 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
 
@@ -113,3 +92,9 @@ The following test verifies the `ramdisk_size` for the non-deault kernel:
     grub_conf('/etc/grub.conf',  'CentOS (2.6.32-573.12.1.el6.x86_64)') do
       its('kernel') { should include 'audit=1' }
     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/host.md.erb

@@ -6,17 +6,17 @@ title: About the host Resource
 
 Use the `host` InSpec audit resource to test the name used to refer to a specific host and its availability, including the Internet protocols and ports over which that host name should be available.
 
+<br>
+
 ## Syntax
 
 A `host` resource block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:
 
-.. code-block:: ruby
-
-   describe host('example.com', port: 80, protocol: 'tcp') do
-     it { should be_reachable }
-     it { should be_resolvable }
-     its('ipaddress') { should include '12.34.56.78' }
-   end
+    describe host('example.com', port: 80, protocol: 'tcp') do
+      it { should be_reachable }
+      it { should be_resolvable }
+      its('ipaddress') { should include '12.34.56.78' }
+    end
 
 where
 
@@ -25,48 +25,7 @@ where
 * `port:` is the port number
 * `protocol: 'name'` is the Internet protocol: TCP (`protocol: 'tcp'`), UDP (`protocol: 'udp'` or  ICMP (`protocol: 'icmp'`))
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_reachable
-
-The `be_reachable` matcher tests if the host name is available:
-
-    it { should be_reachable }
-
-### be_resolvable
-
-The `be_resolvable` matcher tests for host name resolution, i.e. "resolvable to an IP address":
-
-    it { should be_resolvable }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### ipaddress
-
-The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
-
-    its('ipaddress') { should include '93.184.216.34' }
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -92,3 +51,27 @@ The following examples show how to use this InSpec audit resource.
       its('connection') { should_not match /connection refused/ }
       its('socket') { should match /STATUS_OK/ }
     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_reachable
+
+The `be_reachable` matcher tests if the host name is available:
+
+    it { should be_reachable }
+
+### be_resolvable
+
+The `be_resolvable` matcher tests for host name resolution, i.e. "resolvable to an IP address":
+
+    it { should be_resolvable }
+
+### ipaddress
+
+The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
+
+    its('ipaddress') { should include '93.184.216.34' }

data/docs/resources/http.md.erb

@@ -6,9 +6,14 @@ title: About the http Resource
 
 Use the `http` InSpec audit resource to test an http endpoint.
 
-<p class="warning">Currently, this resource always executes on the host on which <code>inspec exec</code> is run, even if you use the <code>--target</code> option to remotely scan a different host.<br>
+<p class="warning">In InSpec 1.40 and earlier, this resource always executes on the host on which <code>inspec exec</code> is run, even if you use the <code>--target</code> option to remotely scan a different host.<br>
+<br>
+Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target, provided <code>curl</code> is available. See the "Local vs. Remote" section below.<br>
+<br>
+Executing the HTTP test on the remote target will be the default behavior in InSpec 2.0.
+</p>
+
 <br>
-This will be corrected in a future version of InSpec. New InSpec releases are posted in the <a href="https://discourse.chef.io/c/chef-release" target="_blank">Release Announcements Category in Discourse</a>.</p>
 
 ## Syntax
 
@@ -32,51 +37,16 @@ where
 * `read_timeout` may be specified for a timeout for reading connections (default to 60)
 * `ssl_verify` may be specified to enable or disable verification of SSL certificates (default to `true`)
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### body
-
-The `body` matcher tests body content of http response:
-
-   its('body') { should eq 'hello\n' }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### headers
-
-The `headers` matcher returns an hash of all http headers:
-
-    its('headers') { should eq {} }
-
-Individual headers can be tested via:
-
-    its('headers.Content-Type') { should cmp 'text/html' }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
+## Local vs. Remote
 
-### status
+Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target:
 
-The `status` matcher tests status of the http response:
+    describe http('http://www.example.com', enable_remote_worker: true) do
+      its('body') { should cmp 'awesome' }
+    end
 
-    its('status') { should eq 200 }
+In InSpec 2.0, the HTTP test will automatically execute remotely whenever InSpec is testing a remote node.
 
 ## Examples
 
@@ -102,3 +72,27 @@ For example, a service is listening on default http port can be tested like this
       its('body') { should cmp 'pong' }
       its('headers.Content-Type') { should cmp 'text/html' }
     end
+
+<br>
+
+### body
+
+The `body` matcher tests body content of http response:
+
+   its('body') { should eq 'hello\n' }
+
+### headers
+
+The `headers` matcher returns an hash of all http headers:
+
+    its('headers') { should eq {} }
+
+Individual headers can be tested via:
+
+    its('headers.Content-Type') { should cmp 'text/html' }
+
+### status
+
+The `status` matcher tests status of the http response:
+
+    its('status') { should eq 200 }

data/docs/resources/iis_app.md.erb

@@ -6,6 +6,8 @@ title: About the iis_app Resource
 
 Use the `iis_app` InSpec audit resource to test the state of IIS on Windows Server 2012 (and later).
 
+<br>
+
 ## Syntax
 
 An `iis_app` resource block declares details about the named site:
@@ -38,17 +40,34 @@ For example:
       it { should have_path('\\My Application') }
     end
 
-## Matchers
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a default IIS web application
+
+    describe iis_app('Default Web Site') do
+      it { should exist }
+      it { should be_running }
+      it { should have_app_pool('DefaultAppPool') }
+      it { should have_binding('http *:80:') }
+      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
+    end
 
-This InSpec audit resource has the following matchers:
+### Test if IIS service is running
 
-### cmp
+    describe service('W3SVC') do
+      it { should be_installed }
+      it { should be_running }
+    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
 
@@ -95,32 +114,3 @@ Testing a web application with https enabled and http enabled:
 The `have_physical_path` matcher tests if the named path is defined for the web application:
 
     it { should have_physical_path('C:\\inetpub\\wwwroot') }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a default IIS web application
-
-    describe iis_app('Default Web Site') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('DefaultAppPool') }
-      it { should have_binding('http *:80:') }
-      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
-    end
-
-### Test if IIS service is running
-
-    describe service('W3SVC') do
-      it { should be_installed }
-      it { should be_running }
-    end

data/docs/resources/iis_site.md.erb

@@ -6,6 +6,8 @@ title: About the iis_site Resource
 
 Use the `iis_site` InSpec audit resource to test the state of IIS on Windows Server 2012 (and later).
 
+<br>
+
 ## Syntax
 
 An `iis_site` resource block declares details about the named site:
@@ -36,27 +38,40 @@ For example:
       it { should have_path('C:\\inetpub\\wwwroot') }
     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" %>
+### Test a default IIS site
 
-### be_running
+    describe iis_site('Default Web Site') do
+      it { should exist }
+      it { should be_running }
+      it { should have_app_pool('DefaultAppPool') }
+      it { should have_binding('http *:80:') }
+      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
+    end
 
-The `be_running` matcher tests if the site is running:
+### Test if IIS service is running
 
-    it { should be_running }
+    describe service('W3SVC') do
+      it { should be_installed }
+      it { should be_running }
+    end
 
-### cmp
+<br>
 
-<%= partial "/shared/matcher_cmp" %>
+## 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_running
 
-### eq
+The `be_running` matcher tests if the site is running:
 
-<%= partial "/shared/matcher_eq" %>
+    it { should be_running }
 
 ### exist
 
@@ -111,32 +126,3 @@ Testing a site with 128-bit SSL enabled:
 The `have_path` matcher tests if the named path is defined for the site:
 
     it { should have_path('C:\\inetpub\\wwwroot') }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a default IIS site
-
-    describe iis_site('Default Web Site') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('DefaultAppPool') }
-      it { should have_binding('http *:80:') }
-      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
-    end
-
-### Test if IIS service is running
-
-    describe service('W3SVC') do
-      it { should be_installed }
-      it { should be_running }
-    end

data/docs/resources/inetd_conf.md.erb

@@ -6,6 +6,8 @@ title: About the inetd_conf Resource
 
 Use the `inetd_conf` InSpec audit resource to test if a service is listed in the `inetd.conf` file on Linux and Unix platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The `inetd.conf` file is typically located at `/etc/inetd.conf` and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled.`
 
+<br>
+
 ## Syntax
 
 An `inetd_conf` resource block declares the list of services that are enabled in the `inetd.conf` file:
@@ -20,48 +22,7 @@ where
 * `('path')` is the non-default path to the `inetd.conf` file
 * `should eq 'value'` is the value that is expected
 
-
-## Matchers
-
-This resource matches any service that is listed in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`:
-
-    its('shell') { should eq nil }
-
-or:
-
-    its('netstat') { should eq nil }
-
-or:
-
-    its('systat') { should eq nil }
-
-For example:
-
-    describe inetd_conf do
-      its('shell') { should eq nil }
-      its('login') { should eq nil }
-      its('exec') { should eq nil }
-    end
-
-### 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
 
@@ -97,3 +58,27 @@ then the same test will return `false` for `ftp` and the entire test will fail.
     describe inetd_conf do
       its('telnet') { should eq nil }
     end
+
+<br>
+
+## Matchers
+
+This resource matches any service that is listed in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+    its('shell') { should eq nil }
+
+or:
+
+    its('netstat') { should eq nil }
+
+or:
+
+    its('systat') { should eq nil }
+
+For example:
+
+    describe inetd_conf do
+      its('shell') { should eq nil }
+      its('login') { should eq nil }
+      its('exec') { should eq nil }
+    end

data/docs/resources/ini.md.erb

@@ -6,6 +6,8 @@ title: About the ini Resource
 
 Use the `ini` InSpec audit resource to test settings in an INI file.
 
+<br>
+
 ## Syntax
 
 An `ini` resource block declares the configuration settings to be tested:
@@ -27,29 +29,7 @@ For example:
       its('server') { should eq '192.0.2.62' }
     end
 
-## 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 +47,9 @@ and can be tested like this:
     describe ini(/etc/php5/apache2/php.ini) do
       its('smtp_port') { should eq('465') }
     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/interface.md.erb

@@ -9,6 +9,8 @@ Use the `interface` InSpec audit resource to test basic network adapter properti
 * On Linux platforms, `/sys/class/net/#{iface}` is used as source
 * On the Windows platform, the `Get-NetAdapter` cmdlet is used as source
 
+<br>
+
 ## Syntax
 
 An `interface` resource block declares network interface properties to be tested:
@@ -19,13 +21,11 @@ An `interface` resource block declares network interface properties to be tested
       its('name') { should eq eth0 }
     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_up
 
@@ -33,22 +33,6 @@ The `be_up` matcher tests if the network interface is available:
 
     it { should be_up }
 
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### name
 
 The `name` matcher tests if the named network interface exists:
@@ -60,7 +44,3 @@ The `name` matcher tests if the named network interface exists:
 The `speed` matcher tests the speed of the network interface, in MB/sec:
 
     its('speed') { should eq 1000 }
-
-## Examples
-
-None.