inspec 1.40.0 → 1.41.0

data/docs/resources/nginx.md.erb

@@ -8,6 +8,8 @@ Use the `nginx` InSpec audit resource to test the fields and validity of nginx.
 
 Nginx resource extracts and exposes data reported by the command 'nginx -V'
 
+<br>
+
 ## Syntax
 
 An `nginx` InSpec audit resource block extracts configuration settings that should be tested:
@@ -25,10 +27,14 @@ where
 * `'attribute'` is a configuration parsed from result of the command 'nginx -V'
 * `'value'` is the value that is expected of the attribute
 
+<br>
+
 ## Supported Properties
 
 * 'compiler_info',  'error_log_path',  'http_client_body_temp_path',  'http_fastcgi_temp_path',  'http_log_path',  'http_proxy_temp_path',  'http_scgi_temp_path',  'http_uwsgi_temp_path',  'lock_path',  'modules', 'modules_path',  'openssl_version',  'prefix',  'sbin_path',  'service',  'support_info',  'version'
 
+<br>
+
 ## Property Examples and Return Types
 
 ### version(String)

data/docs/resources/nginx_conf.md.erb

@@ -8,6 +8,8 @@ Use the `nginx_conf` InSpec resource to test configuration data for the NGINX se
 
 **Stability: Experimental**
 
+<br>
+
 ## Syntax
 
 An `nginx_conf` resource block declares the client NGINX configuration data to be tested:
@@ -23,10 +25,32 @@ where
 * `params['pid']` selects the `pid` entry from the global NGINX configuration
 * `{ should cmp 'logs/nginx.pid' }` tests if the PID is set to `logs/nginx.pid` (via `cmp` matcher)
 
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Find a specific server
+
+    servers = nginx_conf.servers
+    domain2 = servers.find { |s| s.params['server_name'].flatten.include? 'domain2.com' }
+    describe 'No server serves domain2' do
+      subject { domain2 }
+      it { should be_nil }
+    end
+
+### Test a raw parameter
+
+    describe nginx_conf.params['worker_processes'].flatten do
+      it { should cmp 5 }
+    end
+
+<br>
 
 ## Matchers
 
-This InSpec audit resource has the following matchers:
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### http
 
@@ -101,22 +125,3 @@ Locations provide access to their parent server entry and raw parameters:
 
     location.params
     => {"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Find a specific server
-
-    servers = nginx_conf.servers
-    domain2 = servers.find { |s| s.params['server_name'].flatten.include? 'domain2.com' }
-    describe 'No server serves domain2' do
-      subject { domain2 }
-      it { should be_nil }
-    end
-
-### Test a raw parameter
-
-    describe nginx_conf.params['worker_processes'].flatten do
-      it { should cmp 5 }
-    end

data/docs/resources/npm.md.erb

@@ -6,6 +6,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.
 
+<br>
 
 ## Syntax
 
@@ -20,56 +21,39 @@ where
 * `('npm_package_name')` must specify an NPM package, such as `'bower'` or `'statsd'`
 * `be_installed` is a valid matcher for this resource
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
+## Examples
 
-### be_installed
+The following examples show how to use this InSpec audit resource.
 
-The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
+### Verify that bower is installed, with a specific version
 
-    it { should be_installed }
+    describe npm('bower') do
+      it { should be_installed }
+      its('version') { should eq '1.4.1' }
+    end
 
-### cmp
+### Verify that statsd is not installed
 
-<%= partial "/shared/matcher_cmp" %>
+    describe npm('statsd') do
+      it { should_not be_installed }
+    end
 
-### eq
+<br>
 
-<%= partial "/shared/matcher_eq" %>
+## Matchers
 
-### include
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
-<%= partial "/shared/matcher_include" %>
+### be_installed
 
-### match
+The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
 
-<%= partial "/shared/matcher_match" %>
+    it { should be_installed }
 
 ### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### 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
-
-    describe npm('statsd') do
-      it { should_not be_installed }
-    end

data/docs/resources/ntp_conf.md.erb

@@ -6,6 +6,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`.
 
+<br>
 
 ## Syntax
 
@@ -21,56 +22,38 @@ where
 * `('path')` is the non-default path to the `ntp.conf` file
 * `{ should eq 'value' }` is the value that is expected
 
+<br>
 
-## Matchers
-
-This resource matches any service that is listed in the `ntp.conf` file:
-
-    its('server') { should_not eq nil }
-
-or:
+## Examples
 
-    its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+The following examples show how to use this InSpec audit resource.
 
-For example:
+### Test for clock drift against named servers
 
     describe ntp_conf do
-      its('server') { should_not eq nil }
-      its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+      its('driftfile') { should eq '/var/lib/ntp/ntp.drift' }
+      its('server') { should eq [
+        0.ubuntu.pool.ntp.org,
+        1.ubuntu.pool.ntp.org,
+        2.ubuntu.pool.ntp.org
+      ] }
     end
 
+<br>
 
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
+## Matchers
 
-### match
+This resource matches any service that is listed in the `ntp.conf` file. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
-<%= partial "/shared/matcher_match" %>
+    its('server') { should_not eq nil }
 
-## Examples
+or:
 
-The following examples show how to use this InSpec audit resource.
+    its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
 
-### Test for clock drift against named servers
+For example:
 
     describe ntp_conf do
-      its('driftfile') { should eq '/var/lib/ntp/ntp.drift' }
-      its('server') { should eq [
-        0.ubuntu.pool.ntp.org,
-        1.ubuntu.pool.ntp.org,
-        2.ubuntu.pool.ntp.org
-      ] }
+      its('server') { should_not eq nil }
+      its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
     end

data/docs/resources/oneget.md.erb

@@ -6,6 +6,8 @@ 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.
 
+<br>
+
 ## Syntax
 
 A `oneget` resource block declares a package and (optionally) a package version:
@@ -19,49 +21,32 @@ where
 * `('name')` must specify the name of a package, such as `'VLC'`
 * `be_installed` is a valid matcher for this resource
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed on the system:
+## Examples
 
-    it { should be_installed }
+The following examples show how to use this InSpec audit resource.
 
-### cmp
+### Test if VLC is installed
 
-<%= partial "/shared/matcher_cmp" %>
+    describe oneget('VLC') do
+      it { should be_installed }
+    end
 
-### eq
+<br>
 
-<%= partial "/shared/matcher_eq" %>
+## Matchers
 
-### include
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
-<%= partial "/shared/matcher_include" %>
+### be_installed
 
-### match
+The `be_installed` matcher tests if the named package is installed on the system:
 
-<%= partial "/shared/matcher_match" %>
+    it { should be_installed }
 
 ### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if VLC is installed
-
-    describe oneget('VLC') do
-      it { should be_installed }
-    end

data/docs/resources/oracledb_session.md.erb

@@ -6,6 +6,8 @@ title: About the oracledb_session Resource
 
 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:
@@ -20,17 +22,7 @@ where
 * `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" %>
+<br>
 
 ## Examples
 
@@ -51,3 +43,9 @@ The following examples show how to use this InSpec audit resource.
     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/).

