awspec 1.24.1 → 1.25.0

data/lib/awspec/stub/elasticsearch.rb

@@ -1,4 +1,3 @@
-
 Aws.config[:elasticsearchservice] = {
   stub_responses: {
     list_domain_names: {

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/cloudwatch_logs.rb

@@ -13,9 +13,14 @@ module Awspec::Type
       return true if ret == stream_name
     end
 
-    def has_metric_filter?(filter_name)
-      ret = find_cloudwatch_logs_metric_fileter_by_log_group_name(@id, filter_name).filter_name
-      return true if ret == filter_name
+    def has_metric_filter?(filter_name, pattern = nil)
+      ret = find_cloudwatch_logs_metric_fileter_by_log_group_name(@id, filter_name)
+      if pattern.nil?
+        return true if ret.filter_name == filter_name
+      else
+        return false unless ret.filter_pattern == pattern
+      end
+      return true if ret.filter_name == filter_name
     end
 
     def has_subscription_filter?(filter_name, pattern = nil)

data/lib/awspec/type/ec2.rb

@@ -1,3 +1,5 @@
+require 'awspec/helper/states'
+
 module Awspec::Type
   class Ec2 < ResourceBase
     aws_resource Aws::EC2::Instance
@@ -8,6 +10,16 @@ module Awspec::Type
       @display_name = name
     end
 
+    # required by Awspec::Generator::Doc::Type
+    STATES = Awspec::Helper::States::EC2_STATES
+
+    Awspec::Helper::States.ec2_states_checks.each do |method_name, state|
+      define_method method_name do
+        check_existence
+        resource_via_client.state.name == state
+      end
+    end
+
     def resource_via_client
       @resource_via_client ||= find_ec2(@display_name)
     end
@@ -17,20 +29,10 @@ module Awspec::Type
     end
 
     def security_group_count
+      check_existence
       resource_via_client.security_groups.count
     end
 
-    STATES = %w(
-      pending running shutting-down
-      terminated stopping stopped
-    )
-
-    STATES.each do |state|
-      define_method state.tr('-', '_') + '?' do
-        resource_via_client.state.name == state
-      end
-    end
-
     def disabled_api_termination?
       ret = find_ec2_attribute(id, 'disableApiTermination')
       ret.disable_api_termination.value
@@ -48,7 +50,6 @@ module Awspec::Type
 
     def has_security_groups?(sg_ids)
       return true if match_group_ids?(sg_ids) || match_group_names?(sg_ids)
-
       group_ids = resource_security_groups.map { |sg| sg.group_id }
       tags = select_security_group_by_group_id(group_ids).map { |sg| sg.tags }.flatten
       group_names = tags.select { |tag| tag.key == 'Name' }.map { |tag| tag.value }
@@ -56,6 +57,7 @@ module Awspec::Type
     end
 
     def has_security_group?(sg_id)
+      check_existence
       sgs = resource_via_client.security_groups
       ret = sgs.find do |sg|
         sg.group_id == sg_id || sg.group_name == sg_id
@@ -69,12 +71,14 @@ module Awspec::Type
     end
 
     def has_iam_instance_profile?(iam_instance_profile_name)
+      check_existence
       iam = resource_via_client.iam_instance_profile
       ret = iam.arn.split('/').last == iam_instance_profile_name
       return true if ret
     end
 
     def has_ebs?(volume_id)
+      check_existence
       blocks = resource_via_client.block_device_mappings
       ret = blocks.find do |block|
         next false unless block.ebs
@@ -89,8 +93,9 @@ module Awspec::Type
 
     def has_network_interface?(network_interface_id, device_index = nil)
       res = find_network_interface(network_interface_id)
+      check_existence
       interfaces = resource_via_client.network_interfaces
-      interfaces.find do |interface|
+      ret = interfaces.find do |interface|
         next false if device_index && interface.attachment.device_index != device_index
         interface.network_interface_id == res.network_interface_id
       end
@@ -98,7 +103,7 @@ module Awspec::Type
 
     def has_event?(event_code)
       status = find_ec2_status(id)
-      status.events.find do |event|
+      ret = status.events.find do |event|
         event.code == event_code
       end
     end
@@ -133,8 +138,7 @@ module Awspec::Type
     end
 
     def has_credit_specification?(cpu_credits)
-      ret = find_ec2_credit_specifications(id)
-      ret.cpu_credits == cpu_credits
+      find_ec2_credit_specifications(id).cpu_credits == cpu_credits
     end
 
     private
@@ -148,6 +152,7 @@ module Awspec::Type
     end
 
     def resource_security_groups
+      check_existence
       resource_via_client.security_groups
     end
   end

data/lib/awspec/type/eks_nodegroup.rb

@@ -1,10 +1,47 @@
+require 'set'
+
 module Awspec::Type
+  class EksNodeEC2
+    attr_reader :state, :subnet_id, :sec_groups
+
+    def initialize(id, state, subnet_id, sec_groups)
+      @id = id
+      @state = state
+      @subnet_id = subnet_id
+      @sec_groups = sec_groups
+    end
+
+    def to_s
+      "ID: #{@id}, State: #{@state}, Subnet ID: #{@subnet_id}, Security Groups: #{@sec_groups}"
+    end
+  end
+
+  class EksNodeSecGroup
+    attr_reader :name, :id
+
+    def initialize(id, name)
+      @id = id
+      @name = name
+    end
+
+    def to_s
+      "ID: #{@id}, Name: #{@name}"
+    end
+  end
+
   class EksNodegroup < ResourceBase
+    # the tags below are standard for EKS node groups instances
+    EKS_CLUSTER_TAG = 'tag:eks:cluster-name'
+    EKS_NODEGROUP_TAG = 'tag:eks:nodegroup-name'
+
     attr_accessor :cluster
 
     def initialize(group_name)
       super
       @group_name = group_name
+      @ec2_instances = []
+      @sec_groups = Set.new
+      @sec_groups_ids = Set.new
     end
 
     def resource_via_client
@@ -19,6 +56,39 @@ module Awspec::Type
       @cluster || 'default'
     end
 
+    def subnets
+      ec2_instances = find_nodes
+      Set.new(ec2_instances.map { |ec2| ec2.subnet_id })
+    end
+
+    def has_security_group?(sec_group)
+      if @sec_groups.empty? || @sec_groups_ids.empty?
+        ec2_instances = find_nodes
+
+        ec2_instances.each do |ec2|
+          ec2.sec_groups.each do |sg|
+            @sec_groups.add(sg.name)
+            @sec_groups_ids.add(sg.id)
+          end
+        end
+      end
+
+      @sec_groups.member?(sec_group) || @sec_groups_ids.member?(sec_group)
+    end
+
+    def ready?
+      min_expected = resource_via_client.scaling_config.min_size
+      ec2_instances = find_nodes
+      running_counter = 0
+
+      ec2_instances.each do |ec2|
+        running_counter += 1 if ec2.state.eql?('running')
+        break if running_counter == min_expected
+      end
+
+      running_counter >= min_expected
+    end
+
     STATES = %w(ACTIVE INACTIVE)
 
     STATES.each do |state|
@@ -26,5 +96,40 @@ module Awspec::Type
         resource_via_client.status == state
       end
     end
+
+    private
+
+    def find_nodes
+      return @ec2_instances unless @ec2_instances.empty?
+
+      result = ec2_client.describe_instances(
+        {
+          filters: [
+            { name: EKS_CLUSTER_TAG, values: [cluster] },
+            { name: EKS_NODEGROUP_TAG, values: [@group_name] }
+          ]
+        }
+      )
+      result.reservations.each do |reservation|
+        reservation.instances.each do |instance|
+          sec_groups = []
+
+          instance.security_groups.map do |sg|
+            sec_groups.push(EksNodeSecGroup.new(sg.group_id, sg.group_name))
+          end
+
+          @ec2_instances.push(
+            EksNodeEC2.new(
+              instance.instance_id,
+              instance.state.name,
+              instance.subnet_id,
+              sec_groups
+            )
+          )
+        end
+      end
+
+      @ec2_instances
+    end
   end
 end

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/type/s3_bucket.rb

@@ -108,8 +108,8 @@ module Awspec::Type
           if value.is_a?(Array)
             return false if r[key].map(&:to_h) != value
           end
-          true
         end
+        true
       end
     end
 

data/lib/awspec/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 1.24.1
+  version: 1.25.0
 platform: ruby
 authors:
 - k1LoW
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.57.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.57.0
 description: RSpec tests for your AWS resources.
 email:
 - k1lowxb@gmail.com
@@ -221,9 +221,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".github/workflows/doc.yml"
 - ".rubocop.yml"
-- ".tachikoma.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -435,6 +435,7 @@ files:
 - lib/awspec/generator/spec/ec2.rb
 - lib/awspec/generator/spec/efs.rb
 - lib/awspec/generator/spec/eip.rb
+- lib/awspec/generator/spec/elasticache.rb
 - lib/awspec/generator/spec/elasticsearch.rb
 - lib/awspec/generator/spec/elb.rb
 - lib/awspec/generator/spec/iam_group.rb
@@ -518,6 +519,7 @@ files:
 - lib/awspec/helper/finder/vpc_endpoints.rb
 - lib/awspec/helper/finder/waf.rb
 - lib/awspec/helper/finder/wafregional.rb
+- lib/awspec/helper/states.rb
 - lib/awspec/helper/type.rb
 - lib/awspec/matcher.rb
 - lib/awspec/matcher/be_allowed.rb
@@ -537,6 +539,7 @@ files:
 - lib/awspec/matcher/belong_to_nlb.rb
 - lib/awspec/matcher/belong_to_replication_group.rb
 - lib/awspec/matcher/belong_to_subnet.rb
+- lib/awspec/matcher/belong_to_subnets.rb
 - lib/awspec/matcher/belong_to_vpc.rb
 - lib/awspec/matcher/have_attribute_definition.rb
 - lib/awspec/matcher/have_cluster_parameter_group.rb
@@ -548,6 +551,7 @@ files:
 - lib/awspec/matcher/have_inline_policy.rb
 - lib/awspec/matcher/have_key_policy.rb
 - lib/awspec/matcher/have_key_schema.rb
+- lib/awspec/matcher/have_metric_filter.rb
 - lib/awspec/matcher/have_network_interface.rb
 - lib/awspec/matcher/have_option_group.rb
 - lib/awspec/matcher/have_origin.rb
@@ -593,6 +597,7 @@ files:
 - lib/awspec/stub/ebs.rb
 - lib/awspec/stub/ec2.rb
 - lib/awspec/stub/ec2_has_multi_security_groups.rb
+- lib/awspec/stub/ec2_non_existing.rb
 - lib/awspec/stub/ecr_repository.rb
 - lib/awspec/stub/ecs.rb
 - lib/awspec/stub/ecs_cluster.rb
@@ -640,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