awspec 1.24.3 → 1.25.2

data/lib/awspec/helper/client_wrap.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 require 'awspec/config'
 
 module Awspec::Helper
   class ClientWrap
     attr_reader :client, :backoff, :iteration, :backoff_limit, :symbol1, :symbol2
+
     def initialize(real_client = nil)
       raise ArgumentError, 'Client can not be nil' if real_client.nil?
+
       config = Awspec::Config.instance
       @client        = real_client
       @backoff       = config[:client_backoff]
@@ -34,7 +38,7 @@ module Awspec::Helper
         @backoff = backoff + (iteration * iteration * 0.5)
         @iteration += 1
         sleep backoff
-        results = self.send(m, *args, &block)
+        results = send(m, *args, &block)
       end
 
       reset_backoff

data/lib/awspec/helper/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'term/ansicolor'
 
 class Color

data/lib/awspec/helper/finder/account_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module AccountAttributes
@@ -12,11 +14,11 @@ module Awspec::Helper
             attributes[attr[:attribute_name].tr('-', '_').to_sym] = values
           else
             value = values.first
-            if value =~ /\A\d+\z/
-              attributes[attr[:attribute_name].tr('-', '_').to_sym] = value.to_i
-            else
-              attributes[attr[:attribute_name].tr('-', '_').to_sym] = value
-            end
+            attributes[attr[:attribute_name].tr('-', '_').to_sym] = if value =~ /\A\d+\z/
+                                                                      value.to_i
+                                                                    else
+                                                                      value
+                                                                    end
           end
         end
         attributes.to_struct
@@ -52,7 +54,7 @@ module Awspec::Helper
 
       def find_ses_send_quota
         ses_client.get_send_quota
-      rescue
+      rescue StandardError
         # Aws::Errors::NoSuchEndpointError
         nil
       end

data/lib/awspec/helper/finder/acm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Acm
@@ -10,6 +12,7 @@ module Awspec::Helper
             c.certificate_arn == id || c.domain_name == id
           end
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
 
@@ -26,6 +29,7 @@ module Awspec::Helper
             certs << c.certificate_arn
           end
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
 

data/lib/awspec/helper/finder/alb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Alb
@@ -7,7 +9,7 @@ module Awspec::Helper
           lb.type == 'application'
         end.single_resource(id)
       rescue Aws::ElasticLoadBalancingV2::Errors::LoadBalancerNotFound
-        return nil
+        nil
       end
 
       def select_alb_by_vpc_id(vpc_id)
@@ -21,7 +23,7 @@ module Awspec::Helper
         res = elbv2_client.describe_listeners({ listener_arns: [arn] })
         res.listeners.single_resource(arn)
       rescue StandardError
-        return nil
+        nil
       end
 
       def select_alb_listener_by_alb_arn(arn)
@@ -38,10 +40,10 @@ module Awspec::Helper
       def find_alb_target_group(id)
         res = elbv2_client.describe_target_groups({ names: [id] })
         res.target_groups.select do |tg|
-          %w(HTTP HTTPS).include?(tg.protocol)
+          %w[HTTP HTTPS].include?(tg.protocol)
         end.single_resource(id)
       rescue StandardError
-        return nil
+        nil
       end
 
       def select_rule_by_alb_listener_id(id)
@@ -61,7 +63,7 @@ module Awspec::Helper
           resource.resource_arn == id
         end.first.tags
       rescue StandardError
-        return nil
+        nil
       end
     end
   end

data/lib/awspec/helper/finder/ami.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Ami
@@ -7,11 +9,13 @@ module Awspec::Helper
                                          })
         resource = res.images.single_resource(image_id)
         return resource if resource
+
         res = ec2_client.describe_images({
                                            filters: [{ name: 'name', values: [image_id] }]
                                          })
         resource = res.images.single_resource(image_id)
         return resource if resource
+
         res = ec2_client.describe_images({
                                            filters: [{ name: 'tag:Name', values: [image_id] }]
                                          })

data/lib/awspec/helper/finder/apigateway.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Apigateway

data/lib/awspec/helper/finder/autoscaling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Autoscaling
@@ -51,6 +53,7 @@ module Awspec::Helper
             end
           end
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
         selected

data/lib/awspec/helper/finder/batch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Batch

data/lib/awspec/helper/finder/cloudformation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Cloudformation

