cloudformation-ruby-dsl 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3174d42bb251437f17975b141976100ffbe490ea
-  data.tar.gz: 8dbaf407a4062a3a4009f926e38e355f08c68f79
+  metadata.gz: b96d9566c8f7eb64af7c88c4d809d6c6b6cd79ac
+  data.tar.gz: d43e2ce163a5047f8aeecd15cf936bdf422bfff8
 SHA512:
-  metadata.gz: 354b62ddb73631ef94cc0cc85ce78bbb9857b6ef8ad4bf1e2693306417d8a7500d0c26ff34b95e99a990cec1811d1a16a7b45f9f6cf58528bd92eecd69b910e7
-  data.tar.gz: e4452d3db3bc6eb9d597be62b6b3c6552ced7066e7028f8b4be91f305f36d736e586f9777fd4fbb8a921c2c6c4031398de62b94f8c0a26dbaf1ffa64e9253eaa
+  metadata.gz: 457204dfb740fbccc51371e4017006bab15e9b03e3ced9bace517850f0494008dc653171b60626c02addc13fe191c25c5601cd466a469c16d0381c4ae12a67e6
+  data.tar.gz: 12a0a10691d43c267fb2172a9a0ba7b703f4f16ecebd95f856a1028ac4b5924def354dae0f10d1ea60d6e27371a33e31b035fd99244b37142ea294b978439c53

data/README.md

@@ -67,6 +67,7 @@ Add the named object to the appropriate collection.
 - `condition(name, conditions)`
 - `resource(name, options)`
 - `output(name, options)`
+- `metadata(object)`
 
 ### CloudFormation Function Calls
 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/cfntemplate-to-ruby

@@ -113,6 +113,8 @@ def pprint_cfn_template(tpl)
   puts
   tpl.each do |section, v|
     case section
+      when 'Metadata'
+        v.each { |name, options| pprint_cfn_section 'metadata', name, options }        
       when 'Parameters'
         v.each { |name, options| pprint_cfn_section 'parameter', name, options }
       when 'Mappings'

data/cloudformation-ruby-dsl.gemspec

@@ -39,4 +39,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency    'diffy'
   gem.add_runtime_dependency    'highline'
   gem.add_runtime_dependency    'rake'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
 end

data/docs/Contributing.md

@@ -8,7 +8,8 @@ To get started:
 
 - fork this project on github
 - create a new branch named after the change you want to make; i.e., `git checkout -b mynewfeature`
-- make your changes and commit them
+- make your changes (including tests) and commit them
+- run the tests to make sure you haven't broken anything: ```rspec```
 - send a pull request to this project from your fork/branch
 
 Once you've sent your pull request, one of the project collaborators will review it and provide feedback. Please accept this commentary as constructive! It is intended as such.
@@ -18,4 +19,4 @@ Once you've sent your pull request, one of the project collaborators will review
 We're opinionated about git. Don't be surprised if we ask you to update your pull request to meet the following standards.
 
 - rebase+squash your branch into a single commit. For clean git history, we'd prefer we merged in just 1 commit that contains the entire set of changes.
-- don't write commit messages longer than 50 characters. See [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) for some examples of how to achieve this, and why.
+- don't write commit messages longer than 50 characters. See [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) for some examples of how to achieve this, and why.

data/examples/cloudformation-ruby-script.rb

@@ -23,6 +23,26 @@ require 'cloudformation-ruby-dsl/table'
 
 template do
 
+  # Metadata may be embedded into the stack, as per http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html 
+  # The below definition produces CloudFormation interface metadata.
+  metadata 'AWS::CloudFormation::Interface', {
+    :ParameterGroups => [
+      {
+        :Label => { :default => 'Instance options' },
+        :Parameters => [ 'InstanceType', 'ImageId', 'KeyPairName' ]
+      },
+      {
+        :Label => { :default => 'Other options' },
+        :Parameters => [ 'Label', 'EmailAddress' ]
+      }
+    ], 
+    :ParameterLabels => {
+      :EmailAddress => {
+        :default => "We value your privacy!"
+      }
+    }
+  }
+
   parameter 'Label',
             :Description => 'The label to apply to the servers.',
             :Type => 'String',

