carinadigital-hiera-cloudformation 0.0.1.4 → 0.0.2.0

data/LICENSE.txt

@@ -1,22 +1,13 @@
-Copyright (c) 2013 Hugh Cole-Baker
+Copyright 2013-2014 FanDuel Ltd.
 
-MIT License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+	http://www.apache.org/licenses/LICENSE-2.0
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -29,14 +29,20 @@ If you do not add these keys to your configuration file, the access keys will be
 the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables, or from an IAM
 instance role (if you are running Hiera on an EC2 instance with an IAM role assigned).
 
-You can also add a region setting to the `:cloudformation` section in
-hiera.yaml:
+The AWS region to use can also be configured in the `:cloudformation` section of hiera.yaml.
+You can also tell the backend to convert string literals "true", "false", "3.14", etc to Boolean
+or Number types with the `:parse_metadata` configuration option; this may be useful as
+CloudFormation will convert Booleans and Numbers in the template JSON metadata into Strings when
+retrieved from a stack resource:
 
     :cloudformation:
-      :region: us-west-2
+      :region: 'us-west-1'
+      :parse_metadata: true
 
-If not specified, the region setting will be looked up from the `AWS_REGION`
-environment variable, or `us-west-2` if not set.
+For use in multiple AWS regions, the region can be set by an interpolated variable.
+
+    :cloudformation:
+      :region: %{::examplefact_region}
 
 To use this backend you also need to add entries to your "hierarchy" in your hiera.yaml file.
 If you put an entry of this form in your hierarchy:
@@ -110,3 +116,12 @@ and you include an entry:
 
 in your hierarchy, you can query hiera for the key "class::access_key_id" or "class::secret_access_key"
 and retrieve the attributes of the "MyIAMKey" resource created by CloudFormation.
+
+
+## Run tests
+
+Requires ruby 1.9+ for minitest
+
+```bash
+rake test
+```

data/Rakefile

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 FanDuel Ltd.
+Copyright 2013-2014 FanDuel Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -16,14 +16,15 @@ limitations under the License.
 
 require 'rubygems'
 require 'rubygems/package_task'
+require 'rake/testtask'
 
 spec = Gem::Specification.new do |gem|
 	gem.name          = "carinadigital-hiera-cloudformation"
-	gem.version       = '0.0.1.4'
+	gem.version       = '0.0.2.0'
 	gem.authors       = ["carinadigital"]
 	gem.email         = ["carinadigital@gmail.com"]
 	gem.summary       = %q{CloudFormation backend for Hiera}
-	gem.description   = %q{Forked from hiera-cloudformation. Queries CloudFormation stack outputs or resource metadata for Hiera data.}
+	gem.description   = %q{Forked from hiera-cloudformation. Multiregion cloudFormation quieries of stack outputs or resource metadata for Hiera.}
 	gem.homepage      = "https://github.com/carinadigital/hiera-cloudformation"
 	gem.license       = "Apache License (2.0)"
 
@@ -33,13 +34,16 @@ spec = Gem::Specification.new do |gem|
 	gem.require_paths = ["lib"]
 
 	gem.add_development_dependency "rake"
-	gem.add_runtime_dependency "nokogiri", "~> 1.5.11"
-	gem.add_runtime_dependency "aws-sdk", "~> 1.33.0"
+	gem.add_runtime_dependency "aws-sdk", "~> 1.11.2"
 	gem.add_runtime_dependency "timedcache", "~> 0.4.0"
 	gem.add_runtime_dependency "json", "~> 1.8.0"
-
 end
 
 Gem::PackageTask.new(spec) do |pkg|
 	pkg.need_tar = true
 end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/lib/hiera/backend/cloudformation_backend.rb

@@ -1,5 +1,5 @@
 =begin
-Copyright 2013 FanDuel Ltd.
+Copyright 2013-2014 FanDuel Ltd.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -31,36 +31,65 @@ class Hiera
 					require 'json'
 				end
 
