awspec 1.24.4 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03a271717bc3471b5109a4831bbb0941a1d2975b90ed04427fa304fb727c251b
-  data.tar.gz: 3eff98cd7e63f51067739eebf9d8c94476b66469ea98b2148d96c9afec502c3d
+  metadata.gz: 5880815a36bbfbccb02df8a4977451509f8f44cbc641a844d07ac1b4d78b40d4
+  data.tar.gz: d85fa09ae26d042910cbb72faa602db6266dbe370af1e62b9fa06519ce77aa58
 SHA512:
-  metadata.gz: 82d89949fa055cbcfda478ff3efa28259a70cf9dc37fba9ea2c9e861c6393e225c5d268b701acdd4c567b0878d4d06f3c2db692b554d41a9737cecac87cc6dab
-  data.tar.gz: 9d5a864c8065cf512aabcb2c2dd8851510253d8486dc0d6653e5c53d4c50376ca9c53a4a7ad45db5c8841e38d6c210a6e14c90970fabb75e03a454f4730cdaf3
+  metadata.gz: 98528081727304b98a323c7469a79bd7876d185def31d3cfcf03b9ebc138df42d6126abe794cdaf00b138289209540b5a96a092ccd37c5482a579da95ae1a78c
+  data.tar.gz: 014e0bcfe3c67c4da754e2405e8545b0ed8d9544f1f9916f2adacb2c1cf7ec56b8f4d1227062d43ab4c44a942b9fcf1f6538930b84f694522ac2ad16e555a322

data/doc/resource_types.md

@@ -678,6 +678,15 @@ describe cloudwatch_logs('my-cloudwatch-logs-group') do
   it { should have_metric_filter('my-cloudwatch-logs-metric-filter') }
 end
 ```
+or
+```ruby
+describe cloudwatch_logs('my-cloudwatch-logs-group') do
+  it do
+    should have_metric_filter('my-cloudwatch-logs-metric-filter')
+      .filter_pattern('[date, error]')
+ end
+end
+```
 
 
 ### have_subscription_filter
@@ -2222,7 +2231,7 @@ DOC
 end
 ```
 
-### its(:aws_account_id), its(:key_id), its(:arn), its(:creation_date), its(:enabled), its(:description), its(:key_usage), its(:key_state), its(:deletion_date), its(:valid_to), its(:origin), its(:custom_key_store_id), its(:cloud_hsm_cluster_id), its(:expiration_model), its(:key_manager), its(:customer_master_key_spec), its(:encryption_algorithms), its(:signing_algorithms), its(:multi_region), its(:multi_region_configuration), its(:pending_deletion_window_in_days)
+### its(:aws_account_id), its(:key_id), its(:arn), its(:creation_date), its(:enabled), its(:description), its(:key_usage), its(:key_state), its(:deletion_date), its(:valid_to), its(:origin), its(:custom_key_store_id), its(:cloud_hsm_cluster_id), its(:expiration_model), its(:key_manager), its(:customer_master_key_spec), its(:key_spec), its(:encryption_algorithms), its(:signing_algorithms), its(:multi_region), its(:multi_region_configuration), its(:pending_deletion_window_in_days)
 ## <a name="lambda">lambda</a>
 
 Lambda resource type.
@@ -3559,7 +3568,7 @@ end
 ```
 
 
-### its(:availability_zone), its(:availability_zone_id), its(:available_ip_address_count), its(:cidr_block), its(:default_for_az), its(:map_public_ip_on_launch), its(:map_customer_owned_ip_on_launch), its(:customer_owned_ipv_4_pool), its(:state), its(:subnet_id), its(:vpc_id), its(:owner_id), its(:assign_ipv_6_address_on_creation), its(:ipv_6_cidr_block_association_set), its(:subnet_arn), its(:outpost_arn)
+
 ### :unlock: Advanced use
 
 `subnet` can use `Aws::EC2::Subnet` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Subnet.html).

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

@@ -1,29 +1,127 @@
+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
+
+        # 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.by_cidr.key?(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/stub/rds_db_parameter_group.rb

@@ -13,6 +13,14 @@ Aws.config[:rds] = {
         {
           parameter_name: 'max_allowed_packet',
           parameter_value: '16777216'
+        },
+        {
+          parameter_name: 'rds.logical_replication',
+          parameter_value: '1'
+        },
+        {
+          parameter_name: 'rds.accepted_password_auth_method',
+          parameter_value: 'md5+scram'
         }
       ]
     }

data/lib/awspec/stub/sns_topic.rb

@@ -1,26 +1,33 @@
+OWNER = '123456789'
+REGION = 'us-east-1'
+TOPIC_ARN = "arn:aws:sns:#{REGION}:#{OWNER}:foobar"
+DISPLAY_NAME = 'Useless'
+SUBSCRIBED = "arn:aws:sns:#{REGION}:#{OWNER}:Foobar:3dbf4999-b3e2-4345-bd11-c34c9784ecca"
+ENDPOINT = "arn:aws:lambda:#{REGION}:#{OWNER}:function:foobar"
+
 Aws.config[:sns] = {
   stub_responses: {
     get_topic_attributes: {
       attributes: {
         # rubocop:disable LineLength
-        'Policy'                  => '{\"Version\":\"2008-10-17\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__default_statement_ID\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":[\"SNS:GetTopicAttributes\",\"SNS:SetTopicAttributes\",\"SNS:AddPermission\",\"SNS:RemovePermission\",\"SNS:DeleteTopic\",\"SNS:Subscribe\",\"SNS:ListSubscriptionsByTopic\",\"SNS:Publish\",\"SNS:Receive\"],\"Resource\":\"arn:aws:sns:us-east-1:123456789:foobar-lambda-sample\",\"Condition\":{\"StringEquals\":{\"AWS:SourceOwner\":\"123456789\"}}}]}',
-        'Owner'                   => '123456789',
+        'Policy'                  => "{\"Version\":\"2008-10-17\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__default_statement_ID\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":[\"SNS:GetTopicAttributes\",\"SNS:SetTopicAttributes\",\"SNS:AddPermission\",\"SNS:RemovePermission\",\"SNS:DeleteTopic\",\"SNS:Subscribe\",\"SNS:ListSubscriptionsByTopic\",\"SNS:Publish\",\"SNS:Receive\"],\"Resource\":\"arn:aws:sns:#{REGION}:#{OWNER}:foobar-lambda-sample\",\"Condition\":{\"StringEquals\":{\"AWS:SourceOwner\":\"#{OWNER}\"}}}]}",
+        'Owner'                   => OWNER,
         'SubscriptionsPending'    => '0',
-        'TopicArn'                => 'arn:aws:sns:us-east-1:123456789:foobar',
+        'TopicArn'                => TOPIC_ARN,
         'EffectiveDeliveryPolicy' => '{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}',
         'SubscriptionsConfirmed'  => '1',
-        'DisplayName'             => 'Useless',
+        'DisplayName'             => DISPLAY_NAME,
         'SubscriptionsDeleted'    => '0'
       }
     },
     list_subscriptions_by_topic: {
       subscriptions: [
         {
-          subscription_arn: 'arn:aws:sns:us-east-1:123456789:Foobar:3dbf4999-b3e2-4345-bd11-c34c9784ecca',
-          owner: '123456789',
+          subscription_arn: SUBSCRIBED,
+          owner: OWNER,
           protocol: 'lambda',
-          endpoint: 'arn:aws:lambda:us-east-1:123456789:function:foobar',
-          topic_arn: 'arn:aws:sns:us-east-1:123456789:foobar'
+          endpoint: ENDPOINT,
+          topic_arn: TOPIC_ARN
         }
       ],
       next_token: nil

data/lib/awspec/stub/sns_topic_error.rb

@@ -0,0 +1,13 @@
+OWNER = '123456789'
+REGION = 'us-east-1'
+TOPIC_ARN = "arn:aws:sns:#{REGION}:#{OWNER}:invalid"
+TOPIC_SUBS_ARN = "arn:aws:sns:us-east-1:#{OWNER}:Foobar:3dbf4999-b3e2-4345-bd11-c34c9784ecca"
+
+Aws.config[:sns] = {
+  stub_responses: {
+    get_topic_attributes: Aws::SNS::Errors::NotFound.new(
+      TOPIC_ARN, 'no such topic'),
+    list_subscriptions_by_topic: Aws::SNS::Errors::NotFound.new(
+      TOPIC_SUBS_ARN, 'no such topic')
+  }
+}

data/lib/awspec/type/rds_db_parameter_group.rb

@@ -1,4 +1,39 @@
 module Awspec::Type
+  class InvalidRdsDbParameter < StandardError
+    ##
+    # Overrides the superclass initialize method to include more information
+    # and default error message.
+    # Expected parameters:
+    # - parameter_name: the name of the parameter.
+
+    def initialize(parameter_name)
+      @param_name = parameter_name
+      message = "There is no such parameter \"rds.#{parameter_name}\""
+      super message
+    end
+  end
+
+  class RdsDBParameters
+    ##
+    # Thanks to AWS for creating parameters names like
+    # 'rds.accepted_password_auth_method', which would be caught as method 'rds'
+    # by method_missing in RdsDbParameterGroup class, this class was created
+    # See https://github.com/k1LoW/awspec/issues/527 for more details
+    def initialize(params)
+      @params = params
+    end
+
+    def to_s
+      return "RdsDBParameters = #{@params}"
+    end
+
+    def method_missing(name)
+      param_name = name.to_sym
+      return @params[param_name] if @params.include?(param_name)
+      raise InvalidRdsDbParameter, name
+    end
+  end
+
   class RdsDbParameterGroup < ResourceBase
     def resource_via_client
       return @resource_via_client if @resource_via_client
@@ -11,11 +46,30 @@ module Awspec::Type
 
     def method_missing(name)
       param_name = name.to_s
+      return create_rds_params if param_name == 'rds'
+
       if resource_via_client.include?(param_name)
         resource_via_client[param_name].to_s
       else
         super
       end
     end
+
+    private
+
+    def create_rds_params
+      return @rds_params if @rds_params
+
+      rds_params_keys = resource_via_client.keys.select { |key| key.to_s.start_with?('rds.') }
+      rds_params = {}
+
+      rds_params_keys.each do |key|
+        new_key = key.split('.')[-1]
+        rds_params[new_key.to_sym] = resource_via_client[key]
+      end
+
+      @rds_params = RdsDBParameters.new(rds_params)
+      @rds_params
+    end
   end
 end

data/lib/awspec/version.rb

@@ -1,3 +1,3 @@
 module Awspec
-  VERSION = '1.24.4'
+  VERSION = '1.25.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 1.24.4
+  version: 1.25.0
 platform: ruby
 authors:
 - k1LoW
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -645,6 +645,7 @@ files:
 - lib/awspec/stub/security_group.rb
 - lib/awspec/stub/ses_identity.rb
 - lib/awspec/stub/sns_topic.rb
+- lib/awspec/stub/sns_topic_error.rb
 - lib/awspec/stub/sqs.rb
 - lib/awspec/stub/ssm_parameter.rb
 - lib/awspec/stub/subnet.rb