awspec 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 285ebaa881bc63d59e64be0062ba5c986af30fad
-  data.tar.gz: a3e96559203b15ec30373fa7b31e4a6fd191805b
+  metadata.gz: f8bcb89202861083c0752985d3f1fb134cf000a0
+  data.tar.gz: 9d5e2caa69463851d22ae2d98c6128c08823e857
 SHA512:
-  metadata.gz: 88a08d9a0d4b4f95a7833fdda4ee84e59caa236e32f7fc1e679acc48807712c44979c34a3b8471f2b7d362e0c025717bdae751f803228a5e445fd8ee95dbfcae
-  data.tar.gz: 4d748396a3e146fff94b92d80d92baeafcbdb1e81f4e07b744a3ce7a69f764a698c85ea6d7c5b81a0d0edf43caa5809d83e1fea9ef7d2dfb20cee844a5408518
+  metadata.gz: 8f7337502c862ddb03a507996d94e3bce404d91f88c38c9a7c60fda1708b2fd60ed3bf67f0fe51dc2d40f2080cded953556d90e225ddaf32a74fc87cf9df8a35
+  data.tar.gz: 7020a396f1a4ac68742ac099f1081b588c70cae17ca51ba05a5ab2c638d53dc73d1584706bf14f42620cad4dc76683a9904670be635e67ce794a8a9083c3250e

data/README.md

@@ -2,7 +2,7 @@
 
 RSpec tests for your AWS resources.
 
-[Resource Types](doc/resource_types.md)
+[Resource Types](doc/resource_types.md) | [Contributing](doc/contributing.md)
 
 ## Installation
 
@@ -98,33 +98,16 @@ $ awspec generate ec2 vpc-ab123cde >> spec/ec2_spec.rb
     - [x] IAM Group (`iam_group`)
     - [x] IAM Role (`iam_role`)
     - [x] IAM Policy (`iam_policy`)
+- [x] ElastiCache (`elasticache`)
+    - [ ] ElastiCache Cache Parameter Group
 
 [Resource Types more infomation here](doc/resource_types.md)
 
 ### Next..?
 
-- [ ] ElastiCache
 - [ ] CloudWatch
 - ...
 
