inspec 1.40.0 → 1.41.0

data/docs/resources/command.md.erb

@@ -6,6 +6,8 @@ title: About the command Resource
 
 Use the `command` InSpec audit resource to test an arbitrary command that is run on the system.
 
+<br>
+
 ## Syntax
 
 A `command` resource block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:
@@ -21,56 +23,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" %>
-
-### exist
-
-The `exist` matcher tests if a command may be run on the system:
-
-    it { should exist }
-
-### 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). The following example shows matching output using a regular expression:
-
-    describe command('echo 1') do
-       its('stdout') { should match (/[0-9]/) }
-    end
+<br>
 
 ## Examples
 
@@ -149,3 +102,35 @@ Wix includes serveral tools -- such as `candle` (preprocesses and compiles sourc
         it { should be_file }
       end
     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/).
+
+### exist
+
+The `exist` matcher tests if a command may be run on the system:
+
+    it { should exist }
+
+### 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). The following example shows matching output using a regular expression:
+
+    describe command('echo 1') do
+       its('stdout') { should match (/[0-9]/) }
+    end

data/docs/resources/crontab.md.erb

@@ -6,6 +6,8 @@ title: About the crontab Resource
 
 Use the `crontab` InSpec audit resource to test the crontab entries for a particular user on the system. It recognizes special time strings (@yearly, @weekly, etc).
 
+<br>
+
 ## Syntax
 
 A `crontab` resource block declares a user (which defaults to the current user, if not specified), and then the details to be tested, such as the schedule elements for each crontab entry or the commands itself:
