lono 5.2.8 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f1a09d2d9d99ad97a4d8346e67961b193e0adf41f3115a9af315a8db2b6519
-  data.tar.gz: 2e4b5b91dcf4aef831590fcede27d9fbbf68b3dd764f0c26cbca494693863092
+  metadata.gz: 805088c405e44e3e7b228f5d03a893af2a99c2ce990615bb89b906c0c2bb56ee
+  data.tar.gz: fff83f7bdae3c28fed272a489e3170d09f803d35a05e943b98db33c89e5d7a9e
 SHA512:
-  metadata.gz: 5ded0ebbb676ce87582cee552224ae6fbfd2f6622185c951dc0e3340fa66cda61ed2b4b4cfb99e5e55ee8f93d65bab0f4568676947aafe19253e62dce3a65928
-  data.tar.gz: 9b1289222f699b107331306ae10e6e03fb253a332660ade6c0b97843def70e2cb28d4b1e0d69c936e917a5a26e1ecce50d2e6e81014a1097473681a9f33c841c
+  metadata.gz: bd70ed81d8e4495dff371cd2ec66b519b1002325dac0d17d094a31127ea4e9d186a00001200391f36b9dcece8f85b25f085abeb09c49eedc1f269be457113ad0
+  data.tar.gz: 9bb60f3efa20a1c06a0597656f0729e1723380c2af6b20f673f28f4b08fe2ac941876e3252f405864bd488b989b5d7436ce3dad50b65bb059bf51371751b0290

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [5.3.0]
+- #8 param preview feature. 3rd type of preview.
+- #9 ssm helper support in configs
+- Simplify param lookup with direct lookup logic.
+- Allow params files to have different extensions. Both.txt and .sh work are auto-inferred conventionally.
+- Allow condition and depends_on to be a properties level and auto-moved to the attributes level.
+
 ## [5.2.8]
 - add mfa support for normal IAM user
 

data/README.md

