awspec 1.24.1 → 1.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbb248dd9ff83f422a5d62d6463be302ee629861e3a29ebfb3b062313ccca4f
-  data.tar.gz: 14fb693105dafceb27095c0ec2af853422f5ed92ee877a69df66a4679a6acad1
+  metadata.gz: 846285926375fd9f812d6110b9b6f82918a1cd217dde0b51e3e87694fa39861c
+  data.tar.gz: b9b0d5c955add005d788b35ace982d75a74843cb8bb0c4cc86cbf931bb6cb68e
 SHA512:
-  metadata.gz: 4d580f1de54fd8a7b5106d83f4b5b7320f2679d5eb58ef6d73009fb340bc7a0193b78f4f10d16601d9dacb5658a94936efd0af40699ef781229eef54c645e7f3
-  data.tar.gz: bf0f3fa1ab69f5945307284f1b3460bfadb9571c892601418dbfaee6536cd4269fdbc4b1c1631b438098dace53aeb49bdaa59773bc03d759ee3c709970c5b235
+  metadata.gz: 6d2af549c10d9e3634e6e7ff809b6bb3a5518dc3a9ae52e70963718a19aa2731cd274b9bbbba614989b49253eb85e4f806487692c7a7f72c7135dda58162fb5b
+  data.tar.gz: 0aa25037fc049461e9558c57af0b7f6ab02b70cb43b4637496edfb7715704d8abd821b2f52bebc7a4a2ea3bf6ba95d5d9034102084667d249dce7f8584ee8a97

data/.travis.yml

@@ -1,4 +1,8 @@
+---
 language: ruby
+env:
+  global:
+    DISABLE_AWS_CLIENT_CHECK: true
 matrix:
   include:
     - rvm: 2.7.3

data/README.md

@@ -32,7 +32,7 @@ If you're starting on a fresh RSpec project, you can use awspec to generate your
 
     $ awspec init
 
-If you're working on an exisitng RSpec project, you will need to add the following lines to your `spec_helper.rb` file:
+If you're working on an existing RSpec project, you will need to add the following lines to your `spec_helper.rb` file:
 
 ```ruby
 require 'awspec'

data/doc/resource_types.md

@@ -273,7 +273,7 @@ end
 
 ### have_tag
 
-### its(:architecture), its(:creation_date), its(:image_id), its(:image_location), its(:image_type), its(:public), its(:kernel_id), its(:owner_id), its(:platform), its(:platform_details), its(:usage_operation), its(:ramdisk_id), its(:state), its(:description), its(:ena_support), its(:hypervisor), its(:image_owner_alias), its(:name), its(:root_device_name), its(:root_device_type), its(:sriov_net_support), its(:state_reason), its(:virtualization_type), its(:boot_mode)
+### its(:architecture), its(:creation_date), its(:image_id), its(:image_location), its(:image_type), its(:public), its(:kernel_id), its(:owner_id), its(:platform), its(:platform_details), its(:usage_operation), its(:ramdisk_id), its(:state), its(:description), its(:ena_support), its(:hypervisor), its(:image_owner_alias), its(:name), its(:root_device_name), its(:root_device_type), its(:sriov_net_support), its(:state_reason), its(:virtualization_type), its(:boot_mode), its(:deprecation_time)
 ### :unlock: Advanced use
 
 `ami` can use `Aws::EC2::Image` resource (see http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Image.html).
@@ -360,7 +360,7 @@ describe autoscaling_group('my-auto-scaling-group') do
 end
 ```
 