@@ -14,29 +16,7 @@ A `crontab` resource block declares a user (which defaults to the current user,
       its('commands') { should include '/some/scheduled/task.sh' }
     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
 
@@ -82,3 +62,9 @@ The following examples show how to use this InSpec audit resource.
       its('hours') { should cmp '-1' }
       its('minutes') { should cmp '-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/csv.md.erb

@@ -6,6 +6,8 @@ title: About the csv Resource
 
 Use the `csv` InSpec audit resource to test configuration data in a CSV file.
 
+<br>
+
 ## Syntax
 
 A `csv` resource block declares the configuration data to be tested:
@@ -20,43 +22,26 @@ where
 * `name` is a configuration setting in a CSV file
 * `should eq 'foo'` tests a value of `name` as read from a CSV file versus 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" %>
+### Test a CSV file
 
-### include
+    describe csv('some_file.csv') do
+      its('setting') { should eq 1 }
+    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/).
 
 ### name
 
 The `name` matcher tests the value of `name` as read from a CSV file versus the value declared in the test:
 
     its('name') { should eq 'foo' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a CSV file
-
-    describe csv('some_file.csv') do
-      its('setting') { should eq 1 }
-    end

data/docs/resources/dh_params.md

@@ -6,6 +6,7 @@ title: The dh_params Resource
 
 Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH) parameters.
 
+<br>
 
 ## Syntax
 

data/docs/resources/directory.md.erb

@@ -6,6 +6,8 @@ title: About the directory Resource
 
 Use the `directory` InSpec audit resource to test if the file type is a directory. This is equivalent to using the `file` resource and the `be_directory` matcher, but provides a simpler and more direct way to test directories. All of the matchers available to `file` may be used with `directory`.
 
+<br>
+
 ## Syntax
 
 A `directory` resource block declares the location of the directory to be tested, and then one (or more) matchers:
@@ -14,30 +16,8 @@ A `directory` resource block declares the location of the directory to be tested
       it { should MATCHER 'value' }
     end
 
-## Matchers
-
-This resource may use any of the matchers available to the `file` resource that may be useful when testing a directory.
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
+<br>
 
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
+## Matchers
 
-None.
+This resource may use any of the matchers available to the `file` resource that may be useful when testing a directory. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/docker.md.erb

@@ -6,6 +6,8 @@ title: About the docker Resource
 
 Use the `docker` InSpec audit resource to test configuration data for docker daemon. It is a very comprehensive resource. Please have a look at [docker_container](docker_container) and [docker_image](docker_image), too.
 
+<br>
+
 ## Syntax
 
 A `docker` resource block declares allows you to write test for many containers:
@@ -42,63 +44,7 @@ where
 * `.where()` may specify a specific item and value, to which the matchers are compared
 * `commands`, `ids`, `images`, `labels`, `local_volumes`, `mounts`, `names`, `networks`, `ports`, `sizes`  and `'status'` are valid matchers for `containers`
 
-
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### containers
-
-`containers` returns information about containers as returned by [docker ps -a](https://docs.docker.com/engine/reference/commandline/ps/). You can determine specific information about
-
-    describe docker.containers do
-      its('ids') { should include 'sha:71b5df59...442b' }
-      its('commands') { should_not include '/bin/sh' }
-      its('images') { should_not include 'u12:latest' }
-      its('ports') { should include '0.0.0.0:1234->1234/tcp' }
-      its('labels') { should include 'License=GPLv2,Vendor=CentOS' }
-    end
-
-
-### images
-
-`images` returns information about docker image as returned by [docker images](https://docs.docker.com/engine/reference/commandline/images/). You can determine specific information about
-
-    describe docker.images do
-      its('ids') { should include 'sha:12b5df59...442b' }
-      its('repositories') { should_not include 'my_image' }
-      its('tags') { should_not include 'unwanted_tag' }
-      its('sizes') { should_not include "1.41 GB" }
-    end
-
-### version
-
-`info` returns the parsed result of [docker version](https://docs.docker.com/engine/reference/commandline/version/)
-
-    describe docker.version do
-      its('Server.Version') { should cmp >= '1.12'}
-      its('Client.Version') { should cmp >= '1.12'}
-    end
-
-
-### info
-
-`info` returns the parsed result of [docker info](https://docs.docker.com/engine/reference/commandline/info/)
-
-    describe docker.info do
-      its('Configuration.Path') { should eq 'value' }
-    end
-
-
-### object('id')
-
-`object` returns low-level information about docker objects. It is calling [docker inspect](https://docs.docker.com/engine/reference/commandline/info/) under the hood.
-
-    describe docker.object(id) do
-      its('Configuration.Path') { should eq 'value' }
-    end
-
+<br>
 
 ## Examples
 
@@ -158,3 +104,60 @@ and then run:
 Or execute the profile directly via URL:
 
     $ inspec exec https://github.com/dev-sec/cis-docker-benchmark
+
+<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/).
+
+### containers
+
+`containers` returns information about containers as returned by [docker ps -a](https://docs.docker.com/engine/reference/commandline/ps/). You can determine specific information about
+
+    describe docker.containers do
+      its('ids') { should include 'sha:71b5df59...442b' }
+      its('commands') { should_not include '/bin/sh' }
+      its('images') { should_not include 'u12:latest' }
+      its('ports') { should include '0.0.0.0:1234->1234/tcp' }
+      its('labels') { should include 'License=GPLv2,Vendor=CentOS' }
+    end
+
+
+### images
+
+`images` returns information about docker image as returned by [docker images](https://docs.docker.com/engine/reference/commandline/images/). You can determine specific information about
+
+    describe docker.images do
+      its('ids') { should include 'sha:12b5df59...442b' }
+      its('repositories') { should_not include 'my_image' }
+      its('tags') { should_not include 'unwanted_tag' }
+      its('sizes') { should_not include "1.41 GB" }
+    end
+
+### version
+
+`info` returns the parsed result of [docker version](https://docs.docker.com/engine/reference/commandline/version/)
+
+    describe docker.version do
+      its('Server.Version') { should cmp >= '1.12'}
+      its('Client.Version') { should cmp >= '1.12'}
+    end
+
+
+### info
+
+`info` returns the parsed result of [docker info](https://docs.docker.com/engine/reference/commandline/info/)
+
+    describe docker.info do
+      its('Configuration.Path') { should eq 'value' }
+    end
+
+
+### object('id')
+
+`object` returns low-level information about docker objects. It is calling [docker inspect](https://docs.docker.com/engine/reference/commandline/info/) under the hood.
+
+    describe docker.object(id) do
+      its('Configuration.Path') { should eq 'value' }
+    end

data/docs/resources/docker_container.md.erb

@@ -6,6 +6,8 @@ title: About the docker_container Resource
 
 Use the `docker_container` InSpec audit resource to test a docker container.
 
+<br>
+
 ## Syntax
 
 A `docker_container` resource block declares the configuration data to be tested:
@@ -35,10 +37,30 @@ Alternatively, you can pass in the container id:
       it { should be_running }
     end
 
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec resource.
+
+### Verify an running container:
+
+    describe docker_container('an-echo-server') do
+      it { should exist }
+      it { should be_running }
+      its('id') { should_not eq '' }
+      its('image') { should eq 'busybox:latest' }
+      its('repo') { should eq 'busybox' }
+      its('tag') { should eq 'latest' }
+      its('ports') { should eq [] }
+      its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
+    end
+
+<br>
 
 ## Matchers
 
-This InSpec audit resource has the following 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/).
 
 ### id
 
@@ -69,21 +91,3 @@ The `ports` matcher tests the value the docker ports:
 The `command` matcher tests the value of the container run command:
 
     its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
-
-
-## Examples
-
-The following examples show how to use this InSpec resource.
-
-### Verify an running container:
-
-    describe docker_container('an-echo-server') do
-      it { should exist }
-      it { should be_running }
-      its('id') { should_not eq '' }
-      its('image') { should eq 'busybox:latest' }
-      its('repo') { should eq 'busybox' }
-      its('tag') { should eq 'latest' }
-      its('ports') { should eq [] }
-      its('command') { should eq 'nc -ll -p 1234 -e /bin/cat' }
-    end