inspec 2.1.81 → 2.1.83

data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb

@@ -1,100 +1,100 @@
-class AwsCloudwatchLogMetricFilter < Inspec.resource(1)
-  name 'aws_cloudwatch_log_metric_filter'
-  desc 'Verifies individual Cloudwatch Log Metric Filters'
-  example <<-EOX
-  # Look for a LMF by its filter name and log group name.  This combination
-  # will always either find at most one LMF - no duplicates.
-  describe aws_cloudwatch_log_metric_filter(
-    filter_name: 'my-filter',
-    log_group_name: 'my-log-group'
-  ) do
-    it { should exist }
-  end
-
-  # Search for an LMF by pattern and log group.
-  # This could result in an error if the results are not unique.
-  describe aws_cloudwatch_log_metric_filter(
-    log_group_name:  'my-log-group',
-    pattern: 'my-filter'
-  ) do
-    it { should exist }
-  end
-EOX
-  supports platform: 'aws'
-  include AwsSingularResourceMixin
-  attr_reader :filter_name, :log_group_name, :metric_name, :metric_namespace, :pattern
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:filter_name, :log_group_name, :pattern],
-    )
-    if validated_params.empty?
-      raise ArgumentError, 'You must provide either filter_name, log_group, or pattern to aws_cloudwatch_log_metric_filter.'
-    end
-    validated_params
-  end
-
-  def fetch_from_api
-    # get a backend
-    backend = BackendFactory.create(inspec_runner)
-
-    # Perform query with remote filtering
-    aws_search_criteria = {}
-    aws_search_criteria[:filter_name] = filter_name if filter_name
-    aws_search_criteria[:log_group_name] = log_group_name if log_group_name
-    begin
-      aws_results = backend.describe_metric_filters(aws_search_criteria)
-    rescue Aws::CloudWatchLogs::Errors::ResourceNotFoundException
-      @exists = false
-      return
-    end
-
-    # Then perform local filtering
-    if pattern
-      aws_results.select! { |lmf| lmf.filter_pattern == pattern }
-    end
-
-    # Check result count.  We're a singular resource and can tolerate
-    # 0 or 1 results, not multiple.
-    if aws_results.count > 1
-      raise 'More than one result was returned, but aws_cloudwatch_log_metric_filter '\
-            'can only handle a single AWS resource.  Consider passing more resource '\
-            'parameters to narrow down the search.'
-    elsif aws_results.empty?
-      @exists = false
-    else
-      @exists = true
-      # Unpack the funny-shaped object we got back from AWS into our instance vars
-      lmf = aws_results.first
-      @filter_name = lmf.filter_name
-      @log_group_name = lmf.log_group_name
-      @pattern = lmf.filter_pattern # Note inconsistent name
-      # AWS SDK returns an array of metric transformations
-      # but only allows one (mandatory) entry, let's flatten that
-      @metric_name = lmf.metric_transformations.first.metric_name
-      @metric_namespace = lmf.metric_transformations.first.metric_namespace
-    end
-  end
-
-  class Backend
-    # Uses the cloudwatch API to really talk to AWS
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::CloudWatchLogs::Client
-
-      def describe_metric_filters(criteria)
-        query = {}
-        query[:filter_name_prefix] = criteria[:filter_name] if criteria[:filter_name]
-        query[:log_group_name] = criteria[:log_group_name] if criteria[:log_group_name]
-        # 'pattern' is not available as a remote filter,
-        # we filter it after the fact locally
-        # TODO: handle pagination?  Max 50/page.  Maybe you want a plural resource?
-        aws_response = aws_service_client.describe_metric_filters(query)
-        aws_response.metric_filters
-      end
-    end
-  end
-end
+class AwsCloudwatchLogMetricFilter < Inspec.resource(1)
+  name 'aws_cloudwatch_log_metric_filter'
+  desc 'Verifies individual Cloudwatch Log Metric Filters'
+  example <<-EOX
+  # Look for a LMF by its filter name and log group name.  This combination
+  # will always either find at most one LMF - no duplicates.
+  describe aws_cloudwatch_log_metric_filter(
+    filter_name: 'my-filter',
+    log_group_name: 'my-log-group'
+  ) do
+    it { should exist }
+  end
+
+  # Search for an LMF by pattern and log group.
+  # This could result in an error if the results are not unique.
+  describe aws_cloudwatch_log_metric_filter(
+    log_group_name:  'my-log-group',
+    pattern: 'my-filter'
+  ) do
+    it { should exist }
+  end
+EOX
+  supports platform: 'aws'
+  include AwsSingularResourceMixin
+  attr_reader :filter_name, :log_group_name, :metric_name, :metric_namespace, :pattern
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:filter_name, :log_group_name, :pattern],
+    )
+    if validated_params.empty?
+      raise ArgumentError, 'You must provide either filter_name, log_group, or pattern to aws_cloudwatch_log_metric_filter.'
+    end
+    validated_params
+  end
+
+  def fetch_from_api
+    # get a backend
+    backend = BackendFactory.create(inspec_runner)
+
+    # Perform query with remote filtering
+    aws_search_criteria = {}
+    aws_search_criteria[:filter_name] = filter_name if filter_name
+    aws_search_criteria[:log_group_name] = log_group_name if log_group_name
+    begin
+      aws_results = backend.describe_metric_filters(aws_search_criteria)
+    rescue Aws::CloudWatchLogs::Errors::ResourceNotFoundException
+      @exists = false
+      return
+    end
+
+    # Then perform local filtering
+    if pattern
+      aws_results.select! { |lmf| lmf.filter_pattern == pattern }
+    end
+
+    # Check result count.  We're a singular resource and can tolerate
+    # 0 or 1 results, not multiple.
+    if aws_results.count > 1
+      raise 'More than one result was returned, but aws_cloudwatch_log_metric_filter '\
+            'can only handle a single AWS resource.  Consider passing more resource '\
+            'parameters to narrow down the search.'
+    elsif aws_results.empty?
+      @exists = false
+    else
+      @exists = true
+      # Unpack the funny-shaped object we got back from AWS into our instance vars
+      lmf = aws_results.first
+      @filter_name = lmf.filter_name
+      @log_group_name = lmf.log_group_name
+      @pattern = lmf.filter_pattern # Note inconsistent name
+      # AWS SDK returns an array of metric transformations
+      # but only allows one (mandatory) entry, let's flatten that
+      @metric_name = lmf.metric_transformations.first.metric_name
+      @metric_namespace = lmf.metric_transformations.first.metric_namespace
+    end
+  end
+
+  class Backend
+    # Uses the cloudwatch API to really talk to AWS
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::CloudWatchLogs::Client
+
+      def describe_metric_filters(criteria)
+        query = {}
+        query[:filter_name_prefix] = criteria[:filter_name] if criteria[:filter_name]
+        query[:log_group_name] = criteria[:log_group_name] if criteria[:log_group_name]
+        # 'pattern' is not available as a remote filter,
+        # we filter it after the fact locally
+        # TODO: handle pagination?  Max 50/page.  Maybe you want a plural resource?
+        aws_response = aws_service_client.describe_metric_filters(query)
+        aws_response.metric_filters
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_config_delivery_channel.rb