data/lib/awspec/helper/finder/cloudfront.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Cloudfront
@@ -9,6 +11,7 @@ module Awspec::Helper
             item.id == id || item.domain_name == id
           end
           break unless res.distribution_list.is_truncated
+
           res = cloudfront_client.list_distributions({
                                                        marker: res.distribution_list.next_marker
                                                      })

data/lib/awspec/helper/finder/cloudtrail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Cloudtrail

data/lib/awspec/helper/finder/cloudwatch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Cloudwatch
@@ -21,6 +23,7 @@ module Awspec::Helper
         loop do
           selected += res.metric_alarms
           break if res.next_token.nil?
+
           res = cloudwatch_client.describe_alarms({
                                                     next_token: res.next_token
                                                   })

data/lib/awspec/helper/finder/cloudwatch_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module CloudwatchEvent

data/lib/awspec/helper/finder/cloudwatch_logs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module CloudwatchLogs
@@ -29,6 +31,7 @@ module Awspec::Helper
           end
           break if ret.present?
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
         ret
@@ -59,6 +62,7 @@ module Awspec::Helper
           res = cloudwatch_logs_client.describe_log_groups(req)
           log_groups.push(*res.log_groups)
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
         log_groups
@@ -68,21 +72,22 @@ module Awspec::Helper
         cloudwatch_logs_client.list_tags_log_group(log_group_name: id)[:tags]
       end
 
-      filter_types = %w(metric subscription)
+      filter_types = %w[metric subscription]
       filter_types.each do |type|
-        define_method 'select_all_cloudwatch_logs_' + type + '_filter' do |*args|
+        define_method "select_all_cloudwatch_logs_#{type}_filter" do |*args|
           req = { log_group_name: args.first }
-          method_name = 'describe_' + type + '_filters'
+          method_name = "describe_#{type}_filters"
           resources = []
           loop do
             res = cloudwatch_logs_client.send(method_name, req)
             case type
-            when 'metric' then
+            when 'metric'
               resources.push(*res.metric_filters)
-            when 'subscription' then
+            when 'subscription'
               resources.push(*res.subscription_filters)
             end
             break if res.next_token.nil?
+
             req[:next_token] = res.next_token
           end
           resources

data/lib/awspec/helper/finder/codebuild.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Codebuild
@@ -15,6 +17,7 @@ module Awspec::Helper
           res = codebuild_client.list_projects(req)
           projects.push(*res.projects)
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
         projects

data/lib/awspec/helper/finder/codedeploy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Codedeploy

data/lib/awspec/helper/finder/cognito_identity_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module CognitoIdentityPool

data/lib/awspec/helper/finder/cognito_user_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module CognitoUserPool

data/lib/awspec/helper/finder/directconnect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Directconnect

data/lib/awspec/helper/finder/dynamodb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Dynamodb

data/lib/awspec/helper/finder/ebs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Ebs
@@ -7,6 +9,7 @@ module Awspec::Helper
                                           })
         resource = res.volumes.single_resource(volume_id)
         return resource if resource
+
         res = ec2_client.describe_volumes({
                                             filters: [{ name: 'tag:Name', values: [volume_id] }]
                                           })
@@ -17,6 +20,7 @@ module Awspec::Helper
         res = find_ec2(id)
         volumes = []
         return volumes unless res
+
         res.block_device_mappings.each do |block|
           volume = find_ebs(block.ebs.volume_id)
           volumes.push(volume) if volume
@@ -31,6 +35,7 @@ module Awspec::Helper
         loop do
           selected += res.volumes.select { |v| v.attachments.count > 0 }
           break if res.next_token.nil?
+
           res = ec2_client.describe_volumes({
                                               next_token: res.next_token
                                             })

data/lib/awspec/helper/finder/ec2.rb

@@ -1,26 +1,53 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Ec2
       def find_ec2(id)
         # instance_id or tag:Name
-        begin
-          res = ec2_client.describe_instances({
-                                                instance_ids: [id]
-                                              })
-        rescue Aws::EC2::Errors::InvalidInstanceIDNotFound, Aws::EC2::Errors::InvalidInstanceIDMalformed => e
-          res = ec2_client.describe_instances({
-                                                filters: [{ name: 'tag:Name', values: [id] }]
-                                              })
-        end
-        # rubocop:enable Style/GuardClause
-
-        if res.reservations.count == 0
-          nil
-        elsif res.reservations.count == 1
-          res.reservations.first.instances.single_resource(id)
-        elsif res.reservations.count > 1
-          raise Awspec::DuplicatedResourceTypeError, "Duplicate instances matching id or tag #{id}"
+
+        # First tries to search by using an educated guess, based on the
+        # references below:
+        # https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html
+        # https://docs.chef.io/inspec/resources/aws_ec2_instance/
+        # This should be faster then just first trying ID when the parameter is
+        # clearly not one
+
+        # https://medium.com/@Bakku1505/ruby-start-with-end-with-vs-regular-expressions-59728be0859e
+        if id.start_with?('i-') && id.length == 19 && id =~ /^i-[0-9a-f]/
+          begin
+            res = ec2_client.describe_instances({
+                                                  instance_ids: [id]
+                                                })
+          rescue Aws::EC2::Errors::InvalidInstanceIDNotFound, Aws::EC2::Errors::InvalidInstanceIDMalformed => e
+            res = ec2_client.describe_instances({
+                                                  filters: [{ name: 'tag:Name', values: [id] }]
+                                                })
+          end
+        else
+          begin
+            res = ec2_client.describe_instances({
+                                                  filters: [{ name: 'tag:Name', values: [id] }]
+                                                })
+          rescue Aws::EC2::Errors::InvalidInstanceIDNotFound, Aws::EC2::Errors::InvalidInstanceIDMalformed => e
+            res = ec2_client.describe_instances({
+                                                  instance_ids: [id]
+                                                })
+            if res.reservations.count > 1
+              warn "Warning: '#{id}' unexpectedly identified as a valid instance ID during fallback search"
+            end
+          end
         end
+
+        return nil if res.reservations.count == 0
+        return res.reservations.first.instances.single_resource(id) if res.reservations.count == 1
+        raise Awspec::DuplicatedResourceTypeError, dup_ec2_instance(id) if res.reservations.count > 1
+
+        raise "Unexpected condition of having reservations = #{res.reservations.count}"
+      end
+
+      def dup_ec2_instance(id)
+        "Duplicate instances matching id or tag #{id}"
       end
 
       def find_ec2_attribute(id, attribute)
@@ -44,22 +71,23 @@ module Awspec::Helper
       end
 
       # find_internet_gateway find_vpn_gateway find_customer_gateway
-      gateway_types = %w(internet vpn customer transit)
+      gateway_types = %w[internet vpn customer transit]
       gateway_types.each do |type|
-        define_method 'find_' + type + '_gateway' do |*args|
+        define_method "find_#{type}_gateway" do |*args|
           gateway_id = args.first
-          method_name = 'describe_' + type + '_gateways'
+          method_name = "describe_#{type}_gateways"
           res = ec2_client.send(
             method_name,
-            { filters: [{ name: type + '-gateway-id', values: [gateway_id] }] }
+            { filters: [{ name: "#{type}-gateway-id", values: [gateway_id] }] }
           )
-          resource = res[type + '_gateways'].single_resource(gateway_id)
+          resource = res["#{type}_gateways"].single_resource(gateway_id)
           return resource if resource
+
           res = ec2_client.send(
             method_name,
             { filters: [{ name: 'tag:Name', values: [gateway_id] }] }
           )
-          res[type + '_gateways'].single_resource(gateway_id)
+          res["#{type}_gateways"].single_resource(gateway_id)
         end
       end
 
@@ -74,6 +102,7 @@ module Awspec::Helper
                                                   })
         resource = res.vpn_connections.single_resource(vpn_connection_id)
         return resource if resource
