inspec 3.7.1 → 3.7.11

data/lib/resources/aws/aws_sns_topics.rb

@@ -1,11 +1,11 @@
 class AwsSnsTopics < Inspec.resource(1)
   name 'aws_sns_topics'
   desc 'Verifies settings for SNS Topics in bulk'
-  example "
+  example <<~EXAMPLE
     describe aws_sns_topics do
       its('topic_arns') { should include '' }
     end
-  "
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsPluralResourceMixin

data/lib/resources/aws/aws_sqs_queue.rb

@@ -3,12 +3,12 @@ require 'uri'
 class AwsSqsQueue < Inspec.resource(1)
   name 'aws_sqs_queue'
   desc 'Verifies settings for an SQS Queue'
-  example "
+  example <<~EXAMPLE
     describe aws_sqs_queue('https://sqs.ap-southeast-2.amazonaws.com/519527725796/QueueName') do
       it { should exist }
       its('visiblity_timeout') { should be 300}
     end
-  "
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsSingularResourceMixin

data/lib/resources/aws/aws_subnet.rb

@@ -1,12 +1,12 @@
 class AwsSubnet < Inspec.resource(1)
   name 'aws_subnet'
   desc 'This resource is used to test the attributes of a VPC subnet'
-  example "
+  example <<~EXAMPLE
     describe aws_subnet(subnet_id: 'subnet-12345678') do
       it { should exist }
       its('cidr_block') { should eq '10.0.1.0/24' }
     end
-  "
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsSingularResourceMixin

data/lib/resources/aws/aws_subnets.rb

@@ -1,14 +1,14 @@
 class AwsSubnets < Inspec.resource(1)
   name 'aws_subnets'
   desc 'Verifies settings for VPC Subnets in bulk'
-  example "
+  example <<~EXAMPLE
     # you should be able to test the cidr_block of a subnet
     describe aws_subnets.where(vpc_id: 'vpc-123456789') do
       its('subnet_ids') { should eq ['subnet-12345678', 'subnet-87654321'] }
       its('cidr_blocks') { should eq ['172.31.96.0/20'] }
       its('states') { should_not include 'pending' }
     end
-  "
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsPluralResourceMixin

data/lib/resources/aws/aws_vpc.rb

@@ -1,12 +1,12 @@
 class AwsVpc < Inspec.resource(1)
   name 'aws_vpc'
   desc 'Verifies settings for AWS VPC'
-  example "
+  example <<~EXAMPLE
     describe aws_vpc do
       it { should be_default }
       its('cidr_block') { should cmp '10.0.0.0/16' }
     end
-  "
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsSingularResourceMixin

data/lib/resources/aws/aws_vpcs.rb

@@ -1,11 +1,11 @@
 class AwsVpcs < Inspec.resource(1)
   name 'aws_vpcs'
   desc 'Verifies settings for AWS VPCs in bulk'
-  example '
+  example <<~EXAMPLE
     describe aws_vpcs do
       it { should exist }
     end
-  '
+  EXAMPLE
   supports platform: 'aws'
 
   include AwsPluralResourceMixin

data/lib/resources/bash.rb

@@ -8,7 +8,7 @@ module Inspec::Resources
     name 'bash'
     supports platform: 'unix'
     desc 'Run a command or script in BASH.'
-    example "
+    example <<~EXAMPLE
       describe bash('ls -al /') do
         its('stdout') { should match /bin/ }
         its('stderr') { should eq '' }
@@ -20,7 +20,7 @@ module Inspec::Resources
 
       # Specify arguments (defaults to -c)
       bash('...', args: '-x -c')
-    "
+    EXAMPLE
 
     def initialize(command, options = {})
       @raw_command = command

data/lib/resources/bond.rb

@@ -8,11 +8,11 @@ module Inspec::Resources
     name 'bond'
     supports platform: 'unix'
     desc 'Use the bond InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the /proc/net/bonding directory may be tested.'
