hiera-aws 0.2.0 → 0.3.0

data/.rubocop.yml

@@ -15,3 +15,5 @@ SignalException:
   Enabled: false
 StringLiterals:
   Enabled: false
+TrailingComma:
+  Enabled: false

data/README.md

@@ -64,21 +64,6 @@ will be used for all AWS API operations:
 The backend currently supports the following keys that you can pass to the
 `hiera()` function to look up objects in AWS.
 
-### cache_nodes_by_cache_cluster_id
-
-Returns an array of all nodes part of a ElastiCache cluster. The cluster is
-identified by its physical ID which must be passed to the backend via the Puppet
-fact `$cache_cluster_id`. The returned array has the format `["host1:port",
-"host2:port"]`.
-
-Usage:
-
-```
-$cache_cluster_id = "your_cluster_id"
-
-cluster_nodes = hiera("cache_nodes_by_cache_cluster_id")
-```
-
 ### redis_cluster_nodes_for_cfn_stack
 
 Returns an array of all Redis cluster nodes for the CloudFormation stack of an
@@ -91,37 +76,37 @@ Usage:
 cluster_nodes = hiera("redis_cluster_nodes_for_cfn_stack")
 ```
 
-### memcached_cluster_nodes_for_cfn_stack
+### redis_cluster_replica_groups_for_cfn_stack
 
-Returns an array of all Memcached cluster nodes for the CloudFormation stack of
-an EC2 instance. The instance is identified by the Puppet fact
-`$ec2_instance_id`. The returned array has the format `["host1", "host2"]`.
+Returns an array of the Redis Replication Groups of all Redis cluster nodes for
+the CloudFormation stack of an EC2 Instance. The instance is identified by the
+Puppet fact `$ec2_instance_id`.
 
 Usage:
 
 ```
-cluster_nodes = hiera("memcached_cluster_nodes_for_cfn_stack")
+elasticache_redis_replication_groups = hiera("redis_cluster_replica_groups_for_cfn_stack")
 ```
 
-### rds tag=value...
+For each replica group in the array the following hash is returned:
 
-**Note: "rds" has been superseded by "rds_instances" (see below). It is still
-supported for backward compatibility, but will be removed in a future version.**
+```json
+{
+    "replication_group_id" => "some-group-id",
+    "primary_endpoint"     => { "address" => "some.replication.group.primary.endpoint", "port" => 1234 }
+}
+```
+
+### memcached_cluster_nodes_for_cfn_stack
 
-Returns an array of all RDS database instances that have one or more tags. The
-returned array has the format `["host1", "host2"]`.
+Returns an array of all Memcached cluster nodes for the CloudFormation stack of
+an EC2 instance. The instance is identified by the Puppet fact
+`$ec2_instance_id`. The returned array has the format `["host1", "host2"]`.
 
 Usage:
 
 ```