-## Contributing
-
-1. Fork it ( https://github.com/k1LoW/awspec/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-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 ./lib/awspec/bin/toolbox template redshift`)
-3. Fill files with code.
-4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec ./lib/awspec/bin/toolbox docgen > doc/resource_type.md`)
-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/contributing.md

@@ -0,0 +1,26 @@
+# Contributing
+
+## Add new resource type (ex. Redshift resource)
+
+1. Create your feature branch (`git checkout -b add-type-redshift`)
+2. Generate template files (`bundle exec ./lib/awspec/bin/toolbox template redshift`)
+3. Fill files with code.
+4. Generate [doc/resource_types.md](doc/resource_types.md) (`bundle exec ./lib/awspec/bin/toolbox docgen > doc/resource_type.md`)
+5. Run test (`bundle exec rake spec`)
+6. Push to the branch (`git push origin add-type-redshift`)
+7. Create a new Pull Request
+
+## Append resource type document (ex. VPC resource `be_available`)
+
+1. Create vpc.md (`touch doc/_resource_types/vpc.md`)
+2. Write following document.
+
+<pre>
+### be_available
+(Write cool description)
+```ruby
+describe vpc('my-vpc') do
+   it { should be_available }
+end
+```
+</pre>

data/doc/resource_types.md

@@ -17,6 +17,7 @@
 | [iam_group](#iam_group)
 | [iam_role](#iam_role)
 | [iam_policy](#iam_policy)
+| [elasticache](#elasticache)
 
 ## <a name="ec2">ec2</a>
 
@@ -347,3 +348,36 @@ IamPolicy resource type.
 ### be_attached_to_user
 
 #### its(:policy_name), its(:policy_id), its(:arn), its(:path), its(:default_version_id), its(:attachment_count), its(:is_attachable), its(:description), its(:create_date), its(:update_date)
+## <a name="elasticache">elasticache</a>
+
+Elasticache resource type.
+
+### exist
+
+### be_available
+
+### be_creating
+
+### be_deleted
+
+### be_deleting
+
+### be_incompatible_network
+
+### be_modifying
+
+### be_rebooting_cache_cluster_nodes
+
+### be_restore_failed
+
+### be_snapshotting
+
+### have_cache_parameter_group
+
+### belong_to_cache_subnet_group
+
+### belong_to_replication_group
+
+### belong_to_vpc
+
+#### its(:cache_cluster_id), its(:configuration_endpoint), its(:client_download_landing_page), its(:cache_node_type), its(:engine), its(:engine_version), its(:cache_cluster_status), its(:num_cache_nodes), its(:preferred_availability_zone), its(:cache_cluster_create_time), its(:preferred_maintenance_window), its(:notification_configuration), its(:cache_subnet_group_name), its(:auto_minor_version_upgrade), its(:replication_group_id), its(:snapshot_retention_limit), its(:snapshot_window)

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

@@ -0,0 +1,17 @@
+module Awspec::Generator
+  module Doc
+    module Type
+      class Elasticache < Base
+        def initialize
+          super
+          @type_name = 'Elasticache'
+          @type = Awspec::Type::Elasticache.new('my-rep-group-001')
+          @ret = @type.resource
+          @matchers = %w(belong_to_vpc belong_to_replication_group belong_to_cache_subnet_group)
+          @ignore_matchers = []
+          @describes = []
+        end
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder.rb

@@ -10,6 +10,7 @@ require 'awspec/helper/finder/ebs'
 require 'awspec/helper/finder/elb'
 require 'awspec/helper/finder/lambda'
 require 'awspec/helper/finder/iam'
+require 'awspec/helper/finder/elasticache'
 
 module Awspec::Helper
   module Finder
@@ -25,6 +26,7 @@ module Awspec::Helper
     include Awspec::Helper::Finder::Elb
     include Awspec::Helper::Finder::Lambda
     include Awspec::Helper::Finder::Iam
+    include Awspec::Helper::Finder::Elasticache
 
     # rubocop:disable all
     def initialize(id = nil)
@@ -36,6 +38,7 @@ module Awspec::Helper
       @elb_client = Aws::ElasticLoadBalancing::Client.new
       @lambda_client = Aws::Lambda::Client.new
       @iam_client = Aws::IAM::Client.new
+      @elasticache_client = Aws::ElastiCache::Client.new
     end
   end
 end

data/lib/awspec/helper/finder/elasticache.rb

@@ -0,0 +1,21 @@
+module Awspec::Helper
+  module Finder
+    module Elasticache
+      def find_cache_cluster(id)
+        res = @elasticache_client.describe_cache_clusters({
+                                                            cache_cluster_id: id
+                                                          })
+        res[:cache_clusters].first if res[:cache_clusters].count == 1
+      rescue
+        nil
+      end
+
+      def find_cache_subnet_group(group_name)
+        res = @elasticache_client.describe_cache_subnet_groups({
+                                                                 cache_subnet_group_name: group_name
+                                                               })
+        res[:cache_subnet_groups].first if res[:cache_subnet_groups].count == 1
+      end
+    end
+  end
+end

data/lib/awspec/helper/type.rb

@@ -5,7 +5,7 @@ module Awspec
         base ec2 rds rds_db_parameter_group security_group
         vpc s3 route53_hosted_zone auto_scaling_group subnet
         route_table ebs elb lambda iam_user iam_group iam_role
-        iam_policy
+        iam_policy elasticache
       )
 
       TYPES.each do |type|

data/lib/awspec/matcher.rb

@@ -19,3 +19,7 @@ require 'awspec/matcher/belong_to_iam_group'
 
 # IAM User/Group/Role
 require 'awspec/matcher/be_allowed_action'
+
+# ElastiCache
+require 'awspec/matcher/belong_to_replication_group'
+require 'awspec/matcher/belong_to_cache_subnet_group'

data/lib/awspec/matcher/belong_to_cache_subnet_group.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :belong_to_cache_subnet_group do |cache_subnet_group_name|
+  match do |resource|
+    return true if resource.resource[:cache_subnet_group_name] == cache_subnet_group_name
+  end
+end

data/lib/awspec/matcher/belong_to_replication_group.rb

@@ -0,0 +1,6 @@
+RSpec::Matchers.define :belong_to_replication_group do |group_id|
+  match do |resource|
+    # ElastiCache
+    resource.resource[:replication_group_id] == group_id
+  end
+end

data/lib/awspec/stub/elasticache.rb

@@ -0,0 +1,77 @@
+Aws.config[:elasticache] = {
+  stub_responses: {
+    describe_cache_clusters: {
+      cache_clusters:
+        [
+          {
+            cache_cluster_id: 'my-rep-group-001',
+            configuration_endpoint: nil,
+            client_download_landing_page:
+              'https://console.aws.amazon.com/elasticache/home#client-download:',
+            cache_node_type: 'cache.m3.medium',
+            engine: 'redis',
+            engine_version: '2.8.21',
+            cache_cluster_status: 'available',
+            num_cache_nodes: 1,
+            preferred_availability_zone: 'ap-northeast-1b',
+            cache_cluster_create_time: Time.new(2015, 1, 2, 10, 00, 00, '+00:00'),
+            preferred_maintenance_window: 'wed:15:30-wed:16:30',
+            pending_modified_values:
+              {
+                num_cache_nodes: nil,
+                cache_node_ids_to_remove: [],
+                engine_version: nil
+              },
+            notification_configuration: nil,
+            cache_security_groups: [],
+            cache_parameter_group:
+              {
+                cache_parameter_group_name: 'my-cache-parameter-group',
+                parameter_apply_status: 'in-sync',
+                cache_node_ids_to_reboot: []
+              },
+            cache_subnet_group_name: 'my-cache-subnet-group',
+            cache_nodes: [],
+            auto_minor_version_upgrade: true,
+            security_groups: [
+              {
+                security_group_id: 'sg-da1bc2ef',
+                status: 'active'
+              }
+            ],
+            replication_group_id: 'my-rep-group',
+            snapshot_retention_limit: 0,
+            snapshot_window: '17:30-18:30'
+          }
+        ]
+    },
+    describe_cache_subnet_groups: {
+      cache_subnet_groups: [
+        {
+          cache_subnet_group_name: 'my-cache-subnet-group',
+          cache_subnet_group_description: 'stub',
+          vpc_id: 'vpc-ab123cde',
+          subnets: []
+        }
+      ]
+    }
+  }
+}
+
+Aws.config[:ec2] = {
+  stub_responses: {
+    describe_vpcs: {
+      vpcs: [
+        {
+          vpc_id: 'vpc-ab123cde',
+          tags: [
+            {
+              key: 'Name',
+              value: 'my-vpc'
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

data/lib/awspec/type/elasticache.rb

@@ -0,0 +1,31 @@
+module Awspec::Type
+  class Elasticache < Base
+    def initialize(id)
+      super
+      @resource = find_cache_cluster(id)
+      @id = @resource[:cache_cluster_id] if @resource
+    end
+
+    states = %w(
+      available creating deleted deleting
+      incompatible-network modifying
+      rebooting-cache-cluster-nodes restore-failed
+      snapshotting
+    )
+
+    states.each do |state|
+      define_method state.tr('-', '_') + '?' do
+        @resource[:cache_cluster_status] == state
+      end
+    end
+
+    def has_cache_parameter_group?(group_name)
+      @resource[:cache_parameter_group][:cache_parameter_group_name] == group_name
+    end
+
+    def vpc_id
+      cache_subnet_group = find_cache_subnet_group(@resource[:cache_subnet_group_name])
+      cache_subnet_group[:vpc_id] if cache_subnet_group
+    end
+  end
+end

data/lib/awspec/version.rb

@@ -1,3 +1,3 @@
 module Awspec
-  VERSION = '0.12.1'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awspec
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - k1LoW
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -163,6 +163,7 @@ files:
 - doc/_resource_types/lambda.md
 - doc/_resource_types/rds_db_parameter_group.md
 - doc/_resource_types/security_group.md
+- doc/contributing.md
 - doc/resource_types.md
 - lib/awspec.rb
 - lib/awspec/bin/toolbox
@@ -176,6 +177,7 @@ files:
 - lib/awspec/generator/doc/type/base.rb
 - lib/awspec/generator/doc/type/ebs.rb
 - lib/awspec/generator/doc/type/ec2.rb
+- lib/awspec/generator/doc/type/elasticache.rb
 - lib/awspec/generator/doc/type/elb.rb
 - lib/awspec/generator/doc/type/iam_group.rb
 - lib/awspec/generator/doc/type/iam_policy.rb
@@ -203,6 +205,7 @@ files:
 - lib/awspec/helper/finder/auto_scaling.rb
 - lib/awspec/helper/finder/ebs.rb
 - lib/awspec/helper/finder/ec2.rb
+- lib/awspec/helper/finder/elasticache.rb
 - lib/awspec/helper/finder/elb.rb
 - lib/awspec/helper/finder/iam.rb
 - lib/awspec/helper/finder/lambda.rb
@@ -215,8 +218,10 @@ files:
 - lib/awspec/matcher.rb
 - lib/awspec/matcher/be_allowed_action.rb
 - lib/awspec/matcher/be_opened.rb
+- lib/awspec/matcher/belong_to_cache_subnet_group.rb
 - lib/awspec/matcher/belong_to_db_subnet_group.rb
 - lib/awspec/matcher/belong_to_iam_group.rb
+- lib/awspec/matcher/belong_to_replication_group.rb
 - lib/awspec/matcher/belong_to_subnet.rb
 - lib/awspec/matcher/belong_to_vpc.rb
 - lib/awspec/matcher/have_record_set.rb
@@ -226,6 +231,7 @@ files:
 - lib/awspec/stub/auto_scaling_group.rb
 - lib/awspec/stub/ebs.rb
 - lib/awspec/stub/ec2.rb
+- lib/awspec/stub/elasticache.rb
 - lib/awspec/stub/elb.rb
 - lib/awspec/stub/iam_group.rb
 - lib/awspec/stub/iam_policy.rb
@@ -245,6 +251,7 @@ files:
 - lib/awspec/type/base.rb
 - lib/awspec/type/ebs.rb
 - lib/awspec/type/ec2.rb
+- lib/awspec/type/elasticache.rb
 - lib/awspec/type/elb.rb
 - lib/awspec/type/iam_group.rb
 - lib/awspec/type/iam_policy.rb