-    example "
+    example <<~EXAMPLE
       describe bond('bond0') do
         it { should exist }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/bridge.rb

@@ -11,12 +11,12 @@ module Inspec::Resources
     name 'bridge'
     supports platform: 'unix'
     desc 'Use the bridge InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.'
-    example "
+    example <<~EXAMPLE
       describe bridge 'br0' do
         it { should exist }
         it { should have_interface 'eth0' }
       end
-    "
+    EXAMPLE
 
     def initialize(bridge_name)
       @bridge_name = bridge_name

data/lib/resources/chocolatey_package.rb

@@ -7,12 +7,12 @@ module Inspec::Resources
     name 'chocolatey_package'
     supports platform: 'windows'
     desc 'Use the chocolatey_package InSpec audit resource to test if the named package and/or package version is installed on the system.'
-    example <<-EOH
+    example <<~EXAMPLE
       describe chocolatey_package('git') do
         it { should be_installed }
         its('version') { should eq '2.15.1' }
       end
-    EOH
+    EXAMPLE
 
     attr_reader :package_name
 

data/lib/resources/command.rb

@@ -7,7 +7,7 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the command InSpec audit resource to test an arbitrary command that is run on the system.'
-    example "
+    example <<~EXAMPLE
       describe command('ls -al /') do
         its('stdout') { should match /bin/ }
         its('stderr') { should eq '' }
@@ -18,7 +18,7 @@ module Inspec::Resources
       describe command('ls') do
         it { should exist }
       end
-    "
+    EXAMPLE
 
     attr_reader :command
 

data/lib/resources/cpan.rb

@@ -11,11 +11,11 @@ module Inspec::Resources
     name 'cpan'
     supports platform: 'unix'
     desc 'Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.'
-    example "
+    example <<~EXAMPLE
       describe cpan('DBD::Pg') do
         it { should be_installed }
       end
-    "
+    EXAMPLE
 
     def initialize(package_name, perl_lib_path = nil)
       @package_name = package_name

data/lib/resources/cran.rb

@@ -11,11 +11,11 @@ module Inspec::Resources
     name 'cran'
     supports platform: 'unix'
     desc 'Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.'
-    example "
+    example <<~EXAMPLE
       describe cran('DBI') do
         it { should be_installed }
       end
-    "
+    EXAMPLE
 
     def initialize(package_name)
       @package_name = package_name

data/lib/resources/crontab.rb

@@ -8,7 +8,7 @@ module Inspec::Resources
     name 'crontab'
     supports platform: 'unix'
     desc 'Use the crontab InSpec audit resource to test the contents of the crontab for a given user which contains information about scheduled tasks owned by that user.'
-    example "
+    example <<~EXAMPLE
       describe crontab(user: 'root') do
         its('commands') { should include '/path/to/some/script' }
       end
@@ -29,7 +29,7 @@ module Inspec::Resources
       describe crontab(path: '/etc/cron.d/some_crontab') do
         its('commands') { should include '/path/to/some/script' }
       end
-    "
+    EXAMPLE
 
     attr_reader :params
 

data/lib/resources/csv.rb

@@ -7,11 +7,11 @@ module Inspec::Resources
   class CsvConfig < JsonConfig
     name 'csv'
     desc 'Use the csv InSpec audit resource to test configuration data in a CSV file.'
-    example "
+    example <<~EXAMPLE
       describe csv('example.csv') do
         its('name') { should eq(['John', 'Alice']) }
       end
-    "
+    EXAMPLE
 
     # override the parse method from JsonConfig
     # Assuming a header row of name,col1,col2, it will output an array of hashes like so:

data/lib/resources/dh_params.rb

@@ -11,7 +11,7 @@ class DhParams < Inspec.resource(1)
     parameters.
   '
 
-  example "
+  example <<~EXAMPLE
     describe dh_params('/path/to/file.dh_pem') do
       it { should be_dh_params }
       it { should be_valid }
