lono-cfn 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 265bf28e4a45544babe2118667de0af5915340d5
-  data.tar.gz: b0cdecb36faa043904edb48b33f56544d40bbb1c
+  metadata.gz: c8ffa1032d935ae7276a2500f96b1194582d0d53
+  data.tar.gz: 12ad9b4d32e1093bc1a52fa6ae05651f5a633866
 SHA512:
-  metadata.gz: 8c70f4ddd7d26a3328412605aa890802ccbe24e019a1f5e1f27eaf075b8fd704ed8b286b58053aa8433d5dd8e9e42ed33653f9e9237a1f022a10a100c53c75ea
-  data.tar.gz: 4ca23f77a2d84fa824705b43239f4662b239319e6d63d58c8462182c842628d2b9c7454175eb18acec8eb0e8910d7e1cb59f9ac93da101db4bdce3184aa30370
+  metadata.gz: 19148e7e7e85bc34bc2024e3beac7e25a8e5a12aa34c3733267fd8075b40f9b14bcb411d4b04f52636c2711358559e4817f38e0fdfc41d9b3b87019e8fe09c1d
+  data.tar.gz: 0c3a39eb67e4bb16acf08256545916eae5593765c5557a38f614469ded37866f1bce1a3eafe15033a914a43ab66cc52a7d0ad460b23ce4d6aea19518936a9441

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.
 
+## [0.0.2] lono-cfn update
+
+- `lono-cfn update` implemented.
+
 ## [0.0.1] Initial Release
 
-- Initial release.
+- Initial release: `lono-cfn create`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lono-cfn (0.0.1)
+    lono-cfn (0.0.2)
       aws-sdk
       colorize
       hashie
@@ -21,12 +21,12 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    aws-sdk (2.6.4)
-      aws-sdk-resources (= 2.6.4)
-    aws-sdk-core (2.6.4)
+    aws-sdk (2.6.5)
+      aws-sdk-resources (= 2.6.5)
+    aws-sdk-core (2.6.5)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.6.4)
-      aws-sdk-core (= 2.6.4)
+    aws-sdk-resources (2.6.5)
+      aws-sdk-core (= 2.6.5)
     builder (3.1.4)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -68,7 +68,7 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lono (0.5.0)
+    lono (0.5.2)
       colorize
       guard
       guard-cloudformation
@@ -77,7 +77,7 @@ GEM
       rake
       rb-fsevent
       thor
-    lono-params (0.0.2)
+    lono-params (0.0.4)
       colorize
       hashie
       plissken

data/README.md

@@ -1,6 +1,6 @@
 # Lono Cfn
 
