awspec 0.69.1 → 0.70.0

data/lib/awspec/error.rb

@@ -1,4 +1,6 @@
 module Awspec
   class DuplicatedResourceTypeError < StandardError
   end
+  class InvalidAccountError < StandardError
+  end
 end

data/lib/awspec/ext.rb

@@ -1,2 +1,3 @@
+require 'awspec/ext/hash'
 require 'awspec/ext/struct'
 require 'awspec/ext/array'

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/generator.rb

@@ -26,9 +26,15 @@ require 'awspec/generator/spec/iam_role'
 # 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

@@ -1,13 +1,15 @@
 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.map do |type|
+        links = types.sort.map do |type|
           '[' + type + '](#' + type + ')'
         end
+        links.push('[account](#account)') # add account
         header = <<-'EOF'
 # Resource Types
 
@@ -19,6 +21,38 @@ EOF
         types.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

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

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

@@ -0,0 +1,69 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class AccountAttribute < Base
+        def initialize
+          Awspec::Stub.load 'account'
+          @type_name = 'Account Attribute'
+          @type = Awspec::Type::Account.new
+          @ret = Awspec::Type::Account.new.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+
+        def generate_doc
+          @account_attribute_spec = ERB.new(account_attribute_spec_template, nil, '-').result(binding).gsub(/^\n/, '')
+          super
+        end
+
+        def account_attribute_spec_template
+          template = <<-'EOF'
+<% @ret.members.each do |key| %>
+<%- next if @ret[key].is_a?(String) -%>
+describe account_attribute('<%= key %>') do
+<% @ret[key].members.each do |attribute| %>
+<%- if @ret[key][attribute].is_a?(Array) -%>
+  its('<%= attribute %>') { should eq <%= @ret[key][attribute] %> }
+<%- elsif @ret[key][attribute].is_a?(String) -%>
+  its('<%= attribute %>') { should eq '<%= @ret[key][attribute] %>' }
+<%- elsif @ret[key][attribute].is_a?(Struct) -%>
+<% @ret[key][attribute].members.each do |k| %>
+  its('<%= attribute %>.<%= k %>') { should eq <%= @ret[key][attribute][k] %> }
+<% end %>
+<%- else -%>
+  its('<%= attribute %>') { should eq <%= @ret[key][attribute] %> }
+<%- 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_attribute_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

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

@@ -0,0 +1,32 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class AccountAttributeBase < Base
+        def initialize
+          Awspec::Stub.load 'account'
+          @type_name = type_name
+        end
+
+        def doc_template
+          template = <<-'EOF'
+## <a name="<%= @type_name.gsub(/ /, '_').underscore %>"><%= @type_name.gsub(/ /, '_').underscore %></a>
+
+<%= @type_name %> account attributes.
+<%- if @descriptions.include?('first') -%><%= @descriptions['first'] %><%- end -%>
+<% @matchers.each do |matcher| %>
+### <%= matcher %>
+<%- if @descriptions.include?(matcher) -%><%= @descriptions[matcher] %><%- end -%>
+<% end %>
+<%- unless its.empty? -%>### <%= its.join(', ') %><%- end -%>
+<%- if @descriptions.include?('advanced') -%>
+
+### :unlock: Advanced use
+<%= @descriptions['advanced'] %><%- end -%>
+
+EOF
+          template
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,7 @@ module Awspec::Generator
           self.class.to_s.split('::').last
         end
 
+        # rubocop:disable Metrics/MethodLength
         def generate_doc
           @matchers += collect_matchers - @ignore_matchers
           @matchers.sort! do |a, b|
@@ -18,9 +19,15 @@ module Awspec::Generator
             next ret if ret != 0
             a.casecmp(b)
           end
-          @describes += @ret.members.select do |describe|
-            next true unless @ret[describe].is_a?(Array) || @ret[describe].is_a?(Hash) || @ret[describe].is_a?(Struct)
-          end if @ret.respond_to?(:members)
+          if @ret.respond_to?(:members)
+            @describes += @ret.members.select do |describe|
+              if @ret[describe].is_a?(Array)
+                next true unless @ret[describe].first.is_a?(Array) || @ret[describe].first.is_a?(Hash) || @ret[describe].first.is_a?(Struct) # rubocop:disable Metrics/LineLength
+              else
+                next true unless @ret[describe].is_a?(Hash) || @ret[describe].is_a?(Struct)
+              end
+            end
+          end
           its = @describes.map do |describe|
             'its(:' + describe.to_s + ')'
           end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class CloudwatchLogs < Base
+        def initialize
+          super
+          @type_name = 'CloudwatchLogs'
+          @type = Awspec::Type::CloudwatchLogs.new('my-cloudwatch-logs-group')
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Ec2AccountAttributes < AccountAttributeBase
+        def initialize
+          super
+          @type_name = 'Ec2AccountAttributes'
+          @type = Awspec::Type::Ec2AccountAttributes.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class LambdaAccountSettings < AccountAttributeBase
+        def initialize
+          super
+          @type_name = 'LambdaAccountSettings'
+          @type = Awspec::Type::LambdaAccountSettings.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class RdsAccountAttributes < AccountAttributeBase
+        def initialize
+          super
+          @type_name = 'RdsAccountAttributes'
+          @type = Awspec::Type::RdsAccountAttributes.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class SesSendQuota < AccountAttributeBase
+        def initialize
+          super
+          @type_name = 'SesSendQuota'
+          @type = Awspec::Type::SesSendQuota.new
+          @ret = @type.resource_via_client
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

data/lib/awspec/generator/template.rb

@@ -1,7 +1,9 @@
 module Awspec::Generator
+  # rubocop:disable Metrics/ClassLength
   class Template
     def self.generate(type)
       @type = type
+      @account_attribute = false
       @root_path = File.dirname(__FILE__) + '/../../../'
       generate_stub
       generate_type
@@ -11,11 +13,22 @@ module Awspec::Generator
       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
+  class #{@type.camelize} < #{base}
     def resource_via_client
       @resource_via_client ||= # FIXME
     end
@@ -76,6 +89,30 @@ 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"