inspec 1.0.0 → 1.1.0

data/docs/resources/bash.md.erb

@@ -6,7 +6,7 @@ title: About the bash Resource
 
 Use the `bash` InSpec audit resource to test an arbitrary command that is run on the system using a Bash script.
 
-# Syntax
+## 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:
 
@@ -30,55 +30,55 @@ For example:
     end
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if a command may be run on the system:
 
     it { should exist }
 
-## exit_status
+### exit_status
 
 The `exit_status` matcher tests the exit status for the command:
 
     its('exit_status') { should eq 0 }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## stderr
+### stderr
 
 The `stderr` matcher tests results of the command as returned in standard error (stderr):
 
     its('stderr') { should eq '' }
 
-## stdout
+### stdout
 
 The `stdout` matcher tests results of the command as returned in standard output (stdout).
 
     its('stdout') { should match /bin/ }
 
 
-# Examples
+## Examples
 
 None.

data/docs/resources/bond.md.erb

@@ -6,7 +6,7 @@ title: About the bond Resource
 
 Use the `bond` InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the `/proc/net/bonding` directory may be tested.
 
-# Syntax
+## Syntax
 
 A `bond` resource block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:
 
@@ -20,72 +20,72 @@ where
 * `{ should exist }` is a valid matcher for this resource
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## content
+### 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') }
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if the bonded network interface is available:
 
     it { should exist }
 
-## have_interface
+### have_interface
 
 The `have_interface` matcher tests if the bonded network interface has one (or more) secondary interfaces:
 
     it { should have_interface }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## interfaces
+### interfaces
 
 The `interfaces` matcher tests if the named secondary interfaces are available:
 
     its('interfaces') { should eq ['eth0', 'eth1', ...] }
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## params
+### params
 
 The `params` matcher tests arbitrary parameters for the bonded network interface:
 
     its('params') { should eq 'value' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test if eth0 is a secondary interface for bond0
+### Test if eth0 is a secondary interface for bond0
 
     describe bond('bond0') do
       it { should exist }
       it { should have_interface 'eth0' }
     end
 
-## Test parameters for bond0
+### Test parameters for bond0
 
     describe bond('bond0') do
       its('Bonding Mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }

data/docs/resources/bridge.md.erb

@@ -9,7 +9,7 @@ Use the `bridge` InSpec audit resource to test basic network bridge 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
 
-# Syntax
+## Syntax
 
 A `bridge` resource block declares the bridge to be tested and what interface it should be associated with:
 
@@ -18,39 +18,39 @@ A `bridge` resource block declares the bridge to be tested and what interface it
       it { should have_interface 'eth0' }
     end
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if the network bridge is available:
 
     it { should exist }
 
-## have_interface
+### have_interface
 
 The `have_interface` matcher tests if the named interface is defined for the network bridge:
 
     it { should have_interface 'eth0' }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## interfaces
+### interfaces
 
 The `interfaces` matcher tests if the named interface is present:
 
@@ -58,10 +58,10 @@ The `interfaces` matcher tests if the named interface is present:
     its('interfaces') { should eq 'bar' }
     its('interfaces') { should include('foo') }
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 None.

data/docs/resources/bsd_service.md.erb

@@ -6,7 +6,7 @@ title: About the bsd_service Resource
 
 Use the `bsd_service` InSpec audit resource to test a service using a Berkeley OS-style `init` on the FreeBSD platform.
 
-# Syntax
+## Syntax
 
 A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
 
@@ -29,48 +29,48 @@ The path to the service manager's control may be specified for situations where
       it { should be_running }
     end
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_enabled
+### be_enabled
 
 The `be_enabled` matcher tests if the named service is enabled:
 
     it { should be_enabled }
 
-## be_installed
+### be_installed
 
 The `be_installed` matcher tests if the named service is installed:
 
     it { should be_installed }
 
-## be_running
+### be_running
 
 The `be_running` matcher tests if the named service is running:
 
     it { should be_running }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 None.

data/docs/resources/command.md.erb

@@ -6,7 +6,7 @@ title: About the command Resource
 
 Use the `command` InSpec audit resource to test an arbitrary command that is run on the system.
 
-# Syntax
+## 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:
 
@@ -22,49 +22,49 @@ where
 * `'output'` tests the output of the command run on the system versus the output value stated in the test
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if a command may be run on the system:
 
     it { should exist }
 
-## exit_status
+### exit_status
 
 The `exit_status` matcher tests the exit status for the command:
 
     its('exit_status') { should eq 123 }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## stderr
+### stderr
 
 The `stderr` matcher tests results of the command as returned in standard error (stderr):
 
     its('stderr') { should eq 'error' }
 
-## stdout
+### 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:
 
@@ -72,11 +72,11 @@ The `stdout` matcher tests results of the command as returned in standard output
        its('stdout') { should match (/[0-9]/) }
     end
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test for PostgreSQL database running a RC, development, or beta release
+### Test for PostgreSQL database running a RC, development, or beta release
 
     describe command('psql -V') do
       its('stdout') { should eq '/RC/' }
@@ -84,7 +84,7 @@ The following examples show how to use this InSpec audit resource.
       its('stdout') { should_not eq '/BETA/' }
     end
 
-## Test standard output (stdout)
+### Test standard output (stdout)
 
     describe command('echo hello') do
       its('stdout') { should eq 'hello\n' }
@@ -92,7 +92,7 @@ The following examples show how to use this InSpec audit resource.
       its('exit_status') { should eq 0 }
     end
 
-## Test standard error (stderr)
+### Test standard error (stderr)
 
     describe command('>&2 echo error') do
       its('stdout') { should eq '' }
@@ -100,7 +100,7 @@ The following examples show how to use this InSpec audit resource.
       its('exit_status') { should eq 0 }
     end
 
-## Test an exit status code
+### Test an exit status code
 
     describe command('exit 123') do
       its('stdout') { should eq '' }
@@ -108,19 +108,19 @@ The following examples show how to use this InSpec audit resource.
       its('exit_status') { should eq 123 }
     end
 
-## Test if the command shell exists
+### Test if the command shell exists
 
     describe command('/bin/sh').exist? do
       it { should eq true }
     end
 
-## Test for a command that should not exist
+### Test for a command that should not exist
 
     describe command('this is not existing').exist? do
       it { should eq false }
     end
 
-## Verify NTP
+### 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:
 
@@ -136,7 +136,7 @@ The following example shows how to use the `file` audit resource to verify if th
        its('exit_status') { should eq 0 }
     end
 
-## Verify WiX
+### Verify WiX
 
 Wix includes serveral tools -- such as `candle` (preprocesses and compiles source files into object files), `light` (links and binds object files to an installer database), and `heat` (harvests files from various input formats). The following example uses a whitespace array and the `file` audit resource to verify if these three tools are present:
 
@@ -145,7 +145,7 @@ Wix includes serveral tools -- such as `candle` (preprocesses and compiles sourc
       heat.exe
       light.exe
     ).each do |utility|
-      describe file("C:/wix/#{utility}") do
+      describe file("C:/wix/##{utility}") do
         it { should be_file }
       end
     end