-### its(:auto_scaling_group_name), its(:auto_scaling_group_arn), its(:launch_configuration_name), its(:launch_template), its(:mixed_instances_policy), its(:min_size), its(:max_size), its(:desired_capacity), its(:default_cooldown), its(:availability_zones), its(:load_balancer_names), its(:target_group_arns), its(:health_check_type), its(:health_check_grace_period), its(:created_time), its(:placement_group), its(:vpc_zone_identifier), its(:enabled_metrics), its(:status), its(:termination_policies), its(:new_instances_protected_from_scale_in), its(:service_linked_role_arn), its(:max_instance_lifetime), its(:capacity_rebalance), its(:warm_pool_configuration), its(:warm_pool_size)
+### its(:auto_scaling_group_name), its(:auto_scaling_group_arn), its(:launch_configuration_name), its(:launch_template), its(:mixed_instances_policy), its(:min_size), its(:max_size), its(:desired_capacity), its(:predicted_capacity), its(:default_cooldown), its(:availability_zones), its(:load_balancer_names), its(:target_group_arns), its(:health_check_type), its(:health_check_grace_period), its(:created_time), its(:placement_group), its(:vpc_zone_identifier), its(:enabled_metrics), its(:status), its(:termination_policies), its(:new_instances_protected_from_scale_in), its(:service_linked_role_arn), its(:max_instance_lifetime), its(:capacity_rebalance), its(:warm_pool_configuration), its(:warm_pool_size), its(:context)
 ## <a name="batch_compute_environment">batch_compute_environment</a>
 
 BatchComputeEnvironment resource type.
@@ -1372,7 +1372,7 @@ 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(:resources), its(:disk_size), its(:health), its(:launch_template), its(:tags)
+### 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)
 ## <a name="elasticache">elasticache</a>
 
 Elasticache resource type.
@@ -2178,7 +2178,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(: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)
 ## <a name="lambda">lambda</a>
 
 Lambda resource type.
@@ -2422,7 +2422,7 @@ end
 ```
 
 
-### its(:create_time), its(:delete_time), its(:failure_code), its(:failure_message), its(:nat_gateway_id), its(:provisioned_bandwidth), its(:state), its(:subnet_id), its(:vpc_id)
+### its(:create_time), its(:delete_time), its(:failure_code), its(:failure_message), its(:nat_gateway_id), its(:provisioned_bandwidth), its(:state), its(:subnet_id), its(:vpc_id), its(:connectivity_type)
 ## <a name="network_acl">network_acl</a>
 
 NetworkAcl resource type.
@@ -2801,7 +2801,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(: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)
 ### :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/helper/finder.rb

@@ -166,6 +166,12 @@ module Awspec::Helper
       http_wire_trace: ENV['http_wire_trace'] || false
     }
 
+    check_configuration = ENV['DISABLE_AWS_CLIENT_CHECK'] != 'true' if ENV.key?('DISABLE_AWS_CLIENT_CHECK')
+
+    # define_method below will "hide" any exception that comes from bad
+    # setup of AWS client, so let's try first to create a instance
+    Awsecrets.load if check_configuration
+
     CLIENTS.each do |method_name, client|
       define_method method_name do
         unless self.methods.include? "@#{method_name}"

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

@@ -7,15 +7,16 @@ module Awspec::Helper
           res = ec2_client.describe_instances({
                                                 instance_ids: [id]
                                               })
-        rescue
-          # Aws::EC2::Errors::InvalidInstanceIDMalformed
-          # Aws::EC2::Errors::InvalidInstanceIDNotFound
+        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 == 1
+
+        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}"

data/lib/awspec/helper/states.rb

@@ -0,0 +1,16 @@
+module Awspec::Helper
+  module States
+    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('-', '_') + '?'
+          yielder.yield(method_name, EC2_STATES[n])
+          n += 1
+        end
+      end.lazy
+    end
+  end
+end

data/lib/awspec/stub/ec2_non_existing.rb

@@ -0,0 +1,7 @@
+Aws.config[:ec2] = {
+  stub_responses: {
+    describe_instances: {
+      reservations: []
+    }
+  }
+}

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 1.24.1
+  version: 1.24.2
 platform: ruby
 authors:
 - k1LoW
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -518,6 +518,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
@@ -593,6 +594,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