inspec 1.0.0 → 1.1.0

data/docs/resources/login_def.md.erb

@@ -6,7 +6,7 @@ title: About the login_defs Resource
 
 Use the `login_defs` InSpec audit resource to test configuration settings in the `/etc/login.defs` file. The `logins.defs` file defines site-specific configuration for the shadow password suite on Linux and Unix platforms, such as password expiration ranges, minimum/maximum values for automatic selection of user and group identifiers, or the method with which passwords are encrypted.
 
-# Syntax
+## Syntax
 
 A `login_defs` resource block declares the `login.defs` configuration data to be tested:
 
@@ -20,41 +20,41 @@ where
 * `{ should include('foo') }` tests the value of `name` as read from `login.defs` versus the value declared 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" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## name
+### name
 
 The `name` matcher tests the value of `name` as read from `login.defs` versus the value declared in the test:
 
     its('name') { should eq 'foo' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test password expiration settings
+### Test password expiration settings
 
     describe login_defs do
       its('PASS_MAX_DAYS') { should eq '180' }
@@ -63,13 +63,13 @@ The following examples show how to use this InSpec audit resource.
       its('PASS_WARN_AGE') { should eq '30' }
     end
 
-## Test the encryption method
+### Test the encryption method
 
     describe login_defs do
       its('ENCRYPT_METHOD') { should eq 'SHA512' }
     end
 
-## Test umask setting
+### Test umask setting
 
     describe login_def do
       its('UMASK') { should eq '077' }

data/docs/resources/mount.md.erb

@@ -6,7 +6,7 @@ title: About the mount Resource
 
 Use the `mount` InSpec audit resource to test the mount points on Linux systems.
 
-# Syntax
+## Syntax
 
 An `mount` resource block declares the synchronization settings that should be tested:
 
@@ -21,59 +21,59 @@ where
 * `'value'` is the value to be tested
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_mounted
+### be_mounted
 
 The `be_mounted` matcher tests if the file is accessible from the file system:
 
     it { should be_mounted }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## device
+### device
 
 The `device` matcher tests the device from the `fstab` table:
 
     its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## options
+### options
 
 The `options` matcher tests the mount options for the file system from the `fstab` table:
 
     its('options') { should eq ['rw', 'mode=620'] }
 
-## type
+### type
 
 The `type` matcher tests the file system type:
 
     its('type') { should eq  'ext4' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test a the mount point on '/'
+### Test a the mount point on '/'
 
     describe mount('/') do
       it { should be_mounted }

data/docs/resources/mysql_conf.md.erb

@@ -6,7 +6,7 @@ title: About the mysql_conf Resource
 
 Use the `mysql_conf` InSpec audit resource to test the contents of the configuration file for MySQL, typically located at `/etc/mysql/my.cnf` or `/etc/my.cnf`.
 
-# Syntax
+## Syntax
 
 A `mysql_conf` resource block declares one (or more) settings in the `my.cnf` file, and then compares the setting in the configuration file to the value stated in the test:
 
@@ -21,31 +21,31 @@ where
 * `should eq 'value'` is the value that is expected
 
 
-# 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" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## setting
+### setting
 
 The `setting` matcher tests specific, named settings in the `my.cnf` file:
 
@@ -53,18 +53,18 @@ The `setting` matcher tests specific, named settings in the `my.cnf` file:
 
 Use a `setting` matcher for each setting to be tested.
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test the maximum number of allowed connections
+### Test the maximum number of allowed connections
 
     describe mysql_conf do
       its('max_connections') { should eq '505' }
       its('max_user_connections') { should eq '500' }
     end
 
-## Test slow query logging**
+### Test slow query logging**
 
     describe mysql_conf do
       its('slow_query_log_file') { should eq 'hostname_slow.log' }
@@ -74,14 +74,14 @@ The following examples show how to use this InSpec audit resource.
       its('min_examined_row_limit') { should eq '100' }
     end
 
-## Test the port and socket on which MySQL listens
+### Test the port and socket on which MySQL listens
 
     describe mysql_conf do
       its('port') { should eq '3306' }
       its('socket') { should eq '/var/run/mysqld/mysql.sock' }
     end
 
-## Test connection and thread variables
+### Test connection and thread variables
 
     describe mysql_conf do
       its('port') { should eq '3306' }
@@ -95,7 +95,7 @@ The following examples show how to use this InSpec audit resource.
       its('thread_cache_size') { should eq '505' }
     end
 
-## Test the safe-user-create parameter
+### Test the safe-user-create parameter
 
     describe mysql_conf.params('mysqld') do
       its('safe-user-create') { should eq('1') }

data/docs/resources/mysql_session.md.erb

@@ -6,7 +6,7 @@ title: About the mysql_session Resource
 
 Use the `mysql_session` InSpec audit resource to test SQL commands run against a MySQL database.
 
-# Syntax
+## Syntax
 
 A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:
 
@@ -20,41 +20,41 @@ where
 * `query('QUERY')` contains the query to be run
 * `its('output') { should eq('') }` compares the results of the query against the expected result 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" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## output
+### output
 
 The `output` matcher tests the results of the query:
 
     its('output') { should eq(/^0/) }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test for matching databases
+### Test for matching databases
 
     sql = mysql_session('my_user','password')
 

data/docs/resources/npm.md.erb

@@ -7,7 +7,7 @@ title: About the npm Resource
 Use the `npm` InSpec audit resource to test if a global NPM package is installed. NPM is the the package manager for Node.js packages (https://docs.npmjs.com), such as Bower and StatsD.
 
 
-# Syntax
+## Syntax
 
 A `npm` resource block declares a package and (optionally) a package version:
 
@@ -21,54 +21,54 @@ where
 * `be_installed` is a valid matcher for this resource
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_installed
+### be_installed
 
 The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
 
     it { should be_installed }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## version
+### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Verify that bower is installed, with a specific version
+### Verify that bower is installed, with a specific version
 
     describe npm('bower') do
       it { should be_installed }
       its('version') { should eq '1.4.1' }
     end
 
-## Verify that statsd is not installed
+### Verify that statsd is not installed
 
     describe npm('statsd') do
       it { should_not be_installed }

data/docs/resources/ntp_conf.md.erb

@@ -7,7 +7,7 @@ title: About the ntp_conf Resource
 Use the `ntp_conf` InSpec audit resource to test the synchronization settings defined in the `ntp.conf` file. This file is typically located at `/etc/ntp.conf`.
 
 
-# Syntax
+## Syntax
 
 An `ntp_conf` resource block declares the synchronization settings that should be tested:
 
@@ -22,7 +22,7 @@ where
 * `{ should eq 'value' }` is the value that is expected
 
 
-# Matchers
+## Matchers
 
 This resource matches any service that is listed in the `ntp.conf` file:
 
@@ -40,31 +40,31 @@ For example:
     end
 
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## 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
 
 The following examples show how to use this InSpec audit resource.
 
-## Test for clock drift against named servers
+### Test for clock drift against named servers
 
     describe ntp_conf do
       its('driftfile') { should eq '/var/lib/ntp/ntp.drift' }

data/docs/resources/oneget.md.erb

@@ -6,7 +6,7 @@ title: About the oneget Resource
 
 Use the `oneget` InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses Oneget, which is `part of the Windows Management Framework 5.0 and Windows 10 <https://github.com/OneGet/oneget>`__. This resource uses the `Get-Package` cmdlet to return all of the package names in the Oneget repository.
 
-# Syntax
+## Syntax
 
 A `oneget` resource block declares a package and (optionally) a package version:
 
@@ -20,47 +20,47 @@ where
 * `be_installed` is a valid matcher for this resource
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_installed
+### be_installed
 
 The `be_installed` matcher tests if the named package is installed on the system:
 
     it { should be_installed }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## version
+### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test if VLC is installed
+### Test if VLC is installed
 
     describe oneget('VLC') do
       it { should be_installed }