awspec 1.24.3 → 1.25.2

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

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Iam
       # find_iam_user, find_iam_group find_iam_role find_iam_policy
-      role_types = %w(user group role policy)
+      role_types = %w[user group role policy]
       role_types.each do |type|
-        define_method 'find_iam_' + type do |*args|
+        define_method "find_iam_#{type}" do |*args|
           id = args.first
           selected = []
-          res = iam_client.send('list_' + type.pluralize)
+          res = iam_client.send("list_#{type.pluralize}")
           loop do
             selected += res[type.pluralize].select do |u|
-              u[type + '_name'] == id || u[type + '_id'] == id || u.arn == id
+              u["#{type}_name"] == id || u["#{type}_id"] == id || u.arn == id
             end
 
             break unless res.is_truncated
+
             res = iam_client.send(
-              'list_' + type.pluralize,
+              "list_#{type.pluralize}",
               { marker: res.marker }
             )
           end
@@ -43,19 +46,19 @@ module Awspec::Helper
         res.groups
       end
 
-      %w(user group role).each do |type|
-        define_method 'select_iam_policy_by_' + type + '_name' do |name|
+      %w[user group role].each do |type|
+        define_method "select_iam_policy_by_#{type}_name" do |name|
           res = iam_client.send(
-            'list_attached_' + type + '_policies',
-            { (type + '_name').to_sym => name }
+            "list_attached_#{type}_policies",
+            { "#{type}_name".to_sym => name }
           )
           res.attached_policies
         end
 
-        define_method 'select_inline_policy_by_' + type + '_name' do |name|
+        define_method "select_inline_policy_by_#{type}_name" do |name|
           res = iam_client.send(
-            'list_' + type + '_policies',
-            { (type + '_name').to_sym => name }
+            "list_#{type}_policies",
+            { "#{type}_name".to_sym => name }
           )
           res.policy_names
         end
@@ -68,6 +71,7 @@ module Awspec::Helper
         loop do
           selected += res.policies.select { |p| p.attachment_count > 0 }
           break unless res.is_truncated
+
           res = iam_client.list_policies({
                                            marker: res.marker
                                          })

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

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

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Kms
       def find_kms_key(key_id)
         kms_client.describe_key(key_id: key_id).key_metadata
-      rescue
+      rescue StandardError
         nil
       end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Lambda
@@ -10,6 +12,7 @@ module Awspec::Helper
             function.function_name == id || function.function_arn == id
           end
           break if res.next_marker.nil?
+
           res = lambda_client.list_functions({
                                                marker: res.next_marker
                                              })

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Mq
       def find_broker(broker_id)
         mq_client.describe_broker({ broker_id: broker_id })
-      rescue
+      rescue StandardError
         nil
       end
     end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Nlb
@@ -6,8 +8,8 @@ module Awspec::Helper
         res.load_balancers.select do |lb|
           lb.type == 'network'
         end.single_resource(id)
-      rescue
-        return nil
+      rescue StandardError
+        nil
       end
 
       def select_nlb_by_vpc_id(vpc_id)
@@ -20,8 +22,8 @@ module Awspec::Helper
       def find_nlb_listener(arn)
         res = elbv2_client.describe_listeners({ listener_arns: [arn] })
         res.listeners.single_resource(arn)
-      rescue
-        return nil
+      rescue StandardError
+        nil
       end
 
       def select_nlb_listener_by_nlb_arn(arn)
@@ -38,18 +40,19 @@ module Awspec::Helper
       def find_nlb_target_group(id)
         res = elbv2_client.describe_target_groups({ names: [id] })
         httpx_res = res.target_groups.select do |tg|
-          %w(HTTP HTTPS).include?(tg.protocol)
+          %w[HTTP HTTPS].include?(tg.protocol)
         end
         if !httpx_res || httpx_res.empty?
           raise "ERROR: Found no HTTP nor HTTPS -protocol target group named '#{id}'."
         end
+
         httpx_res.single_resource(id)
-      rescue
+      rescue StandardError
         # Prefer the HTTP/HTTPS protocol target group, but survive without it:
         begin
           res.target_groups.single_resource(id)
-        rescue
-          return nil
+        rescue StandardError
+          nil
         end
       end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Rds
@@ -6,7 +8,7 @@ module Awspec::Helper
           res = rds_client.describe_db_instances({
                                                    db_instance_identifier: id
                                                  })
