inspec-core 2.2.55 → 2.2.61

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

data/docs/resources/runit_service.md.erb

@@ -9,6 +9,16 @@ Use the `runit_service` InSpec audit resource to test a service using runit.
 
 <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 `runit_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

data/docs/resources/security_policy.md.erb

@@ -9,6 +9,16 @@ Use the `security_policy` InSpec audit resource to test security policies on 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 `security_policy` resource block declares the name of a security policy and the value to be tested:

data/docs/resources/service.md.erb

@@ -11,6 +11,16 @@ Under some circumstances, it may be necessary to specify the service manager by
 
 <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 `service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

data/docs/resources/shadow.md.erb

@@ -26,6 +26,16 @@ The `shadow` resource understands this format, allows you to search on the field
 
 <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.
+
 ## Resource Parameters
 
 The `shadow` resource takes one optional parameter: the path to the shadow file. If omitted, `/etc/shadow` is assumed.

data/docs/resources/ssh_config.md.erb

@@ -9,6 +9,16 @@ Use the `ssh_config` InSpec audit resource to test OpenSSH client configuration
 
 <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 `ssh_config` resource block declares the client OpenSSH configuration data to be tested:

data/docs/resources/sshd_config.md.erb

@@ -9,6 +9,16 @@ Use the `sshd_config` InSpec audit resource to test configuration data for the O
 
 <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 `sshd_config` resource block declares the client OpenSSH configuration data to be tested:

data/docs/resources/ssl.md.erb

@@ -9,6 +9,16 @@ Use the `ssl` InSpec audit resource to test SSL settings for the named 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
 
 An `ssl` resource block declares an SSL port, and then other properties of the test like cipher and/or protocol:

data/docs/resources/sys_info.md.erb

@@ -9,6 +9,16 @@ Use the `sys_info` InSpec audit resource to test for operating system properties
 
 <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 `sys_info` resource block declares the hostname to be tested:

data/docs/resources/systemd_service.md.erb

@@ -9,6 +9,16 @@ Use the `systemd_service` InSpec audit resource to test a service using SystemD.
 
 <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 `systemd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

data/docs/resources/sysv_service.md.erb

@@ -9,6 +9,16 @@ Use the `sysv_service` InSpec audit resource to test a service using SystemV.
 
 <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 `sysv_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

data/docs/resources/upstart_service.md.erb

@@ -9,6 +9,16 @@ Use the `upstart_service` InSpec audit resource to test a service using Upstart.
 
 <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 `upstart_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

data/docs/resources/user.md.erb

@@ -9,6 +9,16 @@ Use the `user` InSpec audit resource to test user profiles for a single, known/e
 
 <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 `user` resource block declares a user name, and then one (or more) matchers:

data/docs/resources/users.md.erb

@@ -9,6 +9,16 @@ Use the `users` InSpec audit resource to look up all local users available on 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 `users` resource block declares a user name, and then one (or more) matchers: