inspec 4.3.2 → 4.6.3

data/lib/resources/aws/aws_sns_topic.rb

@@ -1,13 +1,17 @@
+require "resource_support/aws/aws_singular_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-sns"
+
 class AwsSnsTopic < Inspec.resource(1)
-  name 'aws_sns_topic'
-  desc 'Verifies settings for an SNS Topic'
+  name "aws_sns_topic"
+  desc "Verifies settings for an SNS Topic"
   example <<~EXAMPLE
     describe aws_sns_topic('arn:aws:sns:us-east-1:123456789012:some-topic') do
       it { should exist }
       its('confirmed_subscription_count') { should_not be_zero }
     end
   EXAMPLE
-  supports platform: 'aws'
+  supports platform: "aws"
 
   include AwsSingularResourceMixin
   attr_reader :arn, :confirmed_subscription_count
@@ -19,11 +23,11 @@ class AwsSnsTopic < Inspec.resource(1)
       raw_params: raw_params,
       allowed_params: [:arn],
       allowed_scalar_name: :arn,
-      allowed_scalar_type: String,
+      allowed_scalar_type: String
     )
     # Validate the ARN
     unless validated_params[:arn] =~ /^arn:aws:sns:[\w\-]+:\d{12}:[\S]+$/
-      raise ArgumentError, 'Malformed ARN for SNS topics.  Expected an ARN of the form ' \
+      raise ArgumentError, "Malformed ARN for SNS topics.  Expected an ARN of the form " \
                            "'arn:aws:sns:REGION:ACCOUNT-ID:TOPIC-NAME'"
     end
     validated_params
@@ -34,7 +38,7 @@ class AwsSnsTopic < Inspec.resource(1)
     @exists = true
 
     # The response has a plain hash with CamelCase plain string keys and string values
-    @confirmed_subscription_count = aws_response['SubscriptionsConfirmed'].to_i
+    @confirmed_subscription_count = aws_response["SubscriptionsConfirmed"].to_i
   rescue Aws::SNS::Errors::NotFound
     @exists = false
   end

data/lib/resources/aws/aws_sns_topics.rb

@@ -1,18 +1,22 @@
+require "resource_support/aws/aws_plural_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-sns"
+
 class AwsSnsTopics < Inspec.resource(1)
-  name 'aws_sns_topics'
-  desc 'Verifies settings for SNS Topics in bulk'
+  name "aws_sns_topics"
+  desc "Verifies settings for SNS Topics in bulk"
   example <<~EXAMPLE
     describe aws_sns_topics do
       its('topic_arns') { should include '' }
     end
   EXAMPLE
-  supports platform: 'aws'
+  supports platform: "aws"
 
   include AwsPluralResourceMixin
 
   def validate_params(resource_params)
     unless resource_params.empty?
-      raise ArgumentError, 'aws_sns_topics does not accept resource parameters.'
+      raise ArgumentError, "aws_sns_topics does not accept resource parameters."
     end
     resource_params
   end
@@ -38,7 +42,7 @@ class AwsSnsTopics < Inspec.resource(1)
   filter.install_filter_methods_on_resource(self, :table)
 
   def to_s
-    'EC2 SNS Topics'
+    "EC2 SNS Topics"
   end
 
   class Backend

data/lib/resources/aws/aws_sqs_queue.rb

@@ -1,15 +1,19 @@
-require 'uri'
+require "resource_support/aws/aws_singular_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-sqs"
+
+require "uri"
 
 class AwsSqsQueue < Inspec.resource(1)
-  name 'aws_sqs_queue'
-  desc 'Verifies settings for an SQS Queue'
+  name "aws_sqs_queue"
+  desc "Verifies settings for an SQS Queue"
   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'
+  supports platform: "aws"
 
   include AwsSingularResourceMixin
   attr_reader :arn, :is_fifo_queue, :visibility_timeout, :maximum_message_size, :message_retention_period, :delay_seconds, :receive_message_wait_timeout_seconds, :content_based_deduplication
@@ -21,29 +25,29 @@ class AwsSqsQueue < Inspec.resource(1)
       raw_params: raw_params,
       allowed_params: [:url],
       allowed_scalar_name: :url,
-      allowed_scalar_type: String,
+      allowed_scalar_type: String
     )
     # Validate the URL
     unless validated_params[:url] =~ /\A#{URI::DEFAULT_PARSER.make_regexp(%w{https})}\z/
-      raise ArgumentError, 'Malformed URL for SQS.  Expected an ARN of the form ' \
+      raise ArgumentError, "Malformed URL for SQS.  Expected an ARN of the form " \
                            "'https://sqs.ap-southeast-2.amazonaws.com/111212121/MyQeueue'"
     end
     validated_params
   end
 
   def fetch_from_api
