inspec 1.0.0 → 1.35.1

data/docs/resources/mount.md.erb

@@ -4,9 +4,9 @@ title: About the mount Resource
 
 # mount
 
-Use the `mount` InSpec audit resource to test the mount points on Linux systems.
+Use the `mount` InSpec audit resource to test the mount points on FreeBSD and 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/mssql_session.md.erb

@@ -0,0 +1,62 @@
+---
+title: About the mssql_session Resource
+---
+
+# mssql_session
+
+Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
+
+## Syntax
+
+A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:
+
+    describe mssql_session(user: 'username', password: 'password').query('QUERY').row(0).column('result') do
+      its('value') { should eq('') }
+    end
+
+where
+
+* `mssql_session` declares a username and password with permission to run the query.  Omitting the username or password parameters results in the use of Windows authentication as the user InSpec is executing as.  You may also optionally pass a host and instance name.  If omitted, they will default to host: localhost and the default instance.
+* `query('QUERY')` contains the query to be run
+* `its('value') { should eq('') }` compares the results of the query against the expected result in the test
+
+## Matchers
+
+This InSpec audit resource has the following matchers:
+
+### cmp
+
+<%= partial "/shared/matcher_cmp" %>
+
+### eq
+
+<%= partial "/shared/matcher_eq" %>
+
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test for matching databases
+
+    sql = mssql_session(user: 'my_user', password: 'password')
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end
+
+### Test using Windows authentication
+
+    sql = mssql_session
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end
+
+### Test a specific host and instance
+
+    sql = mssql_session(user: 'my_user', password: 'password', host: 'mssqlserver', instance: 'foo')
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end

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,44 +20,56 @@ 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')
 
     describe sql.query('show databases like \'test\';') do
       its('stdout') { should_not match(/test/) }
     end
+
+### Alternate Connection: Different Host
+
+  sql = mysql_session('my_user','password','db.example.com')
+
+### Alternate Connection: Different Port
+
+  sql = mysql_seesion('my_user','password','localhost',3307)
+
+### Alternate Connection: Using a socket
+
+  sql = mysql_session('my_user','password', nil, nil, '/var/lib/mysql-default/mysqld.sock')

data/docs/resources/npm.md.erb

@@ -7,11 +7,11 @@ 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:
 
-    describe gem('npm_package_name') do
+    describe npm('npm_package_name') do
       it { should be_installed }
     end
 
@@ -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 }

data/docs/resources/oracledb_session.md.erb

@@ -0,0 +1,53 @@
+---
+title: About the oracledb_session Resource
+---
+
+# oracledb_session
+
+Use the `oracledb_session` InSpec audit resource to test SQL commands run against a Oracle database.
+
+## Syntax
+
+A `oracledb_session` resource block declares the username and password to use for the session with an optional service to connect to, and then the command to be run:
+
+    describe oracledb_session(user: 'username', password: 'password', service: 'ORCL.localdomain').query('QUERY').row(0).column('result') do
+      its('value') { should eq('') }
+    end
+
+where
+
+* `oracledb_session` declares a username and password with permission to run the query (required), and an optional parameters for host (default: `localhost`), SID (default: `nil`, which uses the default SID, and path to the sqlplus binary (default: `sqlplus`).
+* `query('QUERY')` contains the query to be run
+* `its('value') { should eq('') }` compares the results of the query against the expected result in the test
+
+## Matchers
+
+This InSpec audit resource has the following matchers:
+
+### cmp
+
+<%= partial "/shared/matcher_cmp" %>
+
+### eq
+
+<%= partial "/shared/matcher_eq" %>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test for matching databases
+
+    sql = oracledb_session(user: 'my_user', pass: 'password')
+
+    describe sql.query('SELECT NAME AS VALUE FROM v$database;').row(0).column('value') do
+      its('value') { should cmp 'ORCL' }
+    end
+
+### Test for matching databases with custom host, SID and sqlplus binary location
+
+    sql = oracledb_session(user: 'my_user', pass: 'password', host: 'oraclehost', sid: 'mysid', sqlplus_bin: '/u01/app/oracle/product/12.1.0/dbhome_1/bin/sqlplus')
+
+    describe sql.query('SELECT NAME FROM v$database;').row(0).column('name') do
+      its('value') { should cmp 'ORCL' }
+    end

data/docs/resources/os.md.erb

@@ -6,7 +6,7 @@ title: About the os Resource
 
 Use the `os` InSpec audit resource to test the platform on which the system is running.
 
-# Syntax
+## Syntax
 
 An `os` resource block declares the platform to be tested. The platform may specified via matcher or control block name. For example, using a matcher:
 
@@ -22,31 +22,31 @@ or using the block name:
 
 * `'platform_name'` (a string) or `:family_name` (a symbol) is one of `aix`, `bsd`, `darwin`, `debian`, `hpux`, `linux`, `redhat`, `solaris`, `suse`,  `unix`, or `windows`
 
-# 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" %>
 
-# os.family? Helpers
+## os.family? Helpers
 
 The `os` audit resource includes a collection of helpers that enable more granular testing of platforms, platform names, architectures, and releases. Use any of the following platform-specific helpers to test for specific platforms:
 
@@ -56,7 +56,7 @@ The `os` audit resource includes a collection of helpers that enable more granul
 * `debian?`
 * `hpux?`
 * `linux?` (including Alpine Linux, Amazon Linux, ArchLinux, CoreOS, Exherbo, Fedora, Gentoo, and Slackware)
-* `redhat?`
+* `redhat?` (including CentOS)
 * `solaris?` (including Nexenta Core, OmniOS, Open Indiana, Solaris Open, and SmartOS)
 * `suse?`
 * `unix?`
@@ -94,7 +94,7 @@ Use the following helpers to test for operating system names, releases, and arch
        it { should eq 'foo' }
     end
 
-# os[:family] Symbols
+## os[:family] Symbols
 
 Use `os[:family]` to enable more granular testing of platforms, platform names, architectures, and releases. Use any of the following platform-specific symbols to test for specific platforms:
 
@@ -103,7 +103,7 @@ Use `os[:family]` to enable more granular testing of platforms, platform names,
 * `:debian`
 * `:hpux`
 * `:linux`. For platforms that are part of the Linux family: `:alpine`, `:amazon`, `:arch`, `:coreos`, `:exherbo`, `:fedora`, `:gentoo`, and `:slackware`.
-* `:redhat`
+* `:redhat`. For platforms that are part of the Redhat family: `:centos`.
 * `:solaris`. For platforms that are part of the Solaris family: `:nexentacore`, `:omnios`, `:openindiana`, `:opensolaris`, and `:smartos`.
 * `:suse`
 * `:unix`
@@ -115,7 +115,7 @@ For example, both of the following tests should have the same result:
       describe port(69) do
         its('processes') { should include 'in.tftpd' }
       end
-    elsif os[:family] == 'rhel'
+    elsif os[:family] == 'redhat'
       describe port(69) do
         its('processes') { should include 'xinetd' }
       end
@@ -125,29 +125,29 @@ For example, both of the following tests should have the same result:
       describe port(69) do
         its('processes') { should include 'in.tftpd' }
       end
-    elsif os[:rhel]
+    elsif os[:redhat]
       describe port(69) do
         its('processes') { should include 'xinetd' }
       end
     end
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test for RedHat
+### Test for RedHat
 
     describe os[:family] do
       it { should eq 'redhat' }
     end
 
-## Test for Ubuntu
+### Test for Ubuntu
 
     describe os[:family] do
       it { should eq 'debian' }
     end
 
-## Test for Microsoft Windows
+### Test for Microsoft Windows
 
     describe os[:family] do
       it { should eq 'windows' }