awspec 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b179910887dad4c07a7dcb3a3964eddd1bd89a5
-  data.tar.gz: '09e960c5431fbf85ed39531e42dee075f46e9e67'
+  metadata.gz: 5326ef5dcbd3e3d0c6d832875aff370eb2319aeb
+  data.tar.gz: 8d619b765a444302e46962d98561b85ccf405672
 SHA512:
-  metadata.gz: 348f694481e7db4994744ffbc6ee94001f10d2132ae6762dc6f2f314e7dbb62d6e30c2e30609f833604c30bcc5d8472c0a972fd94f6d907ac3ed2815dbd6bccb
-  data.tar.gz: 1584f796a4420efa011fdd2f297096e8872f48d473becda49b8dbfce86d896613546c28d9347ebd5b90e7cd31ce1f2d716cbc5b3e5824202b19c274657dc6087
+  metadata.gz: ae0828218096b5bdca15b27fa098efd163cd8264556d0f6028c25dc2765798bc1e61fcf6efb745ebdd7e7d922859928120d6bfc53f1a44f54aeab7851b03cb56
+  data.tar.gz: d99ca40c1655e97f5cf031ce7b2dd13dd083c309d14606f91fbea8db5dcaf4455a815311a74011f198c23d4bd0af985b59e180c9f4160658c21a359c57970fde

data/doc/_resource_types/nlb.md

@@ -0,0 +1,41 @@
+### exist
+
+```ruby
+describe nlb('my-nlb') do
+  it { should exist }
+end
+```
+
+### be_active, be_provisioning, be_failed
+
+```ruby
+describe nlb('my-nlb') do
+  it { should be_active }
+end
+```
+
+### have_security_group
+
+Note that NLBs never have security groups. The have_security_group() function always returns false. See https://forums.aws.amazon.com/thread.jspa?threadID=263245 for discussion about the security-group-less-ness of NLBs.
+
+```ruby
+describe nlb('my-nlb') do
+  it { should_not have_security_group('sg-1a2b3cd4') }
+end
+```
+
+### have_subnet
+
+```ruby
+describe nlb('my-nlb') do
+  it { should have_subnet('subnet-1234a567') }
+end
+```
+
+### belong_to_vpc
+
+```ruby
+describe nlb('my-nlb') do
+  it { should belong_to_vpc('my-vpc') }
+end
+```

data/doc/_resource_types/nlb_listener.md

@@ -0,0 +1,29 @@
+### exist
+
+```ruby
+describe nlb_listener('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2') do
+  it { should exist }
+  its(:port) { should eq 80 }
+  its(:protocol) { should eq 'HTTP' }
+end
+```
+
+### have_rule
+
+```ruby
+describe nlb_listener('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2') do
+  it { should have_rule('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener-rule/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2/9683b2d02a6cabee') }
+  it do
+    should have_rule.priority('10')
+      .conditions(field: 'path-pattern', values: ['/img/*'])
+      .actions(target_group_arn: 'arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:123456789012:targetgroup/73e2d6bc24d8a067/73e2d6bc24d8a067', type: 'forward')
+  end
+  it do
+    should have_rule.priority('10')
+      .if(field: 'path-pattern', values: ['/img/*'])
+      .then(target_group_arn: 'arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:123456789012:targetgroup/73e2d6bc24d8a067/73e2d6bc24d8a067', type: 'forward')
+  end
+  it { should have_rule.conditions([{ field: 'path-pattern', values: ['/admin/*'] }, { field: 'host-header', values: ['admin.example.com'] }]) }
+  it { should have_rule.actions(target_group_name: 'my-nlb-target-group', type: 'forward') }
+end
+```

data/doc/_resource_types/nlb_target_group.md

@@ -0,0 +1,35 @@
+### exist
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should exist }
+  its(:health_check_path) { should eq '/' }
+  its(:health_check_port) { should eq 'traffic-port' }
+  its(:health_check_protocol) { should eq 'HTTP' }
+end
+```
+
+### have_ec2
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should have_ec2('my-ec2') }
+end
+```
+
+### belong_to_nlb
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should belong_to_nlb('my-nlb') }
+end
+```
+
+### belong_to_vpc
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should belong_to_vpc('my-vpc') }
+end
+```
+

