hiera-aws 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1562b0fa2d2ba741b2f5b12baff4e13567d72849
-  data.tar.gz: f00a5df6b7c0d3c58ff7f9faff00c2e09aaeab49
+  metadata.gz: 6804168e6c111bd7e5edc20f782abbecb230ac19
+  data.tar.gz: 50a75291e7d1625444d21fa37d67cd3669edac7d
 SHA512:
-  metadata.gz: 048087837fc6f406e5e8e3a70b1b1685114fdfbe80a79fb367437d31c55fe52f8476badd34e3d0e175886b313134f0689985438a43a1fb768359ad1a08cb27e9
-  data.tar.gz: 2af386fad0a859c8b7d133a9a2a4c12bea04c7c38c5c4402243ecdfdeb63cb4db65713e703135da99f257db728172d36f26b77c845b1206ca55fff6b0085f9f1
+  metadata.gz: 4a0045d0fd95522afd2197e21aeccfdacd5e1cca54013aa7315de2cf214ed41fb8610abeec10d144ce74eb00289f360b78817a9ffe705a73ee564cb575d51d6b
+  data.tar.gz: 724067dda2420c650282104587d56c444ce776e2ffca8b90f1e7e4579fc2bd9fc839057dc773fb5fe6b0e6018a2ff87c1d7e7373a57afb0b3d93c1403288d17b

data/README.md

@@ -97,6 +97,9 @@ cluster_nodes = hiera("memcached_cluster_nodes_for_cfn_stack")
 
 ### rds tag=value...
 
+**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.**
+
 Returns an array of all RDS database instances that have one or more tags. The
 returned array has the format `["host1", "host2"]`.
 
