awspec 1.24.3 → 1.24.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac14ec851ce396f40316106c3784538793a8522009cc6d2172b71d01bc16691
-  data.tar.gz: 291660659e3c9223777f70e779c1d2ab34a591a4bfd83590002764977a70e73d
+  metadata.gz: 03a271717bc3471b5109a4831bbb0941a1d2975b90ed04427fa304fb727c251b
+  data.tar.gz: 3eff98cd7e63f51067739eebf9d8c94476b66469ea98b2148d96c9afec502c3d
 SHA512:
-  metadata.gz: 411f890f896ba013a75805159318bca637f0c43f0cc2b62c9e745d3b3386a31ba24d2080c1f4821f6fd68d5392bd1003a03838f119fa156b28f1959d4016ef98
-  data.tar.gz: f9ee6a4015f25bb56b85ae3a741a628bc5985b4e85f04e92099faaa9fb14caf02d7e8a13ef6ec86e3e5cd51455fe0b1d7d6fcc6feed3853d88661233f4079afd
+  metadata.gz: 82d89949fa055cbcfda478ff3efa28259a70cf9dc37fba9ea2c9e861c6393e225c5d268b701acdd4c567b0878d4d06f3c2db692b554d41a9737cecac87cc6dab
+  data.tar.gz: 9d5a864c8065cf512aabcb2c2dd8851510253d8486dc0d6653e5c53d4c50376ca9c53a4a7ad45db5c8841e38d6c210a6e14c90970fabb75e03a454f4730cdaf3

data/.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+
+    - name: Run rubocop
+      uses: reviewdog/action-rubocop@v1
+      with:
+        rubocop_version: 0.57.2
+        rubocop_extensions: rubocop:0.57.2
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        reporter: github-pr-review
+        fail_on_error: true
+
+  test:
+    name: Test
+    needs: [ lint ]
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.1'
+          - '2.2'
+          - '2.3'
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          # - '3.0'
+    runs-on: ubuntu-latest
+    env:
+      DISABLE_AWS_CLIENT_CHECK: true
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Install xml lib
+      run: gem install ox
+      if: matrix.ruby-version == '3.0'
+
+    - name: Generate document
+      run: bundle exec bin/toolbox docgen > doc/resource_types.md
+
+    - name: Run tests
+      run: bundle exec rake spec

data/.github/workflows/doc.yml

@@ -0,0 +1,29 @@
+name: Doc
+
+on:
+  schedule:
+    - cron:  '0 0 * * 0'
+
+jobs:
+  doc:
+    name: Document
+    runs-on: ubuntu-latest
+    env:
+      DISABLE_AWS_CLIENT_CHECK: true
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+
+    - name: Generate document
+      run: bundle exec bin/toolbox docgen > doc/resource_types.md
+
+    - uses: EndBug/add-and-commit@v7
+      with:
+        default_author: github_actions
+        add: 'doc/resource_types.md'

data/.rubocop.yml

@@ -10,12 +10,24 @@ Layout/MultilineOperationIndentation:
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
 
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
 Lint/HandleExceptions:
   Enabled: false
 
 Lint/UselessAssignment:
   Enabled: false
 
+Lint/DuplicateMethods:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
 Metrics/AbcSize:
   Max: 50
 
@@ -41,7 +53,13 @@ Metrics/ModuleLength:
 Metrics/PerceivedComplexity:
   Max: 15
 
-Style/PredicateName:
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
   Enabled: false
 
 Performance/StringReplacement:
@@ -65,7 +83,10 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
-Style/MethodMissing:
+Style/MethodMissingSuper:
+  Enabled: false
+
+Style/MissingRespondToMissing:
   Enabled: false
 
 Style/MutableConstant:
@@ -91,3 +112,27 @@ Style/SymbolProc:
 
 Style/YodaCondition:
   Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EvalWithLocation:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - 'lib/awspec/helper.rb'
+
+Style/StderrPuts:
+  Exclude:
+    - 'lib/awspec/generator/template.rb'
+    - 'lib/awspec/setup.rb'
+
+Style/IfUnlessModifier:
+  Enabled: false

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in awspec.gemspec
 gemspec
+
+# gem 'ox' if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('3.0.0')

data/README.md

@@ -1,11 +1,9 @@
-# awspec [![Gem](https://img.shields.io/gem/v/awspec.svg)](https://rubygems.org/gems/awspec) [![Travis](https://img.shields.io/travis/k1LoW/awspec.svg)](https://travis-ci.org/k1LoW/awspec)
+# awspec [![Gem](https://img.shields.io/gem/v/awspec.svg)](https://rubygems.org/gems/awspec) [![CI](https://github.com/k1LoW/awspec/actions/workflows/ci.yml/badge.svg)](https://github.com/k1LoW/awspec/actions)
 
 ![Logo](./awspec-logo.png)
 
 RSpec tests for your AWS resources.
 
-[![Join the chat at https://gitter.im/k1LoW/awspec](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/k1LoW/awspec?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 [Resource Types](doc/resource_types.md) | [Contributing](doc/contributing.md)
 
 ## Installation

data/Rakefile

@@ -23,7 +23,6 @@ if defined?(RSpec)
                'spec:core',
                'spec:generator_spec',
                'spec:generator_doc',
-               'spec:rubocop',
                'spec:helper']
 
     task type: types

data/awspec.gemspec

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'awspec/version'
 
@@ -21,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1'
+  spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'aws-sdk', '~> 3'
   spec.add_runtime_dependency 'awsecrets', '~> 1'
   spec.add_runtime_dependency 'dry-inflector'
@@ -29,10 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rspec-its'
   spec.add_runtime_dependency 'term-ansicolor'
   spec.add_runtime_dependency 'thor'
-  spec.add_runtime_dependency 'addressable'
   spec.add_development_dependency 'bundler', '>= 1.9', '< 3.0'
   spec.add_development_dependency 'octorelease'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
+  spec.add_development_dependency 'rubocop', '~> 0.57.0'
 end

data/doc/_resource_types/cloudwatch_logs.md

@@ -21,6 +21,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
 

data/doc/_resource_types/eks_nodegroup.md

@@ -5,6 +5,25 @@ describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
   it { should exist }
 end
 ```
+
+### have_security_group
+
+```ruby
+describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should have_security_group('sg-1a2b3cd4') }
+end
+```
+
+### scaling_config
+
+```ruby
+describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
+  its('scaling_config.min_size') { should eq 1 }
+  its('scaling_config.desired_size') { should eq 2 }
+  its('scaling_config.max_size') { should eq 3 }
+end
+```
+
 ### be_active, be_creating
 
 ```ruby
@@ -12,3 +31,37 @@ describe eks('my-eks-nodegroup'), cluster: 'my-cluster' do
   it { should be_active }
 end
 ```
+
+### be_ready
+
+This matcher *might* not be exactly you are expecting: it is different from what
+you can see when looking at the AWS console at the Node Groups configuration
+and check if the nodes Status is "Ready".
+
+What you seeing over there is
+[actually the same thing](https://aws.amazon.com/premiumsupport/knowledge-center/eks-node-status-ready/)
+you would if using `kubectl`.
+
+This matcher cannot do the same because it would involve using the Kubernetes
+API: the AWS Ruby SDK currently doesn't expose this information.
+
+What you can get from `be_ready` matcher is asserting that you have **at least**
+the number of EC2 instances (the nodes in your EKS Node Group) are actually
+in running state. It doesn't mean everything is fine, the node (EC2 instance)
+can be running but without communication with the cluster or any order issue
+regarding the Kubernetes configuration.
+
+Although it might look an incomplete assertion, definitely the Node Group
+"Status" won't be "Active" if the EC2 instances associated with it are not
+running.
+
+So, using this assertion like the sample below:
+
+```ruby
+describe eks('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should be_ready }
+end
+```
+
+Will pass if at least the minimum expected (see `scaling_config`) number of EC2
+instances are running.

data/doc/resource_types.md

@@ -836,7 +836,7 @@ describe directconnect_virtual_interface('my-directconnect-virtual-interface') d
 end
 ```
 
-### its(:owner_account), its(:virtual_interface_id), its(:location), its(:connection_id), its(:virtual_interface_type), its(:virtual_interface_name), its(:vlan), its(:asn), its(:amazon_side_asn), its(:auth_key), its(:amazon_address), its(:customer_address), its(:address_family), its(:virtual_interface_state), its(:customer_router_config), its(:mtu), its(:jumbo_frame_capable), its(:virtual_gateway_id), its(:direct_connect_gateway_id), its(:route_filter_prefixes), its(:bgp_peers), its(:region), its(:aws_device_v2), its(:tags)
+### its(:owner_account), its(:virtual_interface_id), its(:location), its(:connection_id), its(:virtual_interface_type), its(:virtual_interface_name), its(:vlan), its(:asn), its(:amazon_side_asn), its(:auth_key), its(:amazon_address), its(:customer_address), its(:address_family), its(:virtual_interface_state), its(:customer_router_config), its(:mtu), its(:jumbo_frame_capable), its(:virtual_gateway_id), its(:direct_connect_gateway_id), its(:route_filter_prefixes), its(:bgp_peers), its(:region), its(:aws_device_v2), its(:aws_logical_device_id), its(:tags)
 ## <a name="dynamodb_table">dynamodb_table</a>
 
 DynamodbTable resource type.
@@ -1370,9 +1370,53 @@ describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
 end
 ```
 
+
 ### be_active, be_inactive
 
-### its(:nodegroup_name), its(:nodegroup_arn), its(:cluster_name), its(:version), its(:release_version), its(:created_at), its(:modified_at), its(:status), its(:capacity_type), its(:scaling_config), its(:instance_types), its(:subnets), its(:remote_access), its(:ami_type), its(:node_role), its(:labels), its(:taints), its(:resources), its(:disk_size), its(:health), its(:update_config), its(:launch_template), its(:tags)
+### be_ready
+
+This matcher *might* not be exactly you are expecting: it is different from what
+you can see when looking at the AWS console at the Node Groups configuration
+and check if the nodes Status is "Ready".
+
+What you seeing over there is
+[actually the same thing](https://aws.amazon.com/premiumsupport/knowledge-center/eks-node-status-ready/)
+you would if using `kubectl`.
+
+This matcher cannot do the same because it would involve using the Kubernetes
+API: the AWS Ruby SDK currently doesn't expose this information.
+
+What you can get from `be_ready` matcher is asserting that you have **at least**
+the number of EC2 instances (the nodes in your EKS Node Group) are actually
+in running state. It doesn't mean everything is fine, the node (EC2 instance)
+can be running but without communication with the cluster or any order issue
+regarding the Kubernetes configuration.
+
+Although it might look an incomplete assertion, definitely the Node Group
+"Status" won't be "Active" if the EC2 instances associated with it are not
+running.
+
+So, using this assertion like the sample below:
+
+```ruby
+describe eks('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should be_ready }
+end
+```
+
+Will pass if at least the minimum expected (see `scaling_config`) number of EC2
+instances are running.
+
+### have_security_group
+
+```ruby
+describe eks_nodegroup('my-eks-nodegroup'), cluster: 'my-cluster' do
+  it { should have_security_group('sg-1a2b3cd4') }
+end
+```
+
+
+### its(:nodegroup_name), its(:nodegroup_arn), its(:cluster_name), its(:version), its(:release_version), its(:created_at), its(:modified_at), its(:status), its(:capacity_type), its(:instance_types), its(:subnets), its(:remote_access), its(:ami_type), its(:node_role), its(:labels), its(:taints), its(:resources), its(:disk_size), its(:health), its(:update_config), its(:launch_template), its(:tags)
 ## <a name="elasticache">elasticache</a>
 
 Elasticache resource type.
@@ -2573,7 +2617,7 @@ describe network_interface('eni-12ab3cde') do
 end
 ```
 
-### its(:association), its(:availability_zone), its(:description), its(:interface_type), its(:ipv_6_addresses), its(:mac_address), its(:network_interface_id), its(:outpost_arn), its(:owner_id), its(:private_dns_name), its(:private_ip_address), its(:requester_id), its(:requester_managed), its(:source_dest_check), its(:status), its(:subnet_id), its(:vpc_id)
+### its(:association), its(:availability_zone), its(:description), its(:interface_type), its(:ipv_6_addresses), its(:mac_address), its(:network_interface_id), its(:outpost_arn), its(:owner_id), its(:private_dns_name), its(:private_ip_address), its(:ipv_4_prefixes), its(:ipv_6_prefixes), its(:requester_id), its(:requester_managed), its(:source_dest_check), its(:status), its(:subnet_id), its(:vpc_id)
 ## <a name="nlb">nlb</a>
 
 NLB resource type.
@@ -2801,7 +2845,7 @@ end
 ```
 
 
-### its(:vpc_id), its(:db_instance_identifier), its(:db_instance_class), its(:engine), its(:db_instance_status), its(:master_username), its(:db_name), its(:endpoint), its(:allocated_storage), its(:instance_create_time), its(:preferred_backup_window), its(:backup_retention_period), its(:db_security_groups), its(:availability_zone), its(:preferred_maintenance_window), its(:pending_modified_values), its(:latest_restorable_time), its(:multi_az), its(:engine_version), its(:auto_minor_version_upgrade), its(:read_replica_source_db_instance_identifier), its(:read_replica_db_instance_identifiers), its(:read_replica_db_cluster_identifiers), its(:replica_mode), its(:license_model), its(:iops), its(:character_set_name), its(:nchar_character_set_name), its(:secondary_availability_zone), its(:publicly_accessible), its(:status_infos), its(:storage_type), its(:tde_credential_arn), its(:db_instance_port), its(:db_cluster_identifier), its(:storage_encrypted), its(:kms_key_id), its(:dbi_resource_id), its(:ca_certificate_identifier), its(:domain_memberships), its(:copy_tags_to_snapshot), its(:monitoring_interval), its(:enhanced_monitoring_resource_arn), its(:monitoring_role_arn), its(:promotion_tier), its(:db_instance_arn), its(:timezone), its(:iam_database_authentication_enabled), its(:performance_insights_enabled), its(:performance_insights_kms_key_id), its(:performance_insights_retention_period), its(:enabled_cloudwatch_logs_exports), its(:processor_features), its(:deletion_protection), its(:associated_roles), its(:listener_endpoint), its(:max_allocated_storage), its(:tag_list), its(:db_instance_automated_backups_replications), its(:customer_owned_ip_enabled), its(:aws_backup_recovery_point_arn), its(:activity_stream_status), its(:activity_stream_kms_key_id), its(:activity_stream_kinesis_stream_name), its(:activity_stream_mode), its(:activity_stream_engine_native_audit_fields_included)
+### its(:vpc_id), its(:db_instance_identifier), its(:db_instance_class), its(:engine), its(:db_instance_status), its(:automatic_restart_time), its(:master_username), its(:db_name), its(:endpoint), its(:allocated_storage), its(:instance_create_time), its(:preferred_backup_window), its(:backup_retention_period), its(:db_security_groups), its(:availability_zone), its(:preferred_maintenance_window), its(:pending_modified_values), its(:latest_restorable_time), its(:multi_az), its(:engine_version), its(:auto_minor_version_upgrade), its(:read_replica_source_db_instance_identifier), its(:read_replica_db_instance_identifiers), its(:read_replica_db_cluster_identifiers), its(:replica_mode), its(:license_model), its(:iops), its(:character_set_name), its(:nchar_character_set_name), its(:secondary_availability_zone), its(:publicly_accessible), its(:status_infos), its(:storage_type), its(:tde_credential_arn), its(:db_instance_port), its(:db_cluster_identifier), its(:storage_encrypted), its(:kms_key_id), its(:dbi_resource_id), its(:ca_certificate_identifier), its(:domain_memberships), its(:copy_tags_to_snapshot), its(:monitoring_interval), its(:enhanced_monitoring_resource_arn), its(:monitoring_role_arn), its(:promotion_tier), its(:db_instance_arn), its(:timezone), its(:iam_database_authentication_enabled), its(:performance_insights_enabled), its(:performance_insights_kms_key_id), its(:performance_insights_retention_period), its(:enabled_cloudwatch_logs_exports), its(:processor_features), its(:deletion_protection), its(:associated_roles), its(:listener_endpoint), its(:max_allocated_storage), its(:tag_list), its(:db_instance_automated_backups_replications), its(:customer_owned_ip_enabled), its(:aws_backup_recovery_point_arn), its(:activity_stream_status), its(:activity_stream_kms_key_id), its(:activity_stream_kinesis_stream_name), its(:activity_stream_mode), its(:activity_stream_engine_native_audit_fields_included)
 ### :unlock: Advanced use
 
 `rds` can use `Aws::RDS::DBInstance` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/RDS/DBInstance.html).

data/lib/awspec/generator/spec/cloudwatch_logs.rb

@@ -23,7 +23,11 @@ module Awspec::Generator
         metric_filters = select_all_cloudwatch_logs_metric_filter(log_group)
         metric_filter_lines = []
         metric_filters.each do |metric_filter|
-          line = "it { should have_metric_filter('#{metric_filter.filter_name}') }"
+          line = "it { should have_metric_filter('#{metric_filter.filter_name}')"
+          unless metric_filter.filter_pattern.empty?
+            line += ".filter_pattern('#{metric_filter.filter_pattern}')"
+          end
+          line += ' }'
           metric_filter_lines.push(line)
         end
         metric_filter_lines

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

@@ -3,24 +3,48 @@ module Awspec::Helper
     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
+              STDERR.puts "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)

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

@@ -36,7 +36,7 @@ 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 if res.container_instances # rubocop:disable Style/UnneededCondition
       end
 
       alias_method :list_ecs_container_instances, :select_ecs_container_instance_arn_by_cluster_name # deprecated method

data/lib/awspec/matcher.rb

@@ -4,6 +4,9 @@ require 'awspec/matcher/belong_to_subnet'
 require 'awspec/matcher/have_tag'
 require 'awspec/matcher/have_network_interface'
 
+# EKS
+require 'awspec/matcher/belong_to_subnets'
+
 # RDS
 require 'awspec/matcher/belong_to_db_subnet_group'
 require 'awspec/matcher/have_db_parameter_group'
@@ -53,6 +56,7 @@ require 'awspec/matcher/have_rule'
 
 # CloudWatch Logs
 require 'awspec/matcher/have_subscription_filter'
+require 'awspec/matcher/have_metric_filter'
 
 # DynamoDB
 require 'awspec/matcher/have_attribute_definition'

data/lib/awspec/matcher/belong_to_subnets.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :belong_to_subnets do |*subnets|
+  match do |nodegroup|
+    superset = Set.new(subnets)
+    nodegroup.subnets.subset?(superset)
+  end
+  failure_message { |nodegroup| super() + failure_reason(nodegroup) }
+  failure_message_when_negated { |nodegroup| super() + failure_reason(nodegroup) }
+end
+
+private
+
+def failure_reason(nodegroup)
+  ", but the nodes are allocated to the subnets #{nodegroup.subnets.to_a}"
+end

data/lib/awspec/matcher/have_metric_filter.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :have_metric_filter do |filter_name|
+  match do |log_group_name|
+    log_group_name.has_metric_filter?(filter_name, @pattern)
+  end
+
+  chain :filter_pattern do |pattern|
+    @pattern = pattern
+  end
+end

data/lib/awspec/setup.rb

@@ -18,7 +18,7 @@ EOF
       dir = 'spec'
       if File.exist? dir
         unless File.directory? dir
-          $stderr.puts '!! #{dir} already exists and is not a directory'
+          $stderr.puts "!! #{dir} already exists and is not a directory"
         end
       else
         FileUtils.mkdir dir

data/lib/awspec/stub/cloudwatch_logs.rb

@@ -18,7 +18,8 @@ Aws.config[:cloudwatchlogs] = {
     describe_metric_filters: {
       metric_filters: [
         {
-          filter_name: 'my-cloudwatch-logs-metric-filter'
+          filter_name: 'my-cloudwatch-logs-metric-filter',
+          filter_pattern: '[date, error]'
         }
       ]
     },

data/lib/awspec/stub/eks_nodegroup.rb

@@ -9,8 +9,68 @@ Aws.config[:eks] = {
         nodegroup_arn: 'arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/my-nodegroup/08bd000a',
         created_at: Time.parse('2018-10-28 00:23:32 -0400'),
         node_role: 'arn:aws:iam::012345678910:role/eks-nodegroup-role',
-        status: 'ACTIVE'
+        status: 'ACTIVE',
+        scaling_config: { min_size: 1, desired_size: 2, max_size: 3 }
       }
     }
   }
 }
+
+Aws.config[:ec2] = {
+  stub_responses: {
+    describe_instances: {
+      reservations: [
+        {
+          instances: [
+            {
+              instance_id: 'i-ec12345a',
+              image_id: 'ami-abc12def',
+              vpc_id: 'vpc-ab123cde',
+              subnet_id: 'subnet-1234a567',
+              public_ip_address: '123.0.456.789',
+              private_ip_address: '10.0.1.1',
+              instance_type: 't2.small',
+              state: {
+                name: 'running'
+              },
+              security_groups: [
+                {
+                  group_id: 'sg-1a2b3cd4',
+                  group_name: 'my-security-group-name'
+                }
+              ],
+              iam_instance_profile: {
+                arn: 'arn:aws:iam::123456789012:instance-profile/Ec2IamProfileName',
+                id: 'ABCDEFGHIJKLMNOPQRSTU'
+              },
+              block_device_mappings: [
+                {
+                  device_name: '/dev/sda',
+                  ebs: {
+                    volume_id: 'vol-123a123b'
+                  }
+                }
+              ],
+              network_interfaces: [
+                {
+                  network_interface_id: 'eni-12ab3cde',
+                  subnet_id: 'subnet-1234a567',
+                  vpc_id: 'vpc-ab123cde',
+                  attachment: {
+                    device_index: 1
+                  }
+                }
+              ],
+              tags: [
+                {
+                  key: 'Name',
+                  value: 'my-ec2'
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

data/lib/awspec/stub/elasticsearch.rb

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

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/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/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.3'
+  VERSION = '1.24.4'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 1.24.3
+  version: 1.24.4
 platform: ruby
 authors:
 - k1LoW
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-08-09 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
@@ -539,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
@@ -550,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
@@ -750,7 +752,7 @@ homepage: https://github.com/k1LoW/awspec
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -765,8 +767,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: RSpec tests for your AWS resources.
 test_files: []

data/.tachikoma.yml

@@ -1 +0,0 @@
-strategy: 'bundler'

data/.travis.yml

@@ -1,27 +0,0 @@
----
-language: ruby
-env:
-  global:
-    DISABLE_AWS_CLIENT_CHECK: true
-matrix:
-  include:
-    - rvm: 2.7.3
-      env: RUBYGEMS_VERSION=
-    - rvm: 2.6.2
-      env: RUBYGEMS_VERSION=
-    - rvm: 2.5.3
-      env: RUBYGEMS_VERSION=
-    - rvm: 2.4.5
-      env: RUBYGEMS_VERSION=
-    - rvm: 2.3.8
-      env: RUBYGEMS_VERSION=
-    - rvm: 2.2.10
-      env: RUBYGEMS_VERSION=2.7.8
-    - rvm: 2.1.10
-      env: RUBYGEMS_VERSION=2.7.8
-before_install:
-  - gem update --system ${RUBYGEMS_VERSION}
-  - gem pristine bundler
-
-script:
-  - bundle exec rake spec