cthiesfork-awspec 1.0.0

data/exe/awspec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'awspec'
+
+Awspec::CLI.start

data/lib/awspec.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec/its'
+require 'time'
+require 'dry/inflector'
+require 'ipaddr'
+require 'ipaddress'
+require 'awsecrets'
+require 'awspec/config'
+require 'awspec/version'
+require 'awspec/ext'
+require 'awspec/error'
+require 'awspec/cli'
+require 'awspec/stub'
+require 'awspec/matcher'
+require 'awspec/helper'
+require 'awspec/generator'
+require 'awspec/toolbox'
+require 'awspec/resource_reader'
+require 'awspec/shared_context'
+
+module Awspec
+end

data/lib/awspec/cli.rb

@@ -0,0 +1,25 @@
+require 'thor'
+require 'awspec/setup'
+require 'awspec/command/generate'
+
+module Awspec
+  class CLI < Thor
+    desc 'init', 'Generate init files'
+    def init
+      Awspec::Setup.run
+    end
+
+    desc 'generate [resource]', 'Generate AWS resource *_spec.rb'
+    subcommand 'generate', Generate
+    map 'g' => 'generate'
+
+    option :version, type: :boolean, aliases: :v
+    def help(version = nil)
+      if version
+        puts Awspec::VERSION
+      else
+        super
+      end
+    end
+  end
+end

data/lib/awspec/command/generate.rb

@@ -0,0 +1,69 @@
+require 'thor'
+require 'awspec/setup'
+
+module Awspec
+  class Generate < Thor
+    class_option :profile
+    class_option :region
+    class_option :secrets_path
+
+    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
+    )
+
+    types.each do |type|
+      desc type + ' [vpc_id]', "Generate #{type} spec from VPC ID (or VPC \"Name\" tag)"
+      define_method type do |_vpc_id|
+        Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+        eval "puts Awspec::Generator::Spec::#{type.camelize}.new.generate_by_vpc_id(_vpc_id)"
+      end
+    end
+
+    desc 'route53_hosted_zone [example.com.]', 'Generate route53_hosted_zone spec from Domain name'
+    def route53_hosted_zone(hosted_zone)
+      Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+      puts Awspec::Generator::Spec::Route53HostedZone.new.generate_by_domain_name(hosted_zone)
+    end
+
+    desc 's3_bucket [bucket_name]', 'Generate s3_bucket spec from S3 bucket name. if NO args, Generate all.'
+    def s3_bucket(bucket_name = nil)
+      Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+      if bucket_name
+        puts Awspec::Generator::Spec::S3Bucket.new.generate(bucket_name)
+      else
+        puts Awspec::Generator::Spec::S3Bucket.new.generate_all
+      end
+    end
+
+    types = %w(
+      rds_db_parameter_group rds_db_cluster_parameter_group redshift_cluster_parameter_group
+    )
+
+    types.each do |type|
+      desc type + ' [parameter_group_name]', "Generate #{type} spec from parameter group name."
+      define_method type do |_parameter_group_name|
+        Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+        eval "puts Awspec::Generator::Spec::#{type.camelize}.new.generate_by_parameter_group(_parameter_group_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
+      acm cloudwatch_logs eip codebuild
+    )
+
+    types_for_generate_all.each do |type|
+      if %w(iam_policy ebs).include?(type)
+        desc type, "Generate attached #{type} spec"
+      else
+        desc type, "Generate #{type} spec"
+      end
+      define_method type do
+        Awsecrets.load(profile: options[:profile], region: options[:region], secrets_path: options[:secrets_path])
+        eval "puts Awspec::Generator::Spec::#{type.camelize}.new.generate_all"
+      end
+    end
+  end
+end

data/lib/awspec/config.rb

@@ -0,0 +1,41 @@
+require 'singleton'
+
+require 'awspec/error'
+
+module Awspec
+  class Config
+    include Singleton
+
+    def initialize
+      @config = {
+        client_backoff: 0.0,
+        client_backoff_limit: 30.0,
+        client_iteration: 1
+      }
+    end
+
+    def client_backoff(backoff)
+      @config[:client_backoff] = backoff
+    end
+
+    def client_backoff_limit(backoff_limit)
+      @config[:client_backoff_limit] = backoff_limit
+    end
+
+    def client_iteration(iteration)
+      @config[:client_iteration] = iteration
+    end
+
+    def [](key)
+      @config.fetch(key)
+    end
+
+    def method_missing(method_name, *_args)
+      raise UnknownConfiguration, "'#{method_name}' is not a valid configuration for Awspec."
+    end
+  end
+
+  def self.configure
+    yield(Config.instance)
+  end
+end