@@ -113,6 +116,38 @@ rds_instances = hiera("rds environment=dev")
 rds_instances = hiera("rds environment=production role=mgmt-db")
 ```
 
+### rds_instances tag=value...
+
+Returns an array of all RDS database instances that have one or more tags
+assigned.
+
+For each instance in the array the following hash is returned:
+
+```json
+{
+    "db_instance_identifier" => "some-instance-identifier",
+    "endpoint" => {"address" => "some.rds.endpoint", "port" => 3306},
+    "engine" => "mysql"
+}
+```
+
+Usage:
+
+```
+# Get all RDS instances
+rds_instances = hiera("rds_instances")
+
+# Get all RDS instances that have a tag named "environment" with the value "dev"
+rds_instances = hiera("rds_instances environment=dev")
+
+# Get all RDS instances that have two specific tags
+rds_instances = hiera("rds_instances environment=production role=mgmt-db")
+
+# Accessing specific properties of the first RDS instance
+$instance_identifier = $rds_instances[0]['db_instance_identifier']
+$endpoint_address = $rds_instances[0]['endpoint']['address']
+```
+
 ## License and Authors
 
 * Author:: Mathias Lafeldt (mathias.lafeldt@jimdo.com)

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

@@ -37,6 +37,22 @@ class Hiera
           return nil if fact == :undefined
           fact
         end
+
+        # Inspired by http://devblog.avdi.org/2009/07/14/recursively-symbolize-keys/
+        def stringify_keys(hash)
+          hash.reduce({}) do |result, (key, value)|
+            new_key = case key
+                      when Symbol then key.to_s
+                      else key
+                      end
+            new_value = case value
+                        when Hash then stringify_keys(value)
+                        else value
+                        end
+            result[new_key] = new_value
+            result
+          end
+        end
       end
     end
   end

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

@@ -11,21 +11,32 @@ class Hiera
         end
 
         # Override default key lookup to implement custom format. Examples:
-        #  - hiera("rds")
-        #  - hiera("rds environment=dev")
-        #  - hiera("rds role=mgmt-db")
-        #  - hiera("rds environment=production role=mgmt-db")
+        #  - hiera("rds_instances")
+        #  - hiera("rds_instances environment=dev")
+        #  - hiera("rds_instances role=mgmt-db")
+        #  - hiera("rds_instances environment=production role=mgmt-db")
         def lookup(key, scope)
           r = super(key, scope)
           return r if r
 
           args = key.split
-          if args.shift == "rds"
+          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.length > 0
               tags = Hash[args.map { |t| t.split("=") }]
-              db_instances_with_tags(tags).map { |i| i[:endpoint][:address] }
+              db_instances_with_tags(tags)
             else
-              db_instances.map { |i| i[:endpoint][:address] }
+              db_instances
+            end.map do |i|
+              if subkey == "rds"
+                i[:endpoint][:address]
+              else
+                prepare_instance_data(i)
+              end
             end
           end
         end
@@ -38,7 +49,7 @@ class Hiera
 
         def db_instances_with_tags(tags)
           db_instances.select do |i|
-            all_tags = db_instance_tags(i[:db_instance_identifier])
+            all_tags = db_instance_tags(i.fetch(:db_instance_identifier))
             tags.all? { |k, v| tags[k] == all_tags[k] }
           end
         end
@@ -51,6 +62,16 @@ class Hiera
           tags = @client.list_tags_for_resource(:resource_name => db_resource_name(db_instance_id))
           Hash[tags[:tag_list].map { |t| [t[:key], t[:value]] }]
         end
+
+        # Prepare RDS instance data for consumption by Puppet. For Puppet to
+        # work, all hash keys have to be converted from symbols to strings.
+        def prepare_instance_data(hash)
+          {
+            "db_instance_identifier" => hash.fetch(:db_instance_identifier),
+            "endpoint"               => stringify_keys(hash.fetch(:endpoint)),
+            "engine"                 => hash.fetch(:engine)
+          }
+        end
       end
     end
   end

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

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

data/lib/hiera/backend/aws_backend.rb

@@ -21,7 +21,7 @@ class Hiera
       def lookup(key, scope, order_override, resolution_type)
         answer = nil
 
-        Hiera.debug("Looking up #{key} in AWS backend")
+        Hiera.debug("Looking up '#{key}' in AWS backend")
 
         Backend.datasources(scope, order_override) do |source|
           Hiera.debug("Looking for data source #{source}")

data/spec/aws_rds_spec.rb

@@ -9,15 +9,18 @@ class Hiera
           :db_instances => [
             {
               :db_instance_identifier => "db1",
-              :endpoint => { :address => "db1.eu-west-1.rds.amazonaws.com" }
+              :endpoint => { :address => "db1.eu-west-1.rds.amazonaws.com" },
+              :engine => "mysql"
             },
             {
               :db_instance_identifier => "db2",
-              :endpoint => { :address => "db2.eu-west-1.rds.amazonaws.com" }
+              :endpoint => { :address => "db2.eu-west-1.rds.amazonaws.com" },
+              :engine => "mysql"
             },
             {
               :db_instance_identifier => "db3",
-              :endpoint => { :address => "db3.eu-west-1.rds.amazonaws.com" }
+              :endpoint => { :address => "db3.eu-west-1.rds.amazonaws.com" },
+              :engine => "mysql"
             }
           ]
         }
@@ -53,7 +56,10 @@ class Hiera
         end
       end
 
-      describe "#lookup" do
+      # 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
@@ -78,6 +84,78 @@ class Hiera
           expect(rds.lookup("rds environment=staging", scope)).to eq []
         end
       end
+
+      describe "rds_instances lookup" 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_instances", scope)).to eq [
+            {
+              "db_instance_identifier" => "db1",
+              "endpoint" => { "address" => "db1.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            },
+            {
+              "db_instance_identifier" => "db2",
+              "endpoint" => { "address" => "db2.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            },
+            {
+              "db_instance_identifier" => "db3",
+              "endpoint" => { "address" => "db3.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            }
+          ]
+        end
+
+        it "returns database instances with role tag" do
+          expect(rds.lookup("rds_instances role=mgmt-db", scope)).to eq [
+            {
+              "db_instance_identifier" => "db2",
+              "endpoint" => { "address" => "db2.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            },
+            {
+              "db_instance_identifier" => "db3",
+              "endpoint" => { "address" => "db3.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            }
+          ]
+        end
+
+        it "returns database instances with environment tag" do
+          expect(rds.lookup("rds_instances environment=dev", scope)).to eq [
+            {
+              "db_instance_identifier" => "db1",
+              "endpoint" => { "address" => "db1.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            },
+            {
+              "db_instance_identifier" => "db2",
+              "endpoint" => { "address" => "db2.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            }
+          ]
+        end
+
+        it "returns database instances with environment and role tags" do
+          expect(rds.lookup("rds_instances environment=production role=mgmt-db", scope)).to eq [
+            {
+              "db_instance_identifier" => "db3",
+              "endpoint" => { "address" => "db3.eu-west-1.rds.amazonaws.com" },
+              "engine" => "mysql"
+            }
+          ]
+        end
+
+        it "returns empty array if no database instances can be found" do
+          expect(rds.lookup("rds_instances environment=staging", scope)).to eq []
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiera-aws
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk