lono-cfn 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cce00749152f718ccb8edc814ae3fc05c65d94f5
-  data.tar.gz: d69c3c08a4165e3f8b77def7a06bc15dcb1a72be
+  metadata.gz: fc7cbd896929c57d603558a99e4b856f33afd5dc
+  data.tar.gz: 3421211ad8ced2927393fa288fe53106fae7107d
 SHA512:
-  metadata.gz: e11817facf60121389255b1fa1aab57ab3051042faa6281bf356c1d0ab91c17c93d5cf7600d45ca32150a7c0b8c8a9d55245a35b415c4d091ac34b62adb0ea27
-  data.tar.gz: ec3826d45cc9264034f20e38a0bc9c1b0e914013548f53e5a890eaf5f14094a5cfc42d98f05826dede05abf038884f919416512bc2d9aad0f9568cab6e60d624
+  metadata.gz: 396a93fe146ae84070e20fb6b357f1ac43062d835b0511f2d286ed0223470f45e7dc610de52ba7cc0ff1c255917d418372e56cb172c9b27676fadcd4f597ed25
+  data.tar.gz: 20311ea9620a5015cf588feb59e9dc2b102c0eb66052b1b5c6051fd2318c61a5d11ebeae890b71cceacd5d753439da0255d8521c6f4d1165dda4c18c95c876fb

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.
 
+## [1.1.0]
+
+- add lono-cfn diff
+- rename lono-cfn preview
+
 ## [1.0.4]
 
 - rename lono_cfn -> lono-cfn
