inspec 2.2.55 → 2.2.61

data/docs/resources/mssql_session.md.erb

@@ -9,6 +9,16 @@ Use the `mssql_session` InSpec audit resource to test SQL commands run against a
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.24.0 of InSpec.
+
 ## Syntax
 
 A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:

data/docs/resources/mysql_conf.md.erb

@@ -9,6 +9,16 @@ Use the `mysql_conf` InSpec audit resource to test the contents of the configura
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## 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:

data/docs/resources/mysql_session.md.erb

@@ -9,6 +9,16 @@ Use the `mysql_session` InSpec audit resource to test SQL commands run against a
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:

data/docs/resources/nginx.md.erb

@@ -11,6 +11,16 @@ Nginx resource extracts and exposes data reported by the command 'nginx -V'
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.37.6 of InSpec.
+
 ## Syntax
 
 An `nginx` InSpec audit resource block extracts configuration settings that should be tested:

data/docs/resources/nginx_conf.md.erb

@@ -11,6 +11,16 @@ Use the `nginx_conf` InSpec resource to test configuration data for the NGINX se
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.37.6 of InSpec.
+
 ## Syntax
 
 An `nginx_conf` resource block declares the client NGINX configuration data to be tested:

data/docs/resources/npm.md.erb

@@ -9,6 +9,16 @@ Use the `npm` InSpec audit resource to test if a global NPM package is installed
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `npm` resource block declares a package and (optionally) a package version:

data/docs/resources/ntp_conf.md.erb

@@ -9,6 +9,16 @@ Use the `ntp_conf` InSpec audit resource to test the synchronization settings de
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 An `ntp_conf` resource block declares the synchronization settings that should be tested:

data/docs/resources/oneget.md.erb

@@ -9,6 +9,16 @@ Use the `oneget` InSpec audit resource to test if the named package and/or packa
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `oneget` resource block declares a package and (optionally) a package version:

data/docs/resources/oracledb_session.md.erb

@@ -9,6 +9,16 @@ Use the `oracledb_session` InSpec audit resource to test SQL commands run agains
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## 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:

data/docs/resources/os.md.erb

@@ -9,6 +9,16 @@ Use the `os` InSpec audit resource to test the platform on which the system is r
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## 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:

data/docs/resources/os_env.md.erb

@@ -9,6 +9,16 @@ Use the `os_env` InSpec audit resource to test the environment variables for the
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `os_env` resource block declares an environment variable, and then declares its value:

data/docs/resources/package.md.erb

@@ -9,6 +9,16 @@ Use the `package` InSpec audit resource to test if the named package and/or pack
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `package` resource block declares a package and (optionally) a package version:

data/docs/resources/packages.md.erb

@@ -9,6 +9,16 @@ Use the `packages` InSpec audit resource to test the properties of multiple pack
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.51.15 of InSpec.
+
 ## Syntax
 
 A `packages` resource block declares a regular expression search to select packages

data/docs/resources/parse_config.md.erb

@@ -9,6 +9,16 @@ Use the `parse_config` InSpec audit resource to test arbitrary configuration fil
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `parse_config` resource block declares the location of the configuration setting to be tested, and then what value is to be tested. Because this resource relies on arbitrary configuration files, the test itself is often arbitrary and relies on custom Ruby code:

data/docs/resources/parse_config_file.md.erb

@@ -9,6 +9,16 @@ Use the `parse_config_file` InSpec audit resource to test arbitrary configuratio
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `parse_config_file` InSpec audit resource block declares the location of the configuration file to be tested, and then which settings in that file are to be tested.

data/docs/resources/passwd.md.erb

@@ -21,6 +21,16 @@ These entries are defined as a colon-delimited row in the file, one row per user
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `passwd` resource block declares one (or more) users and associated user information to be tested:

data/docs/resources/pip.md.erb

@@ -9,6 +9,16 @@ Use the `pip` InSpec audit resource to test packages that are installed using th
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `pip` resource block declares a package and (optionally) a package version:

data/docs/resources/port.md.erb

@@ -9,6 +9,16 @@ Use the `port` InSpec audit resource to test basic port properties, such as port
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `port` resource block declares a port, and then depending on what needs to be tested, a process, protocol, process identifier, and its state (is it listening?):

data/docs/resources/postgres_conf.md.erb

@@ -9,6 +9,16 @@ Use the `postgres_conf` InSpec audit resource to test the contents of the config
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `postgres_conf` resource block declares one (or more) settings in the `postgresql.conf` file, and then compares the setting in the configuration file to the value stated in the test:

data/docs/resources/postgres_hba_conf.md.erb

@@ -9,6 +9,16 @@ Use the `postgres_hba_conf` InSpec audit resource to test the client authenticat
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.31.0 of InSpec.
+
 ## Syntax
 
 An `postgres_hba_conf` InSpec audit resource block declares client authentication data that should be tested:

data/docs/resources/postgres_ident_conf.md.erb

@@ -9,6 +9,16 @@ Use the `postgres_ident_conf` InSpec audit resource to test the client authentic
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.31.0 of InSpec.
+
 ## Syntax
 
 An `postgres_ident_conf` InSpec audit resource block declares client authentication data that should be tested:

data/docs/resources/postgres_session.md.erb

@@ -9,6 +9,16 @@ Use the `postgres_session` InSpec audit resource to test SQL commands run agains
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `postgres_session` resource block declares the username and password to use for the session, and then the command to be run:

data/docs/resources/powershell.md.erb

@@ -9,6 +9,16 @@ Use the `powershell` InSpec audit resource to test a Powershell script on the Wi
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `powershell` resource block declares a Powershell script to be tested, and then compares the output of that command to the matcher in the test:

data/docs/resources/processes.md.erb

@@ -9,6 +9,16 @@ Use the `processes` InSpec audit resource to test properties for programs that a
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `processes` resource block declares the name of the process to be tested, and then declares one (or more) property/value pairs:

data/docs/resources/rabbitmq_config.md.erb

@@ -9,6 +9,16 @@ Use the `rabbitmq_config` InSpec audit resource to test configuration data for t
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.20.0 of InSpec.
+
 ## Syntax
 
 A `rabbitmq_config` resource block declares the RabbitMQ configuration data to be tested:

data/docs/resources/registry_key.md.erb

@@ -9,6 +9,16 @@ Use the `registry_key` InSpec audit resource to test key values in the Windows r
 
 <br>
 
+## Availability
+
+### Installation
+
+This resource is distributed along with InSpec itself. You can use it automatically.
+
+### Version
+
+This resource first became available in v1.0.0 of InSpec.
+
 ## Syntax
 
 A `registry_key` resource block declares the item in the Windows registry, the path to a setting under that item, and then one (or more) name/value pairs to be tested.
@@ -157,5 +167,31 @@ Any name with a dot will not work as expected: <code>its('explorer.exe') { shoul
     # either use have_property_value...
     it { should have_property_value('explorer.exe', :string, 'test') }
 
-    # ...or provide the parts of the dot-separated name in an array
-    its(['explorer', 'exe']) { should eq 'test' }
+    # ...or provide the name in an array
+    its(['explorer.exe']) { should eq 'test' }
+
+The latter workaround may be preferable because upon failure, Inspec will present the expected and actual values:
+
+    inspec> describe registry_key('HKEY_USERS\S-1-5-20\Software\Policies\Microsoft\Windows\Control Panel\Desktop') do
+    inspec>   its(["SCRNSAVE.EXE"]) { should eq "FlyingToasters.scr" }
+    inspec> end
+    
+    Profile: inspec-shell
+    Version: (not specified)
+    
+      Registry Key HKEY_USERS\S-1-5-20\Software\Policies\Microsoft\Windows\Control Panel\Desktop
+         ×  ["SCRNSAVE.EXE"] should eq "FlyingToasters.scr"
+
+         expected: "FlyingToasters.scr"
+              got: "scrnsave.scr"
+    
+         (compared using ==)
+    
+    
+    Test Summary: 0 successful, 1 failure, 0 skipped
+
+`have_property_value` only presents a false assertion:
+
+      Registry Key HKEY_USERS\S-1-5-20\Software\Policies\Microsoft\Windows\Control Panel\Desktop
+         ×  should have property value "SCRNSAVE.EXE", "FlyingToasters.scr"
+         expected #has_property_value?("SCRNSAVE.EXE", "FlyingToasters.scr") to return true, got false