-        rescue
+        rescue StandardError
           res = rds_client.describe_db_instances({
                                                    filters: [{ name: 'db-instance-id', values: [id] }]
                                                  })
@@ -31,6 +33,7 @@ module Awspec::Helper
             parameters[param.parameter_name] = param.parameter_value
           end
           break if res.marker.nil?
+
           res = rds_client.describe_db_parameters({
                                                     db_parameter_group_name: parameter_group,
                                                     marker: res.marker

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Redshift
       def find_redshift_cluster_identifier(id)
         res = redshift_client.describe_clusters(cluster_identifier: id)
         res.clusters.single_resource(id)
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -25,6 +27,7 @@ module Awspec::Helper
             parameters[param.parameter_name] = param.parameter_value
           end
           break if res.marker.nil?
+
           res = redshift_client.describe_cluster_parameters({
                                                               parameter_group_name: parameter_group,
                                                               marker: res.marker

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Route53
@@ -6,12 +8,13 @@ module Awspec::Helper
         selected = []
         loop do
           res.hosted_zones.each do |hosted_zone|
-            if hosted_zone[:name] == id || hosted_zone[:id] == '/hostedzone/' + id || hosted_zone[:id] == id
+            if hosted_zone[:name] == id || hosted_zone[:id] == "/hostedzone/#{id}" || hosted_zone[:id] == id
               selected.push(hosted_zone)
             end
           end
 
           break unless res.is_truncated
+
           res = route53_client.list_hosted_zones({
                                                    marker: res.next_marker
                                                  })

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module S3
@@ -16,9 +18,9 @@ module Awspec::Helper
       def head_object(id, key)
         res = s3_client.head_object({
                                       bucket: id,
-                                      key: key.sub(%r(\A/), '')
+                                      key: key.sub(%r{\A/}, '')
                                     })
-        res.data.class == Aws::S3::Types::HeadObjectOutput
+        res.data.instance_of?(Aws::S3::Types::HeadObjectOutput)
       rescue Aws::S3::Errors::NotFound
         false
       end

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

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

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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module SNSTopic
@@ -20,10 +22,10 @@ module Awspec::Helper
         end
 
         def to_s
-          output = ["SnsTopic: #{self.name}"]
-          self.instance_variables.each do |attrib|
+          output = ["SnsTopic: #{name}"]
+          instance_variables.each do |attrib|
             tmp = attrib.to_s.sub('@', '')
-            output << "  #{tmp} = #{self.send(tmp)}"
+            output << "  #{tmp} = #{send(tmp)}"
           end
           output.join("\n")
         end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module SsmParameter
@@ -10,7 +12,8 @@ module Awspec::Helper
                 values: [name]
               }
             ]
-          }).parameters[0]
+          }
+        ).parameters[0]
       end
 
       def find_parameter_tag(id, tag_key)

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

@@ -1,29 +1,135 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
 module Awspec::Helper
   module Finder
     module Subnet