-				if Config.include?(:cloudformation) && !Config[:cloudformation].nil?
-					aws_config = {}
-					if Config[:cloudformation].include?(:access_key_id) && Config[:cloudformation].include?(:secret_access_key)
-						Hiera.debug("Found AWS access key from configuration")
-						aws_config[:access_key_id] = Config[:cloudformation][:access_key_id]
-						aws_config[:secret_access_key] = Config[:cloudformation][:secret_access_key]
+				if Config.include?(:cloudformation) && !Config[:cloudformation].nil? then
+					if Config[:cloudformation].fetch(:parse_metadata, false) then
+						Hiera.debug("Will convert CloudFormation stringified metadata back to numbers or booleans.")
+						@parse_metadata = true
+					else
+						@parse_metadata = false
 					end
-					if Config[:cloudformation].include?(:region)
-						Hiera.debug("Found AWS region from configuration")
-						aws_config[:region] = Config[:cloudformation][:region]
+
+					@aws_config = {}
+					if Config[:cloudformation].include?(:access_key_id) && Config[:cloudformation].include?(:secret_access_key) then
+						Hiera.debug("Found AWS access key #{Config[:cloudformation][:access_key_id]} from configuration")
+						@aws_config[:access_key_id] = Config[:cloudformation][:access_key_id]
+						@aws_config[:secret_access_key] = Config[:cloudformation][:secret_access_key]
 					end
-					if aws_config.length == 0
-						Hiera.debug("CloudFormation configuration is found, but none of the settings are recognized.")
-					else
-						AWS.config(aws_config)
+					if Config[:cloudformation].include?(:region) then
+						Hiera.debug("Found AWS region #{Config[:cloudformation][:region]} from configuration")
+						@aws_config[:region] = Config[:cloudformation][:region]
 					end
+
 				else
 					Hiera.debug("No configuration found, will fall back to env variables or IAM role")
+					@cf = AWS::CloudFormation.new
 				end
 
-				@cf = AWS::CloudFormation.new
 				@output_cache = TimedCache.new
 				@resource_cache = TimedCache.new
 
 				Hiera.debug("Hiera cloudformation backend loaded")
 			end
 
+
+			def create_connection(scope)
+
+				# If we already have a connection object then return early.
+				if defined? @cf then
+					return
+				end
+
+				# Interpolate the value from hiera.yaml
+				if @aws_config.include?(:region)
+					@aws_config[:region] = Backend.parse_answer(@aws_config[:region], scope)
+	 				Hiera.debug("Using lookups from region #{@aws_config[:region]} for this run.")
+	 			end
+
+				if @aws_config.length != 0 then
+					@cf = AWS::CloudFormation.new(@aws_config)
+				else
+					Hiera.debug("No AWS configuration found, will fall back to env variables or IAM role")
+					@cf = AWS::CloudFormation.new
+				end
+			end
+
+
 			def lookup(key, scope, order_override, resolution_type)
 				answer = nil
 
+				# Idempotent connection creation.
+	  			create_connection(scope)
+
 				Backend.datasources(scope, order_override) do |elem|
 					case elem
 					when /cfstack\/([^\/]+)\/outputs/
@@ -76,6 +105,10 @@ class Hiera
 
 					next if raw_answer.nil?
 
+					if @parse_metadata then
+						raw_answer = convert_metadata(raw_answer)
+					end
+
 					new_answer = Backend.parse_answer(raw_answer, scope)
 
 					case resolution_type
@@ -140,6 +173,36 @@ class Hiera
 
 				return nil
 			end
