inspec 2.1.21 → 2.1.30

data/docs/resources/nginx.md.erb

@@ -1,79 +1,79 @@
----
-title: The Nginx Resource
-platform: linux
----
-
-# nginx
-
-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:
-
-    describe nginx do
-      its('attribute') { should eq 'value' }
-    end
-
-    describe nginx('path to nginx') do
-      its('attribute') { should eq 'value' }
-    end
-
-where
-
-* `'attribute'` is a configuration parsed from result of the command 'nginx -V'
-* `'value'` is the value that is expected of the attribute
-
-<br>
-
-## 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
-
-### version(String)
-
-`version` returns a string of the version of the running nginx instance
-
-    describe nginx do
-      its('version') { should eq '1.12.0' }
-    end
-
-### modules(String)
-
-`modules` returns a array modules in the running nginx instance
-
-    describe nginx do
-      its('modules') { should include 'my_module' }
-    end
-
-### openssl_version(Hash)
-
-`openssl_version ` returns a hash with 'version' and 'date' as keys
-
-    describe nginx do
-      its('openssl_version.date') { should eq '11 Feb 2013' }
-    end
-
-### compiler_info(Hash)
-
-`compiler_info ` returns a hash with 'compiler' , version' and 'date' as keys
-
-    describe nginx do
-      its('compiler_info.compiler') { should eq 'gcc' }
-    end
-
-### support_info(String)
-
-`support_info ` returns a string containing supported protocols
-
-    describe nginx do
-      its('support_info') { should match /TLS/ }
-    end
+---
+title: The Nginx Resource
+platform: linux
+---
+
+# nginx
+
+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:
+
+    describe nginx do
+      its('attribute') { should eq 'value' }
+    end
+
+    describe nginx('path to nginx') do
+      its('attribute') { should eq 'value' }
+    end
+
+where
+
+* `'attribute'` is a configuration parsed from result of the command 'nginx -V'
+* `'value'` is the value that is expected of the attribute
+
+<br>
+
+## 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
+
+### version(String)
+
+`version` returns a string of the version of the running nginx instance
+
+    describe nginx do
+      its('version') { should eq '1.12.0' }
+    end
+
+### modules(String)
+
+`modules` returns a array modules in the running nginx instance
+
+    describe nginx do
+      its('modules') { should include 'my_module' }
+    end
+
+### openssl_version(Hash)
+
+`openssl_version ` returns a hash with 'version' and 'date' as keys
+
+    describe nginx do
+      its('openssl_version.date') { should eq '11 Feb 2013' }
+    end
+
+### compiler_info(Hash)
+
+`compiler_info ` returns a hash with 'compiler' , version' and 'date' as keys
+
+    describe nginx do
+      its('compiler_info.compiler') { should eq 'gcc' }
+    end
+
+### support_info(String)
+
+`support_info ` returns a string containing supported protocols
+
+    describe nginx do
+      its('support_info') { should match /TLS/ }
+    end

data/docs/resources/nginx_conf.md.erb

@@ -1,138 +1,138 @@
----
-title: About the nginx_conf Resource
-platform: linux
----
-
-# nginx_conf
-
-Use the `nginx_conf` InSpec resource to test configuration data for the NGINX server located at `/etc/nginx/nginx.conf` on Linux and Unix platforms.
-
-**Stability: Experimental**
-
-<br>
-
-## Syntax
-
-An `nginx_conf` resource block declares the client NGINX configuration data to be tested:
-
-    describe nginx_conf.params['pid'] do
-      it { should cmp 'logs/nginx.pid' }
-    end
-
-where
-
-* `nginx_conf` is the resource to reference your NGINX configuration
-* `params` accesses all its parameters
-* `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
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### http
-
-Retrieves all `http` entries in the configuration file.
-
-    nginx_conf.http
-    => nginx_conf /etc/nginx/nginx.conf, http entries
-
-It provides further access to all individual entries, servers, and locations.
-
-    nginx_conf.http.entries
-    => [nginx_conf /etc/nginx/nginx.conf, http entry ...]
-
-    nginx_conf.http.servers
-    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
-
-    nginx_conf.http.locations
-    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
-
-You can access each of these from the array and inspect it further (see below).
-
-### servers
-
-Retrieve all `servers` entries in the configuration:
-
-    # all servers across all configs aggregated:
-    nginx_conf.servers
-    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
-
-    # servers that belong to a specific http entry:
-    nginx_conf.http.entries[0].servers
-    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
-
-Servers provide access to all their locations, parent http entry, and raw parameters:
-
-    server = nginx_conf.servers[0]
-
-    server.locations
-    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
-
-    server.parent
-    => nginx_conf /etc/nginx/nginx.conf, http entry
-
-    server.params
-    => {"listen"=>[["85"]],
-       "server_name"=>[["domain1.com", "www.domain1.com"]],
-       "root"=>[["html"]],
-       "location"=>[{"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}]}
-
-### locations
-
-Retrieve all `location` entries in the configuration:
-
-    # all locations across all configs aggregated:
-    nginx_conf.locations
-    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
-
-    # locations of a http entry aggregated:
-    nginx_conf.http.entries[0].locations
-    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
-
-    # locations of a specific server:
-    nginx_conf.servers[0].locations
-    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
-
-Locations provide access to their parent server entry and raw parameters:
-
-    location = nginx_conf.locations[0]
-
-    location.parent
-    => nginx_conf /etc/nginx/nginx.conf, server entry
-
-    location.params
-    => {"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}
-
-### configuration file path
-
-If the NGINX configuration file is not located at the default path, `/etc/nginx/nginx.conf`, the path can specified as the first parameter of the describe block:
-
-    describe nginx_conf('/opt/nginx/nginx.conf').params['pid'] do
-      it { should cmp 'logs/nginx.pid' }
-    end
-
-
+---
+title: About the nginx_conf Resource
+platform: linux
+---
+
+# nginx_conf
+
+Use the `nginx_conf` InSpec resource to test configuration data for the NGINX server located at `/etc/nginx/nginx.conf` on Linux and Unix platforms.
+
+**Stability: Experimental**
+
+<br>
+
+## Syntax
+
+An `nginx_conf` resource block declares the client NGINX configuration data to be tested:
+
+    describe nginx_conf.params['pid'] do
+      it { should cmp 'logs/nginx.pid' }
+    end
+
+where
+
+* `nginx_conf` is the resource to reference your NGINX configuration
+* `params` accesses all its parameters
+* `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
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### http
+
+Retrieves all `http` entries in the configuration file.
+
+    nginx_conf.http
+    => nginx_conf /etc/nginx/nginx.conf, http entries
+
+It provides further access to all individual entries, servers, and locations.
+
+    nginx_conf.http.entries
+    => [nginx_conf /etc/nginx/nginx.conf, http entry ...]
+
+    nginx_conf.http.servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+    nginx_conf.http.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+You can access each of these from the array and inspect it further (see below).
+
+### servers
+
+Retrieve all `servers` entries in the configuration:
+
+    # all servers across all configs aggregated:
+    nginx_conf.servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+    # servers that belong to a specific http entry:
+    nginx_conf.http.entries[0].servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+Servers provide access to all their locations, parent http entry, and raw parameters:
+
+    server = nginx_conf.servers[0]
+
+    server.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    server.parent
+    => nginx_conf /etc/nginx/nginx.conf, http entry
+
+    server.params
+    => {"listen"=>[["85"]],
+       "server_name"=>[["domain1.com", "www.domain1.com"]],
+       "root"=>[["html"]],
+       "location"=>[{"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}]}
+
+### locations
+
+Retrieve all `location` entries in the configuration:
+
+    # all locations across all configs aggregated:
+    nginx_conf.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    # locations of a http entry aggregated:
+    nginx_conf.http.entries[0].locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    # locations of a specific server:
+    nginx_conf.servers[0].locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+Locations provide access to their parent server entry and raw parameters:
+
+    location = nginx_conf.locations[0]
+
+    location.parent
+    => nginx_conf /etc/nginx/nginx.conf, server entry
+
+    location.params
+    => {"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}
+
+### configuration file path
+
+If the NGINX configuration file is not located at the default path, `/etc/nginx/nginx.conf`, the path can specified as the first parameter of the describe block:
+
+    describe nginx_conf('/opt/nginx/nginx.conf').params['pid'] do
+      it { should cmp 'logs/nginx.pid' }
+    end
+
+

data/docs/resources/npm.md.erb

@@ -1,60 +1,60 @@
----
-title: About the npm Resource
-platform: os
----
-
-# npm
-
-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
-
-A `npm` resource block declares a package and (optionally) a package version:
-
-    describe npm('npm_package_name') do
-      it { should be_installed }
-    end
-
-where
-
-* `('npm_package_name')` must specify an NPM package, such as `'bower'` or `'statsd'`
-* `be_installed` is a valid matcher for this resource
-
-<br>
-
-## 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
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_installed
-
-The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
-
-    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' }
+---
+title: About the npm Resource
+platform: os
+---
+
+# npm
+
+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
+
+A `npm` resource block declares a package and (optionally) a package version:
+
+    describe npm('npm_package_name') do
+      it { should be_installed }
+    end
+
+where
+
+* `('npm_package_name')` must specify an NPM package, such as `'bower'` or `'statsd'`
+* `be_installed` is a valid matcher for this resource
+
+<br>
+
+## 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
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_installed
+
+The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
+
+    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' }