cloudformation-ruby-dsl-addedvars 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e7c2c0a0a70a6a7fd805e721fdb1b1307486de2
+  data.tar.gz: b59977b05cd853d59c3377f610303f3e5c912730
+SHA512:
+  metadata.gz: 4c0294a8955b1e53859009b65c78242c611ddd5b85bd277c51ecf9521024e24a17c01be0e7fc8965488550abfe815dc8d433ed5735a2a64e5814ba6377447033
+  data.tar.gz: 48e71fc4893c51545d744c425e5cb8032654f5337429a303b95dc841ef51cdcce6b9c982b56a47ac402d9fd5dced588a79da8d5c68949387a562b0fb29e285a7

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-addedvars.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 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.

data/OWNERS

@@ -0,0 +1,4 @@
+# Owners.
+
+jonaf
+temujin9

data/README.md

@@ -0,0 +1,125 @@
+# cloudformation-ruby-dsl-addedvars
+
+__TEMPORARY FORK__
+
+This gem contains changes not yet suitable for the upstream project. This fork will be retired once a proper implementation of the changes is merged upstream. Discussion likely to continue [here](https://github.com/bazaarvoice/cloudformation-ruby-dsl/issues/77) and/or [here](https://github.com/bazaarvoice/cloudformation-ruby-dsl/pull/87).
+
+__END TEMPORARY FORK NOTICE__
+
+
+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-addedvars` to install system-wide.
+
+To use in a specific project, add `gem 'cloudformation-ruby-dsl-addedvars'` to your Gemfile, and then run `bundle`.
+
+## Releasing
+
+See [Releasing](docs/Releasing.md).
+
+## Contributing
+
+See [Contributing](docs/Contributing.md).
+
+## 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 (takes optional `--nopretty` to minimize the output)
+- `diff`: compare an existing stack with your template. Produces following exit codes:
+```
+    0 - no differences, nothing to update
+    1 - stack does not exist, template Validation error
+    2 - there are differences between an existing stack and your template
+```
+- `validate`: run validation against the stack definition
+- `create`: create a new stack from the output
+- `update`: update an existing stack from the output. Produces following exit codes:
+```
+    0 - update finished successfully
+    1 - no updates to perform, stack doesn't exist, unable to update immutable parameter or tag, AWS ServiceError exception
+```
+- `cancel-update`: cancel updating a stack
+- `delete`: delete a stack (with prompt)
+- `describe`: get output of an existing stack and output it (takes optional `--nopretty` to minimize output)
+- `describe-resource`: given two arguments: stack-name and logical-resource-id, get output from a stack concerning the specific resource (takes optional `--nopretty` to minimize output)
+- `get-template`: get entire template output of an existing stack
+
+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)
+  - The special option key :UsePreviousValue can be set to preserve the parameter's existing value during stack updates (e.g. database passwords that won't be saved in revision control).
+- `mapping(name, options)`
+- `condition(name, conditions)`
+- `resource(name, options)`
+- `output(name, options)`
+
+### CloudFormation Function Calls
+
+Invoke an intrinsic 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)`
+
+Intrinsic conditionals are also supported, with some syntactic sugar.
+- `fn_not(condition)`
+- `fn_or(*condition_list)`
+- `fn_and(*condition_list)`
+- `fn_if(condition, value_if_true, value_if_false)`
+- `equal(lhsOperand, rhsOperand)`
+- `not_equal(lhsOperand, rhsOperand)`
+
+Reference a CloudFormation pseudo parameter.
+- `aws_account_id()`
+- `aws_notification_arns()`
+- `aws_no_value()`
+- `aws_region()`
+- `aws_stack_id()`
+- `aws_stack_name()`
+
+### Utility Functions
+
+Additional capabilities for file inclusion, etc.
+- `tag(tag_name, tag_options_hash)`: add tags to the stack, which are inherited by all resources in that stack. `tag_options_hash` includes `:Value=>value` and `:Immutable=>true` properties. `tag(tag_value_hash)` is deprecated and will be removed in a future version.
+- `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`)
+
+### Default Region
+
+The tool defaults to region `us-east-1`. To change this set either `EC2_REGION` or `AWS_DEFAULT_REGION` in your environment.
+
+### Storing Command Line Options
+
+The following (optional) variables can be set in your CloudFormation .rb file (before the template) to avoid needing to set them on the command-line:
+- `$aws_profile`: A string setting the `~/.aws/credentials` profile to use
+- `$aws_region`: A string setting the AWS region
+- `$stack_name`: A string containing the stack name
+- `$stack_params`: A hash containing parameter values, e.g. `{'EnvironmentName' => 'prod'}`

data/Rakefile

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

data/bin/aws-sdk-patch

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+# Ruby shell to run bash patch file
+system( File.join( File.dirname(__FILE__) + "/../share/aws-sdk-patch.sh " + ARGV.join( ) ) )

data/bin/cfntemplate-to-ruby

@@ -0,0 +1,345 @@
+#!/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-addedvars/cfntemplate'"
+  puts "require 'cloudformation-ruby-dsl-addedvars/spotprice'"
+  puts "require 'cloudformation-ruby-dsl-addedvars/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 'Conditions'
+        v.each { |name, options| pprint_cfn_section 'condition', 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 many(val)
+  if val.is_a?(Array)
+    val
+  else
+    [ val ]
+  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]] + many(v[1]), true
+        when k == 'Fn::Select'
+          FnCall.new 'select', v
+        when k == 'Ref' && v == 'AWS::AccountId'
+          FnCall.new 'aws_account_id', []
+        when k == 'Ref' && v == 'AWS::NotificationARNs'
+          FnCall.new 'aws_notification_arns', []
+        when k == 'Ref' && v == 'AWS::NoValue'
+          FnCall.new 'aws_no_value', []
+        when k == 'Ref' && v == 'AWS::Region'
+          FnCall.new 'aws_region', []
+        when k == 'Ref' && v == 'AWS::StackId'
+          FnCall.new 'aws_stack_id', []
+        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)