-      def find_subnet(subnet_id)
-        res = ec2_client.describe_subnets({
-                                            filters: [{ name: 'subnet-id', values: [subnet_id] }]
-                                          })
-        resource = res.subnets.single_resource(subnet_id)
-        return resource if resource
-        res = ec2_client.describe_subnets({
-                                            filters: [{ name: 'tag:Name', values: [subnet_id] }]
-                                          })
-        resource = res.subnets.single_resource(subnet_id)
-        return resource if resource
-        res = ec2_client.describe_subnets({
-                                            filters: [{ name: 'cidrBlock', values: [subnet_id] }]
-                                          })
-        res.subnets.single_resource(subnet_id)
+      # Implements in-memory cache for +AWS::Ec2::Client+ +describe_subnets+
+      # method.
+
+      # == Usage
+      # Includes {Singleton}[https://ruby-doc.org/stdlib-2.7.3/libdoc/singleton/rdoc/index.html]
+      # module, so use +instance+ instead of +new+ to get a instance.
+      #
+      # It is intended to be used internally by the +find_subnet+ function only.
+      #
+      # Many of the methods expect a symbol to search through the cache to
+      # avoid having to call +to_sym+ multiple times.
+
+      class SubnetCache
+        include Singleton
+
+        def initialize # :nodoc:
+          @by_tag_name = {}
+          @by_cidr = {}
+          @subnet_ids = {}
+          @ip_matcher = Regexp.new('^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/\d{1,2}$')
+        end
+
+        # Add a mapping of a CIDR to the respective subnet ID
+        def add_by_cidr(cidr, subnet_id)
+          key_sym = cidr.to_sym
+          @by_cidr[key_sym] = subnet_id.to_sym unless @by_cidr.key?(key_sym)
+        end
+
+        # Add a mapping of a tag to the respective subnet ID
+        def add_by_tag(tag, subnet_id)
+          key_sym = tag.to_sym
+          @by_tag_name[key_sym] = subnet_id.to_sym unless @by_tag_name.key?(key_sym)
+        end
+
+        # Add a +Aws::EC2::Types::Subnet+ instance to the cache, mapping it's ID
+        # to the instance itself.
+        def add_subnet(subnet)
+          key_sym = subnet.subnet_id.to_sym
+          @subnet_ids[key_sym] = subnet unless @subnet_ids.key?(key_sym)
+        end
+
+        # Check if a subnet ID (as a symbol) exists in the cache.
+        def has_subnet?(subnet_id_symbol)
+          @subnet_ids.key?(subnet_id_symbol)
+        end
+
+        # Check if a IPv4 CIDR (as a symbol) exists in the cache.
+        def has_cidr?(cidr_symbol)
+          @by_cidr.key?(cidr_symbol)
+        end
+
+        # Return a +Aws::EC2::Types::Subnet+ that matches the given CIDR.
+        def subnet_by_cidr(cidr_symbol)
+          @subnet_ids[@by_cidr[cidr_symbol]]
+        end
+
+        # Return a +Aws::EC2::Types::Subnet+ that matches the given tag.
+        def subnet_by_tag(tag_symbol)
+          @subnet_ids[@by_tag_name[tag_symbol]]
+        end
+
+        # Return a +Aws::EC2::Types::Subnet+ that matches the given subnet ID.
+        def subnet_by_id(subnet_id_symbol)
+          @subnet_ids[subnet_id_symbol]
+        end
+
+        # Check if a given string looks like a IPv4 CIDR.
+        def is_cidr?(subnet_id)
+          @ip_matcher.match(subnet_id)
+        end
+
+        # Check if the cache was already initialized or not.
+        def empty?
+          @subnet_ids.empty?
+        end
+
+        # Return the cache as a string.
+        def to_s
+          "by tag name: #{@by_tag_name}, by CIDR: #{@by_cidr}"
+        end
       end
 
-      def select_subnet_by_vpc_id(vpc_id)
-        res = ec2_client.describe_subnets({
-                                            filters: [{ name: 'vpc-id', values: [vpc_id] }]
-                                          })
-        res.subnets
+      # Try to locate a +Aws::EC2::Types::Subnet+ with a given subnet ID.
+      #
+      # A subnet ID might be multiple things, like the
+      # +Aws::EC2::Types::Subnet.subnet_id+, or a IPv4 CIDR or the value for the
+      # +Name+ tag associated with the subnet.
+      #
+      # Returns a instance of +Aws::EC2::Types::Subnet+ or +nil+.
+      def find_subnet(subnet_id)
+        cache = SubnetCache.instance
+
+        if cache.empty?
+          res = ec2_client.describe_subnets
+
+          res.subnets.each do |sub|
+            cache.add_by_cidr(sub.cidr_block, sub.subnet_id)
+            cache.add_subnet(sub)
+            next if sub.tags.empty?
+
+            sub.tags.each do |tag|
+              if tag[:key].eql?('Name')
+                cache.add_by_tag(tag[:value], sub.subnet_id)
+                break
+              end
+            end
+          end
+        end
+
+        id_key = subnet_id.to_sym
+        return cache.subnet_by_id(id_key) if subnet_id.start_with?('subnet-') && cache.has_subnet?(id_key)
+        return cache.subnet_by_cidr(id_key) if cache.is_cidr?(subnet_id) && cache.has_cidr?(id_key)
+
+        cache.subnet_by_tag(id_key)
       end
     end
+
+    # Search for the subnets associated with a given VPC ID.
+    #
+    # Returns an array of +Aws::EC2::Types::Subnet+ instances.
+    def select_subnet_by_vpc_id(vpc_id)
+      res = ec2_client.describe_subnets({
+                                          filters: [{ name: 'vpc-id', values: [vpc_id] }]
+                                        })
+      res.subnets
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Vpc
@@ -7,6 +9,7 @@ module Awspec::Helper
                                        })
         resource = res.vpcs.single_resource(id)
         return resource if resource
+
         res = ec2_client.describe_vpcs({
                                          filters: [{ name: 'tag:Name', values: [id] }]
                                        })
@@ -19,6 +22,7 @@ module Awspec::Helper
                                                })
         resource = res.route_tables.single_resource(route_table_id)
         return resource if resource
+
         res = ec2_client.describe_route_tables({
                                                  filters: [{ name: 'tag:Name', values: [route_table_id] }]
                                                })
@@ -31,6 +35,7 @@ module Awspec::Helper
                                                })
         resource = res.network_acls.single_resource(id)
         return resource if resource
+
         res = ec2_client.describe_network_acls({
                                                  filters: [{ name: 'tag:Name', values: [id] }]
                                                })
@@ -62,6 +67,7 @@ module Awspec::Helper
                                                           })
         resource = res.vpc_peering_connections.single_resource(vpc_peering_connection_id)
         return resource if resource
+
         res = ec2_client.describe_vpc_peering_connections({
                                                             filters: [
                                                               {
@@ -87,24 +93,24 @@ module Awspec::Helper
       def find_vpc_attribute(vpc_id, vpc_attribute)
         res = ec2_client.describe_vpc_attribute({ vpc_id: vpc_id, attribute: vpc_attribute })
         case vpc_attribute
-        when 'enableDnsSupport' then
+        when 'enableDnsSupport'
           res.enable_dns_support.value
-        when 'enableDnsHostnames' then
+        when 'enableDnsHostnames'
           res.enable_dns_hostnames.value
         end
       end
 
       def select_vpc_attribute(vpc_id)
         attributes = {}
-        vpc_attributes = %w(
+        vpc_attributes = %w[
           enableDnsHostnames enableDnsSupport
-        )
+        ]
         vpc_attributes.each do |vpc_attribute|
           res = ec2_client.describe_vpc_attribute({ vpc_id: vpc_id, attribute: vpc_attribute })
           attributes[vpc_attribute] = case vpc_attribute
-                                      when 'enableDnsHostnames' then
+                                      when 'enableDnsHostnames'
                                         res.enable_dns_hostnames.value
-                                      when 'enableDnsSupport' then
+                                      when 'enableDnsSupport'
                                         res.enable_dns_support.value
                                       end
         end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module Waf
@@ -14,6 +16,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         waf_client.get_web_acl(web_acl_id: finded.web_acl_id).web_acl
       end
 
@@ -30,6 +33,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         waf_client.get_rule(rule_id: finded.rule_id).rule
       end
 
@@ -46,6 +50,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         waf_client.get_ip_set(ip_set_id: finded.ip_set_id).ip_set
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module Finder
     module WafRegional
@@ -14,6 +16,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         wafregional_client.get_web_acl(web_acl_id: finded.web_acl_id).web_acl
       end
 
@@ -30,6 +33,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         wafregional_client.get_rule(rule_id: finded.rule_id).rule
       end
 
@@ -46,6 +50,7 @@ module Awspec::Helper
         end
 
         return nil unless finded
+
         wafregional_client.get_ip_set(ip_set_id: finded.ip_set_id).ip_set
       end
     end

data/lib/awspec/helper/finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'aws-sdk'
 require 'awspec/helper/finder/nlb'
 require 'awspec/helper/finder/alb'
@@ -174,7 +176,7 @@ module Awspec::Helper
 
     CLIENTS.each do |method_name, client|
       define_method method_name do
-        unless self.methods.include? "@#{method_name}"
+        unless methods.include? "@#{method_name}"
           instance_variable_set(
             "@#{method_name}",
             Awspec::Helper::ClientWrap.new(client.new(CLIENT_OPTIONS))

data/lib/awspec/helper/states.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Awspec::Helper
   module States
-    EC2_STATES = %w(pending running shutting-down terminated stopping stopped)
+    EC2_STATES = %w[pending running shutting-down terminated stopping stopped]
 
     def self.ec2_states_checks
       Enumerator.new do |yielder|
         n = 0
         while n < EC2_STATES.size
-          method_name = EC2_STATES[n].tr('-', '_') + '?'
+          method_name = "#{EC2_STATES[n].tr('-', '_')}?"
           yielder.yield(method_name, EC2_STATES[n])
           n += 1
         end