Merge pull request #587 from alpineriveredge/add-managed-prefix-list

Add managed_prefix_list resource

doc/_resource_types/managed_prefix_list.md

@@ -0,0 +1,32 @@
+### exist
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should exist }
+end
+```
+
+### have_cidr
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should have_cidr('10.0.0.0/16') }
+  it { should have_cidr('192.168.0.0/24').desc('dev') }
+end
+```
+
+### its(:entries_count)
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  its(:entries_count) { should eq 2 }
+end
+```
+
+### have_tag
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should have_tag('env').value('dev') }
+end
+```

doc/resource_types.md

@@ -52,6 +52,7 @@
 | [lambda](#lambda)
 | [launch_configuration](#launch_configuration)
 | [launch_template](#launch_template)
+| [managed_prefix_list](#managed_prefix_list)
 | [mq](#mq)
 | [msk](#msk)
 | [nat_gateway](#nat_gateway)
@@ -2411,6 +2412,47 @@ end
 ```
 
 ### its(:launch_template_id), its(:launch_template_name), its(:create_time), its(:created_by), its(:default_version_number), its(:latest_version_number), its(:tags)
+## <a name="managed_prefix_list">managed_prefix_list</a>
+
+ManagedPrefixList resource type.
+
+### exist
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should exist }
+end
+```
+
+
+### have_cidr
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should have_cidr('10.0.0.0/16') }
+  it { should have_cidr('192.168.0.0/24').desc('dev') }
+end
+```
+
+
+### have_tag
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should have_tag('env').value('dev') }
+end
+```
+
+### its(:entries_count)
+
+```ruby
+describe managed_prefix_list('my-managed-prefix-list') do
+  its(:entries_count) { should eq 2 }
+end
+```
+
+
+### its(:prefix_list_id), its(:address_family), its(:state), its(:state_message), its(:prefix_list_arn), its(:prefix_list_name), its(:max_entries), its(:version), its(:owner_id)
 ## <a name="mq">mq</a>
 
 MQ resource type.

lib/awspec/command/generate.rb

@@ -65,7 +65,7 @@ def s3_bucket(bucket_name = nil)
     types_for_generate_all = %w[
       cloudwatch_alarm cloudwatch_event directconnect ebs efs
       elasticsearch iam_group iam_policy iam_role iam_user kms lambda
-      acm cloudwatch_logs eip codebuild elasticache
+      acm cloudwatch_logs eip codebuild elasticache managed_prefix_list
     ]
 
     types_for_generate_all.each do |type|

lib/awspec/generator.rb

@@ -43,6 +43,7 @@
 require 'awspec/generator/spec/rds_proxy'
 require 'awspec/generator/spec/rds_db_cluster'
 require 'awspec/generator/spec/rds_global_cluster'
+require 'awspec/generator/spec/managed_prefix_list'
 
 # Doc
 require 'awspec/generator/doc/type'

lib/awspec/generator/doc/type/managed_prefix_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Awspec::Generator
+  module Doc
+    module Type
+      class ManagedPrefixList < Base
+        def initialize
+          super
+          @type_name = 'ManagedPrefixList'
+          @type = Awspec::Type::ManagedPrefixList.new('my-managed-prefix-list')
+          @ret = @type.resource_via_client
+          @matchers = ['its(:entries_count)']
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

lib/awspec/generator/spec/managed_prefix_list.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Awspec::Generator
+  module Spec
+    class ManagedPrefixList
+      include Awspec::Helper::Finder
+      def select_all_managed_prefix_lists
+        res = ec2_client.describe_managed_prefix_lists
+        res.prefix_lists
+      end
+
+      def generate_all
+        prefix_lists = select_all_managed_prefix_lists
+        raise 'Not Found Managed Prefix List.' if prefix_lists.empty?
+
+        specs = prefix_lists.map do |prefix_list|
+          entries = select_managed_prefix_list_entries(prefix_list.prefix_list_id)
+          content = ERB.new(managed_prefix_list_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+        end
+        specs.join("\n")
+      end
+
+      def managed_prefix_list_spec_template
+        <<-'EOF'
+describe managed_prefix_list('<%= prefix_list.prefix_list_name %>') do
+  it { should exist }
+<% entries.each do |entry| %>
+<% if entry.description.nil? %>
+  it { should have_cidr('<%= entry.cidr %>') }
+<% else %>
+  it { should have_cidr('<%= entry.cidr %>').desc('<%= entry.description %>') }
+<% end %>
+<% end %>
+  its(:entries_count) { should eq <%= entries.length %> }
+  its(:prefix_list_id) { should eq '<%= prefix_list.prefix_list_id %>' }
+  its(:address_family) { should eq '<%= prefix_list.address_family %>' }
+  its(:state) { should eq '<%= prefix_list.state %>' }
+  its(:prefix_list_arn) { should eq '<%= prefix_list.prefix_list_arn %>' }
+<% if prefix_list.max_entries %>
+  its(:max_entries) { should eq <%= prefix_list.max_entries %> }
+<% end %>
+<% if prefix_list.version %>
+  its(:version) { should eq <%= prefix_list.version %> }
+<% end %>
+  its(:owner_id) { should eq '<%= prefix_list.owner_id %>' }
+<% prefix_list.tags.each do |tag| %>
+  it { should have_tag('<%= tag.key %>').value('<%= tag.value %>') }
+<% end %>
+end
+EOF
+      end
+    end
+  end
+end

lib/awspec/helper/finder/ec2.rb

@@ -228,6 +228,18 @@ def find_tgw_attachments_by_tgw_id(tgw_id)
                                                               })
         res.transit_gateway_attachments
       end
+
+      def find_managed_prefix_list(prefix_list_name)
+        res = ec2_client.describe_managed_prefix_lists({
+                                                         filters: [{ name: 'prefix-list-name',
+                                                                     values: [prefix_list_name] }]
+                                                       })
+        res.prefix_lists.single_resource(prefix_list_name)
+      end
+
+      def select_managed_prefix_list_entries(prefix_list_id)
+        ec2_client.get_managed_prefix_list_entries({ prefix_list_id: prefix_list_id }).data.entries
+      end
     end
   end
 end

lib/awspec/helper/type.rb

@@ -24,7 +24,7 @@ module Type
         internet_gateway acm cloudwatch_logs dynamodb_table eip sqs ssm_parameter cloudformation_stack
         codebuild sns_topic redshift redshift_cluster_parameter_group codedeploy codedeploy_deployment_group
         secretsmanager msk transit_gateway cognito_identity_pool cognito_user_pool vpc_endpoints
-        transfer_server
+        transfer_server managed_prefix_list
       ]
 
       ACCOUNT_ATTRIBUTES = %w[

lib/awspec/matcher.rb

@@ -90,3 +90,6 @@
 require 'awspec/matcher/have_env_vars'
 require 'awspec/matcher/have_env_var'
 require 'awspec/matcher/have_env_var_value'
+
+# ManagedPrefixList
+require 'awspec/matcher/have_cidr'

lib/awspec/matcher/have_cidr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_cidr do |cidr|
+  match do |type|
+    type.has_cidr?(cidr, @desc)
+  end
+
+  chain :desc do |desc|
+    @desc = desc
+  end
+end

lib/awspec/stub/managed_prefix_list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+Aws.config[:ec2] = {
+  stub_responses: {
+    describe_managed_prefix_lists: {
+      next_token: nil,
+      prefix_lists: [
+        {
+          prefix_list_id: 'pl-12345678',
+          address_family: 'IPv4',
+          state: 'create-complete',
+          state_message: nil,
+          prefix_list_arn: 'arn:aws:ec2:ap-northeast-1:aws:prefix-list/pl-12345678',
+          prefix_list_name: 'my-managed-prefix-list',
+          max_entries: 2,
+          version: 1,
+          tags: [
+            {
+              key: 'env',
+              value: 'dev'
+            }
+          ],
+          owner_id: '123456789012'
+        }
+      ]
+    },
+    get_managed_prefix_list_entries: {
+      next_toke: nil,
+      entries: [
+        {
+          cidr: '10.0.0.0/16',
+          description: 'test'
+        },
+        {
+          cidr: '192.168.0.0/24',
+          description: 'dev'
+        }
+      ]
+    }
+  }
+}

lib/awspec/type/managed_prefix_list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Awspec::Type
+  class ManagedPrefixList < ResourceBase
+    aws_resource Aws::EC2::Types::ManagedPrefixList
+    tags_allowed
+
+    def resource_via_client
+      @resource_via_client ||= find_managed_prefix_list(@display_name)
+    end
+
+    def id
+      @id ||= resource_via_client.prefix_list_id if resource_via_client
+    end
+
+    def entries
+      @entries ||= select_managed_prefix_list_entries(id)
+    end
+
+    def has_cidr?(cidr, description = nil)
+      entries.find do |entry|
+        if description.nil?
+          entry.cidr == cidr
+        else
+          entry.cidr == cidr && entry.description == description
+        end
+      end
+    end
+
+    def entries_count
+      entries.length
+    end
+  end
+end

spec/generator/spec/managed_prefix_list_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Awspec::Generator::Spec::ManagedPrefixList' do
+  before do
+    Awspec::Stub.load 'managed_prefix_list'
+  end
+  let(:managed_prefix_list) { Awspec::Generator::Spec::ManagedPrefixList.new }
+  it 'generate spec' do
+    spec = <<-'EOF'
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should exist }
+  it { should have_cidr('10.0.0.0/16').desc('test') }
+  it { should have_cidr('192.168.0.0/24').desc('dev') }
+  its(:entries_count) { should eq 2 }
+  its(:prefix_list_id) { should eq 'pl-12345678' }
+  its(:address_family) { should eq 'IPv4' }
+  its(:state) { should eq 'create-complete' }
+  its(:prefix_list_arn) { should eq 'arn:aws:ec2:ap-northeast-1:aws:prefix-list/pl-12345678' }
+  its(:max_entries) { should eq 2 }
+  its(:version) { should eq 1 }
+  its(:owner_id) { should eq '123456789012' }
+  it { should have_tag('env').value('dev') }
+end
+EOF
+    expect(managed_prefix_list.generate_all.to_s.gsub(/\n/, "\n")).to eq spec
+  end
+end

spec/type/managed_prefix_list_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+Awspec::Stub.load 'managed_prefix_list'
+
+describe managed_prefix_list('my-managed-prefix-list') do
+  it { should exist }
+  it { should have_cidr('10.0.0.0/16') }
+  it { should have_cidr('192.168.0.0/24').desc('dev') }
+  its(:entries_count) { should eq 2 }
+  it { should have_tag('env').value('dev') }
+end