data/doc/resource_types.md

@@ -40,6 +40,9 @@
 | [nat_gateway](#nat_gateway)
 | [network_acl](#network_acl)
 | [network_interface](#network_interface)
+| [nlb](#nlb)
+| [nlb_listener](#nlb_listener)
+| [nlb_target_group](#nlb_target_group)
 | [rds](#rds)
 | [rds_db_cluster_parameter_group](#rds_db_cluster_parameter_group)
 | [rds_db_parameter_group](#rds_db_parameter_group)
@@ -279,6 +282,8 @@ end
 ```
 
 
+### have_nlb_target_group
+
 ### have_suspended_process
 
 ### have_tag
@@ -957,7 +962,7 @@ describe ecs_service('my-ecs-service') do
 end
 ```
 
-### its(:service_arn), its(:service_name), its(:cluster_arn), its(:load_balancers), its(:status), its(:desired_count), its(:running_count), its(:pending_count), its(:launch_type), its(:platform_version), its(:task_definition), its(:role_arn), its(:created_at), its(:placement_constraints), its(:placement_strategy), its(:network_configuration)
+### its(:service_arn), its(:service_name), its(:cluster_arn), its(:load_balancers), its(:status), its(:desired_count), its(:running_count), its(:pending_count), its(:launch_type), its(:platform_version), its(:task_definition), its(:role_arn), its(:created_at), its(:placement_constraints), its(:placement_strategy), its(:network_configuration), its(:health_check_grace_period_seconds)
 ## <a name="ecs_task_definition">ecs_task_definition</a>
 
 ECS Task Definition resource type.
@@ -1670,7 +1675,7 @@ end
 
 This matcher does not support Amazon S3 event sources. ( [See SDK doc](http://docs.aws.amazon.com/sdkforruby/api/Aws/Lambda/Client.html#list_event_source_mappings-instance_method) )
 
-### its(:function_name), its(:function_arn), its(:runtime), its(:role), its(:handler), its(:code_size), its(:description), its(:timeout), its(:memory_size), its(:last_modified), its(:code_sha_256), its(:version), its(:vpc_config), its(:dead_letter_config), its(:environment), its(:kms_key_arn), its(:tracing_config), its(:master_arn)
+### its(:function_name), its(:function_arn), its(:runtime), its(:role), its(:handler), its(:code_size), its(:description), its(:timeout), its(:memory_size), its(:last_modified), its(:code_sha_256), its(:version), its(:vpc_config), its(:dead_letter_config), its(:environment), its(:kms_key_arn), its(:tracing_config), its(:master_arn), its(:revision_id)
 ## <a name="launch_configuration">launch_configuration</a>
 
 LaunchConfiguration resource type.
@@ -1886,6 +1891,137 @@ end
 ```
 
 ### its(:association), its(:availability_zone), its(:description), its(:interface_type), its(:ipv_6_addresses), its(:mac_address), its(:network_interface_id), 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)
+## <a name="nlb">nlb</a>
+
+NLB resource type.
+
+### exist
+
+```ruby
+describe nlb('my-nlb') do
+  it { should exist }
+end
+```
+
+
+### be_active, be_provisioning, be_failed
+
+```ruby
+describe nlb('my-nlb') do
+  it { should be_active }
+end
+```
+
+
+### have_security_group
+
+Note that NLBs never have security groups. The have_security_group() function always returns false. See https://forums.aws.amazon.com/thread.jspa?threadID=263245 for discussion about the security-group-less-ness of NLBs.
+
+```ruby
+describe nlb('my-nlb') do
+  it { should_not have_security_group('sg-1a2b3cd4') }
+end
+```
+
+
+### have_subnet
+
+```ruby
+describe nlb('my-nlb') do
+  it { should have_subnet('subnet-1234a567') }
+end
+```
+
+
+### belong_to_vpc
+
+```ruby
+describe nlb('my-nlb') do
+  it { should belong_to_vpc('my-vpc') }
+end
+```
+
+### its(:load_balancer_arn), its(:dns_name), its(:canonical_hosted_zone_id), its(:created_time), its(:load_balancer_name), its(:scheme), its(:vpc_id), its(:type), its(:security_groups), its(:ip_address_type)
+## <a name="nlb_listener">nlb_listener</a>
+
+NlbListener resource type.
+
+### exist
+
+```ruby
+describe nlb_listener('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2') do
+  it { should exist }
+  its(:port) { should eq 80 }
+  its(:protocol) { should eq 'HTTP' }
+end
+```
+
+
+### have_rule
+
+```ruby
+describe nlb_listener('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2') do
+  it { should have_rule('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener-rule/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2/9683b2d02a6cabee') }
+  it do
+    should have_rule.priority('10')
+      .conditions(field: 'path-pattern', values: ['/img/*'])
+      .actions(target_group_arn: 'arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:123456789012:targetgroup/73e2d6bc24d8a067/73e2d6bc24d8a067', type: 'forward')
+  end
+  it do
+    should have_rule.priority('10')
+      .if(field: 'path-pattern', values: ['/img/*'])
+      .then(target_group_arn: 'arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:123456789012:targetgroup/73e2d6bc24d8a067/73e2d6bc24d8a067', type: 'forward')
+  end
+  it { should have_rule.conditions([{ field: 'path-pattern', values: ['/admin/*'] }, { field: 'host-header', values: ['admin.example.com'] }]) }
+  it { should have_rule.actions(target_group_name: 'my-nlb-target-group', type: 'forward') }
+end
+```
+
+### its(:listener_arn), its(:load_balancer_arn), its(:port), its(:protocol), its(:certificates), its(:ssl_policy)
+## <a name="nlb_target_group">nlb_target_group</a>
+
+NlbTargetGroup resource type.
+
+### exist
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should exist }
+  its(:health_check_path) { should eq '/' }
+  its(:health_check_port) { should eq 'traffic-port' }
+  its(:health_check_protocol) { should eq 'HTTP' }
+end
+```
+
+
+### have_ec2
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should have_ec2('my-ec2') }
+end
+```
+
+
+### belong_to_nlb
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should belong_to_nlb('my-nlb') }
+end
+```
+
+
+### belong_to_vpc
+
+```ruby
+describe nlb_target_group('my-nlb-target-group') do
+  it { should belong_to_vpc('my-vpc') }
+end
+```
+
+
+### its(:target_group_arn), its(:target_group_name), its(:protocol), its(:port), its(:vpc_id), its(:health_check_protocol), its(:health_check_port), its(:health_check_interval_seconds), its(:health_check_timeout_seconds), its(:healthy_threshold_count), its(:unhealthy_threshold_count), its(:health_check_path), its(:load_balancer_arns), its(:target_type)
 ## <a name="rds">rds</a>
 
 RDS resource type.
@@ -1974,7 +2110,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(:license_model), its(:iops), its(: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(: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(:license_model), its(:iops), its(: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(:enabled_cloudwatch_logs_exports)
 ### :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/command/generate.rb

@@ -8,7 +8,7 @@ module Awspec
     class_option :secrets_path
 
     types = %w(
-      vpc ec2 rds security_group elb network_acl route_table subnet nat_gateway network_interface alb
+      vpc ec2 rds security_group elb network_acl route_table subnet nat_gateway network_interface alb nlb
       internet_gateway
     )
 
@@ -36,6 +36,18 @@ module Awspec
       end
     end
 
+    types = %w(
+      rds_db_parameter_group rds_db_cluster_parameter_group
+    )
+
+    types.each do |type|
+      desc type + ' [paramater_name]', "Generate #{type} spec from paramater name."
+      define_method type do |_paramater_name|
+        Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+        eval "puts Awspec::Generator::Spec::#{type.camelize}.new.generate_by_paramater_group(_paramater_name)"
+      end
+    end
+
     types_for_generate_all = %w(
       cloudwatch_alarm cloudwatch_event directconnect ebs efs
       elasticsearch iam_group iam_policy iam_role iam_user kms lambda

data/lib/awspec/generator.rb

@@ -25,9 +25,12 @@ require 'awspec/generator/spec/iam_role'
 require 'awspec/generator/spec/acm'
 require 'awspec/generator/spec/cloudwatch_logs'
 require 'awspec/generator/spec/alb'
+require 'awspec/generator/spec/nlb'
 require 'awspec/generator/spec/internet_gateway'
 require 'awspec/generator/spec/elasticsearch'
 require 'awspec/generator/spec/eip'
+require 'awspec/generator/spec/rds_db_parameter_group'
+require 'awspec/generator/spec/rds_db_cluster_parameter_group'
 
 # Doc
 require 'awspec/generator/doc/type'

data/lib/awspec/generator/doc/type/nlb.rb

@@ -0,0 +1,20 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Nlb < Base
+        def initialize
+          super
+          @type_name = 'NLB'
+          @type = Awspec::Type::Nlb.new('my-nlb')
+          @ret = @type.resource_via_client
+          @matchers = [
+            Awspec::Type::Nlb::STATES.map { |state| 'be_' + state }.join(', '),
+            'belong_to_vpc'
+          ]
+          @ignore_matchers = Awspec::Type::Nlb::STATES.map { |state| 'be_' + state }
+          @describes = []
+        end
+      end
+    end
+  end
+end

data/lib/awspec/generator/doc/type/nlb_listener.rb

@@ -0,0 +1,18 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class NlbListener < Base
+        # rubocop:disable Metrics/LineLength
+        def initialize
+          super
+          @type_name = 'NlbListener'
+          @type = Awspec::Type::NlbListener.new('arn:aws:elasticloadbalancing:ap-northeast-1:1234567890:listener/app/my-nlb/1aa1bb1cc1ddee11/f2f7dc8efc522ab2')
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

data/lib/awspec/generator/doc/type/nlb_target_group.rb

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class NlbTargetGroup < Base
+        def initialize
+          super
+          @type_name = 'NlbTargetGroup'
+          @type = Awspec::Type::NlbTargetGroup.new('my-nlb-target-group')
+          @ret = @type.resource_via_client
+          @matchers = %w(belong_to_nlb belong_to_vpc)
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Awspec::Generator
+  module Spec
+    class Nlb
+      include Awspec::Helper::Finder
+      def generate_by_vpc_id(vpc_id)
+        describes = %w(
+          load_balancer_name
+        )
+        vpc = find_vpc(vpc_id)
+        raise 'Not Found VPC' unless vpc
+        @vpc_id = vpc[:vpc_id]
+        @vpc_tag_name = vpc.tag_name
+        nlbs = select_nlb_by_vpc_id(@vpc_id)
+
+        specs = nlbs.map do |nlb|
+          content = ERB.new(nlb_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+        end
+        specs.join("\n")
+      end
+
+      def nlb_spec_template
+        template = <<-'EOF'
+describe nlb('<%= nlb.load_balancer_name %>') do
+  it { should exist }
+  its(:load_balancer_arn) { should eq '<%= nlb.load_balancer_arn %>' }
+  its(:dns_name) { should eq '<%= nlb.dns_name %>' }
+  its(:load_balancer_name) { should eq '<%= nlb.load_balancer_name %>' }
+  its(:scheme) { should eq '<%= nlb.scheme %>' }
+  its(:vpc_id) { should eq '<%= nlb.vpc_id %>' }
+  its(:type) { should eq '<%= nlb.type %>' }
+  its(:ip_address_type) { should eq '<%= nlb.ip_address_type %>' }
+end
+EOF
+        template
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Awspec::Generator
+  module Spec
+    class RdsDbClusterParameterGroup
+      include Awspec::Helper::Finder
+      def generate_by_paramater_group(paramater_group)
+        @paramater_group = paramater_group
+        res = select_all_rds_db_cluster_parameters(@paramater_group)
+        ERB.new(db_cluster_parameter_group_template, nil, '-').result(binding).gsub(/^\n/, '')
+      end
+
+      def db_cluster_parameter_group_template
+        template = <<-'EOF'
+describe rds_db_cluster_parameter_group('<%= @paramater_group %>') do
+<% res.each do |key, value| %>
+  its('<%= key %>') { should eq '<%= value %>' }
+<% end %>
+end
+EOF
+        template
+      end
+    end
+  end
+end