data/docs/resources/os.md.erb

@@ -6,45 +6,53 @@ title: About the os Resource
 
 Use the `os` InSpec audit resource to test the platform on which the system is running.
 
+<br>
+
 ## 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:
 
     describe os[:family] do
-      it { should eq 'platform_name' }
+      it { should eq 'platform_family_name' }
     end
 
-or using the block name:
-
-    describe os[:family_name] do
-      ...
-    end
+* `'platform_family_name'` (a string) is one of `aix`, `bsd`, `darwin`, `debian`, `hpux`, `linux`, `redhat`, `solaris`, `suse`,  `unix`, or `windows`
 
-* `'platform_name'` (a string) or `:family_name` (a symbol) is one of `aix`, `bsd`, `darwin`, `debian`, `hpux`, `linux`, `redhat`, `solaris`, `suse`,  `unix`, or `windows`
+The parameters available to `os` are:
 
-## Matchers
+* `:name` - the operating system name, such as `centos`
+* `:family` - the operating system family, such as `redhat`
+* `:release` - the version of the operating system, such as `7.3.1611`
+* `:arch` - the architecture of the operating system, such as `x86_64`
+<br>
 
-This InSpec audit resource has the following matchers:
+## Examples
 
-### be
+The following examples show how to use this InSpec audit resource.
 
-<%= partial "/shared/matcher_be" %>
+### Test for RedHat
 
-### cmp
+    describe os[:family] do
+      it { should eq 'redhat' }
+    end
 
-<%= partial "/shared/matcher_cmp" %>
+### Test for Ubuntu
 
-### eq
+    describe os[:family] do
+      it { should eq 'debian' }
+    end
 
-<%= partial "/shared/matcher_eq" %>
+### Test for Microsoft Windows
 
-### include
+    describe os[:family] do
+      it { should eq 'windows' }
+    end
 
-<%= partial "/shared/matcher_include" %>
+<br>
 
-### match
+## Matchers
 
-<%= partial "/shared/matcher_match" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ## os.family? Helpers
 
@@ -121,34 +129,12 @@ For example, both of the following tests should have the same result:
       end
     end
 
-    if os[:debian]
+    if os.debian?
       describe port(69) do
         its('processes') { should include 'in.tftpd' }
       end
-    elsif os[:redhat]
+    elsif os.redhat?
       describe port(69) do
         its('processes') { should include 'xinetd' }
       end
     end
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test for RedHat
-
-    describe os[:family] do
-      it { should eq 'redhat' }
-    end
-
-### Test for Ubuntu
-
-    describe os[:family] do
-      it { should eq 'debian' }
-    end
-
-### Test for Microsoft Windows
-
-    describe os[:family] do
-      it { should eq 'windows' }
-    end