@@ -1,70 +1,70 @@
-class AwsConfigDeliveryChannel < Inspec.resource(1)
-  name 'aws_config_delivery_channel'
-  desc 'Verifies settings for AWS Config Delivery Channel'
-  example "
-    describe aws_config_delivery_channel do
-      it { should exist }
-      its('s3_bucket_name') { should eq 'my_bucket' }
-      its('sns_topic_arn') { should eq arn:aws:sns:us-east-1:721741954427:sns_topic' }
-    end
-  "
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :channel_name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn,
-              :delivery_frequency_in_hours
-
-  def to_s
-    "Config_Delivery_Channel: #{@channel_name}"
-  end
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:channel_name],
-      allowed_scalar_name: :channel_name,
-      allowed_scalar_type: String,
-    )
-
-    validated_params
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-    query = @channel_name ? { delivery_channel_names: [@channel_name] } : {}
-    response = backend.describe_delivery_channels(query)
-
-    @exists = !response.delivery_channels.empty?
-    return unless exists?
-
-    channel = response.delivery_channels.first.to_h
-    @channel_name = channel[:name]
-    @s3_bucket_name = channel[:s3_bucket_name]
-    @s3_key_prefix = channel[:s3_key_prefix]
-    @sns_topic_arn = channel[:sns_topic_arn]
-    @delivery_frequency_in_hours = channel.dig(:config_snapshot_delivery_properties, :delivery_frequency)
-    frequencies = {
-      'One_Hour' => 1,
-      'TwentyFour_Hours' => 24,
-      'Three_Hours' => 3,
-      'Six_Hours' => 6,
-      'Twelve_Hours' => 12,
-    }
-    @delivery_frequency_in_hours = frequencies[@delivery_frequency_in_hours]
-  rescue Aws::ConfigService::Errors::NoSuchDeliveryChannelException
-    @exists = false
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::ConfigService::Client
-
-      def describe_delivery_channels(query = {})
-        aws_service_client.describe_delivery_channels(query)
-      end
-    end
-  end
-end
+class AwsConfigDeliveryChannel < Inspec.resource(1)
+  name 'aws_config_delivery_channel'
+  desc 'Verifies settings for AWS Config Delivery Channel'
+  example "
+    describe aws_config_delivery_channel do
+      it { should exist }
+      its('s3_bucket_name') { should eq 'my_bucket' }
+      its('sns_topic_arn') { should eq arn:aws:sns:us-east-1:721741954427:sns_topic' }
+    end
+  "
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :channel_name, :s3_bucket_name, :s3_key_prefix, :sns_topic_arn,
+              :delivery_frequency_in_hours
+
+  def to_s
+    "Config_Delivery_Channel: #{@channel_name}"
+  end
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:channel_name],
+      allowed_scalar_name: :channel_name,
+      allowed_scalar_type: String,
+    )
+
+    validated_params
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+    query = @channel_name ? { delivery_channel_names: [@channel_name] } : {}
+    response = backend.describe_delivery_channels(query)
+
+    @exists = !response.delivery_channels.empty?
+    return unless exists?
+
+    channel = response.delivery_channels.first.to_h
+    @channel_name = channel[:name]
+    @s3_bucket_name = channel[:s3_bucket_name]
+    @s3_key_prefix = channel[:s3_key_prefix]
+    @sns_topic_arn = channel[:sns_topic_arn]
+    @delivery_frequency_in_hours = channel.dig(:config_snapshot_delivery_properties, :delivery_frequency)
+    frequencies = {
+      'One_Hour' => 1,
+      'TwentyFour_Hours' => 24,
+      'Three_Hours' => 3,
+      'Six_Hours' => 6,
+      'Twelve_Hours' => 12,
+    }
+    @delivery_frequency_in_hours = frequencies[@delivery_frequency_in_hours]
+  rescue Aws::ConfigService::Errors::NoSuchDeliveryChannelException
+    @exists = false
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::ConfigService::Client
+
+      def describe_delivery_channels(query = {})
+        aws_service_client.describe_delivery_channels(query)
+      end
+    end
+  end
+end

data/lib/resources/aws/aws_config_recorder.rb

@@ -1,93 +1,93 @@
-class AwsConfigurationRecorder < Inspec.resource(1)
-  name 'aws_config_recorder'
-  desc 'Verifies settings for AWS Configuration Recorder'
-  example "
-    describe aws_config_recorder('My_Recorder') do
-      it { should exist }
-      it { should be_recording }
-      it { should be_all_supported }
-      it { should have_include_global_resource_types }
-    end
-  "
-  supports platform: 'aws'
-
-  include AwsSingularResourceMixin
-  attr_reader :role_arn, :resource_types, :recorder_name
-
-  def to_s
-    "Configuration_Recorder: #{@recorder_name}"
-  end
-
-  def recording_all_resource_types?
-    @recording_all_resource_types
-  end
-
-  def recording_all_global_types?
-    @recording_all_global_types
-  end
-
-  def status
-    return {} unless @exists
-    backend = BackendFactory.create(inspec_runner)
-    catch_aws_errors do
-      response = backend.describe_configuration_recorder_status(configuration_recorder_names: [@recorder_name])
-      @status = response.configuration_recorders_status.first.to_h
-    end
-  end
-
-  def recording?
-    return unless @exists
-    status[:recording]
-  end
-
-  private
-
-  def validate_params(raw_params)
-    validated_params = check_resource_param_names(
-      raw_params: raw_params,
-      allowed_params: [:recorder_name],
-      allowed_scalar_name: :recorder_name,
-      allowed_scalar_type: String,
-    )
-
-    validated_params
-  end
-
-  def fetch_from_api
-    backend = BackendFactory.create(inspec_runner)
-    query = @recorder_name ? { configuration_recorder_names: [@recorder_name] } : {}
-    response = backend.describe_configuration_recorders(query)
-
-    @exists = !response.configuration_recorders.empty?
-    return unless exists?
-
-    if response.configuration_recorders.count > 1
-      raise ArgumentError, 'Internal error: unexpectedly received multiple AWS Config Recorder objects from API; expected to be singleton per-region.  Please file a bug report at https://github.com/chef/inspec/issues .'
-    end
-
-    recorder = response.configuration_recorders.first.to_h
-    @recorder_name = recorder[:name]
-    @role_arn = recorder[:role_arn]
-    @recording_all_resource_types = recorder[:recording_group][:all_supported]
-    @recording_all_global_types = recorder[:recording_group][:include_global_resource_types]
-    @resource_types = recorder[:recording_group][:resource_types]
-  rescue Aws::ConfigService::Errors::NoSuchConfigurationRecorderException
-    @exists = false
-    return
-  end
-
-  class Backend
-    class AwsClientApi < AwsBackendBase
-      BackendFactory.set_default_backend(self)
-      self.aws_client_class = Aws::ConfigService::Client
-
-      def describe_configuration_recorders(query)
-        aws_service_client.describe_configuration_recorders(query)
-      end
-
-      def describe_configuration_recorder_status(query)
-        aws_service_client.describe_configuration_recorder_status(query)
-      end
-    end
-  end
-end
+class AwsConfigurationRecorder < Inspec.resource(1)
+  name 'aws_config_recorder'
+  desc 'Verifies settings for AWS Configuration Recorder'
+  example "
+    describe aws_config_recorder('My_Recorder') do
+      it { should exist }
+      it { should be_recording }
+      it { should be_all_supported }
+      it { should have_include_global_resource_types }
+    end
+  "
+  supports platform: 'aws'
+
+  include AwsSingularResourceMixin
+  attr_reader :role_arn, :resource_types, :recorder_name
+
+  def to_s
+    "Configuration_Recorder: #{@recorder_name}"
+  end
+
+  def recording_all_resource_types?
+    @recording_all_resource_types
+  end
+
+  def recording_all_global_types?
+    @recording_all_global_types
+  end
+
+  def status
+    return {} unless @exists
+    backend = BackendFactory.create(inspec_runner)
+    catch_aws_errors do
+      response = backend.describe_configuration_recorder_status(configuration_recorder_names: [@recorder_name])
+      @status = response.configuration_recorders_status.first.to_h
+    end
+  end
+
+  def recording?
+    return unless @exists
+    status[:recording]
+  end
+
+  private
+
+  def validate_params(raw_params)
+    validated_params = check_resource_param_names(
+      raw_params: raw_params,
+      allowed_params: [:recorder_name],
+      allowed_scalar_name: :recorder_name,
+      allowed_scalar_type: String,
+    )
+
+    validated_params
+  end
+
+  def fetch_from_api
+    backend = BackendFactory.create(inspec_runner)
+    query = @recorder_name ? { configuration_recorder_names: [@recorder_name] } : {}
+    response = backend.describe_configuration_recorders(query)
+
+    @exists = !response.configuration_recorders.empty?
+    return unless exists?
+
+    if response.configuration_recorders.count > 1
+      raise ArgumentError, 'Internal error: unexpectedly received multiple AWS Config Recorder objects from API; expected to be singleton per-region.  Please file a bug report at https://github.com/chef/inspec/issues .'
+    end
+
+    recorder = response.configuration_recorders.first.to_h
+    @recorder_name = recorder[:name]
+    @role_arn = recorder[:role_arn]
+    @recording_all_resource_types = recorder[:recording_group][:all_supported]
+    @recording_all_global_types = recorder[:recording_group][:include_global_resource_types]
+    @resource_types = recorder[:recording_group][:resource_types]
+  rescue Aws::ConfigService::Errors::NoSuchConfigurationRecorderException
+    @exists = false
+    return
+  end
+
+  class Backend
+    class AwsClientApi < AwsBackendBase
+      BackendFactory.set_default_backend(self)
+      self.aws_client_class = Aws::ConfigService::Client
+
+      def describe_configuration_recorders(query)
+        aws_service_client.describe_configuration_recorders(query)
+      end
+
+      def describe_configuration_recorder_status(query)
+        aws_service_client.describe_configuration_recorder_status(query)
+      end
+    end
+  end
+end