@@ -8,6 +8,8 @@
 [![CircleCI](https://circleci.com/gh/tongueroo/lono.svg?style=svg)](https://circleci.com/gh/tongueroo/lono)
 [![Support](https://img.shields.io/badge/get-support-blue.svg)](https://boltops.com?utm_source=badge&utm_medium=badge&utm_campaign=lono)
 
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
 Lono is a powerful CloudFormation framework. Lono handles the entire CloudFormation lifecycle. It builds, manages and deploys CloudFormation templates.
 
 * Lono generates CloudFormation templates based on a [DSL](http://lono.cloud/docs/dsl/).

data/lib/lono/cfn.rb

@@ -22,8 +22,9 @@ module Lono
     end
     update_options = Proc.new do
       option :change_set, type: :boolean, default: true, desc: "Uses generated change set to update the stack.  If false, will perform normal update-stack."
-      option :diff, type: :boolean, default: true, desc: "Show diff of the source code template changes before continuing."
-      option :preview, type: :boolean, default: true, desc: "Show preview of the stack changes before continuing."
+      option :codediff_preview, type: :boolean, default: true, desc: "Show codediff changes preview."
+      option :changeset_preview, type: :boolean, default: true, desc: "Show ChangeSet changes preview."
+      option :param_preview, type: :boolean, default: true, desc: "Show parameter diff preview."
       option :sure, type: :boolean, desc: "Skips are you sure prompt"
     end
 
@@ -75,20 +76,15 @@ module Lono
     desc "preview STACK", "Preview a CloudFormation stack update.  This is similar to terraform's plan or puppet's dry-run mode."
     long_desc Lono::Help.text("cfn/preview")
     option :keep, type: :boolean, desc: "keep the changeset instead of deleting it afterwards"
-    option :diff, type: :boolean, default: true, desc: "Show diff of the source code template changes also."
+    option :param_preview, type: :boolean, default: true, desc: "Show parameter diff preview."
+    option :codediff_preview, type: :boolean, default: true, desc: "Show codediff changes preview."
+    option :changeset_preview, type: :boolean, default: true, desc: "Show ChangeSet changes preview."
     base_options.call
     suffix_option.call
     def preview(stack_name=:current)
-      Diff.new(stack_name, options).run if options[:diff]
-      Preview.new(stack_name, options).run
-    end
-
-    desc "diff STACK", "Diff newly generated template vs existing template."
-    long_desc Lono::Help.text("cfn/diff")
-    base_options.call
-    suffix_option.call
-    def diff(stack_name=:current)
-      Diff.new(stack_name, options).run
+      Preview::Param.new(stack_name, options).run if options[:param_preview]
+      Preview::Codediff.new(stack_name, options).run if options[:codediff_preview]
+      Preview::Changeset.new(stack_name, options).run if options[:changeset_preview]
     end
 
     desc "download STACK", "Download CloudFormation template from existing stack."

data/lib/lono/cfn/preview.rb

@@ -1,151 +1,4 @@
 class Lono::Cfn
-  class Preview < Base
-    # Override run from Base superclass, the run method is different enough with Preview
-    def run
-      if @options[:noop]
-        puts "NOOP CloudFormation preview for #{@stack_name} update"
-      else
-        params = generate_all
-        success = preview_change_set(params)
-        delete_change_set if success && !@options[:keep] # Clean up and delete the change set
-      end
-    end
-
-    def preview_change_set(params)
-      success = create_change_set(params)
-      display_change_set if success
-    end
-
-    def create_change_set(params)
-      unless stack_exists?(@stack_name)
-        puts "WARN: Cannot create a change set for the stack because the #{@stack_name} does not exists.".color(:yellow)
-        return false
-      end
-      exit_unless_updatable!(stack_status(@stack_name))
-
-      params = {
-        change_set_name: change_set_name,
-        stack_name: @stack_name,
-        parameters: params,
-        capabilities: capabilities, # ["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"],
-      }
-      params[:tags] = tags unless tags.empty?
-      set_template_body!(params)
-      show_parameters(params, "cfn.create_change_set")
-      begin
-        cfn.create_change_set(params)
-      rescue Aws::CloudFormation::Errors::ValidationError => e
-        handle_error(e)
-      end
-      true
-    end
-
-    # Example errors:
-    # "Template error: variable names in Fn::Sub syntax must contain only alphanumeric characters, underscores, periods, and colons"
-    def handle_error(e)
-      raise if ENV['FULL_BACKTRACE']
-
-      if e.message =~ /^Parameters: / || e.message =~ /^Template error: /
-        puts "Error creating CloudFormation preview because invalid CloudFormation parameters. Full error message:".color(:red)
-        puts e.message
-        puts "For full backtrace run command again with FULL_BACKTRACE=1"
-        quit(1)
-      else
-        raise
-      end
-    end
-
-    def display_change_set
-      print "Generating CloudFormation Change Set for preview.."
-      change_set = describe_change_set
-      until change_set_finished?(change_set) do
-        change_set = describe_change_set
-        sleep 1
-        print '.'
-      end
-      puts
-
-      case change_set.status
-      when "CREATE_COMPLETE"
-        puts "CloudFormation preview for '#{@stack_name}' stack update. Changes:"
-        changes = change_set.changes.sort_by do |change|
-          change["resource_change"]["action"]
-        end
-        changes.each do |change|
-          display_change(change)
-        end
-      when "FAILED"
-        puts "WARN: Fail to create a CloudFormation preview for '#{@stack_name}' stack update. Reason:".color(:yellow)
-        puts change_set.status_reason
-        quit(0)
-      else
-        raise "hell: never come here"
-      end
-    end
-
-    def delete_change_set
-      cfn.delete_change_set(
-        change_set_name: change_set_name,
-        stack_name: @stack_name
-      )
-    end
-
-    def execute_change_set
-      cfn.execute_change_set(
-        change_set_name: change_set_name,
-        stack_name: @stack_name
-      )
-    end
-
-    # generates a change set name
-    def change_set_name
-      @change_set_name ||= "changeset-#{Time.now.strftime("%Y%d%m%H%M%S")}"
-    end
-
-  private
-    # Private: formats a Aws::CloudFormation::Types::Change in pretty human readable form
-    #
-    # change  - Aws::CloudFormation::Types::Change
-    #
-    # Examples
-    #
-    #   display_change(change)
-    #   => Remove AWS::Route53::RecordSet: DnsRecord testsubdomain.sub.tongueroo.com
-    #
-    # Returns nil
-    #
-    # change.to_h
-    # {:type=>"Resource",
-    #  :resource_change=>
-    #   {:action=>"Remove",
-    #    :logical_resource_id=>"DnsRecord",
-    #    :physical_resource_id=>"testsubdomain.sub.tongueroo.com",
-    #    :resource_type=>"AWS::Route53::RecordSet",
-    #    :scope=>[],
-    #    :details=>[]}}
-    def display_change(change)
-      message = if change.type == "Resource"
-        c = change.resource_change
-        "#{c.action} #{c.resource_type}: #{c.logical_resource_id} #{c.physical_resource_id}"
-      else
-        change.to_h
-      end
-
-      colors = { Remove: :red, Add: :green, Modify: :yellow }
-      action = change.resource_change.action.to_sym
-      message = message.color(colors[action]) if colors.has_key?(action)
-      puts message
-    end
-
-    def change_set_finished?(change_set)
-      change_set.status =~ /_COMPLETE/ || change_set.status == "FAILED"
-    end
-
-    def describe_change_set
-      cfn.describe_change_set(
-        change_set_name: change_set_name,
-        stack_name: @stack_name
-      )
-    end
+  module Preview
   end
-end
+end

data/lib/lono/cfn/preview/changeset.rb

@@ -0,0 +1,154 @@
+module Lono::Cfn::Preview
+  class Changeset < Lono::Cfn::Base
+    # Override run from Base superclass, the run method is different enough with Preview
+    def run
+      puts "Changeset Preview:".color(:green)
+
+      if @options[:noop]
+        puts "NOOP CloudFormation preview for #{@stack_name} update"
+        return
+      end
+
+      params = generate_all
+      success = preview_change_set(params)
+      delete_change_set if success && !@options[:keep] # Clean up and delete the change set
+    end
+
+    def preview_change_set(params)
+      success = create_change_set(params)
+      display_change_set if success
+    end
+
+    def create_change_set(params)
+      unless stack_exists?(@stack_name)
+        puts "WARN: Cannot create a change set for the stack because the #{@stack_name} does not exists.".color(:yellow)
+        return false
+      end
+      exit_unless_updatable!(stack_status(@stack_name))
+
+      params = {
+        change_set_name: change_set_name,
+        stack_name: @stack_name,
+        parameters: params,
+        capabilities: capabilities, # ["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"],
+      }
+      params[:tags] = tags unless tags.empty?
+      set_template_body!(params)
+      show_parameters(params, "cfn.create_change_set")
+      begin
+        cfn.create_change_set(params)
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        handle_error(e)
+      end
+      true
+    end
+
+    # Example errors:
+    # "Template error: variable names in Fn::Sub syntax must contain only alphanumeric characters, underscores, periods, and colons"
+    def handle_error(e)
+      raise if ENV['FULL_BACKTRACE']
+
+      if e.message =~ /^Parameters: / || e.message =~ /^Template error: /
+        puts "Error creating CloudFormation preview because invalid CloudFormation parameters. Full error message:".color(:red)
+        puts e.message
+        puts "For full backtrace run command again with FULL_BACKTRACE=1"
+        quit(1)
+      else
+        raise
+      end
+    end
+
+    def display_change_set
+      print "Generating CloudFormation Change Set for preview.."
+      change_set = describe_change_set
+      until change_set_finished?(change_set) do
+        change_set = describe_change_set
+        sleep 1
+        print '.'
+      end
+      puts
+
+      case change_set.status
+      when "CREATE_COMPLETE"
+        puts "CloudFormation preview for '#{@stack_name}' stack update. Changes:"
+        changes = change_set.changes.sort_by do |change|
+          change["resource_change"]["action"]
+        end
+        changes.each do |change|
+          display_change(change)
+        end
+      when "FAILED"
+        puts "WARN: Fail to create a CloudFormation preview for '#{@stack_name}' stack update. Reason:".color(:yellow)
+        puts change_set.status_reason
+        quit(0)
+      else
+        raise "hell: never come here"
+      end
+    end
+
+    def delete_change_set
+      cfn.delete_change_set(
+        change_set_name: change_set_name,
+        stack_name: @stack_name
+      )
+    end
+
+    def execute_change_set
+      cfn.execute_change_set(
+        change_set_name: change_set_name,
+        stack_name: @stack_name
+      )
+    end
+
+    # generates a change set name
+    def change_set_name
+      @change_set_name ||= "changeset-#{Time.now.strftime("%Y%d%m%H%M%S")}"
+    end
+
+  private
+    # Private: formats a Aws::CloudFormation::Types::Change in pretty human readable form
+    #
+    # change  - Aws::CloudFormation::Types::Change
+    #
+    # Examples
+    #
+    #   display_change(change)
+    #   => Remove AWS::Route53::RecordSet: DnsRecord testsubdomain.sub.tongueroo.com
+    #
+    # Returns nil
+    #
+    # change.to_h
+    # {:type=>"Resource",
+    #  :resource_change=>
+    #   {:action=>"Remove",
+    #    :logical_resource_id=>"DnsRecord",
+    #    :physical_resource_id=>"testsubdomain.sub.tongueroo.com",
+    #    :resource_type=>"AWS::Route53::RecordSet",
+    #    :scope=>[],
+    #    :details=>[]}}
+    def display_change(change)
+      message = if change.type == "Resource"
+        c = change.resource_change
+        "#{c.action} #{c.resource_type}: #{c.logical_resource_id} #{c.physical_resource_id}"
+      else
+        change.to_h
+      end
+
+      colors = { Remove: :red, Add: :green, Modify: :yellow }
+      action = change.resource_change.action.to_sym
+      message = message.color(colors[action]) if colors.has_key?(action)
+      puts message
+    end
+
+    def change_set_finished?(change_set)
+      change_set.status =~ /_COMPLETE/ || change_set.status == "FAILED"
+    end
+
+    def describe_change_set
+      cfn.describe_change_set(
+        change_set_name: change_set_name,
+        stack_name: @stack_name
+      )
+    end
+  end
+end

data/lib/lono/cfn/{diff.rb → preview/codediff.rb}

@@ -1,8 +1,11 @@
-class Lono::Cfn
-  class Diff < Base
+module Lono::Cfn::Preview
+  class Codediff < Lono::Cfn::Base
+    include DiffViewer
     include Lono::AwsServices
 
     def run
+      puts "Code Diff Preview:".color(:green)
+
       unless stack_exists?(@stack_name)
         puts "WARN: Cannot create a diff for the stack because the #{@stack_name} does not exists.".color(:yellow)
         return
@@ -14,7 +17,7 @@ class Lono::Cfn
         generate_all # from Base superclass. Generates the output lono teplates
         puts "Generating CloudFormation source code diff..."
         download_existing_cfn_template
-        show_changes
+        show_diff(existing_template_path, new_cfn_template)
       end
     end
 
@@ -27,22 +30,11 @@ class Lono::Cfn
       IO.write(existing_template_path, resp.template_body)
     end
 
-    def show_changes
-      command = "#{diff_viewer} #{existing_template_path} #{new_cfn_template}"
-      puts "Running: #{command}"
-      system(command)
-    end
-
     # for clarity
     def new_cfn_template
       @template_path
     end
 
-    def diff_viewer
-      return ENV['LONO_DIFF'] if ENV['LONO_DIFF']
-      system("type colordiff > /dev/null") ? "colordiff" : "diff"
-    end
-
     def existing_template_path
       "/tmp/existing_cfn_template.yml"
     end

data/lib/lono/cfn/preview/diff_viewer.rb

@@ -0,0 +1,19 @@
+module Lono::Cfn::Preview
+  module DiffViewer
+    def show_diff(existing_path, new_path)
+      command = "#{diff_viewer} #{existing_path} #{new_path}"
+      puts "Running: #{command}"
+      out = `#{command}`
+      if out.strip == ''
+        puts "There were no differences."
+      else
+        puts out
+      end
+    end
+
+    def diff_viewer
+      return ENV['LONO_DIFF'] if ENV['LONO_DIFF']
+      system("type colordiff > /dev/null") ? "colordiff" : "diff"
+    end
+  end
+end