-    aws_response = BackendFactory.create(inspec_runner).get_queue_attributes(queue_url: @url, attribute_names: ['All']).attributes
+    aws_response = BackendFactory.create(inspec_runner).get_queue_attributes(queue_url: @url, attribute_names: ["All"]).attributes
     @exists = true
-    @visibility_timeout = aws_response['VisibilityTimeout'].to_i
-    @maximum_message_size = aws_response['MaximumMessageSize'].to_i
-    @message_retention_period = aws_response['MessageRetentionPeriod'].to_i
-    @delay_seconds = aws_response['DelaySeconds'].to_i
-    @receive_message_wait_timeout_seconds = aws_response['ReceiveMessageWaitTimeSeconds'].to_i
+    @visibility_timeout = aws_response["VisibilityTimeout"].to_i
+    @maximum_message_size = aws_response["MaximumMessageSize"].to_i
+    @message_retention_period = aws_response["MessageRetentionPeriod"].to_i
+    @delay_seconds = aws_response["DelaySeconds"].to_i
+    @receive_message_wait_timeout_seconds = aws_response["ReceiveMessageWaitTimeSeconds"].to_i
 
     # FIFO queues - these attributes only exist for FIFO queues, their presence indicates a FIFO
     # queue
-    @is_fifo_queue = aws_response['FifoQueue'].nil? ? false: true
-    @content_based_deduplication = aws_response['ContentBasedDeduplication'].nil? ? false: true
+    @is_fifo_queue = aws_response["FifoQueue"].nil? ? false : true
+    @content_based_deduplication = aws_response["ContentBasedDeduplication"].nil? ? false : true
   rescue Aws::SQS::Errors::NonExistentQueue
     @exists = false
   end

data/lib/resources/aws/aws_subnet.rb

@@ -1,13 +1,17 @@
+require "resource_support/aws/aws_singular_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-ec2"
+
 class AwsSubnet < Inspec.resource(1)
-  name 'aws_subnet'
-  desc 'This resource is used to test the attributes of a VPC subnet'
+  name "aws_subnet"
+  desc "This resource is used to test the attributes of a VPC subnet"
   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'
+  supports platform: "aws"
 
   include AwsSingularResourceMixin
   attr_reader :assigning_ipv_6_address_on_creation, :availability_zone, :available_ip_address_count,
@@ -29,7 +33,7 @@ class AwsSubnet < Inspec.resource(1)
       raw_params: raw_params,
       allowed_params: [:subnet_id],
       allowed_scalar_name: :subnet_id,
-      allowed_scalar_type: String,
+      allowed_scalar_type: String
     )
 
     # Make sure the subnet_id parameter was specified and in the correct form.
@@ -38,7 +42,7 @@ class AwsSubnet < Inspec.resource(1)
     end
 
     if validated_params.empty?
-      raise ArgumentError, 'You must provide a subnet_id to aws_subnet.'
+      raise ArgumentError, "You must provide a subnet_id to aws_subnet."
     end
 
     validated_params
@@ -49,7 +53,7 @@ class AwsSubnet < Inspec.resource(1)
 
     # Transform into filter format expected by AWS
     filters = []
-    filters.push({ name: 'subnet-id', values: [@subnet_id] })
+    filters.push({ name: "subnet-id", values: [@subnet_id] })
     ds_response = backend.describe_subnets(filters: filters)
 
     # If no subnets exist in the VPC, exist is false.
@@ -69,7 +73,7 @@ class AwsSubnet < Inspec.resource(1)
     @available_ip_address_count          = ds_response.subnets[0].available_ip_address_count
     @default_for_az                      = ds_response.subnets[0].default_for_az
     @mapping_public_ip_on_launch         = ds_response.subnets[0].map_public_ip_on_launch
-    @available                           = ds_response.subnets[0].state == 'available'
+    @available                           = ds_response.subnets[0].state == "available"
     @ipv_6_cidr_block_association_set    = ds_response.subnets[0].ipv_6_cidr_block_association_set
     @assigning_ipv_6_address_on_creation = ds_response.subnets[0].assign_ipv_6_address_on_creation
   end

data/lib/resources/aws/aws_subnets.rb

@@ -1,6 +1,10 @@
+require "resource_support/aws/aws_plural_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-ec2"
+
 class AwsSubnets < Inspec.resource(1)
-  name 'aws_subnets'
-  desc 'Verifies settings for VPC Subnets in bulk'
+  name "aws_subnets"
+  desc "Verifies settings for VPC Subnets in bulk"
   example <<~EXAMPLE
     # you should be able to test the cidr_block of a subnet
     describe aws_subnets.where(vpc_id: 'vpc-123456789') do