@@ -21,7 +21,7 @@ class DhParams < Inspec.resource(1)
       its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
       its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
     end
-  "
+  EXAMPLE
 
   include FileReader
 

data/lib/resources/directory.rb

@@ -8,11 +8,11 @@ module Inspec::Resources
     supports platform: 'unix'
     supports platform: 'windows'
     desc 'Use the directory InSpec audit resource to test if the file type is a directory. This is equivalent to using the file InSpec audit resource and the be_directory matcher, but provides a simpler and more direct way to test directories. All of the matchers available to file may be used with directory.'
-    example "
+    example <<~EXAMPLE
       describe directory('path') do
         it { should be_directory }
       end
-    "
+    EXAMPLE
 
     def exist?
       file.exist? && file.directory?

data/lib/resources/docker.rb

@@ -94,7 +94,7 @@ module Inspec::Resources
       A resource to retrieve information about docker
     "
 
-    example "
+    example <<~EXAMPLE
       describe docker.containers do
         its('images') { should_not include 'u12:latest' }
       end
@@ -127,7 +127,7 @@ module Inspec::Resources
           its(%w(HostConfig Privileged)) { should_not cmp true }
         end
       end
-    "
+    EXAMPLE
 
     def containers
       DockerContainerFilter.new(parse_containers)

data/lib/resources/docker_container.rb

@@ -11,7 +11,7 @@ module Inspec::Resources
     name 'docker_container'
     supports platform: 'unix'
     desc ''
-    example "
+    example <<~EXAMPLE
       describe docker_container('an-echo-server') do
         it { should exist }
         it { should be_running }
@@ -28,7 +28,7 @@ module Inspec::Resources
         it { should exist }
         it { should be_running }
       end
-    "
+    EXAMPLE
 
     def initialize(opts = {})
       # if a string is provided, we expect it is the name

data/lib/resources/docker_image.rb

@@ -11,7 +11,7 @@ module Inspec::Resources
     name 'docker_image'
     supports platform: 'unix'
     desc ''
-    example "
+    example <<~EXAMPLE
       describe docker_image('alpine:latest') do
         it { should exist }
         its('id') { should_not eq '' }
@@ -27,7 +27,7 @@ module Inspec::Resources
       describe docker_image(id: '4a415e366388') do
         it { should exist }
       end
-    "
+    EXAMPLE
 
     def initialize(opts = {})
       # do sanitizion of input values

data/lib/resources/docker_plugin.rb

@@ -5,7 +5,7 @@ module Inspec::Resources
     name 'docker_plugin'
     supports platform: 'unix'
     desc 'Retrieves info about docker plugins'
-    example "
+    example <<~EXAMPLE
       describe docker_plugin('rexray/ebs') do
         it { should exist }
         its('id') { should_not eq '0ac30b93ad40' }
@@ -20,7 +20,7 @@ module Inspec::Resources
       describe docker_plugin(id: '4a415e366388') do
         it { should exist }
       end
-    "
+    EXAMPLE
 
     def initialize(opts = {})
       # do sanitizion of input values

data/lib/resources/docker_service.rb

@@ -11,7 +11,7 @@ module Inspec::Resources
     name 'docker_service'
     supports platform: 'unix'
     desc 'Swarm-mode service'
-    example "
+    example <<~EXAMPLE
       describe docker_service('service1') do
         it { should exist }
         its('id') { should_not eq '' }
@@ -27,7 +27,7 @@ module Inspec::Resources
       describe docker_service(image: 'alpine:latest') do
         it { should exist }
       end
-    "
+    EXAMPLE
 
     def initialize(opts = {})
       # do sanitizion of input values

data/lib/resources/elasticsearch.rb

@@ -11,7 +11,7 @@ module Inspec::Resources
     desc "Use the Elasticsearch InSpec audit resource to test the status of nodes in
       an Elasticsearch cluster."
 
