cloudformation-ruby-dsl 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa81a5113abb0ee72e9abaac42fc8128012449ce
-  data.tar.gz: 9a8d10f20443f9ada8534a7dd485bbe40e742883
+  metadata.gz: 922a754ed43415e7919a4e4b6793c14ed596ec62
+  data.tar.gz: cdbdcedd3c9a48a194c0ba38cc2ddb7462cd5fbf
 SHA512:
-  metadata.gz: 0c83e68921de83c6b2cab289b5c3de09a3cde4d306021a4ee262e8f5084319c392951dfa566d8b9528a6a0bbb2bc729ccf73cf974960725a37617efecd8f93bc
-  data.tar.gz: cead01a51502610a2ad58948f366d827eb4d8f7e52d73d0579e605f79e17d2d200d570b5c71090b78aca35c5f22d4065ac5f9d3784d2807fec78e1dffc88ae5d
+  metadata.gz: 63e08da62b61214f641fb651457c1cfb4114ae3eea242a49a6b0939f913184bd5f658471e98176e173c5820ed5fc289e41bf071e99cbd1e0b712be760590295a
+  data.tar.gz: ae973485d3a5cfde77175006ee831467ba9ebc4c23231d17b81818741df20f59ff78d10462896af4866ef8d0d5d609b5dffe129f4267fab83ee8257f2defb088

data/OWNERS

@@ -1,4 +1,6 @@
 # Owners.
 
 jonaf
-temujin9
+temujin9
+mike-unitskyi
+shawnsmith

data/README.md

@@ -45,8 +45,8 @@ Make the resulting file executable (`chmod +x [NEW_NAME.rb]`). It can respond to
     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:
+- `create`: create a new stack from the output (takes optional `--s3-bucket` to upload the template to the specified S3 bucket prior to creating the stack)
+- `update`: update an existing stack from the output (takes optional `--s3-bucket` to upload the template to the specified S3 bucket prior to creating the stack). 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
@@ -62,7 +62,7 @@ Command line options similar to cloudformation commands, but parsed by the dsl.
 - `--stack-name`
 - `--region`
 - `--parameters`
-- `--tag  `
+- `--tag`
 
 Any other parameters are passed directly onto cloudformation. (--disable-rollback for instance)
 

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

@@ -31,7 +31,7 @@ require 'highline/import'
 
 ############################# AWS SDK Support
 
-class AwsCfn
+class AwsClients
   attr_accessor :cfn_client_instance
 
   def initialize(args)
@@ -58,6 +58,13 @@ class AwsCfn
     end
     @cfn_client_instance
   end
+
+  def s3_client
+    if @s3_client_instance == nil
+      @s3_client_instance = Aws::S3::Client.new()
+    end
+    @s3_client_instance
+  end
 end
 
 # utility class to deserialize Structs as JSON
@@ -85,13 +92,14 @@ def parse_args
     :region      => default_region,
     :profile     => nil,
     :nopretty    => false,
+    :s3_bucket   => nil,
   }
   ARGV.slice_before(/^--/).each do |name, value|
     case name
     when '--stack-name'
       args[:stack_name] = value
     when '--parameters'
-      args[:parameters] = Hash[value.split(/;/).map { |pair| parts = pair.split(/=/, 2); [ parts[0], Parameter.new(parts[1]) ] }]  #/# fix for syntax highlighting
+      args[:parameters] = Hash[value.split(/;/).map { |pair| parts = pair.split(/=/, 2); [ parts[0], Parameter.new(parts[1]) ] }]
     when '--interactive'
       args[:interactive] = true
     when '--region'
@@ -100,6 +108,8 @@ def parse_args
       args[:profile] = value
     when '--nopretty'
       args[:nopretty] = true
+    when '--s3-bucket'
+      args[:s3_bucket] = value
     end
   end
 
@@ -151,8 +161,9 @@ def validate_action(action)
 end
 
 def cfn(template)
-  aws_cfn = AwsCfn.new({:region => template.aws_region, :aws_profile => template.aws_profile})
-  cfn_client = aws_cfn.cfn_client
+  aws_clients = AwsClients.new({:region => template.aws_region, :aws_profile => template.aws_profile})
+  cfn_client = aws_clients.cfn_client
+  s3_client = aws_clients.s3_client
 
   action = validate_action( ARGV[0] )
 
@@ -170,14 +181,10 @@ def cfn(template)
 
   cfn_tags.each {|k, v| cfn_tags[k] = v[:Value].to_s}
 
-  if action == 'diff' or (action == 'expand' and not template.nopretty)
-    template_string = JSON.pretty_generate(template)
-  else
-    template_string = JSON.generate(template)
-  end
+  template_string = generate_template(template)
 
   # Derive stack name from ARGV
-  _, options = extract_options(ARGV[1..-1], %w(--nopretty), %w(--profile --stack-name --region --parameters --tag))
+  _, options = extract_options(ARGV[1..-1], %w(--nopretty), %w(--profile --stack-name --region --parameters --tag --s3-bucket))
   # If the first argument is not an option and stack_name is undefined, assume it's the stack name
   # The second argument, if present, is the resource name used by the describe-resource command
   if template.stack_name.nil?
@@ -222,7 +229,7 @@ Make the resulting file executable (`chmod +x [NEW_NAME.rb]`). It can respond to
 - `get-template`: get entire template output of an existing stack
 
 Command line options similar to cloudformation commands, but parsed by the dsl.
- --profile --stack-name --region --parameters --tag
+ --profile --stack-name --region --parameters --tag --s3-bucket
 
 Any other parameters are passed directly onto cloudformation. (--disable-rollback for instance)
 