-Wrapper cfn tool to quickly create CloudFormation stacks from lono templates and params files.  
+Wrapper cfn tool to quickly create CloudFormation stacks from [lono templates](https://github.com/tongueroo/lono) and [lono-params](https://github.com/tongueroo/lono-params) files.  Example:
 
 ```bash
 $ bundle exec lono-cfn create my-stack-$(date +%s) --template my-template --params my-params
@@ -12,7 +12,7 @@ The above command:
 2. Generate a parameters file from the params/my-params.txt.
 3. Launch the CloudFormation stack with those parameters.
 
-This tool is meant to be used in conjuction with [lono](https://github.com/tongueroo/lono) but can also be used separately with the `--no-lono` flag, which skips the `lono generate` call.
+This tool is meant to be used in conjuction with [lono](https://github.com/tongueroo/lono) but can also be used separately with the `--no-lono` flag, which skips the `lono generate` step.
 
 ## Installation
 
@@ -36,15 +36,32 @@ Provided that you are in a lono project and have a `my-stack` lono template defi
 $ lono-cfn create my-stack
 ```
 
-The above command will generate and use the template in output/my-stack.json and parameters in params/my-stack.txt.  The template defaults by convention to the name of the stack.  The params defaults by convention to the name of the template in turn.  The conventions allows the command to be a very nice short command that can be easily remembered.  Both conventions can be overridden.
+The above command will generate and use the template in output/my-stack.json and parameters in params/my-stack.txt.  
 
-## More About Conventions
+### Conventions
 
-* stack - This is a required parameter and is the passed in from the CLI as the first parameter.
+The template by convention defaults to the name of the stack.  In turn, the params by convention defaults to the name of the template in turn.
+
+* stack - This is a required parameter and is the CLI first parameter.
 * template - By convention matches the stack name but can be overriden with `--template`.
-* params = By convention matches the template name but can be overriden with `--params`.
+* params - By convention matches the template name but can be overriden with `--params`.
+
+The conventions allows the command to be a very nice short command that can be easily remembered.  For example, these 2 commands are the same:
+
+Long form:
+
+```
+$ lono-cfn create my-stack --template my-stack --params --my-stack
+```
+
+Short form:
+
+```
+$ lono-cfn create my-stack
+```
+
 
-Here are examples of overriding the template and params name conventions.
+Both template and params conventions can be overridden.  Here are examples of overriding the template and params name conventions.
 
 ```
 $ lono-cfn create my-stack --template different-name1

data/lib/lono-cfn.rb

@@ -4,5 +4,7 @@ require "pp"
 
 module LonoCfn
   autoload :CLI, 'lono_cfn/cli'
+  autoload :Base, 'lono_cfn/base'
   autoload :Create, 'lono_cfn/create'
+  autoload :Update, 'lono_cfn/update'
 end

data/lib/lono_cfn/base.rb

@@ -0,0 +1,93 @@
+require "lono"
+require "lono-params"
+require "aws-sdk"
+
+module LonoCfn
+  class Base
+    def initialize(stack_name, options={})
+      @stack_name = stack_name
+      @options = options
+      @project_root = options[:project_root] || '.'
+
+      template_name = options[:template] || @stack_name
+      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}"
+
+      @region = options[:region] || 'us-east-1'
+    end
+
+    def run
+      generate_templates if @options[:lono]
+      check_for_errors
+      params = generate_params
+      save_stack(params) # defined in the sub class
+    end
+
+    def generate_templates
+      Lono::DSL.new(
+          project_root: @project_root,
+          pretty: true
+        ).run
+    end
+
+    def generate_params
+      generator = LonoParams::Generator.new(@stack_name,
+        project_root: @project_root,
+        path: @params_path,
+        allow_no_file: true)
+      generator.generate  # Writes the json file in CamelCase keys format
+      generator.params    # Returns Array in underscore keys format
+    end
+
+    def cfn
+      @cfn ||= Aws::CloudFormation::Client.new(region: @region)
+    end
+
+    def check_for_errors
+      errors = check_files
+      unless errors.empty?
+        puts "Please double check the command you ran.  There were some errors."
+        puts "#{errors.join("\n")}"
+        exit
+      end
+    end
+
+    def check_files
+      errors = []
+      unless File.exist?(@template_path)
+        errors << "Template file missing: could not find #{@template_path}"
+      end
+      if @options[:params] && !File.exist?(@params_path)
+        errors << "Parameters file missing: could not find #{@params_path}"
+      end
+      errors
+    end
+
+    # if existing in params path then use that
+    # if it doesnt assume it is a full path and check that
+    # else fall back to convention, which also eventually gets checked in check_for_errors
+    #
+    # Type - :params or :template
+    def get_source_path(path, type)
+      default_convention_path = convention_path(@stack_name, type)
+
+      return default_convention_path if path.nil?
+      # convention path based on the input from the user
+      convention_path(path, type)
+    end
+
+    def convention_path(name, type)
+      case type
+      when :template
+        "#{@project_root}/output/#{name}.json"
+      when :params
+        "#{@project_root}/params/#{name}.txt"
+      else
+        raise "hell: dont come here"
+      end
+    end
+  end
+end

data/lib/lono_cfn/cli/help.rb

@@ -26,6 +26,33 @@ $ lono-cfn create my-stack --template different-name3 --params different-name4
 
 The template that will be use is output/different-name3.json and the parameters will use params/different-name4.json.
 
+EOL
+        end
+
+        def update
+<<-EOL
+Examples:
+
+Provided that you are in a lono project and have a `my-stack` lono template definition.  To update a stack you can simply run:
+
+$ lono-cfn update my-stack
+
+The above command will generate and use the template in output/my-stack.json and parameters in params/my-stack.txt.  The template defaults by convention to the name of the stack.  The params defaults by convention to the name of the template in turn.  The convention allows the command to be a very nice short command that can be easily remembered.  Both conventions can be overridden.
+
+Here are examples of overriding the template and params name conventions.
+
+$ lono-cfn update my-stack --template different-name1
+
+The template that will be use is output/different-name1.json and the parameters will use params/different-name1.json.
+
+$ lono-cfn update my-stack --params different-name2
+
+The template that will be use is output/different-name2.json and the parameters will use params/different-name2.json.
+
+$ lono-cfn update my-stack --template different-name3 --params different-name4
+
+The template that will be use is output/different-name3.json and the parameters will use params/different-name4.json.
+
 EOL
         end
       end

data/lib/lono_cfn/cli.rb

@@ -8,13 +8,21 @@ module LonoCfn
     class_option :noop, type: :boolean
     class_option :project_root, desc: "Project folder.  Defaults to current directory", default: '.'
 
+    # common to create and update
+    class_option :template, desc: 'override convention and specify the template file to use'
+    class_option :params, desc: 'override convention and specify the params file to use'
+    class_option :lono, type: :boolean, desc: 'invoke lono to generate CloudFormation templates', default: true
+
     desc "create STACK", "create a CloudFormation stack"
     long_desc Help.create
-    option :template, desc: 'override convention and specify the template file to use'
-    option :params, desc: 'override convention and specify the params file to use'
-    option :lono, type: :boolean, desc: 'invoke lono to generate CloudFormation templates', default: true
     def create(name)
       Create.new(name, options).run
     end
+
+    desc "update STACK", "update a CloudFormation stack"
+    long_desc Help.update
+    def update(name)
+      Update.new(name, options).run
+    end
   end
 end

data/lib/lono_cfn/create.rb

@@ -1,53 +1,19 @@
-require "lono"
-require "lono-params"
-require "aws-sdk"
-
 module LonoCfn
-  class Create
-    def initialize(stack_name, options={})
-      @stack_name = stack_name
-      @options = options
-      @project_root = options[:project_root] || '.'
-
-      template_name = options[:template] || @stack_name
-      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}"
-
-      @region = options[:region] || 'us-east-1'
-    end
-
-    def run
-      generate_templates if @options[:lono]
-      check_for_errors
-      params = generate_params
+  class Create < Base
+    # save_stack is the interface method
+    def save_stack(params)
       create_stack(params)
     end
 
-    def generate_templates
-      Lono::DSL.new(
-          project_root: @project_root,
-          pretty: true
-        ).run
-    end
-
-    def generate_params
-      generator = LonoParams::Generator.new(@stack_name,
-        project_root: @project_root,
-        path: @params_path,
-        allow_blank: true)
-      generator.generate  # Writes the json file in CamelCase keys format
-      generator.params    # Returns Array in underscore keys format
-    end
-
-    # aws cloudformation create-stack --stack-name cluster-hi \
-    #   --template-body file://output/cluster-hi.json \
-    #   --parameters file://parameters/output/cluster-hi.json
+    # aws cloudformation create-stack --stack-name prod-hi-123456789 --parameters file://output/params/prod-hi-123456789.json --template-body file://output/prod-hi.json
     def create_stack(params)
+      if stack_exists?
+        puts "Cannot create a stack because the #{@stack_name} already exists."
+        return
+      end
+
       template_body = IO.read(@template_path)
-      message = "#{@stack_name} stack created."
+      message = "#{@stack_name} stack creating."
       if @options[:noop]
         message = "NOOP #{message}"
       else
@@ -61,52 +27,10 @@ module LonoCfn
       puts message unless @options[:mute]
     end
 
-    def cfn
-      @cfn ||= Aws::CloudFormation::Client.new(region: @region)
-    end
-
-    def check_for_errors
-      errors = check_files
-      unless errors.empty?
-        puts "Please double check the command you ran.  There were some errors."
-        puts "#{errors.join("\n")}" 
-        exit
-      end
-    end
-
-    def check_files
-      errors = []
-      unless File.exist?(@template_path)
-        errors << "Template file missing: could not find #{@template_path}"
-      end
-      if @options[:params] && !File.exist?(@params_path)
-        errors << "Parameters file missing: could not find #{@params_path}"
-      end
-      errors
-    end
-
-    # if existing in params path then use that
-    # if it doesnt assume it is a full path and check that
-    # else fall back to convention, which also eventually gets checked in check_for_errors
-    # 
-    # Type - :params or :template
-    def get_source_path(path, type)
-      default_convention_path = convention_path(@stack_name, type)
-
-      return default_convention_path if path.nil?
-      # convention path based on the input from the user
-      convention_path(path, type)
-    end
-
-    def convention_path(name, type)
-      case type
-      when :template
-        "#{@project_root}/output/#{name}.json"
-      when :params
-        "#{@project_root}/params/#{name}.txt"
-      else
-        raise "hell: dont come here"
-      end
+    def stack_exists?
+      return if @options[:noop]
+      stack = cfn.describe_stacks(stack_name: @stack_name).stacks.first
+      !!stack
     end
   end
 end

data/lib/lono_cfn/update.rb

@@ -0,0 +1,25 @@
+module LonoCfn
+  class Update < Base
+    # save_stack is the interface method
+    def save_stack(params)
+      update_stack(params)
+    end
+
+    # aws cloudformation update-stack --stack-name prod-hi-123456789 --parameters file://output/params/prod-hi-123456789.json --template-body file://output/prod-hi.json
+    def update_stack(params)
+      template_body = IO.read(@template_path)
+      message = "#{@stack_name} stack updating."
+      if @options[:noop]
+        message = "NOOP #{message}"
+      else
+        cfn.update_stack(
+          stack_name: @stack_name,
+          template_body: template_body,
+          parameters: params#,
+          # capabilities: ["CAPABILITY_IAM"]
+        )
+      end
+      puts message unless @options[:mute]
+    end
+  end
+end

data/lib/lono_cfn/version.rb

@@ -1,3 +1,3 @@
 module LonoCfn
-  VERSION = "0.0.1"
-end
+  VERSION = "0.0.2"
+end

data/spec/lib/cli_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 # to run specs with what's remembered from vcr
 #   $ rake
-# 
+#
 # to run specs with new fresh data from aws api calls
 #   $ rake clean:vcr ; time rake
 describe LonoCfn::CLI do
@@ -13,7 +13,12 @@ describe LonoCfn::CLI do
   describe "lono-cfn" do
     it "creates stack" do
       out = execute("bin/lono-cfn create my-stack #{@args}")
-      expect(out).to include("stack created.")
+      expect(out).to include("stack creating.")
+    end
+
+    it "updates stack" do
+      out = execute("bin/lono-cfn update my-stack #{@args}")
+      expect(out).to include("stack updating.")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono-cfn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2016-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -184,9 +184,11 @@ files:
 - Rakefile
 - bin/lono-cfn
 - lib/lono-cfn.rb
+- lib/lono_cfn/base.rb
 - lib/lono_cfn/cli.rb
 - lib/lono_cfn/cli/help.rb
 - lib/lono_cfn/create.rb
+- lib/lono_cfn/update.rb
 - lib/lono_cfn/version.rb
 - lono_cfn.gemspec
 - spec/fixtures/my_project/config/lono.rb
@@ -227,4 +229,3 @@ test_files:
 - spec/fixtures/my_project/params/my-stack.txt
 - spec/lib/cli_spec.rb
 - spec/spec_helper.rb
-has_rdoc: