cthiesfork-awspec 1.0.0

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

@@ -0,0 +1,95 @@
+module Awspec::Generator
+  module Spec
+    class SecurityGroup
+      include Awspec::Helper::Finder
+      def generate_by_vpc_id(vpc_id)
+        describes = %w(
+          group_id group_name
+        )
+        vpc = find_vpc(vpc_id)
+        raise 'Not Found VPC' unless vpc
+        @vpc_id = vpc[:vpc_id]
+        @vpc_tag_name = vpc.tag_name
+        sgs = select_security_group_by_vpc_id(@vpc_id)
+
+        specs = sgs.map do |sg|
+          linespecs = generate_linespecs(sg)
+          inbound_rule_count = sg[:ip_permissions].reduce(0) do |sum, permission|
+            sum += permission.ip_ranges.count + permission.user_id_group_pairs.count
+          end
+          outbound_rule_count = sg[:ip_permissions_egress].reduce(0) do |sum, permission|
+            sum += permission.ip_ranges.count + permission.user_id_group_pairs.count
+          end
+          content = ERB.new(security_group_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+        end
+        specs.join("\n")
+      end
+
+      def generate_linespecs(sg)
+        linespecs = []
+        permissions = { 'inbound' => sg.ip_permissions, 'outbound' => sg.ip_permissions_egress }
+        %w(inbound outbound).each do |inout|
+          permissions[inout].each do |permission|
+            port = if permission.from_port.nil?
+                     nil
+                   elsif permission.from_port == permission.to_port
+                     permission.from_port
+                   else
+                     "'" + permission.from_port.to_s + '-' + permission.to_port.to_s + "'"
+                   end
+
+            protocol = if permission.ip_protocol.to_i < 0
+                         'all'
+                       else
+                         permission.ip_protocol
+                       end
+
+            permission.ip_ranges.each do |ip_range|
+              target = ip_range.cidr_ip
+              linespecs.push(ERB.new(security_group_spec_linetemplate, nil, '-').result(binding))
+            end
+            permission.user_id_group_pairs.each do |group|
+              target = group.group_name
+              target = group.group_id unless group.group_name
+              linespecs.push(ERB.new(security_group_spec_linetemplate, nil, '-').result(binding))
+            end
+          end
+        end
+        linespecs
+      end
+
+      def security_group_spec_linetemplate
+        template = <<-'EOF'
+its(:<%= inout %>) { should be_opened<%- unless port.nil? -%>(<%= port %>)<%- end -%>.protocol('<%= protocol %>').for('<%= target %>') }
+EOF
+        template
+      end
+
+      def security_group_spec_template
+        template = <<-'EOF'
+describe security_group('<%= sg.group_name %>') do
+  it { should exist }
+<% describes.each do |describe| %>
+<%- if sg.key?(describe) -%>
+  its(:<%= describe %>) { should eq '<%= sg[describe] %>' }
+<%- end -%>
+<% end %>
+<% linespecs.each do |line| %>
+  <%= line %>
+<% end %>
+  its(:inbound_rule_count) { should eq <%= inbound_rule_count %> }
+  its(:outbound_rule_count) { should eq <%= outbound_rule_count %> }
+  its(:inbound_permissions_count) { should eq <%= sg.ip_permissions.count %> }
+  its(:outbound_permissions_count) { should eq <%= sg.ip_permissions_egress.count %> }
+<%- if @vpc_tag_name -%>
+  it { should belong_to_vpc('<%= @vpc_tag_name %>') }
+<%- else -%>
+  it { should belong_to_vpc('<%= @vpc_id %>') }
+<%- end -%>
+end
+EOF
+        template
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Awspec::Generator
+  module Spec
+    class Subnet
+      include Awspec::Helper::Finder
+      def generate_by_vpc_id(vpc_id)
+        describes = %w(
+          subnet_id cidr_block
+        )
+        vpc = find_vpc(vpc_id)
+        raise 'Not Found VPC' unless vpc
+        @vpc_id = vpc[:vpc_id]
+        @vpc_tag_name = vpc.tag_name
+        subnets = select_subnet_by_vpc_id(@vpc_id)
+        specs = subnets.map do |subnet|
+          subnet_id = subnet[:subnet_id]
+          subnet_tag_name = subnet.tag_name
+          content = ERB.new(subnet_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+        end
+        specs.join("\n")
+      end
+
+      def subnet_spec_template
+        template = <<-'EOF'
+<%- if subnet_tag_name -%>
+describe subnet('<%= subnet_tag_name %>') do
+<%- else -%>
+describe subnet('<%= subnet_id %>') do
+<%- end -%>
+  it { should exist }
+  it { should be_<%= subnet.state %> }
+  it { should belong_to_vpc('<%= @vpc_tag_name %>') }
+<% describes.each do |describe| %>
+<%- if subnet.members.include?(describe.to_sym) && !subnet[describe.to_sym].nil? -%>
+<%- if subnet[describe].is_a?(String) -%>
+  its(:<%= describe %>) { should eq '<%= subnet[describe] %>' }
+<%- else -%>
+  its(:<%= describe %>) { should eq <%= subnet[describe] %> }
+<%- end -%>
+<%- end -%>
+<% end %>
+end
+EOF
+        template
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Awspec::Generator
+  module Spec
+    class Vpc
+      include Awspec::Helper::Finder
+      def generate_by_vpc_id(vpc_id)
+        describes = %w(
+          vpc_id cidr_block
+        )
+        vpc = find_vpc(vpc_id)
+        raise 'Not Found VPC' unless vpc
+        @vpc_id = vpc[:vpc_id]
+        @vpc_tag_name = vpc.tag_name
+        route_tables = select_route_table_by_vpc_id(@vpc_id)
+        network_acls = select_network_acl_by_vpc_id(@vpc_id)
+        vpc_attributes = select_vpc_attribute(@vpc_id)
+        spec = ERB.new(vpc_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+      end
+
+      # rubocop:disable all
+      def vpc_spec_template
+        template = <<-'EOF'
+<%- if @vpc_tag_name -%>
+describe vpc('<%= @vpc_tag_name %>') do
+<%- else -%>
+describe vpc('<%= @vpc_id %>') do
+<%- end -%>
+  it { should exist }
+  it { should be_<%= vpc.state %> }
+<% describes.each do |describe| %>
+<%- if vpc.key?(describe) -%>
+<%- if vpc[describe].is_a?(String) -%>
+  its(:<%= describe %>) { should eq '<%= vpc[describe] %>' }
+<%- else -%>
+  its(:<%= describe %>) { should eq <%= vpc[describe] %> }
+<%- end -%>
+<%- end -%>
+<% end %>
+<% route_tables.each do |route_table| %>
+<%- if route_table.tag_name -%>
+  it { should have_route_table('<%= route_table.tag_name %>') }
+<%- else -%>
+  it { should have_route_table('<%= route_table.route_table_id %>') }
+<%- end -%>
+<% end %>
+<% network_acls.each do |network_acl| %>
+<%- if network_acl.tag_name -%>
+  it { should have_network_acl('<%= network_acl.tag_name %>') }
+<%- else -%>
+  it { should have_network_acl('<%= network_acl.network_acl_id %>') }
+<%- end -%>
+<% end %>
+<% vpc_attributes.each do |vpc_attribute| %>
+<%- if vpc_attribute[1] -%>
+  it { should have_vpc_attribute('<%= vpc_attribute[0] %>') }
+<%- else -%>
+  it { should_not have_vpc_attribute('<%= vpc_attribute[0] %>') }
+<%- end -%>
+<% end %>
+end
+EOF
+        template
+      end
+    end
+  end
+end

data/lib/awspec/generator/template.rb

@@ -0,0 +1,145 @@
+module Awspec::Generator
+  class Template
+    def self.generate(type)
+      @type = type
+      @account_attribute = false
+      @root_path = File.dirname(__FILE__) + '/../../../'
+      generate_stub
+      generate_type
+      generate_type_spec
+      generate_generator_doc
+      generate_resource_type_doc
+      put_message
+    end
+
+    def self.generate_account_attribute(type)
+      @type = type
+      @account_attribute = true
+      @root_path = File.dirname(__FILE__) + '/../../../'
+      generate_type
+      generate_account_attribute_generator_doc
+      generate_resource_type_doc
+      put_message
+    end
+
+    def self.generate_type
+      path = 'lib/awspec/type/' + @type.underscore + '.rb'
+      base = @account_attribute ? 'AccountAttributeBase' : 'ResourceBase'
+      content = <<-"EOF"
+module Awspec::Type
+  class #{@type.camelize} < #{base}
+    def resource_via_client
+      @resource_via_client ||= # FIXME
+    end
+
+    def id
+     @id ||= # FIXME
+    end
+  end
+end
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.generate_stub
+      path = 'lib/awspec/stub/' + @type.underscore + '.rb'
+      content = <<-"EOF"
+# Aws.config[:ec2] = {
+#   stub_responses: true
+# }
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.generate_type_spec
+      path = 'spec/type/' + @type.underscore + '_spec.rb'
+      content = <<-"EOF"
+require 'spec_helper'
+Awspec::Stub.load '#{@type.underscore}'
+
+describe #{@type.underscore}('my-#{@type.underscore.tr('_', '-')}') do
+  it { should exist }
+end
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.generate_generator_doc
+      path = 'lib/awspec/generator/doc/type/' + @type.underscore + '.rb'
+      content = <<-"EOF"
+module Awspec::Generator
+  module Doc
+    module Type
+      class #{@type.camelize} < Base
+        def initialize
+          super
+          @type_name = '#{@type.camelize}'
+          @type = Awspec::Type::#{@type.camelize}.new('my-#{@type.underscore.tr('_', '-')}')
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.generate_account_attribute_generator_doc
+      path = 'lib/awspec/generator/doc/type/' + @type.underscore + '.rb'
+      content = <<-"EOF"
+module Awspec::Generator
+  module Doc
+    module Type
+      class #{@type.camelize} < AccountAttributeBase
+        def initialize
+          super
+          @type_name = '#{@type.camelize}'
+          @type = Awspec::Type::#{@type.camelize}.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.generate_resource_type_doc
+      path = 'doc/_resource_types/' + @type.underscore + '.md'
+      content = <<-"EOF"
+### exist
+EOF
+      self.file_check_and_puts(path, content)
+    end
+
+    def self.put_message
+      content = <<-"EOF"
+
+Generate #{@type.camelize} template files.
+
+* !! AND add '#{@type.underscore}' to Awspec::Helper::Type::TYPES in lib/awspec/helper/type.rb *
+* !! AND add '#{@type.underscore}' client to lib/awspec/helper/finder.rb *
+
+EOF
+    end
+
+    def self.file_check_and_puts(path, content)
+      if File.exist? @root_path + path
+        $stderr.puts "!! #{path} already exists"
+      else
+        File.open(@root_path + path, 'w') do |f|
+          f.puts content
+        end
+        puts " + #{path}"
+      end
+    end
+  end
+end

data/lib/awspec/helper.rb

@@ -0,0 +1,8 @@
+require 'awspec/helper/color'
+require 'awspec/helper/type'
+require 'awspec/helper/finder'
+extend Awspec::Helper::Type
+class RSpec::Core::ExampleGroup
+  extend Awspec::Helper::Type
+  include Awspec::Helper::Type
+end

data/lib/awspec/helper/client_wrap.rb

@@ -0,0 +1,49 @@
+require 'awspec/config'
+
+module Awspec::Helper
+  class ClientWrap
+    attr_reader :client, :backoff, :iteration, :backoff_limit, :symbol
+    def initialize(real_client = nil)
+      raise ArgumentError, 'Client can not be nil' if real_client.nil?
+      config = Awspec::Config.instance
+      @client        = real_client
+      @backoff       = config[:client_backoff]
+      @orig_backoff  = @backoff
+      @iteration     = config[:client_iteration]
+      @orig_iter     = @iteration
+      @backoff_limit = config[:client_backoff_limit]
+      # build the symbol we'll use to compare to any errors caught in method_missing
+      # below.
+      @symbol = real_client.class.to_s.split('::').shift(2).push('Errors', 'RequestLimitExceeded').join('::').to_sym
+    end
+
+    protected
+
+    # used to capture only the "RequestLimitExceeded" error from an aws
+    # client api call.  In the case of matching it we want to try again,
+    # backing off successively each time, until the backoff_limit is reached or
+    # exceeded, in which case, the error will be re-raised and it should fail
+    # as expected.
+    def method_missing(m, *args, &block)
+      begin
+        results = client.send(m, *args, &block)
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        raise unless e.class.to_s == symbol.to_s && backoff < backoff_limit
+
+        @backoff = backoff + (iteration * iteration * 0.5)
+        @iteration += 1
+        sleep backoff
+        results = self.send(m, *args, &block)
+      end
+
+      reset_backoff
+
+      results
+    end
+
+    def reset_backoff
+      @backoff   = @orig_backoff
+      @iteration = @orig_iter
+    end
+  end
+end

data/lib/awspec/helper/color.rb

@@ -0,0 +1,5 @@
+require 'term/ansicolor'
+
+class Color
+  extend Term::ANSIColor
+end

data/lib/awspec/helper/finder.rb

@@ -0,0 +1,168 @@
+require 'aws-sdk'
+require 'awspec/helper/finder/nlb'
+require 'awspec/helper/finder/alb'
+require 'awspec/helper/finder/vpc'
+require 'awspec/helper/finder/subnet'
+require 'awspec/helper/finder/ec2'
+require 'awspec/helper/finder/ecr'
+require 'awspec/helper/finder/ecs'
+require 'awspec/helper/finder/efs'
+require 'awspec/helper/finder/security_group'
+require 'awspec/helper/finder/rds'
+require 'awspec/helper/finder/route53'
+require 'awspec/helper/finder/s3'
+require 'awspec/helper/finder/autoscaling'
+require 'awspec/helper/finder/ebs'
+require 'awspec/helper/finder/elb'
+require 'awspec/helper/finder/firehose'
+require 'awspec/helper/finder/lambda'
+require 'awspec/helper/finder/iam'
+require 'awspec/helper/finder/kms'
+require 'awspec/helper/finder/elasticache'
+require 'awspec/helper/finder/elasticsearch'
+require 'awspec/helper/finder/cloudwatch'
+require 'awspec/helper/finder/cloudwatch_event'
+require 'awspec/helper/finder/ses'
+require 'awspec/helper/finder/directconnect'
+require 'awspec/helper/finder/ami'
+require 'awspec/helper/finder/cloudfront'
+require 'awspec/helper/finder/elastictranscoder'
+require 'awspec/helper/finder/cloudtrail'
+require 'awspec/helper/finder/waf'
+require 'awspec/helper/finder/wafregional'
+require 'awspec/helper/finder/acm'
+require 'awspec/helper/finder/cloudwatch_logs'
+require 'awspec/helper/finder/dynamodb'
+require 'awspec/helper/finder/sqs'
+require 'awspec/helper/finder/cloudformation'
+require 'awspec/helper/finder/ssm_parameter'
+require 'awspec/helper/finder/codebuild'
+require 'awspec/helper/finder/apigateway'
+require 'awspec/helper/finder/kinesis'
+require 'awspec/helper/finder/batch'
+require 'awspec/helper/finder/eks'
+require 'awspec/helper/finder/sns_topic'
+require 'awspec/helper/finder/emr'
+require 'awspec/helper/finder/redshift'
+require 'awspec/helper/finder/codedeploy'
+require 'awspec/helper/finder/mq'
+require 'awspec/helper/finder/secretsmanager'
+
+require 'awspec/helper/finder/account_attributes'
+
+require 'awspec/helper/client_wrap'
+
+module Awspec::Helper
+  module Finder
+    include Awspec::Helper::Finder::Nlb
+    include Awspec::Helper::Finder::Alb
+    include Awspec::Helper::Finder::Vpc
+    include Awspec::Helper::Finder::Subnet
+    include Awspec::Helper::Finder::Ec2
+    include Awspec::Helper::Finder::Ecr
+    include Awspec::Helper::Finder::Ecs
+    include Awspec::Helper::Finder::Efs
+    include Awspec::Helper::Finder::Firehose
+    include Awspec::Helper::Finder::SecurityGroup
+    include Awspec::Helper::Finder::Rds
+    include Awspec::Helper::Finder::Route53
+    include Awspec::Helper::Finder::S3
+    include Awspec::Helper::Finder::Autoscaling
+    include Awspec::Helper::Finder::Ebs
+    include Awspec::Helper::Finder::Elb
+    include Awspec::Helper::Finder::Lambda
+    include Awspec::Helper::Finder::Iam
+    include Awspec::Helper::Finder::Kms
+    include Awspec::Helper::Finder::Elasticache
+    include Awspec::Helper::Finder::Elasticsearch
+    include Awspec::Helper::Finder::Cloudwatch
+    include Awspec::Helper::Finder::CloudwatchEvent
+    include Awspec::Helper::Finder::Ses
+    include Awspec::Helper::Finder::Directconnect
+    include Awspec::Helper::Finder::Ami
+    include Awspec::Helper::Finder::Cloudfront
+    include Awspec::Helper::Finder::Elastictranscoder
+    include Awspec::Helper::Finder::Cloudtrail
+    include Awspec::Helper::Finder::Waf
+    include Awspec::Helper::Finder::WafRegional
+    include Awspec::Helper::Finder::Acm
+    include Awspec::Helper::Finder::AccountAttributes
+    include Awspec::Helper::Finder::CloudwatchLogs
+    include Awspec::Helper::Finder::Dynamodb
+    include Awspec::Helper::Finder::Sqs
+    include Awspec::Helper::Finder::SsmParameter
+    include Awspec::Helper::Finder::Cloudformation
+    include Awspec::Helper::Finder::Codebuild
+    include Awspec::Helper::Finder::Apigateway
+    include Awspec::Helper::Finder::Kinesis
+    include Awspec::Helper::Finder::Batch
+    include Awspec::Helper::Finder::Eks
+    include Awspec::Helper::Finder::SNSTopic
+    include Awspec::Helper::Finder::Emr
+    include Awspec::Helper::Finder::Redshift
+    include Awspec::Helper::Finder::Codedeploy
+    include Awspec::Helper::Finder::Mq
+    include Awspec::Helper::Finder::Secretsmanager
+
+    CLIENTS = {
+      ec2_client: Aws::EC2::Client,
+      ecr_client: Aws::ECR::Client,
+      ecs_client: Aws::ECS::Client,
+      efs_client: Aws::EFS::Client,
+      firehose_client: Aws::Firehose::Client,
+      rds_client: Aws::RDS::Client,
+      route53_client: Aws::Route53::Client,
+      s3_client: Aws::S3::Client,
+      autoscaling_client: Aws::AutoScaling::Client,
+      elb_client: Aws::ElasticLoadBalancing::Client,
+      elbv2_client: Aws::ElasticLoadBalancingV2::Client,
+      lambda_client: Aws::Lambda::Client,
+      iam_client: Aws::IAM::Client,
+      kms_client: Aws::KMS::Client,
+      elasticache_client: Aws::ElastiCache::Client,
+      cloudwatch_client: Aws::CloudWatch::Client,
+      cloudwatch_event_client: Aws::CloudWatchEvents::Client,
+      ses_client: Aws::SES::Client,
+      directconnect_client: Aws::DirectConnect::Client,
+      cloudfront_client: Aws::CloudFront::Client,
+      elastictranscoder_client: Aws::ElasticTranscoder::Client,
+      elasticsearch_client: Aws::ElasticsearchService::Client,
+      cloudtrail_client: Aws::CloudTrail::Client,
+      waf_client: Aws::WAF::Client,
+      wafregional_client: Aws::WAFRegional::Client,
+      sts_client: Aws::STS::Client,
+      acm_client: Aws::ACM::Client,
+      cloudwatch_logs_client: Aws::CloudWatchLogs::Client,
+      dynamodb_client: Aws::DynamoDB::Client,
+      sqs_client: Aws::SQS::Client,
+      ssm_client: Aws::SSM::Client,
+      cloudformation_client: Aws::CloudFormation::Client,
+      codebuild_client: Aws::CodeBuild::Client,
+      apigateway_client: Aws::APIGateway::Client,
+      kinesis_client: Aws::Kinesis::Client,
+      batch_client: Aws::Batch::Client,
+      eks_client: Aws::EKS::Client,
+      sns_client: Aws::SNS::Client,
+      emr_client: Aws::EMR::Client,
+      redshift_client: Aws::Redshift::Client,
+      codedeploy_client: Aws::CodeDeploy::Client,
+      mq_client: Aws::MQ::Client,
+      secretsmanager_client: Aws::SecretsManager::Client
+    }
+
+    CLIENT_OPTIONS = {
+      http_proxy: ENV['http_proxy'] || ENV['https_proxy'] || nil
+    }
+
+    CLIENTS.each do |method_name, client|
+      define_method method_name do
+        unless self.methods.include? "@#{method_name}"
+          instance_variable_set(
+            "@#{method_name}",
+            Awspec::Helper::ClientWrap.new(client.new(CLIENT_OPTIONS))
+          )
+        end
+      end
+    end
+  end
+end