+
+			def convert_metadata(json_object)
+				if json_object.is_a?(Hash) then
+					# convert each value of a Hash
+					converted_object = {}
+					json_object.each do |key, value|
+						converted_object[key] = convert_metadata(value)
+					end
+					return converted_object
+				elsif json_object.is_a?(Array) then
+					# convert each item in an Array
+					return json_object.map { |item| convert_metadata(item) }
+				elsif json_object == "true" then
+					# Boolean literals
+					return true
+				elsif json_object == "false" then
+					return false
+				elsif json_object == "null" then
+					return nil
+				elsif /^-?([1-9]\d*|0)(.\d+)?([eE][+-]?\d+)?$/.match(json_object) then
+					# Numeric literals
+					if json_object.include?('.') then
+						return json_object.to_f
+					else
+						return json_object.to_i
+					end
+				else
+					return json_object
+				end
+			end
 		end
 	end
 end

data/test/convert_metadata_test.rb

@@ -0,0 +1,51 @@
+require 'minitest/autorun'
+require_relative '../lib/hiera/backend/cloudformation_backend'
+
+class ConvertMetadataTest < MiniTest::Unit::TestCase
+
+  class CloudformationBackendNoInit < Hiera::Backend::Cloudformation_backend
+    def initialize
+      # nope
+    end
+  end
+
+  def setup
+    @cfb = CloudformationBackendNoInit.new
+  end
+
+  def test_boolean
+    assert_equal true, @cfb.convert_metadata("true")
+    assert_equal false, @cfb.convert_metadata("false")
+  end
+
+  def test_nil
+    assert_equal nil, @cfb.convert_metadata("null")
+  end
+
+  def test_integer
+    assert_equal 1, @cfb.convert_metadata("1")
+    assert_equal -1, @cfb.convert_metadata("-1")
+  end
+
+  def test_float
+    assert_in_delta 1.0, @cfb.convert_metadata("1.0"), 0.001
+    assert_in_delta -1.0, @cfb.convert_metadata("-1.0"), 0.001
+  end
+
+  def test_string
+    assert_equal "monkey", @cfb.convert_metadata("monkey")
+    assert_equal "1.0.1", @cfb.convert_metadata("1.0.1")
+    assert_equal "True", @cfb.convert_metadata("True")
+  end
+
+  def test_array
+    expected = [1, 2, 3, [4, 5, 6]]
+    assert_equal expected, @cfb.convert_metadata(["1", "2", "3", ["4", "5", "6"]])
+  end
+
+  def test_hash
+    expected = {"monkey" => {"fez" => [1, 2, 3]}}
+    assert_equal expected, @cfb.convert_metadata({"monkey" => {"fez" => ["1", "2", "3"]}})
+  end
+
+end

metadata

@@ -1,60 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: carinadigital-hiera-cloudformation
 version: !ruby/object:Gem::Version
-  version: 0.0.1.4
+  version: 0.0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - carinadigital
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !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: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.11
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.11
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: timedcache
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,12 +70,13 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-description: Forked from hiera-cloudformation. Queries CloudFormation stack outputs
-  or resource metadata for Hiera data.
+description: Forked from hiera-cloudformation. Multiregion cloudFormation quieries
+  of stack outputs or resource metadata for Hiera.
 email:
 - carinadigital@gmail.com
 executables: []
@@ -89,31 +84,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hiera/backend/cloudformation_backend.rb
+- test/convert_metadata_test.rb
 - Rakefile
 - README.md
 - LICENSE.txt
 homepage: https://github.com/carinadigital/hiera-cloudformation
 licenses:
 - Apache License (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.0.7
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: CloudFormation backend for Hiera
-test_files: []
+test_files:
+- test/convert_metadata_test.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 0c4e11fe875d3211e816ad3b21441e5e3903ddd3
-  data.tar.gz: 8b04f982419a7a5fb2e9c3f8796117ff3c572d95
-SHA512:
-  metadata.gz: 14cf1e677ca9a55547dd6bbabc40228640aedbcab4db542daa892a7d1f34e77f84c154a63bcd28bb96c9975a8ae4304ecddb8a952b64871a61a07cb60a6223a2
-  data.tar.gz: ca8d9ccef14715cb11821d831c296687ec1a179418bf5a65044317bca73b972914f45d166eba720e5fd2d85431c6d68ac23fb0a5c7df4e02bbd839692ef3fc04