data/examples/simple_template.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'cloudformation-ruby-dsl/cfntemplate'
+
+template = template do
+  resource "HelloBucket", :Type => "AWS::S3::Bucket"
+end
+
+template.exec!

data/lib/cloudformation-ruby-dsl/cfntemplate.rb

@@ -37,7 +37,7 @@ class AwsCfn
   def initialize(args)
     Aws.config[:region] = args[:region] if args.key?(:region)
     # Profile definition was replaced with environment variables
-    if args.key?(:aws_profile)
+    if args.key?(:aws_profile) && !(args[:aws_profile].nil? || args[:aws_profile].empty?)
         ENV['AWS_PROFILE'] = args[:aws_profile]
         ENV['AWS_ACCESS_KEY'] = nil
         ENV['AWS_ACCESS_KEY_ID'] = nil
@@ -78,26 +78,32 @@ end
 
 # Parse command-line arguments and return the parameters and region
 def parse_args
-  stack_name = nil
-  parameters = {}
-  region     = default_region
-  profile    = nil
-  nopretty   = false
+  args = {
+    :stack_name  => nil,
+    :parameters  => {},
+    :interactive => false,
+    :region      => default_region,
+    :profile     => nil,
+    :nopretty    => false,
+  }
   ARGV.slice_before(/^--/).each do |name, value|
     case name
     when '--stack-name'
-      stack_name = value
+      args[:stack_name] = value
     when '--parameters'
-      parameters = Hash[value.split(/;/).map { |pair| pair.split(/=/, 2) }]  #/# fix for syntax highlighting
+      args[:parameters] = Hash[value.split(/;/).map { |pair| pair.split(/=/, 2) }]  #/# fix for syntax highlighting
+    when '--interactive'
+      args[:interactive] = true
     when '--region'
-      region = value
+      args[:region] = value
     when '--profile'
-      profile = value
+      args[:profile] = value
     when '--nopretty'
-      nopretty = true
+      args[:nopretty] = true
     end
   end
-  [stack_name, parameters, region, profile, nopretty]
+
+  args
 end
 
 def validate_action(action)
@@ -294,13 +300,16 @@ def cfn(template)
           template_body: template_string,
           parameters: template.parameters.map { |k,v| {parameter_key: k, parameter_value: v}}.to_a,
           tags: cfn_tags.map { |k,v| {"key" => k.to_s, "value" => v} }.to_a,
-          capabilities: ["CAPABILITY_IAM"],
+          capabilities: ["CAPABILITY_NAMED_IAM"],
       }
 
       # fill in options from the command line
       extra_options = parse_arg_array_as_hash(options)
       create_stack_opts = extra_options.merge(create_stack_opts)
 
+      # remove custom options
+      create_stack_opts.delete(:interactive)
+
       # create stack
       create_result = cfn_client.create_stack(create_stack_opts)
       if create_result.successful?
@@ -486,13 +495,16 @@ def cfn(template)
           template_body: template_string,
           parameters: template.parameters.map { |k,v| {parameter_key: k, parameter_value: v}}.to_a,
           tags: cfn_tags.map { |k,v| {"key" => k.to_s, "value" => v.to_s} }.to_a,
-          capabilities: ["CAPABILITY_IAM"],
+          capabilities: ["CAPABILITY_NAMED_IAM"],
       }
 
       # fill in options from the command line
       extra_options = parse_arg_array_as_hash(options)
       update_stack_opts = extra_options.merge(update_stack_opts)
 
+      # remove custom options
+      update_stack_opts.delete(:interactive)
+
       # update the stack
       update_result = cfn_client.update_stack(update_stack_opts)
       if update_result.successful?
