cfer 0.4.2 → 0.5.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 961dee72c1a9265e73effbc45cd013160829858e
-  data.tar.gz: f09eb22eb304921bb05542bd8575c926be330180
+  metadata.gz: 5d9d002adc64d106f800cb61545ae2a62644cdf6
+  data.tar.gz: e6c08b6a6f4d011d23f2b0567f65febb1ebf1a8b
 SHA512:
-  metadata.gz: 95e6cb1e1b177516356a98f87ff3cd54b46e95668cf156ddd54f8ef22d22c0b7130905b1c7665473ad8f06d8dee175464eed4f9937dc6f469f06e94d50064b8d
-  data.tar.gz: 66a4ec1bdcaa018295aa95ca8cde3fba47c95951015ab38c1261a8c4708cdb2766c543ba05e65acae1c3e9b1ed4458def6bc4e241075ed7b8674f5234fb8168a
+  metadata.gz: 6eb2bd6ddf3bc719faaeb11361662bbd7ac938b5ac2d4e37583e144b6cbdf7a59aa43c585f48f1117d2ace34be4a85d9f38a5b237f338231d84e03b9ce75aac5
+  data.tar.gz: d342f24e5c9329cee1088aed994555be198efea702c063e6a62ef5f5b20843c7319c6c055fe92dc6f00ba821694545e3420507ece940e083d1fc25009ad07431

data/.gitignore

@@ -11,3 +11,6 @@
 **/.tags
 
 !/doc/cfer-demo.gif
+
+vendor
+

data/.travis.yml

@@ -1,13 +1,13 @@
 language: ruby
 install: bundle install --without debug --jobs=3 --retry=3
 rvm:
-- 2.1
-- 2.2
+- 2.2.5
 - 2.3.0
 - ruby-head
 matrix:
   allow_failures:
-  - rvm: ruby-head
+  - rvm:
+    - ruby-head
 branches:
   only:
   - master