data/lib/awspec/error.rb

@@ -0,0 +1,32 @@
+module Awspec
+  class DuplicatedResourceTypeError < StandardError
+  end
+  class InvalidAccountError < StandardError
+  end
+  ##
+  # The exception when sending message to a unavailable AWS resource.
+  #
+  # It should be raised everytime a resource is not available (or doesn't
+  # exist) before trying to invoke a method from it and raising instead
+  # NoMethodError exception.
+  class NoExistingResource < StandardError
+    ##
+    # Overrides the superclass initialize method to include more information
+    # and default error message.
+    # Expected parameters:
+    # - resource_type: the name of the resource type. Probably the class method return is the best option to be used.
+    # - id: the string used to search for the AWS resource. It will vary depending on the resource type, but probably
+    # will be an string.
+
+    def initialize(resource_type, id)
+      @resource_type = resource_type
+      @id = id
+      message = "The resource type #{resource_type} with id #{id} does not exist"
+      super message
+    end
+  end
+
+  # Let the user know the configuration they provided is not known.
+  class UnknownConfiguration < StandardError
+  end
+end

data/lib/awspec/ext.rb

@@ -0,0 +1,4 @@
+require 'awspec/ext/array'
+require 'awspec/ext/hash'
+require 'awspec/ext/string'
+require 'awspec/ext/struct'

data/lib/awspec/ext/array.rb

@@ -0,0 +1,8 @@
+class Array
+  def single_resource(id = nil)
+    if self.count > 1
+      raise Awspec::DuplicatedResourceTypeError, "Duplicated resource type #{id}"
+    end
+    self.first if self.count == 1
+  end
+end

data/lib/awspec/ext/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  def to_struct
+    st = Struct.new(*self.keys)
+    maps = self.values.map do |s|
+      next s.to_struct if s.is_a?(Hash)
+      s
+    end
+    st.new(*maps)
+  end
+end

data/lib/awspec/ext/string.rb

@@ -0,0 +1,17 @@
+class String
+  def camelize
+    Dry::Inflector.new.camelize(self)
+  end
+
+  def pluralize
+    Dry::Inflector.new.pluralize(self)
+  end
+
+  def underscore
+    Dry::Inflector.new.underscore(self)
+  end
+
+  def demodulize
+    Dry::Inflector.new.demodulize(self)
+  end
+end

data/lib/awspec/ext/struct.rb

@@ -0,0 +1,8 @@
+class Struct
+  def tag_name
+    tag = self[:tags].find do |t|
+      t[:key] == 'Name'
+    end
+    tag[:value] if tag
+  end
+end

data/lib/awspec/generator.rb

@@ -0,0 +1,55 @@
+# Spec
+require 'awspec/generator/spec/ec2'
+require 'awspec/generator/spec/rds'
+require 'awspec/generator/spec/vpc'
+require 'awspec/generator/spec/security_group'
+require 'awspec/generator/spec/route53_hosted_zone'
+require 'awspec/generator/spec/efs'
+require 'awspec/generator/spec/elb'
+require 'awspec/generator/spec/iam_policy'
+require 'awspec/generator/spec/kms'
+require 'awspec/generator/spec/cloudwatch_alarm'
+require 'awspec/generator/spec/cloudwatch_event'
+require 'awspec/generator/spec/network_acl'
+require 'awspec/generator/spec/route_table'
+require 'awspec/generator/spec/subnet'
+require 'awspec/generator/spec/directconnect'
+require 'awspec/generator/spec/ebs'
+require 'awspec/generator/spec/s3_bucket'
+require 'awspec/generator/spec/nat_gateway'
+require 'awspec/generator/spec/lambda'
+require 'awspec/generator/spec/network_interface'
+require 'awspec/generator/spec/iam_user'
+require 'awspec/generator/spec/iam_group'
+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'
+require 'awspec/generator/spec/codebuild'
+require 'awspec/generator/spec/autoscaling_group'
+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'
+
+# Doc
+require 'awspec/generator/doc/type'
+require 'awspec/generator/doc/type/base'
+require 'awspec/generator/doc/type/account_attribute_base'
+Awspec::Helper::Type::TYPES.each do |type|
+  require 'awspec/generator/doc/type/' + type
+end
+Awspec::Helper::Type::ACCOUNT_ATTRIBUTES.each do |type|
+  require 'awspec/generator/doc/type/' + type
+end
+require 'awspec/generator/doc/type/account'
+require 'awspec/generator/doc/type/account_attribute'
+
+# Template
+require 'awspec/generator/template'

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

