inspec-core 3.7.1 → 3.7.11

data/lib/resources/port.rb

@@ -12,7 +12,7 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc "Use the port InSpec audit resource to test basic port properties, such as port, process, if it's listening."
-    example "
+    example <<~EXAMPLE
       describe port(80) do
         it { should be_listening }
         its('protocols') {should eq ['tcp']}
@@ -22,7 +22,7 @@ module Inspec::Resources
       describe port.where { protocol =~ /tcp/ && port > 80 } do
         it { should_not be_listening }
       end
-    "
+    EXAMPLE
 
     def initialize(*args)
       args.unshift(nil) if args.length <= 1 # add the ip address to the front

data/lib/resources/postgres_conf.rb

@@ -12,11 +12,11 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the postgres_conf InSpec audit resource to test the contents of the configuration file for PostgreSQL, typically located at /etc/postgresql/<version>/main/postgresql.conf or /var/lib/postgres/data/postgresql.conf, depending on the platform.'
-    example "
+    example <<~EXAMPLE
       describe postgres_conf do
         its('max_connections') { should eq '5' }
       end
-    "
+    EXAMPLE
 
     include FindFiles
     include FileReader

data/lib/resources/postgres_hba_conf.rb

@@ -9,11 +9,11 @@ module Inspec::Resources
     supports platform: 'unix'
     desc 'Use the `postgres_hba_conf` InSpec audit resource to test the client
           authentication data defined in the pg_hba.conf file.'
-    example "
+    example <<~EXAMPLE
       describe postgres_hba_conf.where { type == 'local' } do
         its('auth_method') { should eq ['peer'] }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/postgres_ident_conf.rb

@@ -9,11 +9,11 @@ module Inspec::Resources
     supports platform: 'unix'
     desc 'Use the postgres_ident_conf InSpec audit resource to test the client
           authentication data is controlled by a pg_ident.conf file.'
-    example "
+    example <<~EXAMPLE
       describe postgres_ident_conf.where { pg_username == 'acme_user' } do
         its('map_name') { should eq ['ssl-test'] }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/postgres_session.rb