@@ -9,13 +13,13 @@ class AwsSubnets < Inspec.resource(1)
       its('states') { should_not include 'pending' }
     end
   EXAMPLE
-  supports platform: 'aws'
+  supports platform: "aws"
 
   include AwsPluralResourceMixin
 
   def validate_params(resource_params)
     unless resource_params.empty?
-      raise ArgumentError, 'aws_vpc_subnets does not accept resource parameters.'
+      raise ArgumentError, "aws_vpc_subnets does not accept resource parameters."
     end
     resource_params
   end
@@ -35,7 +39,7 @@ class AwsSubnets < Inspec.resource(1)
   filter.install_filter_methods_on_resource(self, :table)
 
   def to_s
-    'EC2 VPC Subnets'
+    "EC2 VPC Subnets"
   end
 
   class Backend

data/lib/resources/aws/aws_vpc.rb

@@ -1,13 +1,17 @@
+require "resource_support/aws/aws_singular_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-ec2"
+
 class AwsVpc < Inspec.resource(1)
-  name 'aws_vpc'
-  desc 'Verifies settings for AWS VPC'
+  name "aws_vpc"
+  desc "Verifies settings for AWS VPC"
   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'
+  supports platform: "aws"
 
   include AwsSingularResourceMixin
 
@@ -27,7 +31,7 @@ class AwsVpc < Inspec.resource(1)
       raw_params: raw_params,
       allowed_params: [:vpc_id],
       allowed_scalar_name: :vpc_id,
-      allowed_scalar_type: String,
+      allowed_scalar_type: String
     )
 
     if validated_params.key?(:vpc_id) && validated_params[:vpc_id] !~ /^vpc\-([0-9a-f]{8})|(^vpc\-[0-9a-f]{17})$/
@@ -41,9 +45,9 @@ class AwsVpc < Inspec.resource(1)
     backend = BackendFactory.create(inspec_runner)
 
     if @vpc_id.nil?
-      filter = { name: 'isDefault', values: ['true'] }
+      filter = { name: "isDefault", values: ["true"] }
     else
-      filter = { name: 'vpc-id', values: [@vpc_id] }
+      filter = { name: "vpc-id", values: [@vpc_id] }
     end
 
     resp = backend.describe_vpcs({ filters: [filter] })

data/lib/resources/aws/aws_vpcs.rb

@@ -1,12 +1,16 @@
+require "resource_support/aws/aws_plural_resource_mixin"
+require "resource_support/aws/aws_backend_base"
+require "aws-sdk-ec2"
+
 class AwsVpcs < Inspec.resource(1)
-  name 'aws_vpcs'
-  desc 'Verifies settings for AWS VPCs in bulk'
+  name "aws_vpcs"
+  desc "Verifies settings for AWS VPCs in bulk"
   example <<~EXAMPLE
     describe aws_vpcs do
       it { should exist }
     end
   EXAMPLE
-  supports platform: 'aws'
+  supports platform: "aws"
 
   include AwsPluralResourceMixin
 
@@ -23,13 +27,13 @@ class AwsVpcs < Inspec.resource(1)
   def validate_params(raw_params)
     # No params yet
     unless raw_params.empty?
-      raise ArgumentError, 'aws_vpcs does not accept resource parameters'
+      raise ArgumentError, "aws_vpcs does not accept resource parameters"
     end
     raw_params
   end
 
   def to_s
-    'VPCs'
+    "VPCs"
   end
 
   def fetch_from_api

data/lib/resources/azure/azure_backend.rb

@@ -26,10 +26,10 @@ module Inspec::Resources
 
       # Determine if the environment variables for the options have been set
       option_var_names = {
-        group_name: 'AZURE_RESOURCE_GROUP_NAME',
-        name: 'AZURE_RESOURCE_NAME',
-        type: 'AZURE_RESOURCE_TYPE',
-        apiversion: 'AZURE_RESOURCE_API_VERSION',
+        group_name: "AZURE_RESOURCE_GROUP_NAME",
+        name: "AZURE_RESOURCE_NAME",
+        type: "AZURE_RESOURCE_TYPE",
+        apiversion: "AZURE_RESOURCE_API_VERSION",
       }
       option_var_names.each do |option_name, env_var_name|
         opts[option_name] = ENV[env_var_name] unless ENV[env_var_name].nil?
@@ -153,12 +153,14 @@ module Inspec::Resources
     # @author Russell Seymour
     def create_tag_methods
       # Iterate around the items of the tags and create the necessary access methods
-      tags.item.each do |name, value|
-        method_name = format('%s_tag', name)
-        define_singleton_method method_name do
-          value
+      if defined?(tags.item)
+        tags.item.each do |name, value|
+          method_name = format("%s_tag", name)
+          define_singleton_method method_name do
+            value
+          end
         end
-      end if defined?(tags.item)
+      end
     end
 
     private
@@ -206,11 +208,11 @@ class AzureResourceDynamicMethods
          /^Azure::Resources::Mgmt::.*::Models::ResourceGroup$/
       # iterate around the instance variables
       data.instance_variables.each do |var|
-        create_method(object, var.to_s.delete('@'), data.instance_variable_get(var))
+        create_method(object, var.to_s.delete("@"), data.instance_variable_get(var))
       end
     # When the data is a Hash object iterate around each of the key value pairs and
     # craete a method for each one.
-    when 'Hash'
+    when "Hash"
       data.each do |key, value|
         create_method(object, key, value)
       end
@@ -233,12 +235,12 @@ class AzureResourceDynamicMethods
     # Create the necessary method based on the var that has been passed
     # Test the value for its type so that the method can be setup correctly
     case value.class.to_s
-    when 'String', 'Integer', 'TrueClass', 'FalseClass', 'Fixnum'
+    when "String", "Integer", "TrueClass", "FalseClass", "Fixnum"
       object.define_singleton_method name do
         value
       end
-    when 'Hash'
-      value.count.zero? ? return_value = value : return_value = AzureResourceProbe.new(value)
+    when "Hash"
+      value.count == 0 ? return_value = value : return_value = AzureResourceProbe.new(value)
       object.define_singleton_method name do
         return_value
       end
@@ -247,16 +249,16 @@ class AzureResourceDynamicMethods
       # This is because the plugin is using the Azure SDK to get this information so it is an SDK object
       # that has to be interrogated in a different way. This is the only object type that behaves like this
       value.instance_variables.each do |var|
-        create_method(object, var.to_s.delete('@'), value.instance_variable_get(var))
+        create_method(object, var.to_s.delete("@"), value.instance_variable_get(var))
       end
-    when 'Array'
+    when "Array"
       # Some things are just string or integer arrays
       # Check this by seeing if the first element is a string / integer / boolean or
       # a hashtable
       # This may not be the best methid, but short of testing all elements in the array, this is
       # the quickest test
       case value[0].class.to_s
-      when 'String', 'Integer', 'TrueClass', 'FalseClass', 'Fixnum'
+      when "String", "Integer", "TrueClass", "FalseClass", "Fixnum"
         probes = value
       else
         probes = []
@@ -369,7 +371,7 @@ class AzureResourceProbe
   #
   # @return string
   def camel_case(data)
-    camel_case_data = data.split('_').inject([]) { |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+    camel_case_data = data.split("_").inject([]) { |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
 
     # Ensure that gb (as in gigabytes) is uppercased
     camel_case_data.gsub(/[gb]/, &:upcase)

data/lib/resources/azure/azure_generic_resource.rb

@@ -1,17 +1,15 @@
-# encoding: utf-8
-
-require 'resources/azure/azure_backend'
-require 'utils/filter'
+require "resources/azure/azure_backend"
+require "inspec/utils/filter"
 
 module Inspec::Resources
   class AzureGenericResource < AzureResourceBase
-    name 'azure_generic_resource'
+    name "azure_generic_resource"
 
     desc '
       InSpec Resource to interrogate any Resource type in Azure
     '
 
-    supports platform: 'azure'
+    supports platform: "azure"
 
     attr_accessor :filter, :total, :counts, :name, :type, :location, :probes
 
@@ -34,21 +32,21 @@ module Inspec::Resources
     # Define the filter table so that it can be interrogated
     @filter = FilterTable.create
     @filter.register_filter_method(:contains)
-           .register_column(:type, field: 'type')
-           .register_column(:name, field: 'name')
-           .register_column(:location, field: 'location')
-           .register_column(:properties, field: 'properties')
+           .register_column(:type, field: "type")
+           .register_column(:name, field: "name")
+           .register_column(:location, field: "location")
+           .register_column(:properties, field: "properties")
 
     @filter.install_filter_methods_on_resource(self, :probes)
 
     def parse_resource(resource)
       # return a hash of information
       parsed = {
-        'location' => resource.location,
-        'name' => resource.name,
-        'type' => resource.type,
-        'exist?' => true,
-        'properties' => AzureResourceProbe.new(resource.properties),
+        "location" => resource.location,
+        "name" => resource.name,
+        "type" => resource.type,
+        "exist?" => true,
+        "properties" => AzureResourceProbe.new(resource.properties),
       }
 
       parsed