docs/resources/oracledb_session.md.erb in inspec-2.1.21 vs docs/resources/oracledb_session.md.erb in inspec-2.1.30

- old
+ new

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