@@ -26,7 +26,7 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the postgres_session InSpec audit resource to test SQL commands run against a PostgreSQL database.'
-    example "
+    example <<~EXAMPLE
       sql = postgres_session('username', 'password', 'host')
       query('sql_query', ['database_name'])` contains the query and (optional) database to execute
 
@@ -38,7 +38,7 @@ module Inspec::Resources
       describe sql.query('SELECT * FROM pg_shadow WHERE passwd IS NULL;') do
         its('output') { should eq '' }
       end
-    "
+    EXAMPLE
 
     def initialize(user, pass, host = nil)
       @user = user || 'postgres'

data/lib/resources/powershell.rb

@@ -7,7 +7,7 @@ module Inspec::Resources
     supports platform: 'windows'
     supports platform: 'unix'
     desc 'Use the powershell InSpec audit resource to test a Windows PowerShell script on the Microsoft Windows platform.'
-    example "
+    example <<~EXAMPLE
       script = <<-EOH
         # your powershell script
       EOH
@@ -15,7 +15,7 @@ module Inspec::Resources
       describe powershell(script) do
         its('matcher') { should eq 'output' }
       end
-    "
+    EXAMPLE
 
     def initialize(script)
       # PowerShell is the default shell on Windows, use the `command` resource

data/lib/resources/processes.rb

@@ -10,7 +10,7 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the processes InSpec audit resource to test properties for programs that are running on the system.'
-    example "
+    example <<~EXAMPLE
       describe processes('mysqld') do
         its('entries.length') { should eq 1 }
         its('users') { should eq ['mysql'] }
@@ -25,7 +25,7 @@ module Inspec::Resources
       describe processes do
         its('entries.length') { should be <= 100 }
       end
-    "
+    EXAMPLE
 
     def initialize(grep = /.*/)
       @grep = grep

data/lib/resources/rabbitmq_conf.rb

@@ -10,11 +10,11 @@ module Inspec::Resources
     desc 'Use the rabbitmq_config InSpec resource to test configuration data '\
          'for the RabbitMQ service located in /etc/rabbitmq/rabbitmq.config on '\
          'Linux and UNIX platforms.'
-    example "
+    example <<~EXAMPLE
       describe rabbitmq_config.params('rabbit', 'ssl_listeners') do
         it { should cmp 5671 }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/registry_key.rb

@@ -50,11 +50,11 @@ module Inspec::Resources
     name 'registry_key'
     supports platform: 'windows'
     desc 'Use the registry_key InSpec audit resource to test key values in the Microsoft Windows registry.'
-    example "
+    example <<~EXAMPLE
       describe registry_key('path\to\key') do
         its('name') { should eq 'value' }
       end
-    "
+    EXAMPLE
 
     def initialize(name, reg_key = nil)
       # if we have one parameter, we use it as name

data/lib/resources/security_identifier.rb

@@ -6,12 +6,12 @@ module Inspec::Resources
     name 'security_identifier'
     supports platform: 'windows'
     desc 'Resource that returns a Security Identifier for a given entity name in Windows.'
-    example <<-EOD
+    example <<~EXAMPLE
       describe security_identifier(group: 'Everyone') do
         it { should exist }
         its('sid') { should eq 'S-1-1-0' }
       end
-    EOD
+    EXAMPLE
 
     def initialize(opts = {})
       supported_opt_keys = [:user, :group, :unspecified]

data/lib/resources/security_policy.rb

@@ -69,7 +69,7 @@ module Inspec::Resources
     name 'security_policy'
     supports platform: 'windows'
     desc 'Use the security_policy InSpec audit resource to test security policies on the Microsoft Windows platform.'
-    example "
+    example <<~EXAMPLE
       describe security_policy do
         its('SeNetworkLogonRight') { should include 'S-1-5-11' }
       end
@@ -77,7 +77,7 @@ module Inspec::Resources
       describe security_policy(translate_sid: true) do
         its('SeNetworkLogonRight') { should include 'NT AUTHORITY\\Authenticated Users' }
       end
-    "
+    EXAMPLE
 
     def initialize(opts = {})
       @translate_sid = opts[:translate_sid] || false

data/lib/resources/service.rb

@@ -71,7 +71,7 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the service InSpec audit resource to test if the named service is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       describe service('service_name') do
         it { should be_installed }
         it { should be_enabled }
@@ -87,7 +87,7 @@ module Inspec::Resources
       describe service('service_name').params do
         its('UnitFileState') { should eq 'enabled' }
       end
-    "
+    EXAMPLE
 
     attr_reader :service_ctl
 
@@ -658,7 +658,7 @@ module Inspec::Resources
     name 'systemd_service'
     supports platform: 'unix'
     desc 'Use the systemd_service InSpec audit resource to test if the named service (controlled by systemd) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe systemd_service('service_name') do
         it { should be_installed }
@@ -670,7 +670,7 @@ module Inspec::Resources
       describe systemd_service('service_name', '/path/to/systemctl') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       Systemd.new(inspec, service_ctl)
@@ -681,7 +681,7 @@ module Inspec::Resources
     name 'upstart_service'
     supports platform: 'unix'
     desc 'Use the upstart_service InSpec audit resource to test if the named service (controlled by upstart) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe upstart_service('service_name') do
         it { should be_installed }
@@ -693,7 +693,7 @@ module Inspec::Resources
       describe upstart_service('service_name', '/path/to/initctl') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       Upstart.new(inspec, service_ctl)
@@ -704,7 +704,7 @@ module Inspec::Resources
     name 'sysv_service'
     supports platform: 'unix'
     desc 'Use the sysv_service InSpec audit resource to test if the named service (controlled by SysV) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe sysv_service('service_name') do
         it { should be_installed }
@@ -716,7 +716,7 @@ module Inspec::Resources
       describe sysv_service('service_name', '/path/to/service') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       SysV.new(inspec, service_ctl)
@@ -727,7 +727,7 @@ module Inspec::Resources
     name 'bsd_service'
     supports platform: 'unix'
     desc 'Use the bsd_service InSpec audit resource to test if the named service (controlled by BSD init) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe bsd_service('service_name') do
         it { should be_installed }
@@ -739,7 +739,7 @@ module Inspec::Resources
       describe bsd_service('service_name', '/path/to/service') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       BSDInit.new(inspec, service_ctl)
@@ -750,7 +750,7 @@ module Inspec::Resources
     name 'launchd_service'
     supports platform: 'unix'
     desc 'Use the launchd_service InSpec audit resource to test if the named service (controlled by launchd) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe launchd_service('service_name') do
         it { should be_installed }
@@ -762,7 +762,7 @@ module Inspec::Resources
       describe launchd_service('service_name', '/path/to/launchctl') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       LaunchCtl.new(inspec, service_ctl)
@@ -773,7 +773,7 @@ module Inspec::Resources
     name 'runit_service'
     supports platform: 'unix'
     desc 'Use the runit_service InSpec audit resource to test if the named service (controlled by runit) is installed, running and/or enabled.'
-    example "
+    example <<~EXAMPLE
       # to override service mgmt auto-detection
       describe runit_service('service_name') do
         it { should be_installed }
@@ -785,7 +785,7 @@ module Inspec::Resources
       describe runit_service('service_name', '/path/to/sv') do
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def select_service_mgmt
       Runit.new(inspec, service_ctl)

data/lib/resources/shadow.rb

@@ -21,7 +21,7 @@ module Inspec::Resources
     desc 'Use the shadow InSpec resource to test the contents of /etc/shadow, '\
          'which contains information for users that may log into '\
          'the system and/or as users that own running processes.'
-    example "
+    example <<~EXAMPLE
       describe shadow do
         its('user') { should_not include 'forbidden_user' }
       end
@@ -30,7 +30,7 @@ module Inspec::Resources
         its('password') { should cmp 'x' }
         its('count') { should eq 1 }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/ssh_conf.rb

@@ -9,13 +9,13 @@ module Inspec::Resources
     name 'ssh_config'
     supports platform: 'unix'
     desc 'Use the `ssh_config` InSpec audit resource to test OpenSSH client configuration data located at `/etc/ssh/ssh_config` on Linux and Unix platforms.'
-    example "
+    example <<~EXAMPLE
       describe ssh_config do
         its('cipher') { should contain '3des' }
         its('port') { should eq '22' }
         its('hostname') { should include('example.com') }
       end
-    "
+    EXAMPLE
 
     include FileReader
 
@@ -80,11 +80,11 @@ module Inspec::Resources
     name 'sshd_config'
     supports platform: 'unix'
     desc 'Use the sshd_config InSpec audit resource to test configuration data for the Open SSH daemon located at /etc/ssh/sshd_config on Linux and UNIX platforms. sshd---the Open SSH daemon---listens on dedicated ports, starts a daemon for each incoming connection, and then handles encryption, authentication, key exchanges, command execution, and data exchanges.'
-    example "
+    example <<~EXAMPLE
       describe sshd_config do
         its('Protocol') { should eq '2' }
       end
-    "
+    EXAMPLE
 
     def initialize(path = nil)
       super(path || '/etc/ssh/sshd_config')

data/lib/resources/ssl.rb

@@ -16,7 +16,7 @@ class SSL < Inspec.resource(1)
     SSL test resource
   "
 
-  example "
+  example <<~EXAMPLE
     describe ssl(port: 443) do
       it { should be_enabled }
     end
@@ -30,7 +30,7 @@ class SSL < Inspec.resource(1)
     describe ssl(port: 443).ciphers(/rc4/i) do
       it { should_not be_enabled }
     end
-  "
+  EXAMPLE
 
   VERSIONS = [
     'ssl2',

data/lib/resources/sys_info.rb

@@ -7,11 +7,11 @@ module Inspec::Resources
     supports platform: 'windows'
 
     desc 'Use the user InSpec system resource to test for operating system properties.'
-    example "
+    example <<~EXAMPLE
       describe sys_info do
         its('hostname') { should eq 'example.com' }
       end
-    "
+    EXAMPLE
 
     # returns the hostname of the local system
     def hostname

data/lib/resources/toml.rb

@@ -7,13 +7,13 @@ module Inspec::Resources
   class TomlConfig < JsonConfig
     name 'toml'
     desc 'Use the toml InSpec resource to test configuration data in a TOML file'
-    example "
+    example <<~EXAMPLE
       describe toml('default.toml') do
         its('key') { should eq('value') }
         its (['arr', 1]) { should eq 2 }
         its (['mytable', 'key1']) { should eq 'value1' }
       end
-    "
+    EXAMPLE
 
     def parse(content)
       Tomlrb.parse(content)

data/lib/resources/users.rb

@@ -56,13 +56,13 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the users InSpec audit resource to test local user profiles. Users can be filtered by groups to which they belong, the frequency of required password changes, the directory paths to home and shell.'
-    example "
+    example <<~EXAMPLE
       describe users.where { uid == 0 }.entries do
         it { should eq ['root'] }
         its('uids') { should eq [1234] }
         its('gids') { should eq [1234] }
       end
-    "
+    EXAMPLE
     def initialize
       # select user provider
       @user_provider = select_user_manager(inspec.os)
@@ -141,13 +141,13 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the user InSpec audit resource to test user profiles, including the groups to which they belong, the frequency of required password changes, the directory paths to home and shell.'
-    example "
+    example <<~EXAMPLE
       describe user('root') do
         it { should exist }
         its('uid') { should eq 1234 }
         its('gid') { should eq 1234 }
       end
-    "
+    EXAMPLE
     def initialize(username = nil)
       @username = username
       # select user provider

data/lib/resources/vbscript.rb

@@ -23,7 +23,7 @@ module Inspec::Resources
     name 'vbscript'
     supports platform: 'windows'
     desc ''
-    example "
+    example <<~EXAMPLE
       script = <<-EOH
         # you vbscript
       EOH
@@ -31,7 +31,7 @@ module Inspec::Resources
       describe vbscript(script) do
         its('stdout') { should eq 'output' }
       end
-    "
+    EXAMPLE
 
     def initialize(vbscript)
       @seperator = SecureRandom.uuid