@@ -567,6 +579,6 @@ end
 
 # Main entry point
 def template(&block)
-  stack_name, parameters, aws_region, aws_profile, nopretty = parse_args
-  raw_template(parameters, stack_name, aws_region, aws_profile, nopretty, &block)
+  options = parse_args
+  raw_template(options, &block)
 end

data/lib/cloudformation-ruby-dsl/dsl.rb

@@ -44,8 +44,8 @@ end
 ############################# CloudFormation DSL
 
 # Main entry point
-def raw_template(parameters = {}, stack_name = nil, aws_region = default_region, aws_profile = nil, nopretty = false, &block)
-  TemplateDSL.new(parameters, stack_name, aws_region, aws_profile, nopretty, &block)
+def raw_template(options, &block)
+  TemplateDSL.new(options, &block)
 end
 
 def default_region
@@ -54,14 +54,20 @@ end
 
 # Core interpreter for the DSL
 class TemplateDSL < JsonObjectDSL
-  attr_reader :parameters, :aws_region, :nopretty, :stack_name, :aws_profile
-
-  def initialize(parameters = {}, stack_name = nil, aws_region = default_region, aws_profile = nil, nopretty = false)
-    @parameters = parameters
-    @stack_name = stack_name
-    @aws_region = aws_region
-    @aws_profile = aws_profile
-    @nopretty = nopretty
+  attr_reader :parameters,
+              :parameter_cli,
+              :aws_region,
+              :nopretty,
+              :stack_name,
+              :aws_profile
+
+  def initialize(options)
+    @parameters  = options[:parameters]
+    @interactive = options[:interactive]
+    @stack_name  = options[:stack_name]
+    @aws_region  = options[:region]
+    @aws_profile = options[:profile]
+    @nopretty    = options[:nopretty]
     super()
   end
 
@@ -71,7 +77,12 @@ class TemplateDSL < JsonObjectDSL
 
   def parameter(name, options)
     default(:Parameters, {})[name] = options
-    @parameters[name] ||= options[:Default]
+
+    if @interactive
+      @parameters[name] ||= _get_parameter_from_cli(name, options)
+    else
+      @parameters[name] ||= options[:Default]
+    end
   end
 
   # Find parameters where the specified attribute is true then remove the attribute from the cfn template.
@@ -144,6 +155,8 @@ class TemplateDSL < JsonObjectDSL
     end
   end
 
+  def metadata(name, options) default(:Metadata, {})[name] = options end
+
   def condition(name, options) default(:Conditions, {})[name] = options end
 
   def resource(name, options) default(:Resources, {})[name] = options end
@@ -160,6 +173,73 @@ class TemplateDSL < JsonObjectDSL
       { :'Fn::FindInMap' => [ map, key, name ] }
     end
   end
