hiera-cloudformation 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  data.tar.gz: 528e5773c1de04e1eb38d19c73ae8629fac0b0ebe235694c8bdb724b666d4aee0badafa093bd34e1f7b840b1ed92b8788ce3f3b045d390cd11f0ccfc66e6766c
-  metadata.gz: 891a69aff5ed2455a88d4e3c008084bf7e964a4cd36227258977232881331e1f0a230ddf2d4504a5d43870779b4baf105ca5f0348d894ca55d2d8862e102d1b7
-SHA1: 
-  data.tar.gz: 048f0606a4b2313a1de2e20732a136b2fb071b33
-  metadata.gz: 1fb1aba71ac1d4d39bf325d21a0af7ab1ae484b3
+---
+SHA1:
+  metadata.gz: 1eba584b63db610211319c070fe1d0d6d4c1f087
+  data.tar.gz: dc817b92d7a69caedcc5d771e9c1371dd8254156
+SHA512:
+  metadata.gz: 24d92d0ba85721c8fcb5aed60992128583762309dae4f68a2053b57970de074996044c8039ab5188b0a3dcddad0a4a641468dc9bdf891c814ce62c7994257356
+  data.tar.gz: abdfcc7971cbf4930b1236092878fd7ac3bb195d750aeaf1bba62c521aa931b2e12050e11907eace114a4279fbd26649d74801fa382c64a4f1d1d95d04ce67b9

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,6 +29,16 @@ 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).
 
+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-1'
+      :parse_metadata: true
+
 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:
 
@@ -101,3 +111,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,10 +16,11 @@ limitations under the License.
 
 require 'rubygems'
 require 'rubygems/package_task'
+require 'rake/testtask'
 
 spec = Gem::Specification.new do |gem|
 	gem.name          = "hiera-cloudformation"
-	gem.version       = '0.0.1'
+	gem.version       = '0.0.2'
 	gem.authors       = ["Hugh Cole-Baker"]
 	gem.email         = ["hugh@fanduel.com"]
 	gem.summary       = %q{CloudFormation backend for Hiera}
@@ -41,3 +42,8 @@ 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,18 +31,35 @@ class Hiera
 					require 'json'
 				end
 
-				if Config.include?(:cloudformation) && !Config[:cloudformation].nil? &&
-					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],
-						: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
+
+					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 Config[:cloudformation].include?(:region) then
+						Hiera.debug("Found AWS region #{Config[:cloudformation][:region]} from configuration")
+						aws_config[:region] = Config[:cloudformation][:region]
+					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
 				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
 
@@ -67,6 +84,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
@@ -131,6 +152,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,93 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hiera-cloudformation
-version: !ruby/object:Gem::Version 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Hugh Cole-Baker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-07-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id005 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: aws-sdk
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.11.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: timedcache
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: timedcache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: Queries CloudFormation stack outputs or resource metadata for Hiera data
-email: 
+email:
 - hugh@fanduel.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/hiera/backend/cloudformation_backend.rb
+- test/convert_metadata_test.rb
 - Rakefile
 - README.md
 - LICENSE.txt
 homepage: https://github.com/fanduel/hiera-cloudformation
-licenses: 
+licenses:
 - Apache License (2.0)
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id005
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id005
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: CloudFormation backend for Hiera
-test_files: []
-
+test_files:
+- test/convert_metadata_test.rb