+
         res = ec2_client.describe_vpn_connections({
                                                     filters: [
                                                       {
@@ -91,7 +120,7 @@ module Awspec::Helper
           res = ec2_client.describe_nat_gateways({
                                                    nat_gateway_ids: [gateway_id]
                                                  })
-        rescue
+        rescue StandardError
           res = ec2_client.describe_nat_gateways({
                                                    filter: [{ name: 'tag:Name', values: [gateway_id] }]
                                                  })
@@ -114,6 +143,7 @@ module Awspec::Helper
                                                      })
         resource = res.network_interfaces.single_resource(interface_id)
         return resource if resource
+
         res = ec2_client.describe_network_interfaces({
                                                        filters: [{ name: 'tag:Name', values: [interface_id] }]
                                                      })
@@ -181,7 +211,7 @@ module Awspec::Helper
           res = ec2_client.describe_launch_templates({
                                                        launch_template_ids: [id]
                                                      })
-        rescue
+        rescue StandardError
           res = ec2_client.describe_launch_templates({
                                                        launch_template_names: [id]
                                                      })
@@ -194,7 +224,7 @@ module Awspec::Helper
         res = ec2_client.describe_launch_template_versions({
                                                              launch_template_id: id
                                                            })
-      rescue
+      rescue StandardError
         res = ec2_client.describe_launch_template_versions({
                                                              launch_template_name: id
                                                            })

data/lib/awspec/helper/finder/ecr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Ecr

data/lib/awspec/helper/finder/ecs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Ecs
@@ -28,6 +30,7 @@ module Awspec::Helper
           res = ecs_client.list_container_instances(req)
           arns.push(*res.container_instance_arns)
           break if res.next_token.nil?
+
           req[:next_token] = res.next_token
         end
         arns
@@ -36,10 +39,10 @@ module Awspec::Helper
       # deprecated method
       def find_ecs_container_instances(cluster, container_instances)
         res = ecs_client.describe_container_instances(cluster: cluster, container_instances: container_instances)
-        res.container_instances if res.container_instances
+        res.container_instances
       end
 
-      alias_method :list_ecs_container_instances, :select_ecs_container_instance_arn_by_cluster_name # deprecated method
+      alias list_ecs_container_instances select_ecs_container_instance_arn_by_cluster_name # deprecated method
     end
   end
 end

data/lib/awspec/helper/finder/efs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Efs
@@ -7,7 +9,7 @@ module Awspec::Helper
                                                    file_system_id: id,
                                                    max_items: 1
                                                  })
-        rescue
+        rescue StandardError
           # Aws::EFS::Errors::BadRequest (invalid file system ID: my-efs)
           file_system_id = get_id_by_name_tag(id)
           res = efs_client.describe_file_systems({
@@ -21,7 +23,7 @@ module Awspec::Helper
       def find_efs_tags(id, tag_key)
         begin
           tag_set = efs_client.describe_tags({ file_system_id: id })
-        rescue
+        rescue StandardError
           # Aws::EFS::Errors::BadRequest (invalid file system ID: my-efs)
           file_system_id = get_id_by_name_tag(id)
           tag_set = efs_client.describe_tags({
@@ -55,8 +57,7 @@ module Awspec::Helper
 
       def select_all_file_systems
         file_systems_query = efs_client.describe_file_systems
-        file_systems = file_systems_query.file_systems
-        file_systems
+        file_systems_query.file_systems
       end
     end
   end

data/lib/awspec/helper/finder/eks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Eks

data/lib/awspec/helper/finder/elasticache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Elasticache
@@ -6,7 +8,7 @@ module Awspec::Helper
                                                            cache_cluster_id: id
                                                          })
         res.cache_clusters.single_resource(id)
-      rescue
+      rescue StandardError
         nil
       end
 

data/lib/awspec/helper/finder/elasticsearch.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Elasticsearch
       def find_elasticsearch_domain(id)
         res = elasticsearch_client.describe_elasticsearch_domain(domain_name: id)
         res.domain_status
-      rescue
+      rescue StandardError
         nil
       end
 

data/lib/awspec/helper/finder/elastictranscoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Elastictranscoder
@@ -9,6 +11,7 @@ module Awspec::Helper
             pipeline.id == id || pipeline.name == id
           end
           break if res.next_page_token.nil?
+
           res = elastictranscoder_client.list_pipelines({
                                                           page_token: res.next_page_token
                                                         })

data/lib/awspec/helper/finder/elb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Elb
@@ -6,8 +8,8 @@ module Awspec::Helper
                                                    load_balancer_names: [id]
                                                  })
         res.load_balancer_descriptions.single_resource(id)
-      rescue
-        return nil
+      rescue StandardError
+        nil
       end
 
       def find_elb_attribute(id)
@@ -15,8 +17,8 @@ module Awspec::Helper
                                                              load_balancer_name: id
                                                            })
         res.load_balancer_attributes
-      rescue
-        return nil
+      rescue StandardError
+        nil
       end
 
       def select_elb_by_vpc_id(vpc_id)

data/lib/awspec/helper/finder/emr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Emr

data/lib/awspec/helper/finder/firehose.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Firehose