awspec 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b09fcc32e566dab95cb91a15aeebfc830f78e251faa9d35301cf6f9ee1bdbed
-  data.tar.gz: 716542189697ce5194df4fb4ea4089a4a04ab673dd9e55a301e13f5811559dea
+  metadata.gz: 733ec333dd6c4035c558544facf4cf168c74f528c2fd133aa2b89532dcc95a0f
+  data.tar.gz: 7f31ead68d437f29da2948decfd77ac92c8ce9b2e97c60fe5d6346d1a8889f72
 SHA512:
-  metadata.gz: 74e05e9c7fa42a71b976303d3bca7ce40b4f09a405c90154eef6bca0bb0414b8f0e2f11d1365fa4804b236b5cae9c94c8db2230dba9f6f66c33078655028ffb6
-  data.tar.gz: a93291cfbe411970f28e3d51a73bb13b68955194a35f4ac8c51def81ad25ceb9609fe99247024ff6e1212294d6b795e649b59ff65a886ee315e507fd8c31deed
+  metadata.gz: fcd55db64d1b79dd6c81cb8afab7196b6bacc59a0739530192ee3fc38ecef812873d7ab7c9def4fc91991a2e0e8aba70bda5d79b6781f1bd548df6ef168d85ec
+  data.tar.gz: a767de714ea4be5c6e8fbaf5bfd9d520f759750129fe35bae3915cf5811526cbd090d69c93d321856164a053c71c65ad4d115030591c41f6e45a506a5a60f92f

data/doc/_resource_types/rds_proxy.md

@@ -0,0 +1,42 @@
+### exist
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should exist }
+end
+```
+
+### be_available, be_creating, be_deleting, be_incompatible_network, be_insufficient_resource_limits, be_modifying, be_reactivating, be_suspended, be_suspending
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should be_available }
+end
+```
+
+### have_security_group
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should have_security_group('sg-5a6b7cd8') }
+  it { should have_security_group('my-db-sg') }
+end
+```
+
+### belong_to_subnet
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should belong_to_subnet('subnet-8901b123') }
+  it { should belong_to_subnet('db-subnet-a') }
+end
+```
+
+### belong_to_vpc
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should belong_to_vpc('vpc-ab123cde') }
+  it { should belong_to_vpc('my-vpc') }
+end
+```

data/doc/resource_types.md

@@ -63,6 +63,7 @@
 | [rds](#rds)
 | [rds_db_cluster_parameter_group](#rds_db_cluster_parameter_group)
 | [rds_db_parameter_group](#rds_db_parameter_group)
+| [rds_proxy](#rds_proxy)
 | [redshift](#redshift)
 | [redshift_cluster_parameter_group](#redshift_cluster_parameter_group)
 | [route53_hosted_zone](#route53_hosted_zone)
@@ -2915,6 +2916,58 @@ end
 ```
 
 
+## <a name="rds_proxy">rds_proxy</a>
+
+RdsProxy resource type.
+
+### exist
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should exist }
+end
+```
+
+
+### be_available, be_creating, be_deleting, be_incompatible_network, be_insufficient_resource_limits, be_modifying, be_reactivating, be_suspended, be_suspending
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should be_available }
+end
+```
+
+
+### have_security_group
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should have_security_group('sg-5a6b7cd8') }
+  it { should have_security_group('my-db-sg') }
+end
+```
+
+
+### belong_to_subnet
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should belong_to_subnet('subnet-8901b123') }
+  it { should belong_to_subnet('db-subnet-a') }
+end
+```
+
+
+### belong_to_vpc
+
+```ruby
+describe rds_proxy('my-rds-proxy') do
+  it { should belong_to_vpc('vpc-ab123cde') }
+  it { should belong_to_vpc('my-vpc') }
+end
+```
+
+### its(:vpc_id), its(:db_proxy_name), its(:db_proxy_arn), its(:status), its(:engine_family), its(:vpc_id), its(:vpc_security_group_ids), its(:vpc_subnet_ids), its(:role_arn), its(:endpoint), its(:require_tls), its(:idle_client_timeout), its(:debug_logging), its(:created_date), its(:updated_date)
 ## <a name="redshift">redshift</a>
 
 Redshift resource type.

