cloudformation-ruby-dsl 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99f3a404577b576209fe2a83f92b4049a2c25afd
+  data.tar.gz: 9e5f806014c4fcbd40e03dd9eb80a69fb99fa41b
+SHA512:
+  metadata.gz: fd36efe1f07eb08b84c8cc2d96c846dffb1b8188ee5eebd367fd3d4288b833443909fdfa1182919238412eaf543701cd0b120fa82c160d32eac49ea441a5d3f7
+  data.tar.gz: 32eb81ebf63a1927b1cce3d63cbf3a0e27e00e82201cdc5b922af3f84045094d2473418f08990b305b2a50eb8537cd35d46cecc1a0fd4e369958473c719fe513

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

@@ -38,10 +38,15 @@ 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 output with existing JSON for a stack
+- `diff`: compare an existing stack with 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
+- `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.
 

data/cloudformation-ruby-dsl.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency    'aws-sdk'
   gem.add_runtime_dependency    'diffy'
   gem.add_runtime_dependency    'highline'
+  gem.add_runtime_dependency    'rake'
 end

data/examples/cloudformation-ruby-script.rb

@@ -94,6 +94,22 @@ template do
   mapping 'TableExampleMultimap',
           vpc.get_multimap({ :visibility => 'private', :zone => ['a', 'c'] }, :env, :region, :subnet)
 
+  # Shows how to use a table for iterative processing.
+  domains = Table.load 'maps/domains.txt'
+  domains.get_multihash(:purpose, {:product => 'demo', :alias => 'true'}, :prefix, :target, :alias_hosted_zone_id).each_pair do |key, value|
+    resource key+'Route53RecordSet', :Type => 'AWS::Route53::RecordSet', :Properties => {
+        :Comment => '',
+        :HostedZoneName => 'bazaarvoice.com',
+        :Name => value[:prefix]+'.bazaarvoice.com',
+        :Type => 'A',
+        :AliasTarget => {
+          :DNSName => value[:target],
+          :HostedZoneId => value[:alias_hosted_zone_id]
+        }
+    }
+  end
+
+
   # The tag type is a DSL extension; it is not a property of actual CloudFormation templates.
   #   These tags are excised from the template and used to generate a series of --tag arguments which are passed to CloudFormation when a stack is created.
   #   They do not ultimately appear in the expanded CloudFormation template.

data/examples/maps/domains.txt

@@ -0,0 +1,4 @@
+purpose             product    prefix                     target                         alias  alias_hosted_zone_id  has_origin_domain  origin_target
+CDN                 demo       code                       dabc123.cloudfront.net         true   Z2FDTNDATAQYW2        false
+Assets              demo       assets                     ddef456.cloudfront.net         true   Z2FDTNDATAQYW2        false
+API                 demo       api                        prod-api                       false                        false              prod-api-origin.whatever.net.

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

@@ -262,13 +262,22 @@ def cfn(template)
 
   when 'create'
     begin
-      create_result = cfn_client.create_stack({
+
+      # default options (not overridable)
+      create_stack_opts = {
           stack_name: stack_name,
           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"],
-        })
+      }
+
+      # fill in options from the command line
+      extra_options = parse_arg_array_as_hash(options)
+      create_stack_opts = extra_options.merge(create_stack_opts)
+
+      # create stack
+      create_result = cfn_client.create_stack(create_stack_opts)
       if create_result.successful?
         puts create_result.stack_id
         exit(true)
@@ -329,7 +338,11 @@ def cfn(template)
           })
         }
         describe_stack.stacks.each { |stack| stacks[stack.stack_name] = stack.to_map.merge!({resources: stack_resources[stack.stack_name]}) }
-        puts JSON.pretty_generate(stacks)
+        unless template.nopretty
+          puts JSON.pretty_generate(stacks)
+        else
+          puts JSON.generate(stacks)
+        end
         exit(true)
       end
     rescue Aws::CloudFormation::Errors::ServiceError => e
@@ -359,8 +372,13 @@ def cfn(template)
   when 'get-template'
     begin
       get_template_result = cfn_client.get_template({stack_name: stack_name})
+      template_body = JSON.parse(get_template_result.template_body)
       if get_template_result.successful?
-        puts get_template_result.template_body
+        unless template.nopretty
+          puts JSON.pretty_generate(template_body)
+        else
+          puts JSON.generate(template_body)
+        end
         exit(true)
       end
     rescue Aws::CloudFormation::Errors::ServiceError => e
@@ -410,12 +428,21 @@ def cfn(template)
 
     # update the stack
     begin
-      update_result = cfn_client.update_stack({
+
+      # default options (not overridable)
+      update_stack_opts = {
           stack_name: stack_name,
           template_body: template_string,
           parameters: template.parameters.map { |k,v| {parameter_key: k, parameter_value: v}}.to_a,
           capabilities: ["CAPABILITY_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)
+
+      # update the stack
+      update_result = cfn_client.update_stack(update_stack_opts)
       if update_result.successful?
         puts update_result.stack_id
         exit(true)
@@ -464,6 +491,20 @@ def extract_options(args, opts_no_val, opts_1_val)
   [opts, rest]
 end
 
+# convert an array of option strings to a hash
+# example input: ["--option", "value", "--optionwithnovalue"]
+# example output: {:option => "value", :optionwithnovalue: true}
+def parse_arg_array_as_hash(options)
+  result = {}
+  options.slice_before(/\A--[a-zA-Z_-]\S/).each { |o|
+      key = ((o[0].sub '--', '').gsub '-', '_').downcase.to_sym
+      value = if o.length > 1 then o.drop(1) else true end
+      value = value[0] if value.is_a?(Array) and value.length == 1
+      result[key] = value
+  }
+  result
+end
+
 ##################################### Additional dsl logic
 # Core interpreter for the DSL
 class TemplateDSL < JsonObjectDSL

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

@@ -37,6 +37,13 @@ class Table
     distinct_values(filter(predicate), key, true)
   end
 
+  # Selects all rows in the table which match the name/value pairs of the predicate object and returns a
+  # hash of hashes, where the key for the top-level hash is the key paramter and the second-level hash keys are
+  # those in the keys paramter. This is useful when you want multiple column values for a given row.
+  def get_multihash(key, predicate, *keys)
+    build_nested_hash(filter(predicate), key, keys)
+  end
+
   # Selects all rows in the table which match the name/value pairs of the predicate object and returns a
   # set of nested maps, where the key for the map at level n is the key at index n in the specified keys,
   # except for the last key in the specified keys which is used to determine the value of the leaf-level map.
@@ -68,6 +75,17 @@ class Table
     @records.select { |record| predicate.all? { |key, value| matches(value, record[key]) } }
   end
 
+  def build_nested_hash(records, key, keys)
+    hash = {}
+    records.each do |record|
+      hash[record[key]] = {}
+      keys.each do |hash_key|
+        hash[record[key]][hash_key] = record[hash_key]
+      end
+    end
+    return hash
+  end
+
   def build_nested_map(records, path, multi)
     key, *rest = path
     if rest.empty?

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

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.0.4"
+      VERSION = "1.0.5"
     end
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Shawn Smith
@@ -16,102 +15,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.
@@ -131,7 +132,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE
+- OWNERS
 - README.md
 - Rakefile
 - bin/cfntemplate-to-ruby
@@ -139,6 +141,7 @@ files:
 - docs/Contributing.md
 - docs/Releasing.md
 - examples/cloudformation-ruby-script.rb
+- examples/maps/domains.txt
 - examples/maps/map.json
 - examples/maps/map.rb
 - examples/maps/map.yaml
@@ -157,28 +160,27 @@ files:
 - lib/cloudformation-ruby-dsl/version.rb
 homepage: http://github.com/bazaarvoice/cloudformation-ruby-dsl
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - bin
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written
   by [Bazaarvoice](http://www.bazaarvoice.com).
 test_files: []

data/LICENSE.txt

@@ -1,201 +0,0 @@
-                                 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.