cloudformation-ruby-dsl 0.4.0

data/.gitignore

@@ -0,0 +1,29 @@
+*.swp
+maestro.json
+.rakeTasks
+.DS_Store
+target
+*.iml
+.idea/
+*.swo
+/manifests
+/modules
+cloudformation/expanded/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudformation-ruby-dsl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Bazaarvoice
+
+   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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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

@@ -0,0 +1,68 @@
+# cloudformation-ruby-dsl
+
+A Ruby DSL and helper utilities for building Cloudformation templates dynamically.
+
+Written by [Bazaarvoice](http://www.bazaarvoice.com): see [the contributors page](https://github.com/bazaarvoice/cloudformation-ruby-dsl/graphs/contributors) and [the initial contributions](https://github.com/bazaarvoice/cloudformation-ruby-dsl/blob/master/initial_contributions.md) for more details.
+
+## Motivation
+
+Cloudformation templates often contain repeated stanzas, information which must be loaded from external sources, and other functionality that would be easier handled as code, instead of configuration. 
+
+Consider when a userdata script needs to be added to a Cloudformation template. Traditionally, you would re-write the script by hand in a valid JSON format. Using the DSL, you can specify the file containing the script and generate the correct information at runtime.
+
+    :UserData => base64(interpolate(file('userdata.sh')))
+
+Additionally, Cloudformation templates are just massive JSON documents, making general readability and reusability an issue. The DSL allows not only a cleaner format (and comments!), but will also allow the same DSL template to be reused as needed.
+
+## Installation
+
+Run `gem install cloudformation-ruby-dsl` to install system-wide.
+
+To use in a specific project, add `gem 'cloudformation-ruby-dsl'` to your Gemfile, and then run `bundle`.
+
+## Usage
+
+To convert existing JSON templates to use the DSL, run
+
+    cfntemplate-to-ruby [EXISTING_CFN] > [NEW_NAME.rb]
+
+You may need to preface this with `bundle exec` if you installed via Bundler.
+
+Make the resulting file executable (`chmod +x [NEW_NAME.rb]`). It can respond to the following subcommands (which are listed if you run without parameters):
+- `expand`: output the JSON template to the command line
+- `diff`: compare output with existing JSON for a stack
+- `cfn-validate-template`: run validation against the stack definition
+- `cfn-create-stack`: create a new stack from the output
+- `cfn-update-stack`: update an existing stack from the output
+
+Below are the various functions currently available in the DSL. See [the example script](examples/cloudformation-ruby-script.rb) for more usage information.
+
+### DSL Statements
+
+Add the named object to the appropriate collection.
+- `parameter(name, options)` (may be marked :Immutable, which will raise error on a later change)
+- `mapping(name, options)`
+- `condition(name, options)`
+- `resource(name, options)`
+- `output(name, options)`
+
+### Cloudformation Function Calls
+
+Invoke a native Cloudformation function.
+- `base64(value)`
+- `find_in_map(map, key, name)`
+- `get_att(resource, attribute)`
+- `get_azs(region)`
+- `join(delim, *list)`
+- `select(index, list)`
+- `ref(name)`
+- `no_value()`
+
+### Utility Functions
+
+Additional capabilities for file inclusion, etc.
+- `tag(tag)`: add tags to the stack, which are inherited by all resources in that stack; can only be used at launch
+- `file(name)`: return the named file as a string, for further use
+- `load_from_file(filename)`: load the named file by a given type; currently handles YAML, JSON, and Ruby
+- `interpolate(string)`: embed CFN references into a string (`{{ref('Service')}}`) for later interpretation by the CFN engine
+- `Table.load(filename)`: load a table from the listed file, which can then be turned into mappings (via `get_map`)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cfntemplate-to-ruby

@@ -0,0 +1,327 @@
+#!/usr/bin/env ruby
+
+# Copyright 2013-2014 Bazaarvoice, Inc.
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+unless RUBY_VERSION >= '1.9'
+  # Ruby 1.9 preserves order within Hash objects which avoid scrambling the template output.
+  $stderr.puts "This script requires ruby 1.9+.  On OS/X use Homebrew to install ruby 1.9:"
+  $stderr.puts "  brew install ruby"
+  exit(2)
+end
+
+require 'json'
+
+def main(argv)
+  unless (argv & %w(-h --help -?)).empty?
+    $stderr.puts <<"EOF"
+usage: #{$PROGRAM_NAME} [cloudformation-template.json] ...
+
+Converts the specified CloudFormation JSON template or template fragment to
+Ruby DSL syntax.  Reads from stdin or from the specified json files.  Note
+that the input must be valid JSON.
+
+Examples:
+
+    # Convert a JSON CloudFormation template to Ruby DSL syntax
+    #{$PROGRAM_NAME} my-template.json > my-template.rb
+    chmod +x my-template.rb
+
+    # Convert the JSON fragment in the clipboard to Ruby DSL syntax
+    pbpaste | #{$PROGRAM_NAME} | less
+
+EOF
+    exit(2)
+  end
+  if argv.empty?
+    pprint(simplify(JSON.parse($stdin.read)))
+  else
+    argv.each do |filename|
+      pprint(simplify(JSON.parse(File.read(filename))))
+    end
+  end
+  # The user should make the resulting template executable w/chmod +x
+end
+
+class FnCall
+  attr_reader :name, :arguments, :multiline
+
+  def initialize(name, arguments, multiline = false)
+    @name = name
+    @arguments = arguments
+    @multiline = multiline
+  end
+
+  def to_s()
+    @name + "(" + @arguments.join(', ') + ")"
+  end
+end
+
+def pprint(val)
+  case detect_type(val)
+    when :template
+      pprint_cfn_template(val)
+    when :parameter
+      pprint_cfn_section 'parameter', 'TODO', val
+    when :resource
+      pprint_cfn_resource 'TODO', val
+    when :parameters
+      val.each { |k, v| pprint_cfn_section 'parameter', k, v }
+    when :resources
+      val.each { |k, v| pprint_cfn_resource k, v }
+    else
+      pprint_value(val, '')
+  end
+end
+
+# Attempt to figure out what fragment of the template we have.  This is imprecise and can't
+# detect Mappings and Outputs sections reliably, so it doesn't attempt to.
+def detect_type(val)
+  if val.is_a?(Hash) && val['AWSTemplateFormatVersion']
+    :template
+  elsif val.is_a?(Hash) && /^(String|Number)$/ =~ val['Type']
+    :parameter
+  elsif val.is_a?(Hash) && val['Type']
+    :resource
+  elsif val.is_a?(Hash) && val.values.all? { |v| detect_type(v) == :parameter }
+    :parameters
+  elsif val.is_a?(Hash) && val.values.all? { |v| detect_type(v) == :resource }
+    :resources
+  end
+end
+
+def pprint_cfn_template(tpl)
+  puts "#!/usr/bin/env ruby"
+  puts
+  puts "require 'bundler/setup'"
+  puts "require 'cloudformation-ruby-dsl/cfntemplate'"
+  puts "require 'cloudformation-ruby-dsl/spotprice'"
+  puts "require 'cloudformation-ruby-dsl/table'"
+  puts
+  puts "template do"
+  puts
+  tpl.each do |section, v|
+    case section
+      when 'Parameters'
+        v.each { |name, options| pprint_cfn_section 'parameter', name, options }
+      when 'Mappings'
+        v.each { |name, options| pprint_cfn_section 'mapping', name, options }
+      when 'Resources'
+        v.each { |name, options| pprint_cfn_resource name, options }
+      when 'Outputs'
+        v.each { |name, options| pprint_cfn_section 'output', name, options }
+      else
+        print "  value #{fmt_key(section)} => "
+        pprint_value v, '  '
+        puts
+        puts
+    end
+  end
+  puts "end.exec!"
+end
+
+def pprint_cfn_section(section, name, options)
+  print "  #{section} #{fmt_string(name)}"
+  indent = '  ' + (' ' * section.length) + ' '
+  options.each do |k, v|
+    puts ","
+    print indent, fmt_key(k), " => "
+    pprint_value v, indent
+  end
+  puts
+  puts
+end
+
+def pprint_cfn_resource(name, options)
+  print "  resource #{fmt_string(name)}"
+  indent = '  '
+  options.each do |k, v|
+    unless k == 'Properties'
+      print ", #{fmt_key(k)} => #{fmt(v)}"
+    end
+  end
+  if options.key?('Properties')
+    print ", #{fmt_key('Properties')} => "
+    pprint_value options['Properties'], indent
+  end
+  puts
+  puts
+end
+
+def pprint_value(val, indent)
+  # Prefer to print the value on a single line if it's reasonable to do so
+  single_line = is_single_line(val) || is_single_line_hack(val)
+  if single_line && !is_multi_line_hack(val)
+    s = fmt(val)
+    if s.length < 120 || is_single_line_hack(val)
+      print s
+      return
+    end
+  end
+
+  # Print the value across multiple lines
+  if val.is_a?(Hash)
+    puts "{"
+    val.each do |k, v|
+      print "#{indent}    #{fmt_key(k)} => "
+      pprint_value v, indent + '    '
+      puts ","
+    end
+    print "#{indent}}"
+
+  elsif val.is_a?(Array)
+    puts "["
+    val.each do |v|
+      print "#{indent}    "
+      pprint_value v, indent + '    '
+      puts ","
+    end
+    print "#{indent}]"
+
+  elsif val.is_a?(FnCall) && val.multiline
+    print val.name, "("
+    args = val.arguments
+    sep = ''
+    sub_indent = indent + '    '
+    if val.name == 'join' && args.length > 1
+      pprint_value args[0], indent + '  '
+      args = args[1..-1]
+      sep = ','
+      sub_indent = indent + '     '
+    end
+    unless args.empty?
+      args.each do |v|
+        puts sep
+        print sub_indent
+        pprint_value v, sub_indent
+        sep = ','
+      end
+      if val.name == 'join' && args.length > 1
+        print ","
+      end
+      puts
+      print indent
+    end
+    print ")"
+
+  else
+    print fmt(val)
+  end
+end
+
+def is_single_line(val)
+  if val.is_a?(Hash)
+    is_single_line(val.values)
+  elsif val.is_a?(Array)
+    val.empty? ||
+        (val.length == 1 && is_single_line(val[0]) && !val[0].is_a?(Hash)) ||
+        val.all? { |v| v.is_a?(String) }
+  else
+    true
+  end
+end
+
+# Emo-specific hacks to force the desired output formatting
+def is_single_line_hack(val)
+  is_array_of_strings_hack(val)
+end
+
+# Emo-specific hacks to force the desired output formatting
+def is_multi_line_hack(val)
+  val.is_a?(Hash) && val['email']
+end
+
+# Emo-specific hacks to force the desired output formatting
+def is_array_of_strings_hack(val)
+  val.is_a?(Array) && val.all? { |v| v.is_a?(String) } && val.grep(/\s/).empty? && (
+      val.include?('autoscaling:EC2_INSTANCE_LAUNCH') ||
+      val.include?('m1.small')
+  )
+end
+
+def fmt(val)
+  if val == {}
+    '{}'
+  elsif val == []
+    '[]'
+  elsif val.is_a?(Hash)
+    '{ ' + (val.map { |k,v| fmt_key(k) + ' => ' + fmt(v) }).join(', ') + ' }'
+  elsif val.is_a?(Array) && is_array_of_strings_hack(val)
+    '%w(' + val.join(' ') + ')'
+  elsif val.is_a?(Array)
+    '[ ' + (val.map { |v| fmt(v) }).join(', ') + ' ]'
+  elsif val.is_a?(FnCall) && val.arguments.empty?
+    val.name
+  elsif val.is_a?(FnCall)
+    val.name + '(' + (val.arguments.map { |v| fmt(v) }).join(', ') + ')'
+  elsif val.is_a?(String)
+    fmt_string(val)
+  elsif val == nil
+    'null'
+  else
+    val.to_s  # number, boolean
+  end
+end
+
+def fmt_key(s)
+  ':' + (/^[a-zA-Z_]\w+$/ =~ s ? s : fmt_string(s))  # returns a symbol like :Foo or :'us-east-1'
+end
+
+def fmt_string(s)
+  if /[^ -~]/ =~ s
+    s.dump  # contains, non-ascii or control char, return double-quoted string
+  else
+    '\'' + s.gsub(/([\\'])/, '\\\\\1') + '\''  # return single-quoted string, escape \ and '
+  end
+end
+
+def simplify(val)
+  if val.is_a?(Hash)
+    val = Hash[val.map { |k,v| [k, simplify(v)] }]
+    if val.length != 1
+      val
+    else
+      k, v = val.entries[0]
+      # CloudFormation functions
+      case
+        when k == 'Fn::Base64'
+          FnCall.new 'base64', [v], true
+        when k == 'Fn::FindInMap'
+          FnCall.new 'find_in_map', v
+        when k == 'Fn::GetAtt'
+          FnCall.new 'get_att', v
+        when k == 'Fn::GetAZs'
+          FnCall.new 'get_azs', v != '' ? [v] : []
+        when k == 'Fn::Join'
+          FnCall.new 'join', [v[0]] + v[1], true
+        when k == 'Fn::Select'
+          FnCall.new 'select', v
+        when k == 'Ref' && v == 'AWS::Region'
+          FnCall.new 'aws_region', []
+        when k == 'Ref' && v == 'AWS::StackName'
+          FnCall.new 'aws_stack_name', []
+        when k == 'Ref'
+          FnCall.new 'ref', [v]
+        else
+          val
+      end
+    end
+  elsif val.is_a?(Array)
+    val.map { |v| simplify(v) }
+  else
+    val
+  end
+end
+
+main(ARGV)