cfer 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,11 +1,24 @@
 language: ruby
 install: bundle install --without debug --jobs=3 --retry=3
 rvm:
-- 2.1.3
+- 2.1
+- 2.2
+- 2.3.0
 - ruby-head
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+branches:
+  only:
+  - master
+  - develop
 script:
 - bundle exec rspec
 - bundle exec yard
+addons:
+  code_climate:
+    repo_token:
+      secure: yokaltZRMTADMBq/htRjXYxchq4e7e66Zlvv0DrLs3yppy3bpCKbXkmtZdUm4XoxOA8fcoeFB0/VVuijmkdpJd2fAj1dc8RDb5uEdwA6ifI2ni1wKZHg15YheL4VwvDK1Nhb9Gr06uXReQ1Fy6jYcXDktyirbX7/AN/csD83IEQ29U58DVCwPxtG1k3h8ji6r/BMayzAd3T/bAeNkLd6t7YIdUAQHqIQsHsER/wQEYRTBVrx+D9b5rj2UluctfJDmpM61lvQnMt6VfgewzGXZCKNdY2DAvySaNg4+9/saZt3Ygpnt7Ef7uBMqgWTayNQ0Wk2VZSUvvLDRAKg+3WLBXTUnbFKK4/GT2T/37Rw9KQGDBJATjDLvNkS1V6Ikzg/4eNtni9RsV/bIwEaYg4CjhVEccj9fa1iPl+2Nzyw7q15UUT89TYJR3L00MQ+M7j5BDgg48kmg2tXBL62kIj/mFzEGuwNLn5nuVkwlnciQ5KCNDrQmN7XL3sPSDyIQ1dAezuj/CAqrRu43KukNZPn9TK9z/NPLUfHvco2E10Mlsw4gXiSp8j1WOmgcenivAoP2x4z5isZ2FShXkxLGq/sT0R4Ko+oGTnD/ghIHuhY3dUDfBhpOkq1wrFB73GjnUh5cYetlS3MvOj0dxT0iUK4oNp1/ds2Bn8in6juiOkN/Zc=
 deploy:
   provider: rubygems
   api_key:

data/Gemfile

@@ -8,6 +8,7 @@ group :test do
   gem 'rspec-mocks'
   gem 'guard-rspec'
   gem 'coveralls', require: false
+  gem "codeclimate-test-reporter", require: nil
 end
 
 group :debug do
@@ -15,4 +16,5 @@ group :debug do
   gem 'pry-byebug'
   gem 'pry-rescue'
   gem 'pry-stack_explorer'
+  gem 'travis'
 end

data/README.md