@@ -22,7 +27,7 @@ This project *tries* to adhere to [Semantic Versioning](http://semver.org/), eve
 
 ## [1.0.0]
 
-- add lono-cfn plan
+- add lono-cfn preview
 - fix edge cases and show helpful error messages when stacks are not in updatable statuses
 
 ## [0.0.8]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lono-cfn (1.0.3)
+    lono-cfn (1.0.4)
       aws-sdk
       colorize
       hashie

data/README.md

@@ -8,7 +8,7 @@ Wrapper cfn tool to quickly create CloudFormation stacks from [lono templates](h
 $ lono-cfn create my-stack-$(date +%s) --template my-template --params my-params
 $ lono-cfn update my-stack-1493859659 --template my-template --params my-params
 $ lono-cfn delete my-stack-1493859659 --sure
-$ lono-cfn plan my-stack-1493859659 --template template-name --params params-name
+$ lono-cfn preview my-stack-1493859659 --template template-name --params params-name
 ```
 
 The above command:
@@ -26,7 +26,7 @@ These blog posts cover both lono and lono-cfn:
 * [AutoScaling CloudFormation Template with Lono](https://medium.com/boltops/autoscaling-cloudformation-template-with-lono-3dc520480c5f)
 * [CloudFormation Tools: lono, lono-params and lono-cfn Together
 ](https://medium.com/boltops/cloudformation-tools-lono-lono-params-and-lono-cfn-play-together-620af51e616)
-* [AWS CloudFormation dry-run with lono-cfn plan](https://medium.com/boltops/aws-cloudformation-dry-run-with-lono-cfn-plan-2a1e0f80d13c)
+* [AWS CloudFormation dry-run with lono-cfn preview](https://medium.com/boltops/aws-cloudformation-dry-run-with-lono-cfn-preview-2a1e0f80d13c)
 
 ## Installation
 
@@ -117,19 +117,19 @@ $ lono-cfn update my-stack --template template-name --params params-name --sure
 $ lono-cfn delete my-stack --sure
 ```
 
-### lono-cfn plan
+### lono-cfn preview
 
-If you want to see the CloudFormation plan without updating the stack you can also use the `lono-cfn plan` command.
+If you want to see the CloudFormation preview without updating the stack you can also use the `lono-cfn preview` command.
 
 ```
-$ lono-cfn plan example --template single_instance --params single_instance
+$ lono-cfn preview example --template single_instance --params single_instance
 Using template: output/single_instance.yml
 Using parameters: params/single_instance.txt
 Generating CloudFormation templates:
   ./output/single_instance.yml
 Params file generated for example at ./output/params/example.json
-Generating CloudFormation Change Set for plan.....
-CloudFormation plan for 'example' stack update. Changes:
+Generating CloudFormation Change Set for preview.....
+CloudFormation preview for 'example' stack update. Changes:
 Remove AWS::Route53::RecordSet: DnsRecord testsubdomain.sub.tongueroo.com
 $
 ```

data/lib/lono-cfn.rb

@@ -16,5 +16,6 @@ module LonoCfn
   autoload :Create, 'lono-cfn/create'
   autoload :Update, 'lono-cfn/update'
   autoload :Delete, 'lono-cfn/delete'
-  autoload :Plan, 'lono-cfn/plan'
+  autoload :Preview, 'lono-cfn/preview'
+  autoload :Diff, 'lono-cfn/diff'
 end

data/lib/lono-cfn/base.rb

@@ -15,15 +15,19 @@ module LonoCfn
       params_name = options[:params] || template_name
       @template_path = get_source_path(template_name, :template)
       @params_path = get_source_path(params_name, :params)
-      puts "Using template: #{@template_path}"
-      puts "Using parameters: #{@params_path}"
+      puts "Using template: #{@template_path}" unless @options[:mute_using]
+      puts "Using parameters: #{@params_path}" unless @options[:mute_using]
     end
 
     def run
+      params = generate_all
+      save_stack(params) # defined in the sub class
+    end
+
+    def generate_all
       generate_templates if @options[:lono]
       check_for_errors
-      params = generate_params if @options[:lono]
-      save_stack(params) # defined in the sub class
+      generate_params(mute: @options[:mute_params])
     end
 
     def generate_templates

data/lib/lono-cfn/cli.rb

@@ -23,7 +23,8 @@ module LonoCfn
     desc "update STACK", "update a CloudFormation stack"
     long_desc Help.update
     option :change_set, type: :boolean, default: true, desc: "Uses generated change set to update the stack.  If false, will perform normal update-stack."
-    option :preview, type: :boolean, default: true, desc: "Prints preview of the stack changes before continuing."
+    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 :sure, type: :boolean, desc: "Skips are you sure prompt"
     def update(name)
       Update.new(name, options).run
@@ -36,11 +37,19 @@ module LonoCfn
       Delete.new(name, options).run
     end
 
-    desc "plan STACK", "preview a CloudFormation stack update"
-    long_desc Help.plan
+    desc "preview STACK", "preview a CloudFormation stack update"
+    long_desc Help.preview
     option :keep, type: :boolean, desc: "keep the changeset instead of deleting it afterwards"
-    def plan(name)
-      Plan.new(name, options).run
+    option :diff, type: :boolean, default: true, desc: "Show diff of the source code template changes also."
+    def preview(name)
+      Diff.new(name, options).run if options[:diff]
+      Preview.new(name, options).run
+    end
+
+    desc "diff STACK", "diff of newly generated template vs existing template in AWS"
+    long_desc Help.diff
+    def diff(name)
+      Diff.new(name, options).run
     end
   end
 end

data/lib/lono-cfn/cli/help.rb

@@ -66,19 +66,29 @@ The above command will delete my-stack.
 EOL
         end
 
-        def plan
+        def preview
 <<-EOL
-Generates a CloudFormation plan.  This is similar to a `terraform plan` or puppet's dry-run mode.
+Generates a CloudFormation preview.  This is similar to a `terraform plan` or puppet's dry-run mode.
 
 Example output:
 
-CloudFormation plan for 'example' stack update. Changes:
+CloudFormation preview for 'example' stack update. Changes:
 
 Remove AWS::Route53::RecordSet: DnsRecord testsubdomain.sub.tongueroo.com
 
 Examples:
 
-$ lono-cfn plan my-stack
+$ lono-cfn preview my-stack
+EOL
+        end
+
+        def diff
+<<-EOL
+Displays code diff of the generated CloudFormation template locally vs the existing template on AWS. You can set a desired diff viewer by setting the LONO_CFN_DIFF environment variable.
+
+Examples:
+
+$ lono-cfn diff my-stack
 EOL
         end
       end

data/lib/lono-cfn/diff.rb

@@ -0,0 +1,45 @@
+module LonoCfn
+  class Diff < Base
+    include AwsServices
+
+    def run
+      if @options[:noop]
+        puts "NOOP Generating CloudFormation source code diff..."
+      else
+        generate_all # from Base superclass. Generates the output lono teplates
+        puts "Generating CloudFormation source code diff..."
+        download_existing_cfn_template
+        show_changes
+      end
+    end
+
+    def download_existing_cfn_template
+      resp = cfn.get_template(
+        stack_name: @stack_name,
+        template_stage: "Original"
+      )
+      resp.template_body
+      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_CFN_DIFF'] if ENV['LONO_CFN_DIFF']
+      system("type colordiff > /dev/null") ? "colordiff" : "diff"
+    end
+
+    def existing_template_path
+      "/tmp/existing_cfn_template.json"
+    end
+  end
+end

data/lib/lono-cfn/{plan.rb → preview.rb}

@@ -1,32 +1,25 @@
 module LonoCfn
   # Inherit from Base because the initializer is the same
-  class Plan < Base
+  class Preview < Base
     include AwsServices
 
-    def setup
-      generate_templates if @options[:lono]
-      check_for_errors
-      @params = generate_params(mute: @options[:mute_params])
-    end
-
-    # Override run from Base superclass, the run method is different enough with Plan
+    # Override run from Base superclass, the run method is different enough with Preview
     def run
-      setup
-
       if @options[:noop]
-        puts "NOOP CloudFormation plan for #{@stack_name} update"
+        puts "NOOP CloudFormation preview for #{@stack_name} update"
       else
-        preview_change_set
+        params = generate_all
+        preview_change_set(params)
         delete_change_set unless @options[:keep] # Clean up and delete the change set
       end
     end
 
-    def preview_change_set
-      create_change_set
+    def preview_change_set(params)
+      create_change_set(params)
       display_change_set
     end
 
-    def create_change_set
+    def create_change_set(params)
       unless stack_exists?(@stack_name)
         puts "Cannot create a change set for the stack because the #{@stack_name} does not exists."
         return
@@ -34,26 +27,26 @@ module LonoCfn
       exist_unless_updatable(stack_status(@stack_name))
 
       template_body = IO.read(@template_path)
-      begin
+      # begin
         cfn.create_change_set(
           change_set_name: change_set_name,
           stack_name: @stack_name,
           template_body: template_body,
-          parameters: @params
+          parameters: params
         )
-      rescue Aws::CloudFormation::Errors::ValidationError => e
-        if e.message =~ /^Parameters: /
-          puts "Error creating CloudFormation plan because invalid CloudFormation parameters. Full error message:".colorize(:red)
-          puts e.message
-          quit(1)
-        else
-          raise
-        end
-      end
+      # rescue Aws::CloudFormation::Errors::ValidationError => e
+      #   if e.message =~ /^Parameters: /
+      #     puts "Error creating CloudFormation preview because invalid CloudFormation parameters. Full error message:".colorize(:red)
+      #     puts e.message
+      #     quit(1)
+      #   else
+      #     raise
+      #   end
+      # end
     end
 
     def display_change_set
-      print "Generating CloudFormation Change Set for plan.."
+      print "Generating CloudFormation Change Set for preview.."
       change_set = describe_change_set
       until change_set_finished?(change_set) do
         change_set = describe_change_set
@@ -64,12 +57,12 @@ module LonoCfn
 
       case change_set.status
       when "CREATE_COMPLETE"
-        puts "CloudFormation plan for '#{@stack_name}' stack update. Changes:"
+        puts "CloudFormation preview for '#{@stack_name}' stack update. Changes:"
         change_set.changes.each do |change|
           display_change(change)
         end
       when "FAILED"
-        puts "Fail to create a CloudFormation plan for '#{@stack_name}' stack update. Reason:".colorize(:red)
+        puts "Fail to create a CloudFormation preview for '#{@stack_name}' stack update. Reason:".colorize(:red)
         puts change_set.status_reason
         quit(1)
       else

data/lib/lono-cfn/update.rb

@@ -18,11 +18,12 @@ module LonoCfn
       if @options[:noop]
         message = "NOOP #{message}"
       else
-        preview_changes if @options[:preview]
+        diff.run if @options[:diff]
+        preview.run if @options[:preview]
         are_you_sure?(:update)
 
         if @options[:change_set] # defaults to this
-          message << " via change set: #{plan.change_set_name}"
+          message << " via change set: #{preview.change_set_name}"
           change_set_update
         else
           standard_update(params)
@@ -46,19 +47,17 @@ module LonoCfn
       end
     end
 
-    def plan
-      return @plan if @plan
-      @plan = Plan.new(@stack_name, @options.merge(lono: false, mute_params: true))
-      @plan.setup
-      @plan
+    def preview
+      options = @options.merge(lono: false, mute_params: true, mute_using: true, keep: true)
+      @preview ||= Preview.new(@stack_name, options)
     end
 
-    def preview_changes
-      plan.preview_change_set
+    def diff
+      @diff ||= Diff.new(@stack_name, @options.merge(lono: false, mute_params: true, mute_using: true))
     end
 
     def change_set_update
-      plan.execute_change_set
+      preview.execute_change_set
     end
   end
 end

data/lib/lono-cfn/version.rb

@@ -1,3 +1,3 @@
 module LonoCfn
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/spec/lib/cli_spec.rb

@@ -11,24 +11,29 @@ describe LonoCfn::CLI do
   end
 
   describe "lono-cfn" do
-    it "creates stack" do
+    it "create stack" do
       out = execute("bin/lono-cfn create my-stack #{@args}")
       expect(out).to include("Creating")
     end
 
-    it "updates stack" do
+    it "update stack" do
       out = execute("bin/lono-cfn update my-stack #{@args}")
       expect(out).to include("Updating")
     end
 
-    it "deletes stack" do
+    it "delete stack" do
       out = execute("bin/lono-cfn delete my-stack #{@args}")
       expect(out).to include("Deleted")
     end
 
-    it "plans stack" do
-      out = execute("bin/lono-cfn plan my-stack #{@args}")
-      expect(out).to include("CloudFormation plan")
+    it "preview stack" do
+      out = execute("bin/lono-cfn preview my-stack #{@args}")
+      expect(out).to include("CloudFormation preview")
+    end
+
+    it "diff stack" do
+      out = execute("bin/lono-cfn diff my-stack #{@args}")
+      expect(out).to include("diff")
     end
   end
 end

data/vendor/lono-params/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.
 
+## [1.0.1]
+- expose mute option
+
 ## [1.0.0]
 - allow --help or -h at the end of the command
 - rename lono_params -> lono-params

data/vendor/lono-params/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lono-params (1.0.0)
+    lono-params (1.0.1)
       colorize
       hashie
       json

data/vendor/lono-params/lib/lono-params/cli.rb

@@ -7,6 +7,7 @@ module LonoParams
   class CLI < Command
     class_option :verbose, type: :boolean
     class_option :noop, type: :boolean
+    class_option :mute, type: :boolean
     class_option :project_root, desc: "project root to use", default: '.'
 
     desc "generate NAME", "generate parameter json file for NAME"

data/vendor/lono-params/lib/lono-params/generator.rb

@@ -72,7 +72,6 @@ module LonoParams
     end
 
     def write_output(json)
-      puts "output_path #{output_path.inspect}"
       dir = File.dirname(output_path)
       FileUtils.mkdir_p(dir) unless File.exist?(dir)
       IO.write(output_path, json)

data/vendor/lono-params/lib/lono-params/version.rb

@@ -1,3 +1,3 @@
 module LonoParams
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lono-cfn
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -180,7 +180,8 @@ files:
 - lib/lono-cfn/command.rb
 - lib/lono-cfn/create.rb
 - lib/lono-cfn/delete.rb
-- lib/lono-cfn/plan.rb
+- lib/lono-cfn/diff.rb
+- lib/lono-cfn/preview.rb
 - lib/lono-cfn/update.rb
 - lib/lono-cfn/util.rb
 - lib/lono-cfn/version.rb
@@ -208,6 +209,7 @@ files:
 - vendor/lono-params/lono-params.gemspec
 - vendor/lono-params/pkg/lono-params-0.0.6.gem
 - vendor/lono-params/pkg/lono-params-1.0.0.gem
+- vendor/lono-params/pkg/lono-params-1.0.1.gem
 - vendor/lono-params/spec/fixtures/my_project/output/params/my-stack.json
 - vendor/lono-params/spec/fixtures/my_project/params/my-stack.txt
 - vendor/lono-params/spec/lib/cli_spec.rb