awspec 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 233cbc5d2647507ec61335211db2877435b21d93
-  data.tar.gz: a3dca3393a13bcbf2802b80c0fc2f3a226a3ff9a
+  metadata.gz: 550ef18bd95e67b78e4e77dfb8436ae9f4577bfe
+  data.tar.gz: 27dfa72aea176f0926111f3a4ee1cf61d9206e94
 SHA512:
-  metadata.gz: 11b94b62d04b77bbd8f477e0f4b554f13309d447b44e336ea558802a10b33cb54ec7cbda2a50031a489a04c216dd60ea789193e7a3d065d81baa784506cfa566
-  data.tar.gz: b141e71cea34ed5595e9d983dbee5505d55b118d9a55b5461c6dca080966513a6456a34fd974618f78fa34dda73ddccff994989fbddd965cc5558dcac303d3b8
+  metadata.gz: c855e75b35e28865fcfb87fb6ade67d2e857b268d8f641d7c3aa64a0e569f51512d8e730c269e4180c1f0ecdf448588c8f133ceece7769f73523583493128a17
+  data.tar.gz: 13d77fdf7d9ea167b11c75a5e3618590a66e354e70b8aa6c00cb14b90bee4a684718acec2c590ea7df45fc83b09effad6e4caa07882269ce604b22db26ff1dfc

data/README.md

@@ -111,6 +111,16 @@ $ awspec generate ec2 vpc-ab123cde >> spec/ec2_spec.rb
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+### How to add new resource type (ex. Redshift resource)
+
+1. Create your feature branch (`git checkout -b add-type-redshift`)
+2. Generate template files (`bundle exec awspec/bin/toolbox template redshift`)
+3. Fill files with code.
+4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec awspec/bin/toolbox docgen`)
+5. Run test (`bundle exec rake spec`)
+6. Push to the branch (`git push origin add-type-redshift`)
+7. Create a new Pull Request
+
 ## References
 
 awspec is inspired by Serverspec.

data/doc/_resource_types/rds_db_parameter_group.md

@@ -0,0 +1,8 @@
+### first
+
+```ruby
+describe rds_db_parameter_group('my-rds-db-parameter-group') do
+  its(:basedir) { should eq '/rdsdbbin/mysql' }
+  its(:innodb_buffer_pool_size) { '{DBInstanceClassMemory*3/4}' }
+end
+```

data/doc/resource_types.md

@@ -26,8 +26,6 @@ end
 ```
 
 
-### be_stopped
-
 ### be_pending
 
 ### be_running
@@ -40,15 +38,17 @@ end
 
 ### be_shutting_down
 
-### be_terminated
+### be_stopped
 
 ### be_stopping
 
-### have_security_group
+### be_terminated
+
+### have_ebs
 
 ### have_eip
 
-### have_ebs
+### have_security_group
 
 ### belong_to_subnet
 
@@ -61,10 +61,6 @@ RDS resource type.
 
 ### exist
 
-### be_upgrading
-
-### be_storage_full
-
 ### be_available
 
 ### be_backing_up
@@ -85,7 +81,7 @@ RDS resource type.
 
 ### be_incompatible_parameters
 
-### be_restore_error
+### be_incompatible_restore
 
 ### be_maintenance
 
@@ -97,7 +93,11 @@ RDS resource type.
 
 ### be_resetting_master_credentials
 
-### be_incompatible_restore
+### be_restore_error
+
+### be_storage_full
+
+### be_upgrading
 
 ### have_db_parameter_group
 
@@ -116,6 +116,13 @@ RDS resource type.
 
 RdsDbParameterGroup resource type.
 
+```ruby
+describe rds_db_parameter_group('my-rds-db-parameter-group') do
+  its(:basedir) { should eq '/rdsdbbin/mysql' }
+  its(:innodb_buffer_pool_size) { '{DBInstanceClassMemory*3/4}' }
+end
+```
+
 ### exist
 
 
@@ -143,10 +150,10 @@ VPC resource type.
 
 ### exist
 
-### be_pending
-
 ### be_available
 
+### be_pending
+
 ### have_network_acl
 
 ### have_route_table
@@ -187,10 +194,10 @@ Subnet resource type.
 
 ### exist
 
-### be_pending
-
 ### be_available
 
+### be_pending
+
 #### its(:subnet_id), its(:state), its(:vpc_id), its(:cidr_block), its(:available_ip_address_count), its(:availability_zone), its(:default_for_az), its(:map_public_ip_on_launch)
 ## <a name="route_table">route_table</a>
 
@@ -207,19 +214,19 @@ EBS resource type.
 
 ### exist
 
-### be_deleted
+### be_attached_to
 
-### be_in_use
+### be_available
 
-### be_deleting
+### be_creating
 
-### be_available
+### be_deleted
 
-### be_error
+### be_deleting
 
-### be_attached_to
+### be_error
 
-### be_creating
+### be_in_use
 
 #### its(:volume_id), its(:size), its(:snapshot_id), its(:availability_zone), its(:state), its(:create_time), its(:volume_type), its(:iops), its(:encrypted), its(:kms_key_id)
 ## <a name="elb">elb</a>
@@ -228,6 +235,8 @@ ELB resource type.
 
 ### exist
 
+### have_ec2
+
 ### have_listener
 
 http://docs.aws.amazon.com/en_us/ElasticLoadBalancing/latest/DeveloperGuide/elb-listener-config.html