-# Get all database instances
-rds_instances = hiera("rds")
-
-# Get all database instances that have a tag named "environment" with the value "dev"
-rds_instances = hiera("rds environment=dev")
-
-# Get all database instances that have two specific tags
-rds_instances = hiera("rds environment=production role=mgmt-db")
+cluster_nodes = hiera("memcached_cluster_nodes_for_cfn_stack")
 ```
 
 ### rds_instances tag=value...
@@ -160,8 +145,9 @@ $endpoint_address = $rds_instances[0]['endpoint']['address']
 
 * Author:: Mathias Lafeldt (mathias.lafeldt@jimdo.com)
 * Author:: Deniz Adrian (deniz.adrian@jimdo.com)
+* Author:: Soenke Ruempler (soenke.ruempler@jimdo.com)
 
-Copyright:: 2013, Jimdo GmbH
+Copyright:: 2013-2014, Jimdo GmbH
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/hiera-aws.gemspec

@@ -6,8 +6,8 @@ require "hiera/backend/aws/version"
 Gem::Specification.new do |spec|
   spec.name          = "hiera-aws"
   spec.version       = Hiera::Backend::Aws::VERSION
-  spec.authors       = ["Mathias Lafeldt", "Deniz Adrian"]
-  spec.email         = ["mathias.lafeldt@jimdo.com", "deniz.adrian@jimdo.com"]
+  spec.authors       = ["Mathias Lafeldt", "Deniz Adrian", "Soenke Ruempler"]
+  spec.email         = ["mathias.lafeldt@jimdo.com", "deniz.adrian@jimdo.com", "soenke.ruempler@jimdo.com"]
   spec.description   = %q{Hiera AWS Backend}
   spec.summary       = %q{Hiera AWS Backend}
   spec.homepage      = "https://github.com/Jimdo/hiera-aws"

data/lib/hiera/backend/aws/elasticache.rb

@@ -5,16 +5,7 @@ class Hiera
     module Aws
       # Implementation of Hiera keys for aws/elasticache
       class ElastiCache < Base
-        def cache_nodes_by_cache_cluster_id
-          client = AWS::ElastiCache::Client.new
-          cache_cluster_id = scope["cache_cluster_id"]
-          raise MissingFactError, "cache_cluster_id not found" unless cache_cluster_id
-          options = { :cache_cluster_id => cache_cluster_id, :show_cache_node_info => true }
-          nodes = client.describe_cache_clusters(options)[:cache_clusters].first[:cache_nodes]
-          nodes.map { |node| "#{node[:endpoint][:address]}:#{node[:endpoint][:port]}" }
-        end
-
-        #
+          #
         # XXX: Lots of spiked code ahead that MUST be refactored.
         #
         def cfn_stack_name(instance_id)
@@ -65,6 +56,40 @@ class Hiera
           endpoints
         end
 
+        def cluster_replica_groups_for_cfn_stack(cluster_engine = nil)
+          ec2_instance_id = scope["ec2_instance_id"]
+          raise MissingFactError, "ec2_instance_id not found" unless ec2_instance_id
+
+          replica_groups = {}
+          stack_name = cfn_stack_name(ec2_instance_id)
+
+          clusters = cache_clusters_in_cfn_stack(stack_name, cluster_engine)
+          clusters.each do |cluster|
+            replication_group_id = cluster[:replication_group_id]
+            next unless replication_group_id
+
+            client = AWS::ElastiCache::Client.new
+            replication_group = client.describe_replication_groups(:replication_group_id => replication_group_id)[:replication_groups].first
+
+            primary_endpoint = replication_group.fetch(:node_groups).first.fetch(:primary_endpoint)
+
+            replica_groups[replication_group_id] = {
+              :primary_endpoint => primary_endpoint
+            }
+          end
+
+          replica_groups.map do |k, v|
+            {
+              "replication_group_id" => k,
+              "primary_endpoint"     => stringify_keys(v[:primary_endpoint])
+            }
+          end
+        end
+
+        def redis_cluster_replica_groups_for_cfn_stack
+          cluster_replica_groups_for_cfn_stack(:redis)
+        end
+
         def redis_cluster_nodes_for_cfn_stack
           cluster_nodes_for_cfn_stack(:redis)
         end

data/lib/hiera/backend/aws/rds.rb

@@ -20,24 +20,13 @@ class Hiera
           return r if r
 
           args = key.split
-          subkey = args.shift
-
-          # TODO: "rds" has been superseded by "rds_instances" but is still
-          # supported for backward compatibility. Remove it in a future
-          # version.
-          if %w(rds rds_instances).include? subkey
+          if args.shift == "rds_instances"
             if args.length > 0
               tags = Hash[args.map { |t| t.split("=") }]
               db_instances_with_tags(tags)
             else
               db_instances
-            end.map do |i|
-              if subkey == "rds"
-                i[:endpoint][:address]
-              else
-                prepare_instance_data(i)
-              end
-            end
+            end.map { |i| prepare_instance_data(i) }
           end
         end
 

data/lib/hiera/backend/aws/version.rb

@@ -1,7 +1,7 @@
 class Hiera
   module Backend
     module Aws # rubocop:disable Documentation
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/spec/aws_elasticache_spec.rb

@@ -3,34 +3,6 @@ require "hiera/backend/aws/elasticache"
 class Hiera
   module Backend # rubocop:disable Documentation
     describe Aws::ElastiCache do
-      let(:ec_redis_client) do
-        double(
-          :describe_cache_clusters => {
-            :cache_clusters => [{
-              :cache_nodes => [
-                { :endpoint => { :address => "1.1.1.1", :port => 1234 } },
-                { :endpoint => { :address => "2.2.2.2", :port => 1234 } }
-
-              ],
-              :engine => "redis"
-            }]
-          }
-        )
-      end
-      let(:ec_memcached_client) do
-        double(
-          :describe_cache_clusters => {
-            :cache_clusters => [{
-              :cache_nodes => [
-                { :endpoint => { :address => "3.3.3.3", :port => 5678 } },
-                { :endpoint => { :address => "4.4.4.4", :port => 5678 } }
-
-              ],
-              :engine => "memcached"
-            }]
-          }
-        )
-      end
       let(:ec2_client) do
         double(
           :instances => {
@@ -54,29 +26,33 @@ class Hiera
           }
         )
       end
+      let(:elasticache) do
+        scope = { "ec2_instance_id" => "some-ec2-instance-id" }
+        Aws::ElastiCache.new scope
+      end
+
+      let(:some_cache_node) { { :endpoint => { :address => "1.1.1.1", :port => 1234 } } }
+      let(:another_cache_node) { { :endpoint => { :address => "2.2.2.2", :port => 1234 } } }
 
       before do
         AWS::EC2.stub(:new => ec2_client)
         AWS::CloudFormation.stub(:new => cfn_client)
       end
 
-      describe "#cache_nodes_by_cache_cluster_id" do
-        it "raises an exception when called without cache_cluster_id set" do
-          elasticache = Aws::ElastiCache.new
-          expect do
-            elasticache.cache_nodes_by_cache_cluster_id
-          end.to raise_error Aws::MissingFactError
-        end
+      describe "#redis_cluster_nodes_for_cfn_stack" do
+        let(:cache_clusters) do
+          {
+            :cache_clusters => [{
+              :cache_nodes => [
+                some_cache_node,
+                another_cache_node
 
-        it "returns all nodes in cache cluster" do
-          scope = { "cache_cluster_id" => "some-cluster-id" }
-          elasticache = Aws::ElastiCache.new scope
-          AWS::ElastiCache::Client.stub(:new => ec_redis_client)
-          expect(elasticache.cache_nodes_by_cache_cluster_id).to eq ["1.1.1.1:1234", "2.2.2.2:1234"]
+              ],
+              :engine => "redis"
+            }]
+          }
         end
-      end
 
-      describe "#redis_cluster_nodes_for_cfn_stack" do
         it "raises an exception when ec2_instance_id fact is missing" do
           elasticache = Aws::ElastiCache.new
           expect do
@@ -85,13 +61,171 @@ class Hiera
         end
 
         it "returns all Redis cluster nodes for CloudFormation stack of EC2 instance" do
-          scope = { "ec2_instance_id" => "some-ec2-instance-id" }
-          elasticache = Aws::ElastiCache.new scope
-          AWS::ElastiCache::Client.stub(:new => ec_redis_client)
+          client = double
+          allow(client).to receive(:describe_cache_clusters).and_return(cache_clusters)
+          AWS::ElastiCache::Client.stub(:new => client)
+
           expect(elasticache.redis_cluster_nodes_for_cfn_stack).to eq ["1.1.1.1", "2.2.2.2"]
         end
       end
 
+      describe "#redis_cluster_replica_groups_for_cfn_stack" do
+        let(:cache_clusters) do
+          {
+            :cache_clusters => [{
+              :cache_nodes => [
+                some_cache_node,
+
+              ],
+              :replication_group_id => "some-group-id",
+              :engine => "redis",
+            }]
+          }
+        end
+        let(:replication_groups) do
+          {
+            :replication_groups => [{
+              :node_groups => [{
+                :primary_endpoint => { :address => "some.replication.group.primary.endpoint", :port => 1234 }
+              }]
+            }]
+          }
+        end
+
+        it "returns all Redis replica groups for CloudFormation stack of EC2 instance" do
+          client = double
+          allow(client).to receive(:describe_cache_clusters).and_return(cache_clusters)
+          allow(client).to receive(:describe_replication_groups).with(:replication_group_id => "some-group-id").and_return(replication_groups)
+          AWS::ElastiCache::Client.stub(:new => client)
+
+          expect(elasticache.redis_cluster_replica_groups_for_cfn_stack).to eq [
+            {
+              "replication_group_id" => "some-group-id",
+              "primary_endpoint"     => { "address" => "some.replication.group.primary.endpoint", "port" => 1234 }
+            },
+          ]
+        end
+
+        context "multiple defined cache clusters are in the same replica group" do
+          let(:cache_clusters) do
+            {
+              :cache_clusters => [
+                {
+                  :cache_nodes => [
+                    some_cache_node,
+                  ],
+                  :replication_group_id => "some-group-id",
+                  :engine => "redis",
+                },
+                {
+                  :cache_nodes => [
+                    another_cache_node,
+                  ],
+                  :replication_group_id => "some-group-id",
+                  :engine => "redis",
+                },
+              ]
+            }
+          end
+          let(:replication_groups) do
+            {
+              :replication_groups => [{
+                :node_groups => [{
+                  :primary_endpoint => { :address => "some.replication.group.primary.endpoint", :port => 1234 }
+                }]
+              }]
+            }
+          end
+
+          it "returns a deduplicated list of Redis replica groups" do
+            client = double
+            allow(client).to receive(:describe_cache_clusters).and_return(cache_clusters)
+            allow(client).to receive(:describe_replication_groups).with(:replication_group_id => "some-group-id").and_return(replication_groups)
+            AWS::ElastiCache::Client.stub(:new => client)
+
+            expect(elasticache.redis_cluster_replica_groups_for_cfn_stack).to eq [
+              {
+                "replication_group_id" => "some-group-id",
+                "primary_endpoint"     => { "address" => "some.replication.group.primary.endpoint", "port" => 1234 }
+              },
+            ]
+          end
+        end
+
+        context "one defined cluster is found without replica group" do
+          let(:cfn_client) do
+            double(
+              :stacks => {
+                "some-stack-name" => double(
+                  :resources => [
+                    double(
+                      :resource_type => "AWS::ElastiCache::CacheCluster",
+                      :physical_resource_id => "some-cluster-id"
+                    ),
+                    double(
+                      :resource_type => "AWS::ElastiCache::CacheCluster",
+                      :physical_resource_id => "another-cluster-id"
+                    ),
+                  ]
+                )
+              }
+            )
+          end
+          let(:cache_clusters) do
+            {
+              "some-cluster-id" => {
+                :cache_clusters => [
+                  {
+                    :cache_nodes => [
+                      some_cache_node,
+                    ],
+                    :replication_group_id => "some-group-id",
+                    :engine => "redis",
+                  },
+                ]
+              },
+              "another-cluster-id" => {
+                :cache_clusters => [
+                  {
+                    :cache_nodes => [
+                      another_cache_node,
+                    ],
+                    :engine => "redis",
+                  },
+                ]
+              }
+            }
+          end
+          let(:replication_groups) do
+            {
+              :replication_groups => [{
+                :node_groups => [{
+                  :primary_endpoint => { :address => "some.replication.group.primary.endpoint", :port => 1234 }
+                }]
+              }]
+            }
+          end
+
+          it "returns all Redis replica groups and does not fail" do
+
+            client = double
+            allow(client).to receive(:describe_cache_clusters) do |options|
+              cache_clusters.fetch(options.fetch(:cache_cluster_id))
+            end
+
+            allow(client).to receive(:describe_replication_groups).with(:replication_group_id => "some-group-id").and_return(replication_groups)
+            AWS::ElastiCache::Client.stub(:new => client)
+
+            expect(elasticache.redis_cluster_replica_groups_for_cfn_stack).to eq [
+              {
+                "replication_group_id" => "some-group-id",
+                "primary_endpoint"     => { "address" => "some.replication.group.primary.endpoint", "port" => 1234 }
+              },
+            ]
+          end
+        end
+      end
+
       describe "#memcached_cluster_nodes_for_cfn_stack" do
         it "raises an exception when ec2_instance_id fact is missing" do
           elasticache = Aws::ElastiCache.new
@@ -100,11 +234,27 @@ class Hiera
           end.to raise_error Aws::MissingFactError
         end
 
-        it "returns all Memcached cluster nodes for CloudFormation stack of EC2 instance" do
-          scope = { "ec2_instance_id" => "some-ec2-instance-id" }
-          elasticache = Aws::ElastiCache.new scope
-          AWS::ElastiCache::Client.stub(:new => ec_memcached_client)
-          expect(elasticache.memcached_cluster_nodes_for_cfn_stack).to eq ["3.3.3.3", "4.4.4.4"]
+        context "single cache cluster" do
+          let(:cache_clusters) do
+            {
+              :cache_clusters => [{
+                :cache_nodes => [
+                  { :endpoint => { :address => "3.3.3.3", :port => 5678 } },
+                  { :endpoint => { :address => "4.4.4.4", :port => 5678 } }
+
+                ],
+                :engine => "memcached"
+              }]
+            }
+          end
+
+          it "returns all Memcached cluster nodes for CloudFormation stack of EC2 instance" do
+            client = double
+            allow(client).to receive(:describe_cache_clusters).and_return(cache_clusters)
+            AWS::ElastiCache::Client.stub(:new => client)
+
+            expect(elasticache.memcached_cluster_nodes_for_cfn_stack).to eq ["3.3.3.3", "4.4.4.4"]
+          end
         end
       end
     end

data/spec/aws_rds_spec.rb

@@ -58,36 +58,7 @@ class Hiera
         end
       end
 
-      # TODO: "rds" has been superseded by "rds_instances" but is still
-      # supported for backward compatibility. Remove it in a future
-      # version.
-      describe "rds lookup (deprecated)" do
-        let(:scope) { { "aws_account_number" => "12345678" } }
-
-        it "returns nil if Hiera key is unknown" do
-          expect(rds.lookup("doge", scope)).to be_nil
-        end
-
-        it "returns all database instances if no tags are provided" do
-          expect(rds.lookup("rds", scope)).to eq ["db1.some-region.rds.amazonaws.com",
-                                                  "db2.some-region.rds.amazonaws.com",
-                                                  "db3.some-region.rds.amazonaws.com"]
-        end
-
-        it "returns database instances with specific tags" do
-          expect(rds.lookup("rds role=mgmt-db", scope)).to eq ["db2.some-region.rds.amazonaws.com",
-                                                               "db3.some-region.rds.amazonaws.com"]
-          expect(rds.lookup("rds environment=dev", scope)).to eq ["db1.some-region.rds.amazonaws.com",
-                                                                  "db2.some-region.rds.amazonaws.com"]
-          expect(rds.lookup("rds environment=production role=mgmt-db", scope)).to eq ["db3.some-region.rds.amazonaws.com"]
-        end
-
-        it "returns empty array if no database instances can be found" do
-          expect(rds.lookup("rds environment=staging", scope)).to eq []
-        end
-      end
-
-      describe "rds_instances lookup" do
+      describe "#lookup" do
         let(:scope) { { "aws_account_number" => "12345678" } }
 
         it "returns nil if Hiera key is unknown" do

metadata

@@ -1,90 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: hiera-aws
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Mathias Lafeldt
 - Deniz Adrian
+- Soenke Ruempler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Hiera AWS Backend
 email:
 - mathias.lafeldt@jimdo.com
 - deniz.adrian@jimdo.com
+- soenke.ruempler@jimdo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,26 +122,27 @@ files:
 homepage: https://github.com/Jimdo/hiera-aws
 licenses:
 - Apache 2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Hiera AWS Backend
 test_files:
 - spec/aws_backend_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: eed5fc6fc7e3723477b66a94f61fb6f9192320dc
-  data.tar.gz: 0c7263e0a1706423950e1b2492d523066cb12293
-SHA512:
-  metadata.gz: 31a9141fbe5a274ff9e978446c4a87f57b5353c3ff9c77140ffca86dc1dfd74ffa50d92bc6c70a1a17f17a645e5e5899b5bffed9eafb0f972e74c3daa740958d
-  data.tar.gz: f131c2343c0fb05f3de4c48a8a39b73dcfb91a2e6544a61ac394946636223d2e086549dd713dd937bbf37ac0d094617fd5157db2af98b881a4aae2d0cb46094e