-    example "
+    example <<~EXAMPLE
       describe elasticsearch('http://eshost.mycompany.biz:9200/', username: 'elastic', password: 'changeme', ssl_verify: false) do
         its('node_count') { should >= 3 }
       end
@@ -21,7 +21,7 @@ module Inspec::Resources
         its('os') { should_not include 'MacOS' }
         its('version') { should cmp > 1.2.0 }
       end
-    "
+    EXAMPLE
 
     filter = FilterTable.create
     filter.register_custom_matcher(:exists?) { |x| !x.entries.empty? }

data/lib/resources/etc_fstab.rb

@@ -9,7 +9,7 @@ module Inspec::Resources
     name 'etc_fstab'
     supports platform: 'unix'
     desc 'Use the etc_fstab InSpec audit resource to check the configuration of the etc/fstab file.'
-    example "
+    example <<~EXAMPLE
       nfs_systems = etc_fstab.nfs_file_systems.entries
       nfs_systems.each do |file_system|
         describe file_system do
@@ -22,7 +22,7 @@ module Inspec::Resources
       describe etc_fstab do
         its ('home_mount_options') { should include 'nosuid' }
       end
-    "
+    EXAMPLE
 
     attr_reader :params
 

data/lib/resources/etc_group.rb

@@ -30,13 +30,13 @@ module Inspec::Resources
     name 'etc_group'
     supports platform: 'unix'
     desc 'Use the etc_group InSpec audit resource to test groups that are defined on Linux and UNIX platforms. The /etc/group file stores details about each group---group name, password, group identifier, along with a comma-separate list of users that belong to the group.'
-    example "
+    example <<~EXAMPLE
       describe etc_group do
         its('gids') { should_not contain_duplicates }
         its('groups') { should include 'my_user' }
         its('users') { should include 'my_user' }
       end
-    "
+    EXAMPLE
 
     include FileReader
 

data/lib/resources/etc_hosts.rb

@@ -10,13 +10,13 @@ class EtcHosts < Inspec.resource(1)
   supports platform: 'windows'
   desc 'Use the etc_hosts InSpec audit resource to find an
     ip_address and its associated hosts'
-  example "
+  example <<~EXAMPLE
     describe etc_hosts.where { ip_address == '127.0.0.1' } do
       its('ip_address') { should cmp '127.0.0.1' }
       its('primary_name') { should cmp 'localhost' }
       its('all_host_names') { should eq [['localhost', 'localhost.localdomain', 'localhost4', 'localhost4.localdomain4']] }
     end
-  "
+  EXAMPLE
 
   attr_reader :params
 

data/lib/resources/etc_hosts_allow_deny.rb

@@ -9,12 +9,12 @@ module Inspec::Resources
     supports platform: 'unix'
     desc 'Use the etc_hosts_allow InSpec audit resource to test the connections
           the client will allow. Controlled by the /etc/hosts.allow file.'
-    example "
+    example <<~EXAMPLE
       describe etc_hosts_allow.where { daemon == 'ALL' } do
         its('client_list') { should include ['127.0.0.1', '[::1]'] }
         its('options') { should eq [[]] }
       end
-    "
+    EXAMPLE
 
     attr_reader :params
 
@@ -91,12 +91,12 @@ module Inspec::Resources
     supports platform: 'unix'
     desc 'Use the etc_hosts_deny InSpec audit resource to test the connections
           the client will deny. Controlled by the /etc/hosts.deny file.'
-    example "
+    example <<~EXAMPLE
       describe etc_hosts_deny.where { daemon_list == 'ALL' } do
         its('client_list') { should eq [['127.0.0.1', '[::1]']] }
         its('options') { should eq [] }
       end
-    "
+    EXAMPLE
 
     def initialize(path = nil)
       return skip_resource '`etc_hosts_deny` is not supported on your OS' unless inspec.os.linux?