+
+  private
+  def _get_parameter_from_cli(name, options)
+    # basic request
+    param_request = "Parameter '#{name}' (#{options[:Type]})"
+
+    # add description to request
+    if options.has_key?(:Description)
+      param_request += "\nDescription: #{options[:Description]}"
+    end
+
+    # add validation to the request
+
+    # allowed pattern
+    if options.has_key?(:AllowedPattern)
+      param_request += "\nAllowed Pattern: /#{options[:AllowedPattern]}/"
+    end
+
+    # allowed values
+    if options.has_key?(:AllowedValues)
+      param_request += "\nAllowed Values: #{options[:AllowedValues].join(', ')}"
+    end
+
+    # min/max length
+    if options.has_key?(:MinLength) or options.has_key?(:MaxLength)
+      min_length = "-infinity"
+      max_length = "+infinity"
+      if options.has_key?(:MinLength)
+        min_length = options[:MinLength]
+      end
+      if options.has_key?(:MaxLength)
+        max_length = options[:MaxLength]
+      end
+      param_request += "\nValid Length: #{min_length} < string < #{max_length}"
+    end
+
+    # min/max value
+    if options.has_key?(:MinValue) or options.has_key?(:MaxValue)
+      min_value = "-infinity"
+      max_value = "+infinity"
+      if options.has_key?(:MinValue)
+        min_value = options[:MinValue]
+      end
+      if options.has_key?(:MaxValue)
+        max_value = options[:MaxValue]
+      end
+      param_request += "\nValid Number: #{min_value} < number < #{max_value}"
+    end
+
+    # add default to request
+    if options.has_key?(:Default) and !options[:Default].nil?
+      param_request += "\nLeave value empty for default: #{options[:Default]}"
+    end
+
+    param_request += "\nValue: "
+
+    # request the param
+    $stdout.puts "===================="
+    $stdout.print param_request
+    input = $stdin.gets.chomp
+
+    if input.nil? or input.empty?
+      options[:Default]
+    else
+      input
+    end
+  end
 end
 
 def base64(value) { :'Fn::Base64' => value } end
@@ -170,6 +250,8 @@ def get_att(resource, attribute) { :'Fn::GetAtt' => [ resource, attribute ] } en
 
 def get_azs(region = '') { :'Fn::GetAZs' => region } end
 
+def import_value(value) { :'Fn::ImportValue' => value } end
+
 def join(delim, *list)
   case list.length
     when 0 then ''

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.2.3"
+      VERSION = "1.2.4"
     end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,161 @@
+require 'fileutils'
+require 'json'
+require 'open3'
+
+##
+# Error encapsulating information about a failed command
+class CommandError < StandardError
+  attr_reader :command, :status, :stderr
+
+  def initialize(command, status, stderr)
+    @command = command
+    @status = status
+    @stderr = stderr
+    super "FAILURE (#{status}) #{stderr}"
+  end
+end
+
+##
+# Helpers for dealing with pathing from specs
+module PathHelpers
+  ##
+  # Returns an absolute path for the specified path that
+  # is relative to the project root irregardless of where
+  # rspec/ruby is invoked
+  def from_project_root(relative_path)
+    source_dir = File.expand_path(File.dirname(__FILE__))
+    File.join(source_dir, "..", relative_path)
+  end
+end
+
+##
+# Mixin containing helper methods for working with
+# commands executed in a subshell
+module CommandHelpers
+  include PathHelpers
+
+  ##
+  # Logs the command that failed and raises an exception
+  # inlcuding status and stderr
+  def cmd_failed(command, status, stderr)
+    STDERR.puts("FAILURE executing #{command}")
+    raise CommandError.new(command, status, stderr)
+  end
+
+  ##
+  # execute a command within a specified directory and
+  # return results or yield them to a block if one is
+  # given to this method.  Results are an array of
+  # strings:
+  #
+  # [stdout, token1, token2, ..., tokenN]
+  #
+  # where stdout is the captured standard output and
+  # the tokens are the words extracted from the output.
+  #
+  # If the command has a non-zero  exit status, an
+  # exception is raised including the exit code
+  # and stderr.
+  #
+  # example call:
+  #   exec_cmd("ls", :within => "/")
+  def exec_cmd(cmd, opts={:within => "."})
+    exec_dir = from_project_root(opts[:within])
+    Dir.chdir(exec_dir) do
+      stdout, stderr, status = Open3.capture3(cmd)
+      results = stdout.split(" ").unshift(stdout)
+
+      cmd_failed(cmd, status, stderr) if status != 0
+      if (block_given?)
+        yield results
+      else
+        results
+      end
+    end
+  end
+end
+
+##
+# Mixin with helper methods for dealing with JSON generated
+# from cloudformation-ruby-dsl
+module JsonHelpers
+  ##
+  # Parse the json string, making sure to write all of it to
+  # STDERR if parsing fails to make it easier to troubleshoot
+  # failures in generated json.
+  def jsparse(json_string)
+    begin
+      JSON.parse(json_string)
+    rescue StandardError => e
+      STDERR.puts "Error parsing JSON:"
+      STDERR.puts json_string
+      raise e
+    end
+  end
+end
+
+##
+# Mixin with helper methods for dealing with files generated
+# from a test/spec
+module FileHelpers
+  include PathHelpers
+
+  ##
+  # Delete a file from the spec/tmp directory
+  def delete_test_file(filename)
+    abs_path = File.join(from_project_root("spec/tmp"), filename)
+    FileUtils.rm(abs_path)
+  end
+
+  ##
+  # Write a file to the spec/tmp directory
+  def write_test_file(filename, contents)
+    dest_dir = from_project_root("spec/tmp")
+    dest_file = File.join(dest_dir, filename)
+
+    FileUtils.mkdir_p(dest_dir)
+    File.open(dest_file, "w") { |f| f.write(contents) }
+    dest_file
+  end
+end
+
+##
+# Mixin to assist in using aws cli for validating results of
+# cloudformation-ruby-dsl
+module AwsHelpers
+  include CommandHelpers
+
+  ##
+  # Validate a cloudformation template within the spec/tmp directory
+  # using aws cli
+  def validate_cfn_template(template_name)
+    template_path = File.join(from_project_root("spec/tmp"), template_name)
+    command = validation_command(template_path)
+    exec_cmd(command) do |output|
+      begin
+        JSON.parse(output.first)
+      rescue JSON::ParserError
+        STDERR.puts "ERROR parsing output of: #{command}"
+        raise
+      end
+    end
+  end
+
+  def profile
+    ENV["AWS_PROFILE"] || "default"
+  end
+
+  def region
+    ENV["AWS_REGION"] || "us-east-1"
+  end
+
+  private
+
+  def validation_command(template_path)
+    return <<-EOF
+      aws cloudformation validate-template --template-body file://#{template_path} \
+                                           --region #{region} \
+                                           --profile #{profile}
+    EOF
+  end
+end

