inspec 2.1.21 → 2.1.30

data/docs/resources/mssql_session.md.erb

@@ -1,60 +1,60 @@
----
-title: About the mssql_session Resource
-platform: windows
----
-
-# mssql_session
-
-Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
-
-<br>
-
-## 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
-
-<br>
-
-## 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
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the mssql_session Resource
+platform: windows
+---
+
+# mssql_session
+
+Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
+
+<br>
+
+## 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
+
+<br>
+
+## 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
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/mysql_conf.md.erb

@@ -1,99 +1,99 @@
----
-title: About the mysql_conf Resource
-platform: os
----
-
-# mysql_conf
-
-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`.
-
-<br>
-
-## 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:
-
-    describe mysql_conf('path') do
-      its('setting') { should eq 'value' }
-    end
-
-    # Test a parameter set within the [mysqld] section
-    describe mysql_conf do
-      its('mysqld.port') { should cmp 3306 }
-    end
-
-    # Test a parameter set within the [mariadb] section using array notation
-    describe mysql_conf do
-      its(['mariadb', 'max-connections']) { should_not be_nil }
-    end
-
-where
-
-* `'setting'` specifies a setting in the `my.cnf` file, such as `max_connections`
-  * when checking a setting within sections, such as `[mysqld]`, the section name must be included
-* `('path')` is the non-default path to the `my.cnf` file
-* `should eq 'value'` is the value that is expected
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### 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**
-
-    describe mysql_conf do
-      its('slow_query_log_file') { should eq 'hostname_slow.log' }
-      its('slow_query_log') { should eq '0' }
-      its('log_queries_not_using_indexes') { should eq '1' }
-      its('long_query_time') { should eq '0.5' }
-      its('min_examined_row_limit') { should eq '100' }
-    end
-
-### 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
-
-    describe mysql_conf do
-      its('port') { should eq '3306' }
-      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
-      its('max_allowed_packet') { should eq '12M' }
-      its('default_storage_engine') { should eq 'InnoDB' }
-      its('character_set_server') { should eq 'utf8' }
-      its('collation_server') { should eq 'utf8_general_ci' }
-      its('max_connections') { should eq '505' }
-      its('max_user_connections') { should eq '500' }
-      its('thread_cache_size') { should eq '505' }
-    end
-
-### Test the safe-user-create parameter
-
-    describe mysql_conf.params('mysqld') do
-      its('safe-user-create') { should eq('1') }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### setting
-
-The `setting` matcher tests specific, named settings in the `my.cnf` file:
-
-    its('setting') { should eq 'value' }
-
-Use a `setting` matcher for each setting to be tested.
+---
+title: About the mysql_conf Resource
+platform: os
+---
+
+# mysql_conf
+
+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`.
+
+<br>
+
+## 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:
+
+    describe mysql_conf('path') do
+      its('setting') { should eq 'value' }
+    end
+
+    # Test a parameter set within the [mysqld] section
+    describe mysql_conf do
+      its('mysqld.port') { should cmp 3306 }
+    end
+
+    # Test a parameter set within the [mariadb] section using array notation
+    describe mysql_conf do
+      its(['mariadb', 'max-connections']) { should_not be_nil }
+    end
+
+where
+
+* `'setting'` specifies a setting in the `my.cnf` file, such as `max_connections`
+  * when checking a setting within sections, such as `[mysqld]`, the section name must be included
+* `('path')` is the non-default path to the `my.cnf` file
+* `should eq 'value'` is the value that is expected
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### 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**
+
+    describe mysql_conf do
+      its('slow_query_log_file') { should eq 'hostname_slow.log' }
+      its('slow_query_log') { should eq '0' }
+      its('log_queries_not_using_indexes') { should eq '1' }
+      its('long_query_time') { should eq '0.5' }
+      its('min_examined_row_limit') { should eq '100' }
+    end
+
+### 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
+
+    describe mysql_conf do
+      its('port') { should eq '3306' }
+      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
+      its('max_allowed_packet') { should eq '12M' }
+      its('default_storage_engine') { should eq 'InnoDB' }
+      its('character_set_server') { should eq 'utf8' }
+      its('collation_server') { should eq 'utf8_general_ci' }
+      its('max_connections') { should eq '505' }
+      its('max_user_connections') { should eq '500' }
+      its('thread_cache_size') { should eq '505' }
+    end
+
+### Test the safe-user-create parameter
+
+    describe mysql_conf.params('mysqld') do
+      its('safe-user-create') { should eq('1') }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### setting
+
+The `setting` matcher tests specific, named settings in the `my.cnf` file:
+
+    its('setting') { should eq 'value' }
+
+Use a `setting` matcher for each setting to be tested.

data/docs/resources/mysql_session.md.erb

@@ -1,74 +1,74 @@
----
-title: About the mysql_session Resource
-platform: os
----
-
-# mysql_session
-
-Use the `mysql_session` InSpec audit resource to test SQL commands run against a MySQL database.
-
-<br>
-
-## Syntax
-
-A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:
-
-    describe mysql_session('username', 'password').query('QUERY') do
-      its('stdout') { should match(/expected-result/) }
-    end
-
-where
-
-* `mysql_session` declares a username and password, connecting locally, with permission to run the query
-* `query('QUERY')` contains the query to be run
-* `its('stdout') { should eq(/expected-result/) }` compares the results of the query against the expected result in the test
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### 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_session('my_user','password','localhost',3307)
-
-### Alternate Connection: Using a socket
-
-    sql = mysql_session('my_user','password', nil, nil, '/var/lib/mysql-default/mysqld.sock')
-
-### Test for a successful query
-
-    describe mysql_session('my_user','password').query('show tables in existing_database;') do
-      its('exit_status') { should eq(0) }
-    end
-
-### Test for a failing query
-
-    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
-      its('exit_status') { should_not eq(0) }
-    end
-
-### Test for specific error message
-
-    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
-      its('stderr') { should match(/Unknown database/) }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource builds a [command](https://www.inspec.io/docs/reference/resources/command) object and returns the the result object. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the mysql_session Resource
+platform: os
+---
+
+# mysql_session
+
+Use the `mysql_session` InSpec audit resource to test SQL commands run against a MySQL database.
+
+<br>
+
+## Syntax
+
+A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:
+
+    describe mysql_session('username', 'password').query('QUERY') do
+      its('stdout') { should match(/expected-result/) }
+    end
+
+where
+
+* `mysql_session` declares a username and password, connecting locally, with permission to run the query
+* `query('QUERY')` contains the query to be run
+* `its('stdout') { should eq(/expected-result/) }` compares the results of the query against the expected result in the test
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### 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_session('my_user','password','localhost',3307)
+
+### Alternate Connection: Using a socket
+
+    sql = mysql_session('my_user','password', nil, nil, '/var/lib/mysql-default/mysqld.sock')
+
+### Test for a successful query
+
+    describe mysql_session('my_user','password').query('show tables in existing_database;') do
+      its('exit_status') { should eq(0) }
+    end
+
+### Test for a failing query
+
+    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
+      its('exit_status') { should_not eq(0) }
+    end
+
+### Test for specific error message
+
+    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
+      its('stderr') { should match(/Unknown database/) }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource builds a [command](https://www.inspec.io/docs/reference/resources/command) object and returns the the result object. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).