@@ -238,12 +247,10 @@ describe elb('my-elb') do
 end
 ```
 
-### have_ec2
+### have_security_group
 
 ### have_subnet
 
-### have_security_group
-
 ### belong_to_subnet
 
 ### belong_to_vpc

data/lib/awspec.rb

@@ -3,10 +3,12 @@ require 'rspec'
 require 'rspec/its'
 require 'awspec/version'
 require 'awspec/cli'
+require 'awspec/stub'
 require 'awspec/matcher'
 require 'awspec/helper'
 require 'awspec/ext'
 require 'awspec/generator'
+require 'awspec/toolbox'
 
 module Awspec
 end

data/lib/awspec/bin/toolbox

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

data/lib/awspec/generator.rb

@@ -9,6 +9,10 @@ require 'awspec/generator/spec/route53_hosted_zone'
 require 'awspec/generator/spec/elb'
 
 # Doc
+require 'awspec/generator/doc/type'
 types.each do |type|
-  require 'awspec/generator/doc/' + type
+  require 'awspec/generator/doc/type/' + type
 end
+
+# Template
+require 'awspec/generator/template'

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

@@ -0,0 +1,26 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      def self.generate_doc
+        Aws.config[:stub_responses] = true
+        types = Awspec::Helper::Type::TYPES
+        types.delete('base')
+        links = types.map do |type|
+          '[' + type + '](#' + type + ')'
+        end
+        header = <<-'EOF'
+# Resource Types
+
+<%= links.join("\n| ") %>
+
+EOF
+        doc = ERB.new(header, nil, '-').result(binding)
+
+        types.map do |type|
+          doc += eval "Awspec::Generator::Doc::Type::#{type.to_camel_case}.new.generate_doc"
+        end
+        doc
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class AutoScalingGroup < Base
+        def initialize
+          super
+          @type = Awspec::Type::AutoScalingGroup.new('my-auto-scaling-group')
+          @ret = @type.group
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Base
+        def initialize
+          Awspec::Stub.load type_name.to_snake_case
+          @type_name = type_name
+        end
+
+        def type_name
+          self.class.to_s.split('::').last
+        end
+
+        def generate_doc
+          @matchers += collect_matchers - @ignore_matchers
+          @matchers.sort! do |a, b|
+            ret = sort_num(a) <=> sort_num(b)
+            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)
+          its = @describes.map do |describe|
+            'its(:' + describe.to_s + ')'
+          end
+
+          @descriptions = {}
+          merge_file = File.dirname(__FILE__) + '/../../../../../doc/_resource_types/' + type_name.to_snake_case + '.md'
+          if File.exist?(merge_file)
+            matcher = nil
+            File.foreach(merge_file) do |line|
+              if /\A### (.+)\Z/ =~ line
+                matcher = Regexp.last_match[1]
+                next
+              end
+              @descriptions[matcher] = '' unless @descriptions[matcher]
+              @descriptions[matcher] += line
+            end
+          end
+          ERB.new(doc_template, nil, '-').result(binding)
+        end
+
+        def collect_matchers
+          methods = @type.methods - Awspec::Helper::Finder.instance_methods - Object.methods
+          methods.select! do |method|
+            method.to_s.include?('?')
+          end
+          methods.map! do |method|
+            next 'exist' if 'exists?' == method.to_s
+            next 'have_' + Regexp.last_match[1] if /\Ahas_(.+)\?\z/ =~ method.to_s
+            next 'be_' + Regexp.last_match[1] if /\A(.+)\?\z/ =~ method.to_s
+            method.to_s
+          end
+        end
+
+        def doc_template
+          template = <<-'EOF'
+## <a name="<%= @type_name.to_snake_case %>"><%= @type_name.to_snake_case %></a>
+
+<%= @type_name %> resource type.
+<%- 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?('last') -%><%= @descriptions['last'] %><%- end -%>
+
+EOF
+          template
+        end
+
+        def sort_num(str)
+          case str
+          when 'exist'
+            0
+          when /\Abe_/
+            1
+          when /\Ahave_/
+            2
+          else
+            3
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Ebs < Base
+        def initialize
+          super
+          @type_name = 'EBS'
+          @type = Awspec::Type::Ebs.new('my-ebs')
+          @ret = @type.volume
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Ec2 < Base
+        def initialize
+          super
+          @type_name = 'EC2'
+          @type = Awspec::Type::Ec2.new('my-ec2')
+          @ret = @type.instance
+          @matchers = %w(belong_to_vpc belong_to_subnet)
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Elb < Base
+        def initialize
+          super
+          @type_name = 'ELB'
+          @type = Awspec::Type::Elb.new('my-elb')
+          @ret = @type.lb
+          @matchers = %w(belong_to_vpc belong_to_subnet)
+          @ignore_matchers = []
+          @describes = %w(
+            health_check_target health_check_interval health_check_timeout
+            health_check_unhealthy_threshold health_check_healthy_threshold
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Rds < Base
+        def initialize
+          super
+          @type_name = 'RDS'
+          @type = Awspec::Type::Rds.new('my-rds')
+          @ret = @type.instance
+          @matchers = %w(belong_to_vpc belong_to_subnet belong_to_db_subnet_group)
+          @ignore_matchers = []
+          @describes = %w(vpc_id)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class RdsDbParameterGroup < Base
+        def initialize
+          super
+          @type = Awspec::Type::RdsDbParameterGroup.new('my-rds-db-parameter-group')
+          @ret = @type.parameters
+          @matchers = []
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end