inspec 1.51.0 → 1.51.6

data/docs/resources/bond.md.erb

@@ -23,10 +23,34 @@ where
 
 <br>
 
-## Examples
+## Property Examples
 
 The following examples show how to use this InSpec audit resource.
 
+### content
+
+The `content` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the `content` matcher are arbitrary.
+
+    its('content') { should match('value') }
+
+### interfaces
+
+The `interfaces` matcher tests if the named secondary interfaces are available.
+
+    its('interfaces') { should eq ['eth0', 'eth1', ...] }
+
+### mode
+
+The `mode` matcher tests the Bonding Mode.
+
+    its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
+
+### params
+
+The `params` matcher tests arbitrary parameters for the bonded network interface.
+
+    its('params') { should eq 'value' }
+
 ### Test if eth0 is a secondary interface for bond0
 
     describe bond('bond0') do
@@ -49,13 +73,7 @@ The following examples show how to use this InSpec audit resource.
 
 ## 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/).
-
-### content
-
-The `content` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the `content` matcher are arbitrary:
-
-    its('content') { should match('value') }
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### exist
 
@@ -69,19 +87,3 @@ The `have_interface` matcher tests if the bonded network interface has one (or m
 
     it { should have_interface }
 
-### interfaces
-
-The `interfaces` matcher tests if the named secondary interfaces are available:
-
-    its('interfaces') { should eq ['eth0', 'eth1', ...] }
-
-### mode
-The `mode` matcher tests the Bonding Mode:
-
-    its('mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
-
-### params
-
-The `params` matcher tests arbitrary parameters for the bonded network interface:
-
-    its('params') { should eq 'value' }

data/docs/resources/bridge.md.erb

@@ -6,9 +6,6 @@ title: About the bridge Resource
 
 Use the `bridge` InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.
 
-* On Linux platforms, any value in the `/sys/class/net/{interface}/bridge` directory may be tested
-* On the Windows platform, the `Get-NetAdapter` cmdlet is associated with the `Get-NetAdapterBinding` cmdlet and returns the `ComponentID ms_bridge` value as a JSON object
-
 <br>
 
 ## Syntax
@@ -22,9 +19,26 @@ A `bridge` resource block declares the bridge to be tested and what interface it
 
 <br>
 
+## Supported Properties 
+
+* On Linux platforms, any value in the `/sys/class/net/{interface}/bridge` directory may be tested
+* On the Windows platform, the `Get-NetAdapter` cmdlet is associated with the `Get-NetAdapterBinding` cmdlet and returns the `ComponentID ms_bridge` value as a JSON object
+
+<br>
+
+## Property Examples
+
+### interfaces
+
+The `interfaces` property tests if the named interface is present:
+
+    its('interfaces') { should eq 'foo' }
+    its('interfaces') { should eq 'bar' }
+    its('interfaces') { should include('foo') }
+
 ## 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/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### exist
 
@@ -38,10 +52,3 @@ The `have_interface` matcher tests if the named interface is defined for the net
 
     it { should have_interface 'eth0' }
 
-### interfaces
-
-The `interfaces` matcher tests if the named interface is present:
-
-    its('interfaces') { should eq 'foo' }
-    its('interfaces') { should eq 'bar' }
-    its('interfaces') { should include('foo') }

data/docs/resources/bsd_service.md.erb

@@ -21,7 +21,11 @@ A `bsd_service` resource block declares the name of a service and then one (or m
 where
 
 * `('service_name')` must specify a service name
-* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource; all matchers available to the `service` resource may be used
+* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource.
+
+### Using `bsd_service` resource parameters
+
+#### Path
 
 The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
 
@@ -33,9 +37,14 @@ The path to the service manager's control may be specified for situations where
 
 <br>
 
+## Supported Properties
+
+All properties available to the `service` resource may be used.
+<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/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### be_enabled
 

data/docs/resources/command.md.erb

@@ -10,31 +10,43 @@ Use the `command` InSpec audit resource to test an arbitrary command that is run
 
 ## 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:
+A `command` resource block declares a command to be run, one (or more) expected values, and the location to which that output is sent:
 
     describe command('command') do
       it { should exist }
-      its('matcher') { should eq 'output' }
+      its('property') { should eq 'value' }
     end
 
 where
 
 * `'command'` must specify a command to be run
-* `'matcher'` is one of `exit_status`, `stderr`, or `stdout`
+* `'property'` 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
 
 <br>
 
-## Examples
+## Property Examples
 
 The following examples show how to use this InSpec audit resource.
 
-### Test for PostgreSQL database running a RC, development, or beta release
+### exit_status
 
-    describe command('psql -V') do
-      its('stdout') { should eq '/RC/' }
-      its('stdout') { should_not eq '/DEVEL/' }
-      its('stdout') { should_not eq '/BETA/' }
+The `exit_status` property tests the exit status for the command:
+
+    its('exit_status') { should eq 123 }
+
+### stderr
+
+The `stderr` property tests results of the command as returned in standard error (stderr):
+
+    its('stderr') { should eq 'error' }
+
+### stdout
+
+The `stdout` property 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
 
 ### Test standard output (stdout)
@@ -73,6 +85,14 @@ The following examples show how to use this InSpec audit resource.
       it { should eq false }
     end
 
+### Test for PostgreSQL database running a RC, development, or beta release
+
+    describe command('psql -V') do
+      its('stdout') { should eq '/RC/' }
+      its('stdout') { should_not eq '/DEVEL/' }
+      its('stdout') { should_not eq '/BETA/' }
+    end
+
 ### Verify NTP
 
 The following example shows how to use the `file` audit resource to verify if the `ntp.conf` and `leap-seconds` files are present, and then the `command` resource to verify if NTP is installed and running:
@@ -107,7 +127,7 @@ Wix includes serveral tools -- such as `candle` (preprocesses and compiles sourc
 
 ## 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/).
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
 
 ### exist
 
@@ -115,22 +135,3 @@ 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/cpan.md.erb

@@ -6,6 +6,8 @@ title: About the cpan Resource
 
 Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.
 
+<br>
+
 ## Syntax
 
 A `cpan` resource block declares a package and (optionally) a package version:
@@ -19,26 +21,15 @@ where
 * `'package_name'` is the name of the package, such as `'DBD::Pg'`
 * `be_installed` tests to see if the package described above is installed
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed on the system:
-
-    it { should be_installed }
-
-### version
-
-The `version` matcher tests if the named package version is on the system:
+## Supported Resource Parameters
 
-    its('version') { should eq '1.2.3' }
+This resource uses package names and perl library paths as resource parameters.
 
-## Examples
+<br>
 
-The following examples show how to use this InSpec audit resource.
+## Resource Parameter Examples
 
 ### Test if DBD::Pg is installed on the system
 
@@ -55,8 +46,33 @@ The following examples show how to use this InSpec audit resource.
     
 ### Test if DBD::Pg is installed within a custom PERL5LIB path on the system
 
-Hint: You can pass multiple path's separated by colon `/path/to/perl5/lib:/usr/share/perl5/vendor_perl/lib/perl5`
+Hint: You can pass multiple paths separated with a colon
+`/path/to/perl5/lib:/usr/share/perl5/vendor_perl/lib/perl5`
 
     describe cpan('DBD::Pg', '/home/jdoe/perl5/lib/perl5') do
       it { should be_installed }
     end
+
+<br>
+
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### version
+
+The `version` property tests if the named package version is on the system:
+
+    its('version') { should eq '1.2.3' }
+
+<br>
+
+## 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 package is installed on the system:
+
+    it { should be_installed }

data/docs/resources/cran.md.erb

@@ -6,6 +6,8 @@ title: About the cran Resource
 
 Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.
 
+<br> 
+
 ## Syntax
 
 A `cran` resource block declares a package and (optionally) a package version:
@@ -19,36 +21,43 @@ where
 * `'package_name'` is the name of the package, such as `'DBI'`
 * `be_installed` tests to see if the package described above is installed
 
+<br>
 
-## Matchers
+## Resource Parameter Examples
 
-This InSpec audit resource has the following matchers:
+The following examples show how to use this InSpec audit resource.
 
-### be_installed
+### Test if DBI is installed on the system
 
-The `be_installed` matcher tests if the named package is installed on the system:
+    describe cran('DBI') do
+      it { should be_installed }
+    end
 
-    it { should be_installed }
+### Test if DBI 0.5.1 is installed on the system
+
+    describe cran('DBI') do
+      it { should be_installed }
+      its('version') { should eq '0.5.1' }
+    end
+
+<br>
+
+## Property Examples
 
 ### version
 
-The `version` matcher tests if the named package version is on the system:
+The `version` property tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
 
-## Examples
+<br>
 
-The following examples show how to use this InSpec audit resource.
+## Matchers
 
-### Test if DBI is installed on the system
+This InSpec audit resource has the following matchers:
 
-    describe cran('DBI') do
-      it { should be_installed }
-    end
+### be_installed
 
-### Test if DBI 0.5.1 is installed on the system
+The `be_installed` matcher tests if the named package is installed on the system:
 
-    describe cran('DBI') do
-      it { should be_installed }
-      its('version') { should eq '0.5.1' }
-    end
+    it { should be_installed }

data/docs/resources/crontab.md.erb

@@ -18,7 +18,7 @@ A `crontab` resource block declares a user (which defaults to the current user,
 
 <br>
 
-## Examples
+## Resource Parameter Examples
 
 The following examples show how to use this InSpec audit resource.
 
@@ -65,6 +65,23 @@ The following examples show how to use this InSpec audit resource.
 
 <br>
 
+## Property Examples
+
+  ### Test a special time string
+
+    describe crontab do
+      its('minutes') { should cmp '0' }
+      its('hours') { should cmp '0' }
+      its('days') { should cmp '1' }
+      its('weekdays') { should cmp '1' }
+      its('user') { should include 'username'}
+      its('commands') { should include '/some/scheduled/task.sh' }
+    end
+
+InSpec will automatically interpret crontab-supported special time strings. For example, a crontab entry set to run `@yearly` can be tested as if the entry was manually configured to run on January 1, 12 AM.
+
+<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

@@ -13,7 +13,7 @@ Use the `csv` InSpec audit resource to test configuration data in a CSV file.
 A `csv` resource block declares the configuration data to be tested:
 
     describe csv('file') do
-      its('name') { should eq 'foo' }
+      its('name') { should cmp 'foo' }
     end
 
 where
@@ -24,7 +24,7 @@ where
 
 <br>
 
-## Examples
+## Resource Parameter Examples
 
 The following examples show how to use this InSpec audit resource.
 
@@ -36,12 +36,18 @@ The following examples show how to use this InSpec audit resource.
 
 <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/).
+## Property Examples
 
 ### name
 
-The `name` matcher tests the value of `name` as read from a CSV file versus the value declared in the test:
+The `name` property tests the value of `name` as read from a CSV file compared to the value declared in the test.
+
+    its('name') { should cmp 'foo' }
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+
 
-    its('name') { should eq 'foo' }