data/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Cfer Change Log
+
+## 0.5.0
+
+### Enhancements
+* Adds support for Pre-build and Post-build hooks for resources and stacks.
+* Adds `json-to-cfer` script to automatically convert json templates to Cfer DSL code.
+* Adds support for directly converging JSON files.
+* Relaxes some version constraints to make it easier to integrate with older Rails projects.
+* Pulled stack validation out into an extension using post-build hooks.
+* Adds some extension methods to improve usability of certain resources.
+* Namespace cleanup.
+* Supports reading ruby template from stdin by specifying the filename `-`
+* Adds exponential backoff to `tail` command.
+* `--on-failure` flag is now case insensitive.
+* Various test improvements.
+
+### Bugfixes
+* Fixes "Stack does not exist" error being reported when stack creation fails and `--on-failure=DELETE` is specified.
+
+## 0.4.2
+
+### Bugfixes
+* Templates now uploaded to S3 in all cases where they should be.
+* Fixes extensions (should be `class_eval`, not `instance_eval`)
+
+## 0.4.0
+
+### **BREAKING CHANGES**
+* Provisioning is removed from Cfer core and moved to [cfer-provisioning](https://github.com/seanedwards/cfer-provisioning)
+
+### Enhancements
+* Adds support for assume-role authentication with MFA (see: https://docs.aws.amazon.com/cli/latest/userguide/cli-roles.html)
+* Adds support for yml-format parameter files with environment-specific sections.
+* Adds a DSL for IAM policies.
+* Adds `cfer estimate` command to estimate the cost of a template using the AWS CloudFormation cost estimation API.
+* Enhancements to chef provisioner to allow for references in chef attributes. (Thanks to @eropple)
+* Adds continue/rollback/quit selection when `^C` is caught during a converge.
+* Stores Cfer version and Git repo information in the Repo metadata.
+* Added support for uploading templates to S3 with the `--s3-path` and `--force-s3` options.
+* Added new way of extending resources, making plugins easier.
+* Added support for [CloudFormation Change Sets](https://aws.amazon.com/blogs/aws/new-change-sets-for-aws-cloudformation/) via the `--change` option.
+
+### Bugfixes
+
+## 0.3.0
+
+### Enhancements:
+* `parameters` hash now includes parameters that are set on the existing stack, but not passed in via CLI during a stack update.
+* `parameters` hash now includes defaults for parameters that were not passed on the CLI during a stack creation.
+* Adds a `lookup_output` function, for looking up outputs of stacks in the same account+region. (See #8)
+* Adds provisioning for cfn-init and chef-solo, including resource signaling.
+* Adds support for stack policies.
+* Cfer no longer validates parameters itself. CloudFormation will throw an error if something is wrong.
+* Adds release notes to the README.
+
+### Bugfixes:
+* Removes automatic parameter mapping in favor of an explicit function available to resources. (Fixes Issue #8)
+* No more double-printing the stack summary when converging a stack with tailing enabled.
+* Update demo to only use 2 AZs, since us-west-1 only has two.
+* `AllowedValues` attribute on parameters is now an array, not a CSV string. (Thanks to @rlister)
+
+## 0.2.0
+
+### Enhancements:
+* Adds support for including other files via `include_template` function.
+* Adds basic Dockerfile
+

data/Dockerfile

@@ -1,5 +1,7 @@
-FROM ruby:2.2
+FROM ruby:2.3
 COPY . /usr/src/app
 WORKDIR /usr/src/app
 RUN bundle install
+RUN rake install
+RUN cfer version
 

data/README.md

@@ -298,45 +298,5 @@ This project also contains a [Code of Conduct](https://github.com/seanedwards/cf
 
 # Release Notes
 
-## 0.4.0
-
-### **BREAKING CHANGES**
-* Provisioning is removed from Cfer core and moved to [cfer-provisioning](https://github.com/seanedwards/cfer-provisioning)
-
-### Enhancements
-* Adds support for assume-role authentication with MFA (see: https://docs.aws.amazon.com/cli/latest/userguide/cli-roles.html)
-* Adds support for yml-format parameter files with environment-specific sections.
-* Adds a DSL for IAM policies.
-* Adds `cfer estimate` command to estimate the cost of a template using the AWS CloudFormation cost estimation API.
-* Enhancements to chef provisioner to allow for references in chef attributes. (Thanks to @eropple)
-* Adds continue/rollback/quit selection when `^C` is caught during a converge.
-* Stores Cfer version and Git repo information in the Repo metadata.
-* Added support for uploading templates to S3 with the `--s3-path` and `--force-s3` options.
-* Added new way of extending resources, making plugins easier.
-* Added support for [CloudFormation Change Sets](https://aws.amazon.com/blogs/aws/new-change-sets-for-aws-cloudformation/) via the `--change` option.
-
-### Bugfixes
-
-## 0.3.0
-
-### Enhancements:
-* `parameters` hash now includes parameters that are set on the existing stack, but not passed in via CLI during a stack update.
-* `parameters` hash now includes defaults for parameters that were not passed on the CLI during a stack creation.
-* Adds a `lookup_output` function, for looking up outputs of stacks in the same account+region. (See #8)
-* Adds provisioning for cfn-init and chef-solo, including resource signaling.
-* Adds support for stack policies.
-* Cfer no longer validates parameters itself. CloudFormation will throw an error if something is wrong.
-* Adds release notes to the README.
-
-### Bugfixes:
-* Removes automatic parameter mapping in favor of an explicit function available to resources. (Fixes Issue #8)
-* No more double-printing the stack summary when converging a stack with tailing enabled.
-* Update demo to only use 2 AZs, since us-west-1 only has two.
-* `AllowedValues` attribute on parameters is now an array, not a CSV string. (Thanks to @rlister)
-
-## 0.2.0
-
-### Enhancements:
-* Adds support for including other files via `include_template` function.
-* Adds basic Dockerfile
+[Change Log](https://github.com/seanedwards/cfer/CHANGELOG.md)
 

data/bin/json-to-cfer

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'pp'
+require 'active_support/inflector'
+
+template = JSON.parse(STDIN.read)
+
+def indent(str, prefix = '  ')
+  prefix + str.gsub("\n", "\n#{prefix}")
+end
+
+def serialize_arg(arg, indent=0)
+  ret = ""
+  PP.pp(arg, ret)
+  ret.strip
+end
+
+def serialize_args(*args)
+  options = args.last.is_a?(Hash) ? args.pop : {}
+  args_str = []
+
+  args.each do |arg|
+    args_str << serialize_arg(arg)
+  end
+
+  opts_str = []
+  options.each do |k, v|
+    opts_str << "#{serialize_arg(k)}: #{serialize_arg(v)}"
+  end
+  args_str << indent(opts_str.join(",\n"), '  ') unless opts_str.empty?
+
+  args_str.join(', ').strip
+end
+
+description = template.delete('Description')
+parameters = template.delete('Parameters') || {}
+resources = template.delete('Resources') || {}
+outputs = template.delete('Outputs') || {}
+version = template.delete('AWSTemplateFormatVersion')
+
+if description
+  puts "description #{serialize_arg(description)}"
+  puts ""
+end
+
+puts "##############"
+puts "# Parameters #"
+puts "##############"
+
+parameters.each do |k, param|
+  puts "parameter #{serialize_args(k, param)}"
+  puts ""
+end
+
+puts "#############"
+puts "# Resources #"
+puts "#############"
+
+resources.each do |k, attrs|
+  properties = attrs.delete('Properties') || {}
+  type = attrs.delete('Type')
+
+  puts "resource #{serialize_args(k, type, attrs)} do"
+  properties.each do |k, v|
+    puts indent("#{k.underscore} #{serialize_args(v)}", '  ')
+  end
+  puts "end"
+  puts ""
+end
+
+outputs.each do |k, out|
+  value = out.delete('Value')
+
+  puts "output #{serialize_args(k, value, out)}"
+end
+
+puts ""
+
+template.each do |k, v|
+  puts "self[#{serialize_arg(k)}] = #{serialize_arg(v)}"
+end
+

data/cfer.gemspec

@@ -14,23 +14,25 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/seanedwards/cfer"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ['~> 2.2', '>= 2.2.5']
+
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'bin'
-  spec.executables   = 'cfer'
+  spec.executables   = ['cfer', 'json-to-cfer']
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'docile', '~> 1.1', '>= 1.1.5'
+  spec.add_runtime_dependency 'docile', '~> 1.1'
   spec.add_runtime_dependency 'thor', '~> 0.19.1'
-  spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.6'
-  spec.add_runtime_dependency 'aws-sdk', '~> 2.2', '>= 2.2.33'
-  spec.add_runtime_dependency 'aws-sdk-resources', '~> 2.2', '>= 2.2.33'
+  spec.add_runtime_dependency 'activesupport', '>= 3'
+  spec.add_runtime_dependency 'aws-sdk', '~> 2.2'
+  spec.add_runtime_dependency 'aws-sdk-resources', '~> 2.2'
   spec.add_runtime_dependency 'preconditions', '~> 0.3.0'
-  spec.add_runtime_dependency 'semantic', '~> 1.4', '>= 1.4.1'
+  spec.add_runtime_dependency 'semantic', '~> 1.4'
   spec.add_runtime_dependency 'rainbow', '~> 2.1'
-  spec.add_runtime_dependency 'highline', '~> 1.7', '>= 1.7.8'
-  spec.add_runtime_dependency 'table_print', '~> 1.5', '>= 1.5.6'
+  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_runtime_dependency 'table_print', '~> 1.5'
   spec.add_runtime_dependency "git", '~> 1.3'
-  spec.add_runtime_dependency "bundler"
 
   spec.add_development_dependency "yard", '~> 0.8.7.6'
+  spec.add_development_dependency "rake"
 end

data/lib/cfer.rb

@@ -14,9 +14,11 @@ end
 
 # Contains the core Cfer logic
 module Cfer
+  # Code relating to working with Amazon CloudFormation
   module Cfn
   end
 
+  # Code relating to building the CloudFormation document out of the Ruby DSL
   module Core
   end
 
@@ -50,8 +52,12 @@ module Cfer
 
   class << self
 
+    # Creates or updates a CloudFormation stack
+    # @param stack_name [String] The name of the stack to update
+    # @param options [Hash]
     def converge!(stack_name, options = {})
       config(options)
+      options[:on_failure].upcase! if options[:on_failure]
       tmpl = options[:template] || "#{stack_name}.rb"
       cfn = options[:aws_options] || {}
 
@@ -85,19 +91,29 @@ module Cfer
             end
           end
         end
+        describe! stack_name, options rescue nil # It's fine if we can't do this.
       rescue Aws::CloudFormation::Errors::ValidationError => e
         Cfer::LOGGER.info "CFN validation error: #{e.message}"
       end
-      describe! stack_name, options unless options[:follow]
+      stack
     end
 
     def describe!(stack_name, options = {})
       config(options)
       cfn = options[:aws_options] || {}
       cfn_stack = options[:cfer_client] || Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
+      cfn_metadata = cfn_stack.fetch_metadata
       cfn_stack = cfn_stack.fetch_stack
 
+      cfer_version = cfn_metadata.fetch("Cfer", {}).fetch("Version", nil)
+      if cfer_version
+        cfer_version_str = [cfer_version["major"], cfer_version["minor"], cfer_version["patch"]].join '.'
+        cfer_version_str << '-' << cfer_version["pre"] unless cfer_version["pre"].nil?
+        cfer_version_str << '+' << cfer_version["pre"] unless cfer_version["pre"].nil?
+      end
+
       Cfer::LOGGER.debug "Describe stack: #{cfn_stack}"
+      Cfer::LOGGER.debug "Describe metadata: #{cfn_metadata}"
 
       case options[:output_format]
       when 'json'
@@ -105,6 +121,7 @@ module Cfer
       when 'table', nil
         puts "Status: #{cfn_stack[:stack_status]}"
         puts "Description: #{cfn_stack[:description]}" if cfn_stack[:description]
+        puts "Created with Cfer version: #{Semantic::Version.new(cfer_version_str).to_s} (current: #{Cfer::SEMANTIC_VERSION.to_s})" if cfer_version
         puts ""
         def tablify(list, type)
           list ||= []
@@ -122,6 +139,7 @@ module Cfer
       else
         raise Cfer::Util::CferError, "Invalid output format #{options[:output_format]}."
       end
+      cfn_stack
     end
 
     def tail!(stack_name, options = {}, &block)
@@ -135,7 +153,6 @@ module Cfer
           Cfer::LOGGER.info "%s %-30s %-40s %-20s %s" % [event.timestamp, color_map(event.resource_status), event.resource_type, event.logical_resource_id, event.resource_status_reason]
         end
       end
-      describe! stack_name, options
     end
 
     def generate!(tmpl, options = {})
@@ -163,6 +180,10 @@ module Cfer
       cfn = options[:aws_options] || {}
       cfn_stack = options[:cfer_client] || cfn_stack = Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
       cfn_stack.delete_stack(stack_name)
+
+      if options[:follow]
+        tail! stack_name, options.merge(cfer_client: cfn_stack)
+      end
     end
 
     # Builds a Cfer::Core::Stack from a Ruby block
@@ -181,13 +202,31 @@ module Cfer
 
     # Builds a Cfer::Core::Stack from a ruby script
     #
-    # @param file [String] The file containing the Cfn DSL
+    # @param file [String] The file containing the Cfn DSL or plain JSON
     # @param options [Hash] (see #stack_from_block)
     # @return [Cfer::Core::Stack] The assembled stack object
     def stack_from_file(file, options = {})
+      return stack_from_stdin(options) if file == '-'
+
+      s = Cfer::Core::Stack.new(options)
+      if file.ends_with?('.json')
+        s.deep_merge! JSON.parse(File.read(file))
+      else
+        templatize_errors(file) do
+          s.build_from_file file
+        end
+      end
+      s
+    end
+
+    # Builds a Cfer::Core::Stack from stdin
+    #
+    # @param options [Hash] (see #stack_from_block)
+    # @return [Cfer::Core::Stack] The assembled stack object
+    def stack_from_stdin(options = {})
       s = Cfer::Core::Stack.new(options)
-      templatize_errors(file) do
-        s.build_from_file file
+      templatize_errors('STDIN') do
+        s.build_from_string STDIN.read, 'STDIN'
       end
       s
     end
@@ -198,9 +237,6 @@ module Cfer
       Cfer::LOGGER.debug "Options: #{options}"
       Cfer::LOGGER.level = Logger::DEBUG if options[:verbose]
 
-      require 'rubygems'
-      require 'bundler/setup'
-
       Aws.config.update region: options[:region] if options[:region]
       Aws.config.update credentials: Cfer::Cfn::CferCredentialsProvider.new(profile_name: options[:profile]) if options[:profile]
     end

data/lib/cfer/block.rb

@@ -12,14 +12,22 @@ module Cfer
       self
     end
 
+    # Evaluates a DSL from a Ruby string
+    # @param args [Array<Object>] Extra arguments to be passed into the block
+    # @param str [String] The Cfer source template to evaluate
+    # @param file [File] The file that will be reported in any error messages
+    def build_from_string(*args, str, file)
+      build_from_block(*args) do
+        instance_eval str, file
+      end
+      self
+    end
+
     # Evaluates a DSL from a Ruby script file
     # @param args [Array<Object>] (see: #build_from_block)
     # @param file [File] The Ruby script to evaluate
     def build_from_file(*args, file)
-      build_from_block(*args) do
-        instance_eval File.read(file), file
-      end
-      self
+      build_from_string File.read(file), file
     end
 
     # Executed just before the DSL is evaluated
@@ -31,13 +39,23 @@ module Cfer
     end
   end
 
+  # BlockHash is a Block that responds to DSL-style properties.
   class BlockHash < Block
-    NON_PROXIED_METHODS = [:parameters, :options, :lookup_output]
+    NON_PROXIED_METHODS = [
+      :parameters,
+      :options,
+      :lookup_output,
+      :lookup_outputs
+    ].freeze
 
+    # Directly sets raw properties in the underlying CloudFormation structure.
+    # @param keyvals [Hash] The properties to set on this object.
     def properties(keyvals = {})
       self.merge!(keyvals)
     end
 
+    # Gets the current value of a given property
+    # @param key [String] The name of the property to fetch
     def get_property(key)
       self.fetch key
     end

data/lib/cfer/cfn/client.rb

@@ -157,6 +157,9 @@ module Cfer::Cfn
     # @param options [Hash] The options hash
     # @option options [Fixnum] :number The maximum number of already-existing CloudFormation events to yield.
     # @option options [Boolean] :follow Set to true to wait until the stack enters a `COMPLETE` or `FAILED` state, yielding events as they occur.
+    # @option options [Boolean] :no_sleep Don't pause between polling. This is used for tests, and shouldn't be when polling the AWS API.
+    # @option options [Fixnum] :backoff The exponential backoff factor (default 1.5)
+    # @option options [Fixnum] :backoff_max_wait The maximum amount of time that exponential backoff will wait before polling agian (default 15s)
     def tail(options = {})
       q = []
       event_id_highwater = nil
@@ -173,30 +176,38 @@ module Cfer::Cfn
         event_id_highwater = event.event_id
       end
 
+      sleep_time = 1
+
       running = true
       if options[:follow]
         while running
-          stack_status = describe_stacks(stack_name: name).stacks.first.stack_status
-          running = running && (/.+_(COMPLETE|FAILED)$/.match(stack_status) == nil)
-
-          yielding = true
-          for_each_event name do |fetched_event|
-            if event_id_highwater == fetched_event.event_id
-              yielding = false
-            end
-
-            if yielding
-              q.unshift fetched_event
+          sleep_time = [sleep_time * (options[:backoff] || 1), options[:backoff_max_wait] || 15].min
+          begin
+            stack_status = describe_stacks(stack_name: name).stacks.first.stack_status
+            running = running && (/.+_(COMPLETE|FAILED)$/.match(stack_status) == nil)
+
+            yielding = true
+            for_each_event name do |fetched_event|
+              if event_id_highwater == fetched_event.event_id
+                yielding = false
+              end
+
+              if yielding
+                q.unshift fetched_event
+              end
             end
+          rescue Aws::CloudFormation::Errors::ValidationError
+            running = false
           end
 
           while q.size > 0
             event = q.shift
             yield event
             event_id_highwater = event.event_id
+            sleep_time = 1
           end
 
-          sleep 1 if running unless options[:no_sleep]
+          sleep sleep_time if running unless options[:no_sleep]
         end
       end
     end

data/lib/cfer/core/functions.rb

@@ -0,0 +1,86 @@
+# Utility methods to make CloudFormation functions feel more like Ruby
+module Cfer::Core::Functions
+  def join(sep, *args)
+    {"Fn::Join" => [sep, [ *args ].flatten ]}
+  end
+
+  def ref(r)
+    {"Ref" => r}
+  end
+
+  def get_att(r, att)
+    {"Fn::GetAtt" => [r, att]}
+  end
+
+  def find_in_map(map_name, key1, key2)
+    {"Fn::FindInMap" => [map_name, key1, key2]}
+  end
+
+  def select(i, o)
+    {"Fn::Select" => [i, o]}
+  end
+
+  def base64(v)
+    {"Fn::Base64" => v}
+  end
+
+  def condition(cond)
+    {"Condition" => cond}
+  end
+
+  def and(*conds)
+    {"Fn::And" => conds}
+  end
+
+  def or(*conds)
+    {"Fn::Or" => conds}
+  end
+
+  def equals(a, b)
+    {"Fn::Equals" => [a, b]}
+  end
+
+  def if(cond, t, f)
+    {"Fn::If" => [cond, t, f]}
+  end
+
+  def not(cond)
+    {"Fn::Not" => [cond]}
+  end
+
+  def get_azs(region)
+    {"Fn::GetAZs" => region}
+  end
+
+  def account_id
+    Fn::ref 'AWS::AccountId'
+  end
+
+  def notification_arns
+    Fn::ref 'AWS::NotificationARNs'
+  end
+
+  def no_value
+    Fn::ref 'AWS::NoValue'
+  end
+
+  def region
+    Fn::ref 'AWS::Region'
+  end
+
+  def stack_id
+    Fn::ref 'AWS::StackId'
+  end
+
+  def stack_name
+    Fn::ref 'AWS::StackName'
+  end
+end
+
+module Cfer::Core::Functions::AWS
+  extend Cfer::Core::Functions
+end
+
+module Cfer::Core::Functions::Fn
+  extend Cfer::Core::Functions
+end

data/lib/cfer/core/hooks.rb

@@ -0,0 +1,42 @@
+module Cfer::Core
+  # Provides support for hooking into resource types, and evaluating code before or after properties are set
+  module Hooks
+    def pre_block
+      self.class.pre_hooks.each do |hook|
+        instance_eval &hook
+      end
+    end
+
+    def post_block
+      self.class.post_hooks.each do |hook|
+        instance_eval &hook
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def before(&block)
+        self.pre_hooks << block
+      end
+
+      def after(&block)
+        self.post_hooks << block
+      end
+
+      def pre_hooks
+        @pre_hooks ||= []
+      end
+
+      def post_hooks
+        @post_hooks ||= []
+      end
+
+      def inherited(subclass)
+        subclass.include Cfer::Core::Hooks
+      end
+    end
+  end
+end

data/lib/cfer/core/resource.rb

@@ -1,41 +1,67 @@
 module Cfer::Core
   class Resource < Cfer::BlockHash
+    include Cfer::Core::Hooks
+
     @@types = {}
 
-    def initialize(name, type, **options, &block)
+    attr_reader :stack
+
+    def initialize(name, type, stack, **options, &block)
       @name = name
+      @stack = stack
 
       self[:Type] = type
       self.merge!(options)
       self[:Properties] = HashWithIndifferentAccess.new
       build_from_block(&block)
-
     end
 
-
+    # Sets a tag on this resource. The resource must support the CloudFormation `Tags` property.
+    # @param k [String] The name of the tag to set
+    # @param v [String] The value for this tag
+    # @param options [Hash] An arbitrary set of additional properties to be added to this tag, for example `PropagateOnLaunch` on `AWS::AutoScaling::AutoScalingGroup`
     def tag(k, v, **options)
       self[:Properties][:Tags] ||= []
       self[:Properties][:Tags].unshift({"Key" => k, "Value" => v}.merge(options))
     end
 
+    # Directly sets raw properties in the underlying CloudFormation structure.
+    # @param keyvals [Hash] The properties to set on this object.
     def properties(keyvals = {})
       self[:Properties].merge!(keyvals)
     end
 
+    # Gets the current value of a given property
+    # @param key [String] The name of the property to fetch
     def get_property(key)
       self[:Properties].fetch key
     end
 
     class << self
+      # Fetches the DSL class for a CloudFormation resource type
+      # @param type [String] The type of resource, for example `AWS::EC2::Instance`
+      # @return [Class] The DSL class representing this resource type, including all extensions
       def resource_class(type)
         @@types[type] ||= "CferExt::#{type}".split('::').inject(Object) { |o, c| o.const_get c if o && o.const_defined?(c) } || Class.new(Cfer::Core::Resource)
       end
 
+      # Patches code into DSL classes for CloudFormation resources
+      # @param type [String] The type of resource, for example `AWS::EC2::Instance`
       def extend_resource(type, &block)
-        resource_class(type).instance_eval(&block)
+        resource_class(type).class_eval(&block)
       end
-    end
 
-    private
+      # Registers a hook that will be run before properties are set on a resource
+      # @param type [String] The type of resource, for example `AWS::EC2::Instance`
+      def before(type, &block)
+        resource_class(type).pre_hooks << block
+      end
+
+      # Registers a hook that will be run after properties have been set on a resource
+      # @param type [String] The type of resource, for example `AWS::EC2::Instance`
+      def after(type, &block)
+        resource_class(type).post_hooks << block
+      end
+    end
   end
 end

data/lib/cfer/core/stack.rb

@@ -2,8 +2,8 @@ module Cfer::Core
 
   # Defines the structure of a CloudFormation stack
   class Stack < Cfer::Block
-    include Cfer::Core
-    include Cfer::Cfn
+    include Cfer::Core::Functions
+    include Cfer::Core::Hooks
 
     # The parameters strictly as passed via command line
     attr_reader :input_parameters
@@ -137,7 +137,7 @@ module Cfer::Core
       Preconditions.check_argument(/[[:alnum:]]+/ =~ name, "Resource name must be alphanumeric")
 
       clazz = Cfer::Core::Resource.resource_class(type)
-      rc = clazz.new(name, type, options, &block)
+      rc = clazz.new(name, type, self, options, &block)
 
       self[:Resources][name] = rc
       rc
@@ -158,6 +158,7 @@ module Cfer::Core
       to_h.to_json
     end
 
+    # Gets the Cfn client, if one exists, or throws an error if one does not
     def client
       @options[:client] || raise(Cfer::Util::CferError, "Stack has no associated client.")
     end
@@ -168,71 +169,32 @@ module Cfer::Core
       include_base = options[:include_base] || File.dirname(caller.first.split(/:\d/,2).first)
       files.each do |file|
         path = File.join(include_base, file)
-        instance_eval(File.read(path), path)
+        if path.ends_with?('.json')
+          self.deep_merge! JSON.parse(File.read(path))
+        else
+          instance_eval(File.read(path), path)
+        end
       end
     end
 
+    # Looks up a specific output of another CloudFormation stack in the same region.
+    # @param stack [String] The name of the stack to fetch an output from
+    # @param out [String] The name of the output to fetch from the stack
     def lookup_output(stack, out)
-      client = @options[:client] || raise(Cfer::Util::CferError, "Can not fetch stack outputs without a client")
-      client.fetch_output(stack, out)
+      lookup_outputs(stack).fetch(out)
     end
 
+    # Looks up a hash of all outputs from another CloudFormation stack in the same region.
+    # @param stack [String] The name of the stack to fetch outputs from
     def lookup_outputs(stack)
       client = @options[:client] || raise(Cfer::Util::CferError, "Can not fetch stack outputs without a client")
       client.fetch_outputs(stack)
     end
 
-    private
-
-    def post_block
-      begin
-        validate_stack!(self)
-      rescue Cfer::Util::CferValidationError => e
-        Cfer::LOGGER.error "Cfer detected #{e.errors.size > 1 ? 'errors' : 'an error'} when generating the stack:"
-        e.errors.each do |err|
-          Cfer::LOGGER.error "* #{err[:error]} in Stack#{validation_contextualize(err[:context])}"
-        end
-        raise e
-      end
-    end
-
-    def validate_stack!(hash)
-      errors = []
-      context = []
-      _inner_validate_stack!(hash, errors, context)
-
-      raise Cfer::Util::CferValidationError, errors unless errors.empty?
-    end
-
-    def _inner_validate_stack!(hash, errors = [], context = [])
-      case hash
-      when Hash
-        hash.each do |k, v|
-          _inner_validate_stack!(v, errors, context + [k])
-        end
-      when Array
-        hash.each_index do |i|
-          _inner_validate_stack!(hash[i], errors, context + [i])
-        end
-      when nil
-        errors << {
-          error: "CloudFormation does not allow nulls in templates",
-          context: context
-        }
-      end
-    end
-
-    def validation_contextualize(err_ctx)
-      err_ctx.inject("") do |err_str, ctx|
-        err_str <<
-          case ctx
-          when String
-            ".#{ctx}"
-          when Numeric
-            "[#{ctx}]"
-          end
+    class << self
+      def extend_stack(&block)
+        class_eval(&block)
       end
     end
   end
-
 end

data/lib/cfer/version.rb

@@ -1,5 +1,5 @@
 module Cfer
-  VERSION = "0.4.2"
+  VERSION = "0.5.0-rc1"
 
   begin
     require 'semantic'

data/lib/cferext/aws/cloud_formation/wait_condition.rb

@@ -0,0 +1,6 @@
+Cfer::Core::Resource.extend_resource 'AWS::CloudFormation::WaitCondition' do
+  def timeout(t)
+    properties :Timeout => t
+  end
+end
+

data/lib/cferext/aws/iam/policy_generator.rb

@@ -10,7 +10,7 @@ module CferExt
         end
 
         def statement(options = {}, &block)
-          statement = Cfer::BlockHash.new(&block)
+          statement = ::Cfer::BlockHash.new(&block)
           statement.merge! options
           statement.build_from_block(&block)
           self[:Statement].unshift statement
@@ -34,7 +34,7 @@ module CferExt
           doc = CferExt::AWS::IAM.generate_policy(&block) if doc == nil
           get_property(:Policies) << {
             PolicyName: name,
-            PolicyDocument: doc.to_h
+            PolicyDocument: doc
           }
         end
       end

data/lib/cferext/aws/kms/key.rb

@@ -0,0 +1,7 @@
+Cfer::Core::Resource.extend_resource "AWS::KMS::Key" do
+  def key_policy(doc = nil, &block)
+    doc = CferExt::AWS::IAM.generate_policy(&block) if doc == nil
+    properties :KeyPolicy => doc
+  end
+end
+

data/lib/cferext/aws/rds/db_instance.rb

@@ -0,0 +1,5 @@
+Cfer::Core::Resource.extend_resource 'AWS::RDS::DBInstance' do
+  def vpc_security_groups(groups)
+    properties :VPCSecurityGroups => groups
+  end
+end

data/lib/cferext/cfer/stack_validation.rb

@@ -0,0 +1,52 @@
+Cfer::Core::Stack.extend_stack do
+  def validate_stack!(hash)
+    errors = []
+    context = []
+    _inner_validate_stack!(hash, errors, context)
+
+    raise Cfer::Util::CferValidationError, errors unless errors.empty?
+  end
+
+  def _inner_validate_stack!(hash, errors = [], context = [])
+    case hash
+    when Hash
+      hash.each do |k, v|
+        _inner_validate_stack!(v, errors, context + [k])
+      end
+    when Array
+      hash.each_index do |i|
+        _inner_validate_stack!(hash[i], errors, context + [i])
+      end
+    when nil
+      errors << {
+        error: "CloudFormation does not allow nulls in templates",
+        context: context
+      }
+    end
+  end
+
+  def validation_contextualize(err_ctx)
+    err_ctx.inject("") do |err_str, ctx|
+      err_str <<
+        case ctx
+        when String
+          ".#{ctx}"
+        when Numeric
+          "[#{ctx}]"
+        end
+    end
+  end
+end
+
+Cfer::Core::Stack.after do
+  begin
+    validate_stack!(self)
+  rescue Cfer::Util::CferValidationError => e
+    Cfer::LOGGER.error "Cfer detected #{e.errors.size > 1 ? 'errors' : 'an error'} when generating the stack:"
+    e.errors.each do |err|
+      Cfer::LOGGER.error "* #{err[:error]} in Stack#{validation_contextualize(err[:context])}"
+    end
+    raise e
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0.pre.rc1
 platform: ruby
 authors:
 - Sean Edwards
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.5
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -48,22 +42,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -71,9 +59,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,9 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
   requirement: !ruby/object:Gem::Requirement
@@ -91,9 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -101,9 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: preconditions
   requirement: !ruby/object:Gem::Requirement
@@ -125,9 +101,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -135,9 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -159,9 +129,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -169,9 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.8
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +143,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -189,9 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -207,38 +165,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.8.7.6
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.7.6
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '0'
 description: Toolkit for automating infrastructure using AWS CloudFormation
 email:
 - stedwards87+cfer@gmail.com
 executables:
 - cfer
+- json-to-cfer
 extensions: []
 extra_rdoc_files: []
 files:
@@ -248,6 +207,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -257,6 +217,7 @@ files:
 - bin/cfer
 - bin/cfer-dbg
 - bin/console
+- bin/json-to-cfer
 - bin/setup
 - cfer.gemspec
 - doc/cfer-demo.gif
@@ -265,19 +226,23 @@ files:
 - examples/vpc.rb
 - lib/cfer.rb
 - lib/cfer/block.rb
-- lib/cfer/cfn/aws.rb
 - lib/cfer/cfn/cfer_credentials_provider.rb
 - lib/cfer/cfn/client.rb
 - lib/cfer/cli.rb
 - lib/cfer/core/client.rb
-- lib/cfer/core/fn.rb
+- lib/cfer/core/functions.rb
+- lib/cfer/core/hooks.rb
 - lib/cfer/core/resource.rb
 - lib/cfer/core/stack.rb
 - lib/cfer/util/error.rb
 - lib/cfer/version.rb
 - lib/cferext/aws/auto_scaling/auto_scaling_group.rb
+- lib/cferext/aws/cloud_formation/wait_condition.rb
 - lib/cferext/aws/iam/policy.rb
 - lib/cferext/aws/iam/policy_generator.rb
+- lib/cferext/aws/kms/key.rb
+- lib/cferext/aws/rds/db_instance.rb
+- lib/cferext/cfer/stack_validation.rb
 homepage: https://github.com/seanedwards/cfer
 licenses:
 - MIT
@@ -288,14 +253,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1

data/lib/cfer/cfn/aws.rb

@@ -1,29 +0,0 @@
-module Cfer::Cfn::AWS
-  class << self
-    include Cfer::Core
-    def account_id
-      Fn::ref 'AWS::AccountId'
-    end
-
-    def notification_arns
-      Fn::ref 'AWS::NotificationARNs'
-    end
-
-    def no_value
-      Fn::ref 'AWS::NoValue'
-    end
-
-    def region
-      Fn::ref 'AWS::Region'
-    end
-
-    def stack_id
-      Fn::ref 'AWS::StackId'
-    end
-
-    def stack_name
-      Fn::ref 'AWS::StackName'
-    end
-  end
-end
-

data/lib/cfer/core/fn.rb

@@ -1,55 +0,0 @@
-module Cfer::Core::Fn
-  class << self
-    def join(sep, *args)
-      {"Fn::Join" => [sep, [ *args ].flatten ]}
-    end
-
-    def ref(r)
-      {"Ref" => r}
-    end
-
-    def get_att(r, att)
-      {"Fn::GetAtt" => [r, att]}
-    end
-
-    def find_in_map(map_name, key1, key2)
-      {"Fn::FindInMap" => [map_name, key1, key2]}
-    end
-
-    def select(i, o)
-      {"Fn::Select" => [i, o]}
-    end
-
-    def base64(v)
-      {"Fn::Base64" => v}
-    end
-
-    def condition(cond)
-      {"Condition" => cond}
-    end
-
-    def and(*conds)
-      {"Fn::And" => conds}
-    end
-
-    def or(*conds)
-      {"Fn::Or" => conds}
-    end
-
-    def equals(a, b)
-      {"Fn::Equals" => [a, b]}
-    end
-
-    def if(cond, t, f)
-      {"Fn::If" => [cond, t, f]}
-    end
-
-    def not(cond)
-      {"Fn::Not" => [cond]}
-    end
-
-    def get_azs(region)
-      {"Fn::GetAZs" => region}
-    end
-  end
-end