data/lib/awspec/command/generate.rb

@@ -11,7 +11,7 @@ module Awspec
 
     types = %w[
       vpc ec2 rds security_group elb network_acl route_table subnet nat_gateway network_interface alb nlb
-      internet_gateway autoscaling_group alb_listener nlb_listener redshift
+      internet_gateway autoscaling_group alb_listener nlb_listener redshift rds_proxy
     ]
 
     types.each do |type|

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Awspec::Generator
+  module Doc
+    module Type
+      class RdsProxy < Base
+        def initialize
+          super
+          @type_name = 'RdsProxy'
+          @type = Awspec::Type::RdsProxy.new('my-rds-proxy')
+          @ret = @type.resource_via_client
+          @matchers = [
+            Awspec::Type::RdsProxy::STATES.map { |state| "be_#{state.tr('-', '_')}" }.join(', '),
+            'belong_to_vpc',
+            'belong_to_subnet'
+          ]
+          @ignore_matchers = Awspec::Type::RdsProxy::STATES.map { |state| "be_#{state.tr('-', '_')}" }
+          @describes = %w[vpc_id]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Awspec::Generator
+  module Spec
+    class RdsProxy
+      include Awspec::Helper::Finder
+      def generate_by_vpc_id(vpc_id)
+        vpc = find_vpc(vpc_id)
+        raise 'Not Found VPC' unless vpc
+
+        @vpc_id = vpc[:vpc_id]
+        db_proxies = select_rds_proxy_by_vpc_id(@vpc_id)
+        specs = db_proxies.map do |db_proxy|
+          content = ERB.new(rds_proxy_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+        end
+        specs.join("\n")
+      end
+
+      # rubocop:disable all
+      def rds_proxy_spec_template
+        template = <<-'EOF'
+describe rds_proxy('<%= db_proxy.db_proxy_name %>') do
+  it { should exist }
+  it { should be_<%= db_proxy.status %> }
+  it { should belong_to_vpc('<%= @vpc_id %>') }
+<% db_proxy.vpc_security_group_ids.each do |sg_group_id| %>
+  it { should have_security_group('<%= sg_group_id %>') }
+<% end %>
+<% db_proxy.vpc_subnet_ids.each do |subnet_id| %>
+  it { should belong_to_subnet('<%= subnet_id %>') }
+<% end %>
+end
+EOF
+        template
+      end
+    end
+  end
+end

data/lib/awspec/generator.rb

@@ -40,6 +40,7 @@ require 'awspec/generator/spec/alb_listener'
 require 'awspec/generator/spec/nlb_listener'
 require 'awspec/generator/spec/redshift'
 require 'awspec/generator/spec/redshift_cluster_parameter_group'
+require 'awspec/generator/spec/rds_proxy'
 
 # Doc
 require 'awspec/generator/doc/type'

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

@@ -57,6 +57,20 @@ module Awspec::Helper
         end
         parameters
       end
+
+      def find_rds_proxy(db_proxy_name)
+        res = rds_client.describe_db_proxies({
+                                               db_proxy_name: db_proxy_name
+                                             })
+        res.db_proxies.single_resource(db_proxy_name)
+      end
+
+      def select_rds_proxy_by_vpc_id(vpc_id)
+        res = rds_client.describe_db_proxies
+        res.db_proxies.select do |db_proxy|
+          db_proxy.vpc_id == vpc_id
+        end
+      end
     end
   end
 end

data/lib/awspec/helper/type.rb

@@ -17,7 +17,7 @@ module Awspec
         efs eks eks_nodegroup elasticache elasticache_cache_parameter_group elasticsearch elb emr firehose iam_group
         iam_policy iam_role iam_user kinesis kms lambda launch_configuration launch_template mq nat_gateway
         network_acl network_interface nlb nlb_listener nlb_target_group
-        rds rds_db_cluster_parameter_group rds_db_parameter_group route53_hosted_zone
+        rds rds_proxy rds_db_cluster_parameter_group rds_db_parameter_group route53_hosted_zone
         route_table s3_bucket security_group ses_identity subnet vpc cloudfront_distribution
         elastictranscoder_pipeline waf_web_acl wafregional_web_acl customer_gateway vpn_gateway vpn_connection
         internet_gateway acm cloudwatch_logs dynamodb_table eip sqs ssm_parameter cloudformation_stack

data/lib/awspec/matcher/belong_to_subnet.rb

@@ -32,5 +32,22 @@ RSpec::Matchers.define :belong_to_subnet do |subnet_id|
 
       return ret[:subnet_availability_zone][:name] == type.availability_zone if ret
     end
+
+    # RDS Proxy
+    if type.instance_of?(Awspec::Type::RdsProxy)
+      subnet_ids = type.resource_via_client[:vpc_subnet_ids]
+      return true if subnet_ids.include?(subnet_id)
+
+      res = type.ec2_client.describe_subnets({
+                                               filters: [{ name: 'tag:Name', values: [subnet_id] }]
+                                             })
+      return false unless res
+
+      ret = subnet_ids.find do |s|
+        s == res[:subnets][0][:subnet_id]
+      end
+
+      return ret ? true : false
+    end
   end
 end

data/lib/awspec/stub/rds_proxy.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+Aws.config[:rds] = {
+  stub_responses: {
+    describe_db_proxies: {
+      db_proxies: [
+        {
+          db_proxy_name: 'my-rds-proxy',
+          db_proxy_arn: 'arn:aws:rds:ap-northeast-1:123456789012:db-proxy:my-rds-proxy',
+          status: 'available',
+          engine_family: 'MYSQL',
+          vpc_id: 'vpc-ab123cde',
+          vpc_security_group_ids: [
+            'sg-5a6b7cd8'
+          ],
+          vpc_subnet_ids: [
+            'subnet-8901b123'
+          ],
+          auth: [
+            {
+              description: nil,
+              user_name: nil,
+              auth_scheme: 'SECRETS',
+              secret_arn: 'arn:aws:secretsmanager:ap-northeast-1:123456789012:secret:mysql-FShJ8c',
+              iam_auth: 'DISABLED'
+            }
+          ],
+          role_arn: 'arn:aws:iam::123456789012:role/service-role/rds-proxy-role-123456789012',
+          endpoint: 'rds-proxy.proxy-abcdefghij12.ap-northeast-1.rds.amazonaws.com',
+          require_tls: true,
+          idle_client_timeout: 5400,
+          debug_logging: false,
+          created_date: Time.local(2022),
+          updated_date: Time.local(2022)
+        }
+      ],
+      marker: nil
+    }
+  }
+}
+
+Aws.config[:ec2] = {
+  stub_responses: {
+    describe_vpcs: {
+      vpcs: [
+        {
+          vpc_id: 'vpc-ab123cde',
+          tags: [
+            {
+              key: 'Name',
+              value: 'my-vpc'
+            }
+          ]
+        }
+      ]
+    },
+    describe_security_groups: {
+      security_groups: [
+        {
+          group_id: 'sg-5a6b7cd8',
+          group_name: 'group-name-sg',
+          tags: [
+            {
+              key: 'Name',
+              value: 'my-db-sg'
+            }
+          ]
+        }
+      ]
+    },
+    describe_subnets: {
+      subnets: [
+        {
+          subnet_id: 'subnet-8901b123',
+          tags: [
+            {
+              key: 'Name',
+              value: 'db-subnet-a'
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

data/lib/awspec/type/rds_proxy.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Awspec::Type
+  class RdsProxy < ResourceBase
+    aws_resource Aws::RDS::Types::DBProxy
+
+    def resource_via_client
+      @resource_via_client ||= find_rds_proxy(@display_name)
+    end
+
+    def id
+      @id ||= resource_via_client.db_proxy_name if resource_via_client
+    end
+
+    STATES = %w[
+      available creating deleting incompatible-network
+      insufficient-resource-limits modifying reactivating
+      suspended suspending
+    ]
+
+    STATES.each do |state|
+      define_method "#{state.tr('-', '_')}?" do
+        resource_via_client.status == state
+      end
+    end
+
+    def vpc_id
+      resource_via_client.vpc_id
+    end
+
+    def has_security_group?(sg_id)
+      return true if has_vpc_security_group_id?(sg_id)
+      return true if has_vpc_security_group_name?(sg_id)
+      return true if has_vpc_security_group_tag_name?(sg_id)
+    end
+
+    private
+
+    def has_vpc_security_group_id?(sg_id)
+      resource_via_client.vpc_security_group_ids.include?(sg_id)
+    end
+
+    def has_vpc_security_group_name?(sg_id)
+      sgs = resource_via_client.vpc_security_group_ids
+      res = ec2_client.describe_security_groups({
+                                                  filters: [{ name: 'group-name', values: [sg_id] }]
+                                                })
+      return false unless res.security_groups.count == 1
+
+      sgs.find do |sg|
+        sg == res.security_groups.first.group_id
+      end
+    end
+
+    def has_vpc_security_group_tag_name?(sg_id)
+      sgs = resource_via_client.vpc_security_group_ids
+      res = ec2_client.describe_security_groups({
+                                                  filters: [{ name: 'tag:Name', values: [sg_id] }]
+                                                })
+      return false unless res.security_groups.count == 1
+
+      sgs.find do |sg|
+        sg == res.security_groups.first.group_id
+      end
+    end
+  end
+end

data/lib/awspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Awspec
-  VERSION = '1.26.0'
+  VERSION = '1.27.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - k1LoW
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -311,6 +311,7 @@ files:
 - doc/_resource_types/rds_account_attributes.md
 - doc/_resource_types/rds_db_cluster_parameter_group.md
 - doc/_resource_types/rds_db_parameter_group.md
+- doc/_resource_types/rds_proxy.md
 - doc/_resource_types/redshift.md
 - doc/_resource_types/redshift_cluster_parameter_group.md
 - doc/_resource_types/route53_hosted_zone.md
@@ -417,6 +418,7 @@ files:
 - lib/awspec/generator/doc/type/rds_account_attributes.rb
 - lib/awspec/generator/doc/type/rds_db_cluster_parameter_group.rb
 - lib/awspec/generator/doc/type/rds_db_parameter_group.rb
+- lib/awspec/generator/doc/type/rds_proxy.rb
 - lib/awspec/generator/doc/type/redshift.rb
 - lib/awspec/generator/doc/type/redshift_cluster_parameter_group.rb
 - lib/awspec/generator/doc/type/route53_hosted_zone.rb
@@ -469,6 +471,7 @@ files:
 - lib/awspec/generator/spec/rds.rb
 - lib/awspec/generator/spec/rds_db_cluster_parameter_group.rb
 - lib/awspec/generator/spec/rds_db_parameter_group.rb
+- lib/awspec/generator/spec/rds_proxy.rb
 - lib/awspec/generator/spec/redshift.rb
 - lib/awspec/generator/spec/redshift_cluster_parameter_group.rb
 - lib/awspec/generator/spec/route53_hosted_zone.rb
@@ -653,6 +656,7 @@ files:
 - lib/awspec/stub/rds.rb
 - lib/awspec/stub/rds_db_cluster_parameter_group.rb
 - lib/awspec/stub/rds_db_parameter_group.rb
+- lib/awspec/stub/rds_proxy.rb
 - lib/awspec/stub/redshift.rb
 - lib/awspec/stub/redshift_cluster_parameter_group.rb
 - lib/awspec/stub/route53_hosted_zone.rb
@@ -745,6 +749,7 @@ files:
 - lib/awspec/type/rds_account_attributes.rb
 - lib/awspec/type/rds_db_cluster_parameter_group.rb
 - lib/awspec/type/rds_db_parameter_group.rb
+- lib/awspec/type/rds_proxy.rb
 - lib/awspec/type/redshift.rb
 - lib/awspec/type/redshift_cluster_parameter_group.rb
 - lib/awspec/type/resource_base.rb