data/spec/validation_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.shared_examples "template acceptance validations" do
+  include CommandHelpers
+  include JsonHelpers
+  include FileHelpers
+  include AwsHelpers
+
+  it "should create a valid JSON template from the example ruby template" do
+    delete_test_file(json_template)
+    json = exec_cmd("./#{ruby_template} expand", :within => "examples").first
+    write_test_file(json_template, json)
+    validate_cfn_template(json_template)
+  end
+end
+
+describe "cloudformation-ruby-dsl" do
+  context "simplest template" do
+    let(:ruby_template) { "simple_template.rb" }
+    let(:json_template) { "simple_template.json" }
+
+    include_examples "template acceptance validations"
+  end
+
+  # TODO validate examples/cloudformation-ruby-script.rb
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Shawn Smith
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
@@ -115,6 +115,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby DSL library that provides a wrapper around the CloudFormation.
 email:
 - Shawn.Smith@bazaarvoice.com
@@ -150,6 +178,7 @@ files:
 - examples/maps/more_maps/map3.json
 - examples/maps/table.txt
 - examples/maps/vpc.txt
+- examples/simple_template.rb
 - examples/userdata.sh
 - initial_contributions.md
 - lib/cloudformation-ruby-dsl.rb
@@ -158,6 +187,8 @@ files:
 - lib/cloudformation-ruby-dsl/spotprice.rb
 - lib/cloudformation-ruby-dsl/table.rb
 - lib/cloudformation-ruby-dsl/version.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb
 homepage: http://github.com/bazaarvoice/cloudformation-ruby-dsl
 licenses: []
 metadata: {}
@@ -183,4 +214,6 @@ signing_key:
 specification_version: 4
 summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written
   by [Bazaarvoice](http://www.bazaarvoice.com).
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/validation_spec.rb