@@ -0,0 +1,60 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      # rubocop:disable Metrics/MethodLength
+      def self.generate_doc
+        Aws.config[:stub_responses] = true
+        types = Awspec::Helper::Type::TYPES
+        types.delete('base')
+        links = types.sort.map do |type|
+          '[' + type + '](#' + type + ')'
+        end
+        links.push('[account](#account)') # add account
+        header = <<-'EOF'
+# Resource Types
+
+<%= links.join("\n| ") %>
+
+EOF
+        doc = ERB.new(header, nil, '-').result(binding)
+
+        types.sort.map do |type|
+          doc += eval "Awspec::Generator::Doc::Type::#{type.camelize}.new.generate_doc"
+        end
+
+        # account and attributes
+        attributes = Awspec::Helper::Type::ACCOUNT_ATTRIBUTES
+
+        doc += <<-'EOF'
+# Account and Attributes
+
+EOF
+        doc += Awspec::Generator::Doc::Type::Account.new.generate_doc
+
+        doc += <<-'EOF'
+## :unlock: Another way: Test with account_attribute type
+
+EOF
+
+        doc += Awspec::Generator::Doc::Type::AccountAttribute.new.generate_doc
+
+        doc += <<-'EOF'
+## :unlock: Another way: Test with separated resource types
+
+EOF
+
+        links = attributes.map do |type|
+          '[' + type + '](#' + type + ')'
+        end
+
+        doc += links.join("\n| ") + "\n"
+
+        attributes.map do |type|
+          doc += eval "Awspec::Generator::Doc::Type::#{type.camelize}.new.generate_doc"
+        end
+
+        doc.sub(/\n*\z/, '')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Account < Base
+        def initialize
+          super
+          @type_name = 'Account'
+          @type = Awspec::Type::Account.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+
+        def generate_doc
+          @account_spec = ERB.new(account_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+          super
+        end
+
+        def account_spec_template
+          template = <<-'EOF'
+describe account do
+<% @ret.members.each do |key| %>
+<%- if @ret[key].is_a?(String) -%>
+  its(:<%= key %>) { should eq '<%= @ret[key] %>' }
+<%- else -%>
+<% @ret[key].members.each do |attribute| %>
+<%- if @ret[key][attribute].is_a?(Array) -%>
+  its('<%= key %>.<%= attribute %>') { should eq <%= @ret[key][attribute] %> }
+<%- elsif @ret[key][attribute].is_a?(String) -%>
+  its('<%= key %>.<%= attribute %>') { should eq '<%= @ret[key][attribute] %>' }
+<%- elsif @ret[key][attribute].is_a?(Struct) -%>
+<% @ret[key][attribute].members.each do |k| %>
+  its('<%= key %>.<%= attribute %>.<%= k %>') { should eq <%= @ret[key][attribute][k] %> }
+<% end %>
+<%- else -%>
+  its('<%= key %>.<%= attribute %>') { should eq <%= @ret[key][attribute] %> }
+<%- end -%>
+<% end %>
+<% end %>
+<%- end -%>
+end
+EOF
+          template
+        end
+
+        def doc_template
+          template = <<-'EOF'
+## <a name="<%= @type_name.gsub(/ /, '_').underscore %>"><%= @type_name.gsub(/ /, '_').underscore %></a>
+
+<%= @type_name %> resource type.
+<%- if @descriptions.include?('first') -%><%= @descriptions['first'] %><%- end -%>
+
+```ruby
+<%= @account_spec %>```
+
+<% @matchers.each do |matcher| %>
+### <%= matcher %>
+<%- if @descriptions.include?(matcher) -%><%= @descriptions[matcher] %><%- end -%>
+<% end %>
+<%- if @descriptions.include?('advanced') -%>
+
+### :unlock: Advanced use
+<%= @descriptions['advanced'] %><%- end -%>
+EOF
+          template
+        end
+      end
+    end
+  end
+end