@@ -1,13 +1,22 @@
 # Cfer
 
 [![Build Status](https://travis-ci.org/seanedwards/cfer.svg?branch=master)](https://travis-ci.org/seanedwards/cfer)
-[![Coverage Status](https://coveralls.io/repos/seanedwards/cfer/badge.svg)](https://coveralls.io/r/seanedwards/cfer)
 [![Gem Version](https://badge.fury.io/rb/cfer.svg)](http://badge.fury.io/rb/cfer)
+[![Code Climate](https://codeclimate.com/github/seanedwards/cfer/badges/gpa.svg)](https://codeclimate.com/github/seanedwards/cfer)
+[![Test Coverage](https://codeclimate.com/github/seanedwards/cfer/badges/coverage.svg)](https://codeclimate.com/github/seanedwards/cfer/coverage)
+[![Issue Count](https://codeclimate.com/github/seanedwards/cfer/badges/issue_count.svg)](https://codeclimate.com/github/seanedwards/cfer)
+
 
 Cfer is a lightweight toolkit for managing CloudFormation templates.
 
 Read about Cfer [here](http://tilmonedwards.com/2015/07/28/cfer.html).
 
+## Support
+
+Cfer is pre-1.0 software, and may contain bugs or incomplete features. Please see the [license](https://github.com/seanedwards/cfer/blob/master/LICENSE.txt) for disclaimers.
+
+If you would like support or guidance on Cfer, or CloudFormation in general, I offer DevOps consulting services. Please [Contact Bitlancer](http://www.bitlancer.com/contact-us/) and we'll be happy to discuss your needs.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,12 +44,12 @@ cfer converge instance -t examples/instance.rb --profile [YOUR-PROFILE] --region
 
 You should see something like this:
 
-![Demo](cfer-demo.gif)
+![Demo](https://raw.githubusercontent.com/seanedwards/cfer/master/doc/cfer-demo.gif)
 
 ### Command line
 
     Commands:
-      cfer converge [OPTIONS] <stack-name>   # Converges a cloudformation stack according to the template
+      cfer converge [OPTIONS] <stack-name>   # Creates or updates a cloudformation stack according to the template
       cfer generate [OPTIONS] <template.rb>  # Generates a CloudFormation template by evaluating a Cfer template
       cfer help [COMMAND]                    # Describe available commands or one specific command
       cfer tail <stack-name>                 # Follows stack events on standard output as they occur
@@ -65,10 +74,12 @@ Creates or updates a CloudFormation stack according to the specified template.
 
 The following options may be used with the `converge` command:
 
-* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place. 
+* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place.
 * `--stack-file <template.rb>`: Reads this file from the filesystem, rather than the default `<stack-name>.rb`
 * `--parameters <Key1>:<Value1> <Key2>:<Value2> ...`: Specifies input parameters, which will be available to Ruby in the `parameters` hash, or to CloudFormation by using the `Fn::ref` function
 * `--on-failure <DELETE|ROLLBACK|DO_NOTHING>`: Specifies the action to take when a stack creation fails. Has no effect if the stack already exists and is being updated.
+* `--stack-policy <filename|URL|JSON string>` (`-s`): Stack policy to apply to the stack in order to control updates; takes a local filename containing the policy, a URL to an S3 object, or a raw JSON string.
+* `--stack-policy-during-update <filename|URL|JSON string>` (`-u`): Stack policy as in `--stack-policy` option above, but applied as a temporary override to the permanent policy during stack update.
 
 #### `tail <stack-name>`
 
@@ -76,7 +87,7 @@ Prints the latest `n` stack events, and optionally follows events while a stack
 
 The following options may be used with the `tail` command:
 
-* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place. 
+* `--follow` (`-f`): Follows stack events on standard output as the create/update process takes place.
 * `--number` (`-n`): Print the last `n` stack events.
 
 ### Template Anatomy
@@ -93,8 +104,6 @@ parameter :ParameterName,
   default: 'ParameterValue'
 ```
 
-A parameter's value may have the form `@stack.output` to look up output values from other stacks in the same account and region. This works anywhere a parameter value is specified, including defaults and inputs. (See the SDK section on [Cfer Stacks](#cfer-stacks) for caveats.)
-
 Any parameter can be referenced either in Ruby by using the `parameters` hash:
 
 ```ruby
@@ -139,6 +148,12 @@ Outputs may be defined using the `output` function:
 output :OutputName, Fn::ref(:ResourceName)
 ```
 
+Outputs may be retireved from other stacks anywhere in a template by using the `lookup_output` function.
+
+```ruby
+lookup_output('stack_name', 'output_name')
+```
+
 #### Including code from multiple files
 
 Templates can get pretty large, and splitting template code into multiple
@@ -229,15 +244,13 @@ stack = Cfer::stack_from_block(client: <client>) do
 end
 ```
 
-Note: Specifying a client is optional, but if no client is specified, parameter mappings will not occur.
-
 ## Contributing
 
 This project uses [git-flow](http://nvie.com/posts/a-successful-git-branching-model/). Please name branches and pull requests according to that convention.
 
 Always use `--no-ff` when merging into `develop` or `master`.
 
-This project also contains a [Code of Conduct](CODE_OF_CONDUCT.md), which should be followed when submitting feedback or contributions to this project.
+This project also contains a [Code of Conduct](https://github.com/seanedwards/cfer/blob/master/CODE_OF_CONDUCT.md), which should be followed when submitting feedback or contributions to this project.
 
 ### New features
 
@@ -263,3 +276,28 @@ This project also contains a [Code of Conduct](CODE_OF_CONDUCT.md), which should
 * Merge into `develop` and `master`
 * Name branch `release/<major.minor>`
 
+# Release Notes
+
+## 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/Rakefile

@@ -3,13 +3,11 @@ gem 'cfer'
 require 'cfer'
 require 'highline'
 
-Cfer::LOGGER.level = Logger::DEBUG
-
 task :default => [:spec]
 
 task :config_aws, [:profile] do |t, args|
-  Aws.config.update region: ENV['AWS_REGION'] || 'us-east-1',
-    credentials: Aws::SharedCredentials.new(profile_name: ENV['AWS_PROFILE'] || 'default')
+  Aws.config.update region: ENV['AWS_REGION'] || ask('AWS Region?') { |q| q.default = 'us-east-1' },
+    credentials: Aws::SharedCredentials.new(profile_name: ENV['AWS_PROFILE'] || ask('AWS Profile?') { |q| q.default = 'default' })
 end
 
 task :vpc => :config_aws do |t, args|
@@ -22,7 +20,7 @@ task :describe_vpc => :config_aws do
   Cfer.describe! 'vpc'
 end
 
-task :instance => :config_aws do |t, args|
+task :instance => :vpc do |t, args|
   key_pair = ask("Enter your EC2 KeyPair name: ")
 
   Cfer.converge! 'instance',
@@ -48,10 +46,11 @@ task :converge => [:vpc, :instance]
 # This task isn't really part of Cfer.
 # It just makes it easier for me to release new versions.
 task :release do
+  `git checkout master`
+  `git merge develop --no-ff -m 'Merge from develop for release'`
+
   require_relative 'lib/cfer/version.rb'
 
-  `git checkout master`
-  `git merge develop --no-ff -m 'Merge from develop for release v#{Cfer::VERSION}'`
   `git tag -m "Release v#{Cfer::VERSION}" #{Cfer::VERSION}`
 end
 

data/cfer.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "cfer"
   spec.version       = Cfer::VERSION
   spec.authors       = ["Sean Edwards"]
-  spec.email         = ["stedwards87+git@gmail.com"]
+  spec.email         = ["stedwards87+cfer@gmail.com"]
 
   spec.summary       = %q{Toolkit for automating infrastructure using AWS CloudFormation}
   spec.description   = spec.summary
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'highline'
   spec.add_runtime_dependency 'table_print'
   spec.add_runtime_dependency "rake"
+  spec.add_runtime_dependency "erubis"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "yard"

data/examples/chef_instance.rb

@@ -0,0 +1,56 @@
+description 'Example stack template for a small EC2 instance'
+
+# NOTE: This template depends on vpc.rb
+
+# Include common template code that will be used for examples that create EC2 instances.
+include_template 'common/instance_deps.rb'
+
+resource :instance, "AWS::EC2::Instance",
+  # Set a creation policy so that the stack will wait for
+  # on-instance provisioning to complete before marking the instance
+  # as done.
+  :CreationPolicy => {
+    :ResourceSignal => {
+      :Count => 1
+    }
+  } do
+  # Chef provisioning depends on cfn-init, so set that up first.
+  # We will have the initial provisioning set up cfn-hup, install chef, and run our cookbooks.
+  # Cfn-hup will only rerun chef when the metadata changes.
+  cfn_init_setup signal: :instance,
+    cfn_init_config_set: [ :cfn_hup, :install_chef, :run_chef],
+    cfn_hup_config_set: [ :cfn_hup, :run_chef]
+
+  # Configure chef to generate a Berksfile that will download the AWS cookbook from the Chef supermarket.
+  # Set the run list to run the AWS cookbook, so our instance will have the AWS SDK available.
+  chef_solo version: 'latest',
+    node: {
+      cfer: {
+        demo: {
+          welcome: "Welcome to Cfer!"
+        }
+      },
+      run_list: 'recipe[ec2-demo]'
+    },
+    # We specify a berksfile inline, but you could read this from somewhere else in your repo too.
+    # This uses a simple cookbook to write a file, similar to the instance.rb example.
+    # Review this cookbook here: https://github.com/seanedwards/cfer-cookbook-demo
+    berksfile: <<-EOF
+      source "https://supermarket.chef.io"
+      cookbook 'ec2-demo', github: 'seanedwards/cfer-cookbook-demo', branch: 'master'
+    EOF
+
+  image_id Fn::ref(:ImageId)
+  instance_type Fn::ref(:InstanceType)
+  key_name Fn::ref(:KeyName)
+
+  network_interfaces [ {
+      AssociatePublicIpAddress: "true",
+      DeviceIndex: "0",
+      GroupSet: [ Fn::ref(:instancesg) ],
+      SubnetId: Fn::ref(:SubnetId)
+    } ]
+end
+
+output :instance, Fn::ref(:instance)
+output :instanceip, Fn::get_att(:instance, :PublicIp)

data/examples/common/instance_deps.rb

@@ -0,0 +1,34 @@
+# By not specifying a default value, a parameter becomes required.
+# Specify this parameter by adding `--parameters KeyName:<ec2-keyname>` to your CLI options.
+parameter :KeyName
+
+# We define some more parameters the same way we did in the VPC template.
+# Cfer will fetch the output values from the `vpc` stack we created earlier.
+#
+# If you created the VPC stack with a different name, you can overwrite these default values
+# by adding `Vpc:<vpc_stack_name> to your `--parameters` option
+parameter :Vpc, default: 'vpc'
+parameter :VpcId, default: lookup_output(parameters[:Vpc], 'vpcid')
+parameter :SubnetId, default: lookup_output(parameters[:Vpc], 'subnetid1')
+
+# This is the Ubuntu 14.04 LTS HVM AMI provided by Amazon.
+parameter :ImageId, default: 'ami-fce3c696'
+parameter :InstanceType, default: 't2.nano'
+
+# Define a security group to be applied to an instance.
+# This one will allow SSH access from anywhere, and no other inbound traffic.
+resource :instancesg, "AWS::EC2::SecurityGroup" do
+  group_description 'Wide-open SSH'
+  vpc_id Fn::ref(:VpcId)
+
+  # Parameter values can be Ruby arrays and hashes. These will be transformed to JSON.
+  # You could write your own functions to make stuff like this easier, too.
+  security_group_ingress [
+    {
+      CidrIp: '0.0.0.0/0',
+      IpProtocol: 'tcp',
+      FromPort: 22,
+      ToPort: 22
+    }
+  ]
+end

data/examples/instance.rb

@@ -2,42 +2,8 @@ description 'Example stack template for a small EC2 instance'
 
 # NOTE: This template depends on vpc.rb
 
-
-# By not specifying a default value, a parameter becomes required.
-# Specify this parameter by adding `--parameters KeyName:<ec2-keyname>` to your CLI options.
-parameter :KeyName
-
-# We define some more parameters the same way we did in the VPC template.
-# Cfer will interpret the default value by looking up the stack output named `vpcid`
-# on the stack named `vpc`.
-#
-# If you created the VPC stack with a different name, you can overwrite these default values
-# by adding `VpcId:@<vpc-stack-name>.vpcid SubnetId:@<vpc-stack-name>.subnetid1`
-# to your `--parameters` option
-parameter :VpcId, default: '@vpc.vpcid'
-parameter :SubnetId, default: '@vpc.subnetid1'
-
-# This is the Ubuntu 14.04 LTS HVM AMI provided by Amazon.
-parameter :ImageId, default: 'ami-d05e75b8'
-parameter :InstanceType, default: 't2.medium'
-
-# Define a security group to be applied to an instance.
-# This one will allow SSH access from anywhere, and no other inbound traffic.
-resource :instancesg, "AWS::EC2::SecurityGroup" do
-  group_description 'Wide-open SSH'
-  vpc_id Fn::ref(:VpcId)
-
-  # Parameter values can be Ruby arrays and hashes. These will be transformed to JSON.
-  # You could write your own functions to make stuff like this easier, too.
-  security_group_ingress [
-    {
-      CidrIp: '0.0.0.0/0',
-      IpProtocol: 'tcp',
-      FromPort: 22,
-      ToPort: 22
-    }
-  ]
-end
+# Include common template code that will be used for examples that create EC2 instances.
+include_template 'common/instance_deps.rb'
 
 # We can define extension objects, which extend the basic JSON-building
 # functionality of Cfer. Cfer provides a few of these, but you're free
@@ -82,3 +48,4 @@ resource :instance, "AWS::EC2::Instance" do
 end
 
 output :instance, Fn::ref(:instance)
+output :instanceip, Fn::get_att(:instance, :PublicIp)

data/examples/vpc.rb

@@ -49,7 +49,7 @@ resource :routetable, 'AWS::EC2::RouteTable' do
   vpc_id Fn::ref(:vpc)
 end
 
-(1..3).each do |i|
+(1..2).each do |i|
   resource "subnet#{i}", 'AWS::EC2::Subnet' do
     # Other CloudFormation intrinsics, such as `Fn::Select` and `AWS::Region` are available as Ruby objects
     # Inspecting these functions will reveal that they simply return a Ruby hash representing the same CloudFormation structures

data/lib/cfer.rb

@@ -20,22 +20,30 @@ module Cfer
   module Core
   end
 
+  %w{
+    DB
+    ASG
+  }.each do |acronym|
+    ActiveSupport::Inflector.inflections.acronym acronym
+  end
+
   # The Cfer logger
   LOGGER = Logger.new(STDERR)
   LOGGER.level = Logger::INFO
-  LOGGER.formatter = proc { |severity, datetime, progname, msg|
-    msg = case severity
-    when 'FATAL'
-      Rainbow(msg).red.bright
-    when 'ERROR'
-      Rainbow(msg).red
-    when 'WARN'
-      Rainbow(msg).yellow
-    when 'DEBUG'
-      Rainbow(msg).black.bright
-    else
-      msg
-    end
+  LOGGER.formatter = proc { |severity, _datetime, _progname, msg|
+    msg =
+      case severity
+      when 'FATAL'
+        Rainbow(msg).red.bright
+      when 'ERROR'
+        Rainbow(msg).red
+      when 'WARN'
+        Rainbow(msg).yellow
+      when 'DEBUG'
+        Rainbow(msg).black.bright
+      else
+        msg
+      end
 
     "#{msg}\n"
   }
@@ -47,8 +55,8 @@ module Cfer
       tmpl = options[:template] || "#{stack_name}.rb"
       cfn = options[:aws_options] || {}
 
-      cfn_stack = Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
-      stack = Cfer::stack_from_file(tmpl, options.merge(client: cfn_stack))
+      cfn_stack = options[:cfer_client] || Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
+      stack = options[:cfer_stack] || Cfer::stack_from_file(tmpl, options.merge(client: cfn_stack))
 
       begin
         cfn_stack.converge(stack, options)
@@ -58,25 +66,36 @@ module Cfer
       rescue Aws::CloudFormation::Errors::ValidationError => e
         Cfer::LOGGER.info "CFN validation error: #{e.message}"
       end
-      describe! stack_name, options
+      describe! stack_name, options unless options[:follow]
     end
 
     def describe!(stack_name, options = {})
       config(options)
       cfn = options[:aws_options] || {}
-      cfn_stack = Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name)).fetch_stack
+      cfn_stack = options[:cfer_client] || Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
+      cfn_stack = cfn_stack.fetch_stack
 
       Cfer::LOGGER.debug "Describe stack: #{cfn_stack}"
 
-      case options[:output_format] || 'table'
+      case options[:output_format]
       when 'json'
         puts render_json(cfn_stack, options)
-      when 'table'
+      when 'table', nil
         puts "Status: #{cfn_stack[:stack_status]}"
         puts "Description: #{cfn_stack[:description]}" if cfn_stack[:description]
         puts ""
-        parameters = (cfn_stack[:parameters] || []).map { |param| {:Type => "Parameter", :Key => param[:parameter_key], :Value => param[:parameter_value]} }
-        outputs = (cfn_stack[:outputs] || []).map { |output| {:Type => "Output", :Key => output[:output_key], :Value => output[:output_value]} }
+        def tablify(list, type)
+          list ||= []
+          list.map { |param|
+            {
+              :Type => type.to_s.titleize,
+              :Key => param[:"#{type}_key"],
+              :Value => param[:"#{type}_value"]
+            }
+          }
+        end
+        parameters = tablify(cfn_stack[:parameters] || [], 'parameter')
+        outputs = tablify(cfn_stack[:outputs] || [], 'output')
         tp parameters + outputs, :Type, :Key, {:Value => {:width => 80}}
       else
         raise Cfer::Util::CferError, "Invalid output format #{options[:output_format]}."
@@ -86,7 +105,7 @@ module Cfer
     def tail!(stack_name, options = {}, &block)
       config(options)
       cfn = options[:aws_options] || {}
-      cfn_client = Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
+      cfn_client = options[:cfer_client] || Cfer::Cfn::Client.new(cfn.merge(stack_name: stack_name))
       if block
         cfn_client.tail(options, &block)
       else
@@ -143,7 +162,7 @@ module Cfer
 
     def render_json(obj, options = {})
       if options[:pretty_print]
-        puts JSON.pretty_generate(obj)
+        puts JSON.pretty_generate(obj, options)
       else
         puts obj.to_json
       end