@@ -237,12 +244,7 @@ template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-stat
   when 'expand'
     # Write the pretty-printed JSON template to stdout and exit.  [--nopretty] option writes output with minimal whitespace
     # example: <template.rb> expand --parameters "Env=prod" --region eu-west-1 --nopretty
-    if template.nopretty
-      puts template_string
-    else
-      puts template_string
-    end
-    exit(true)
+    template_string
 
   when 'diff'
     # example: <template.rb> diff my-stack-name --parameters "Env=prod" --region eu-west-1
@@ -332,7 +334,28 @@ template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-stat
 
   when 'validate'
     begin
-      valid = cfn_client.validate_template({template_body: template_string})
+      validation_payload = {}
+      if template.s3_bucket.nil? then
+        validation_payload = {template_body: template_string}
+      else
+        template_path = "#{Time.now.strftime("%s")}/#{stack_name}.json"
+        # assumption: JSON is the only supported serialization format (YAML not allowed)
+        template_url = "https://s3.amazonaws.com/#{template.s3_bucket}/#{template_path}"
+        begin
+          s3_client.put_object({
+            bucket: template.s3_bucket,
+            key: template_path,
+            # canned ACL for authorized users to read the bucket (that should be *this* IAM role!)
+            acl: "private",
+            body: template_string,
+          })
+        rescue Aws::S3::Errors::ServiceError => e
+          $stderr.puts "Failed to upload stack template to S3: #{e}"
+          exit(false)
+        end
+        validation_payload = {template_url: template_url}
+      end
+      valid = cfn_client.validate_template(validation_payload)
       if valid.successful?
         puts "Validation successful"
         exit(true)
@@ -351,12 +374,34 @@ template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-stat
       # 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_NAMED_IAM"],
       }
 
+      # If the user supplied the --s3-bucket option and
+      # access to the bucket, upload the template body to S3
+      if template.s3_bucket.nil? then
+        create_stack_opts["template_body"] = template_string
+      else
+        template_path = "#{Time.now.strftime("%s")}/#{stack_name}.json"
+        # assumption: JSON is the only supported serialization format (YAML not allowed)
+        template_url = "https://s3.amazonaws.com/#{template.s3_bucket}/#{template_path}"
+        begin
+          s3_client.put_object({
+            bucket: template.s3_bucket,
+            key: template_path,
+            # canned ACL for authorized users to read the bucket (that should be *this* IAM role!)
+            acl: "private",
+            body: template_string,
+          })
+        rescue Aws::S3::Errors::ServiceError => e
+          $stderr.puts "Failed to upload stack template to S3: #{e}"
+          exit(false)
+        end
+        create_stack_opts["template_url"] = template_url
+      end
+
       # fill in options from the command line
       extra_options = parse_arg_array_as_hash(options)
       create_stack_opts = extra_options.merge(create_stack_opts)
@@ -563,12 +608,29 @@ template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-stat
       # default options (not overridable)
       update_stack_opts = {
           stack_name: stack_name,
-          template_body: template_string,
           parameters: template.parameters.map { |k,v| (v.use_previous_value && old_parameters.include?([k,v])) ? {parameter_key: k, use_previous_value: v.use_previous_value.to_s} : {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_NAMED_IAM"],
       }
 
+      # if the the user supplies a bucket bucket and
+      # access to it, upload the template body
+      if template.s3_bucket.nil? then
+        update_stack_opts["template_body"] = template_string
+      else
+        template_path = "#{Time.now.strftime("%s")}/#{stack_name}.json"
+        # assumption: JSON is the only supported serialization format (YAML not allowed)
+        template_url = "https://s3.amazonaws.com/#{template.s3_bucket}/#{template_path}"
+        s3_client.put_object({
+          bucket: template.s3_bucket,
+          key: template_path,
+          # canned ACL for authorized users to read the bucket (that should be *this* IAM role!)
+          acl: "private",
+          body: template_string,
+        })
+        update_stack_opts["template_url"] = template_url
+      end
+
       # fill in options from the command line
       extra_options = parse_arg_array_as_hash(options)
       update_stack_opts = extra_options.merge(update_stack_opts)
@@ -654,7 +716,10 @@ end
 ##################################### Additional dsl logic
 # Core interpreter for the DSL
 class TemplateDSL < JsonObjectDSL
-  def exec!()
+  def exec!
+    puts cfn(self)
+  end
+  def exec
     cfn(self)
   end
 end

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

@@ -4,7 +4,7 @@ require 'json'
 
 # Formats a template as JSON
 def generate_template(template)
-  format_json template, !template.nopretty
+  generate_json template, !template.nopretty
 end
 
 def generate_json(data, pretty = true)
@@ -67,7 +67,8 @@ class TemplateDSL < JsonObjectDSL
               :aws_region,
               :nopretty,
               :stack_name,
-              :aws_profile
+              :aws_profile,
+              :s3_bucket
 
   def initialize(options)
     @parameters  = options.fetch(:parameters, {})
@@ -76,6 +77,7 @@ class TemplateDSL < JsonObjectDSL
     @aws_region  = options.fetch(:region, default_region)
     @aws_profile = options[:profile]
     @nopretty    = options.fetch(:nopretty, false)
+    @s3_bucket   = options.fetch(:s3_bucket, nil)
     super()
   end
 

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

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.4.6"
+      VERSION = "1.5.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Shawn Smith
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby DSL library that provides a wrapper around the CloudFormation.  Written