hygroscope 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6843b8aec13ea4cea7186e3e0d303bf9fb9a3fcc
-  data.tar.gz: e8892054ee9e904e1c3d668c56866d01d5f9e624
+  metadata.gz: d0c04fe1271358a786c6d3a11bf560b6dd3b473c
+  data.tar.gz: 651417b88a81f851051083505ef069f1a74f11f3
 SHA512:
-  metadata.gz: cd09dd561634d91ce8ed58851c58b58e445cfb5e275119923ee6fb7a977d66e486d96143e035ac8566d70a257cc3f51c07e2adfacb9a165724e424fbde5d6552
-  data.tar.gz: 8b508549617eee3670492368d9616bba7293e6072d6199ebe944fe9553b74e8a487b03fa4e4ac7f8d06caecf989639ad8cf1024481d30c686002c157be657248
+  metadata.gz: 0cc74e488efa5facd0b5f460a0035a5da03055324ede819b25333f969d45b815a41452199bc966cb83377decddba2ceac2675e1691ef346ae4d3ab66d4cb57be
+  data.tar.gz: dde59539318ab9315129291de3ceed29c7e7e5ba52efcfca38059e5d94bf8aa92bd230a397d87a8b1bbd87289dfc87ff104d7d4f46c1121e19ead89e2206bfb6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.3.0 (2016-08-12)
+- Support passing capabilities using new --capabilities option. No longer set
+    CAPABILITY_IAM by default.
+- When performing updates use existing parameters by default
+- Do not compress template by default (readability vs slight space savings)
+- Rubocop code cleanup
+
 ## 1.2.0 (2015-10-08)
 - Support AWS credential profiles and multiple regions using new --region and
   --profile options.

data/hygroscope.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'hygroscope'
-  s.version     = '1.2.0'
+  s.version     = '1.3.0'
   s.summary     = 'CloudFormation launcher'
   s.description = 'A tool for managing the launch of complex CloudFormation stacks'
   s.authors     = ['Daniel Silverman']

data/lib/hygroscope/cli.rb

@@ -81,18 +81,18 @@ module Hygroscope
     # NOTE: Profiles cannot assume roles, see:
     # https://github.com/aws/aws-sdk-ruby/issues/910
     class_option :profile,
-                  aliases: '-p',
-                  type: :string,
-                  default: 'default',
-                  desc: 'AWS account credentials profile name'
+      aliases: '-p',
+      type:    :string,
+      default: 'default',
+      desc:    'AWS account credentials profile name'
     class_option :region,
-                  aliases: '-r',
-                  type: :string,
-                  default: 'us-east-1',
-                  desc: 'AWS region'
+      aliases: '-r',
+      type:    :string,
+      default: 'us-east-1',
+      desc:    'AWS region'
 
     desc 'prepare', 'Prepare to create or update a stack by generating the template, assembling parameters, and managing payload upload', hide: true
-    def prepare
+    def prepare(action = 'create')
       # Generate the template
       t = Hygroscope::Template.new(template_path, options[:region], options[:profile])
 
@@ -132,49 +132,57 @@ module Hygroscope
         end
       end if options[:existing].is_a?(Array)
 
-      # Prompt for each missing parameter and save it in the paramset object
-      missing.each do |key|
-        # Do not prompt for keys prefixed with the "Hygroscope" reserved word.
-        # These parameters are populated internally without user input.
-        next if key =~ /^Hygroscope/
-
-        type = t.parameters[key]['Type']
-        default = p.get(key) ? p.get(key) : t.parameters[key]['Default'] || ''
-        description = t.parameters[key]['Description'] || false
-        values = t.parameters[key]['AllowedValues'] || false
-        no_echo = t.parameters[key]['NoEcho'] || false
-
-        # Thor conveniently provides some nice logic for formatting,
-        # allowing defaults, and validating user input
-        ask_opts = {}
-        ask_opts[:default] = default unless default.to_s.empty?
-        ask_opts[:limited_to] = values if values
-        ask_opts[:echo] = false if no_echo
-
-        puts
-        say("#{description} (#{type})") if description
-        # Make sure user enters a value
-        # TODO: Better input validation
-        answer = ''
-        answer = ask(key, :cyan, ask_opts) until answer != ''
-
-        # Save answer to paramset object
-        p.set(key, answer)
-
-        # Add a line break
-        say if no_echo
-      end
+      # If this is an update and ask was not specified, set any missing
+      # parameters to use_previous_value
+      if action == 'update' && !options[:ask]
+        missing.each do |key|
+          p.set(key, nil, use_previous_value: true)
+        end
+      else
+        # Prompt for each missing parameter and save it in the paramset object
+        missing.each do |key|
+          # Do not prompt for keys prefixed with the "Hygroscope" reserved word.
+          # These parameters are populated internally without user input.
+          next if key =~ /^Hygroscope/
+
+          type = t.parameters[key]['Type']
+          default = p.get(key) ? p.get(key) : t.parameters[key]['Default'] || ''
+          description = t.parameters[key]['Description'] || false
+          values = t.parameters[key]['AllowedValues'] || false
+          no_echo = t.parameters[key]['NoEcho'] || false
+
+          # Thor conveniently provides some nice logic for formatting,
+          # allowing defaults, and validating user input
+          ask_opts = {}
+          ask_opts[:default] = default unless default.to_s.empty?
+          ask_opts[:limited_to] = values if values
+          ask_opts[:echo] = false if no_echo
+
+          puts
+          say("#{description} (#{type})") if description
+          # Make sure user enters a value
+          # TODO: Better input validation
+          answer = ''
+          answer = ask(key, :cyan, ask_opts) until answer != ''
+
+          # Save answer to paramset object
+          p.set(key, answer)
 
-      # Offer to save paramset if it was modified
-      # Filter out keys beginning with "Hygroscope" since they are not visible
-      # to the user and may be modified on each invocation.
-      unless missing.reject { |k| k =~ /^Hygroscope/ }.empty?
-        puts
-        if yes?('Save changes to paramset?')
-          unless options[:paramset]
-            p.name = ask('Paramset name', :cyan, default: options[:name])
+          # Add a line break
+          say if no_echo
+        end
+
+        # Offer to save paramset if it was modified
+        # Filter out keys beginning with "Hygroscope" since they are not visible
+        # to the user and may be modified on each invocation.
+        unless missing.reject { |k| k =~ /^Hygroscope/ }.empty?
+          puts
+          if yes?('Save changes to paramset?')
+            unless options[:paramset]
+              p.name = ask('Paramset name', :cyan, default: options[:name])
+            end
+            p.save!
           end
-          p.save!
         end
       end
 
@@ -196,39 +204,51 @@ module Hygroscope
 
     desc 'create', "Create a new stack.\nUse the --name option to launch more than one stack from the same template.\nCommand prompts for parameters unless --paramset is specified.\nUse --existing to set parameters from an existing stack's outputs."
     method_option :name,
-                  aliases: '-n',
-                  default: File.basename(Dir.pwd),
-                  desc: 'Name of stack'
+      aliases: '-n',
+      default: File.basename(Dir.pwd),
+      desc:    'Name of stack'
     method_option :paramset,
-                  aliases: '-s',
-                  required: false,
-                  desc: 'Name of saved paramset to use (optional)'
+      aliases:  '-s',
+      required: false,
+      desc:     'Name of saved paramset to use (optional)'
     method_option :existing,
-                  aliases: '-e',
-                  type: :array,
-                  required: false,
-                  desc: 'Name of one or more existing stacks from which to retrieve outputs as parameters (optional)'
+      aliases:  '-e',
+      type:     :array,
+      required: false,
+      desc:     'Name of one or more existing stacks from which to retrieve outputs as parameters (optional)'
     method_option :ask,
-                  aliases: '-a',
-                  type: :boolean,
-                  default: false,
-                  desc: 'Still prompt for parameters even when using a paramset'
+      aliases: '-a',
+      type:    :boolean,
+      default: false,
+      desc:    'Still prompt for parameters even when using a paramset'
     method_option :tags,
-                  aliases: '-t',
-                  type: :array,
-                  required: false,
-                  default: [],
-                  desc: 'One or more parameters to apply as tags to all stack resources'
+      aliases:  '-t',
+      type:     :array,
+      required: false,
+      default:  [],
+      desc:     'One or more parameters to apply as tags to all stack resources'
+    method_option :capabilities,
+      aliases:  '-c',
+      type:     :array,
+      required: false,
+      default:  [],
+      desc:     'One or more capabilities to pass to CloudFormation (i.e. CAPABILITY_IAM)'
+    method_option :compress,
+      type:    :boolean,
+      default: false,
+      desc:    'Whether to compress the CloudFormation template slightly at the expense of readability by removing extra spaces'
     def create
       check_path
       validate
 
       # Prepare task takes care of shared logic between "create" and "update"
-      template, paramset = prepare
+      template, paramset = prepare('create')
 
-      stack = Hygroscope::Stack.new(options[:name], options[:region], options[:profile])
-      stack.parameters = paramset.parameters
-      stack.template = template.compress
+      stack              = Hygroscope::Stack.new(options[:name], options[:region], options[:profile])
+      stack.parameters   = paramset.parameters
+      stack.template     = options[:compress] ? template.compress : template.process
+      stack.capabilities = options[:capabilities]
+      stack.timeout      = 60
 
       stack.tags['X-Hygroscope-Template'] = hygro_name
       options[:tags].each do |tag|
@@ -239,58 +259,67 @@ module Hygroscope
         end
       end
 
-      stack.capabilities = ['CAPABILITY_IAM']
-      stack.timeout = 60
-
       stack.create!
-
       status
     end
 
-    desc 'update', "Update a running stack.\nCommand prompts for parameters unless a --paramset is specified."
+    desc 'update', "Update an existing stack.\nUse the --name option to specify the stack name if it differs from the template name.\nBy default parameters are set to existing values, unless --paramset or --ask is specified."
     method_option :name,
-                  aliases: '-n',
-                  default: File.basename(Dir.pwd),
-                  desc: 'Name of stack'
+      aliases: '-n',
+      default: File.basename(Dir.pwd),
+      desc:    'Name of stack'
     method_option :paramset,
-                  aliases: '-s',
-                  required: false,
-                  desc: 'Name of saved paramset to use (optional)'
+      aliases:  '-s',
+      required: false,
+      desc:     'Name of saved paramset to use (optional)'
+    method_option :existing,
+      aliases:  '-e',
+      type:     :array,
+      required: false,
+      desc:     'Name of one or more existing stacks from which to retrieve outputs as parameters (optional)'
     method_option :ask,
-                  aliases: '-a',
-                  type: :boolean,
-                  default: false,
-                  desc: 'Still prompt for parameters even when using a paramset'
+      aliases: '-a',
+      type:    :boolean,
+      default: false,
+      desc:    'Still prompt for parameters even when using a paramset'
+    method_option :capabilities,
+      aliases:  '-c',
+      type:     :array,
+      required: false,
+      default:  [],
+      desc:     'One or more capabilities to pass to CloudFormation (i.e. CAPABILITY_NAMED_IAM)'
+    method_option :compress,
+      type:    :boolean,
+      default: false,
+      desc:    'Whether to compress the CloudFormation template slightly at the expense of readability by removing extra spaces'
     def update
-      # TODO: Right now update just does the same thing as create, not taking
-      # into account the complications of updating (which params to keep,
-      # whether to re-upload the payload, etc.)
+      # TODO: Make re-uploading the payload optional
       check_path
       validate
 
       # Prepare task takes care of shared logic between "create" and "update"
-      template, paramset = prepare
+      template, paramset = prepare('update')
 
-      s = Hygroscope::Stack.new(options[:name], options[:region], options[:profile])
-      s.parameters = paramset.parameters
-      s.template = template.compress
-      s.capabilities = ['CAPABILITY_IAM']
-      s.timeout = 60
-      s.update!
+      stack              = Hygroscope::Stack.new(options[:name], options[:region], options[:profile])
+      stack.parameters   = paramset.parameters
+      stack.template     = options[:compress] ? template.compress : template.process
+      stack.capabilities = options[:capabilities]
+      stack.timeout      = 60
 
+      stack.update!
       status
     end
 
     desc 'delete', 'Delete a running stack after asking for confirmation.'
     method_option :name,
-                  aliases: '-n',
-                  default: File.basename(Dir.pwd),
-                  desc: 'Name of stack'
+      aliases: '-n',
+      default: File.basename(Dir.pwd),
+      desc:    'Name of stack'
     method_option :force,
-                  aliases: '-f',
-                  type: :boolean,
-                  default: false,
-                  desc: 'Delete without asking for confirmation'
+      aliases: '-f',
+      type:    :boolean,
+      default: false,
+      desc:    'Delete without asking for confirmation'
     def delete
       check_path
       abort unless options[:force] ||
@@ -304,76 +333,78 @@ module Hygroscope
 
     desc 'status', 'View status of stack create/update/delete action.\nUse the --name option to change which stack is reported upon.'
     method_option :name,
-                  aliases: '-n',
-                  default: File.basename(Dir.pwd),
-                  desc: 'Name of stack'
+      aliases: '-n',
+      default: File.basename(Dir.pwd),
+      desc:    'Name of stack'
     def status
       check_path
       stack = Hygroscope::Stack.new(options[:name], options[:region], options[:profile])
 
       # Query and display the status of the stack and its resources. Refresh
       # every 10 seconds until the user aborts or an error is encountered.
-      begin
-        s = stack.describe
-
-        system('clear') || system('cls')
-
-        header = {
-          'Name:'    => s.stack_name,
-          'Created:' => s.creation_time,
-          'Status:'  => colorize_status(s.stack_status)
-        }
-
-        print_table header
-        puts
-
-        # Fancy acrobatics to fit output to terminal width. If the terminal
-        # window is too small, fallback to something appropriate for ~80 chars
-        term_width = `stty size 2>/dev/null`.split[1].to_i || `tput cols 2>/dev/null`.to_i
-        type_width   = term_width < 80 ? 30 : term_width - 50
-        output_width = term_width < 80 ? 54 : term_width - 31
-
-        # Header row
-        puts set_color(sprintf(' %-28s %-*s %-18s ', 'Resource', type_width, 'Type', 'Status'), :white, :on_blue)
-        resources = stack.list_resources
-        resources.each do |r|
-          puts sprintf(' %-28s %-*s %-18s ', r[:name][0..26], type_width, r[:type][0..type_width], colorize_status(r[:status]))
-        end
+      loop do
+        begin
+          s = stack.describe
+
+          system('clear') || system('cls')
+
+          header = {
+            'Name:'    => s.stack_name,
+            'Created:' => s.creation_time,
+            'Status:'  => colorize_status(s.stack_status)
+          }
 
-        if s.stack_status.downcase =~ /complete$/
-          # If the stack is complete display any available outputs and stop refreshing
+          print_table header
           puts
-          puts set_color(sprintf(' %-28s %-*s ', 'Output', output_width, 'Value'), :white, :on_yellow)
-          s.outputs.each do |o|
-            puts sprintf(' %-28s %-*s ', o.output_key, output_width, o.output_value)
+
+          # Fancy acrobatics to fit output to terminal width. If the terminal
+          # window is too small, fallback to something appropriate for ~80 chars
+          term_width = `stty size 2>/dev/null`.split[1].to_i || `tput cols 2>/dev/null`.to_i
+          type_width   = term_width < 80 ? 30 : term_width - 50
+          output_width = term_width < 80 ? 54 : term_width - 31
+
+          # Header row
+          puts set_color(format(' %-28s %-*s %-18s ', 'Resource', type_width, 'Type', 'Status'), :white, :on_blue)
+          resources = stack.list_resources
+          resources.each do |r|
+            puts format(' %-28s %-*s %-18s ', r[:name][0..26], type_width, r[:type][0..type_width], colorize_status(r[:status]))
           end
 
-          puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
-          break
-        elsif s.stack_status.downcase =~ /failed$/
-          # If the stack failed to create, stop refreshing
-          puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
-          break
-        else
-          puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
-          countdown('Updating in', 9)
-          puts
+          if s.stack_status.downcase =~ /complete$/
+            # If the stack is complete display any available outputs and stop refreshing
+            puts
+            puts set_color(format(' %-28s %-*s ', 'Output', output_width, 'Value'), :white, :on_yellow)
+            s.outputs.each do |o|
+              puts format(' %-28s %-*s ', o.output_key, output_width, o.output_value)
+            end
+
+            puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
+            break
+          elsif s.stack_status.downcase =~ /failed$/
+            # If the stack failed to create, stop refreshing
+            puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
+            break
+          else
+            puts "\nMore information: https://console.aws.amazon.com/cloudformation/home"
+            countdown('Updating in', 9)
+            puts
+          end
+        rescue Aws::CloudFormation::Errors::ValidationError
+          say_fail('Stack not found')
+        rescue Interrupt
+          abort
         end
-      rescue Aws::CloudFormation::Errors::ValidationError
-        say_fail('Stack not found')
-      rescue Interrupt
-        abort
-      end while true
+      end
     end
 
     desc 'generate',
-         "Generate and display JSON output from template files.\n" \
-         "To validate that the template is well-formed use the 'validate' command."
+      "Generate and display JSON output from template files.\n" \
+      "To validate that the template is well-formed use the 'validate' command."
     method_option :color,
-                  aliases: '-c',
-                  type: :boolean,
-                  default: true,
-                  desc: 'Colorize JSON output'
+      aliases: '-c',
+      type:    :boolean,
+      default: true,
+      desc:    'Colorize JSON output'
     def generate
       check_path
       t = Hygroscope::Template.new(template_path, options[:region], options[:profile])
@@ -405,9 +436,9 @@ module Hygroscope
 
     desc 'paramset', "List saved paramsets.\nIf --name is passed, shows all parameters in the named set."
     method_option :name,
-                  aliases: '-n',
-                  required: false,
-                  desc: 'Name of a paramset'
+      aliases:  '-n',
+      required: false,
+      desc:     'Name of a paramset'
     def paramset
       if options[:name]
         say_paramset(options[:name])

data/lib/hygroscope/paramset.rb

@@ -12,20 +12,19 @@ module Hygroscope
       @parameters = {}
       @path = File.join(Dir.pwd, 'paramsets')
 
-      if name
-        @name = name
-        self.load!
-      end
+      return unless name
+
+      @name = name
+      load!
     end
 
     def load!
       files = Dir.glob(File.join(@path, @name + '.{yml,yaml}'))
-      if files.empty?
-        fail Hygroscope::ParamSetNotFoundError
-      else
-        @file = files.first
-        @parameters = YAML.load_file(@file)
-      end
+
+      raise Hygroscope::ParamSetNotFoundError if files.empty?
+
+      @file = files.first
+      @parameters = YAML.load_file(@file)
     end
 
     def save!
@@ -40,8 +39,12 @@ module Hygroscope
       @parameters[key]
     end
 
-    def set(key, value)
-      @parameters[key] = value
+    def set(key, value, use_previous_value: false)
+      @parameters[key] = if use_previous_value
+                           'HYGROSCOPE_USE_PREVIOUS_VALUE'
+                         else
+                           value
+                         end
     end
   end
 end

data/lib/hygroscope/payload.rb

@@ -47,8 +47,8 @@ module Hygroscope
     def send
       @client.put_object(
         bucket: @bucket,
-        key: key,
-        body: @archive
+        key:    key,
+        body:   @archive
       )
     end
 

data/lib/hygroscope/stack.rb

@@ -25,7 +25,7 @@ module Hygroscope
       stack_parameters = []
       @parameters.each do |k, v|
         stack_parameters << {
-          parameter_key: k,
+          parameter_key:   k,
           parameter_value: v.to_s
         }
       end
@@ -33,17 +33,17 @@ module Hygroscope
       stack_tags = []
       @tags.each do |k, v|
         stack_tags << {
-          key: k,
+          key:   k,
           value: v.to_s
         }
       end
 
       stack_opts = {
-        stack_name: @name,
-        template_body: @template,
-        parameters: stack_parameters,
+        stack_name:         @name,
+        template_body:      @template,
+        parameters:         stack_parameters,
         timeout_in_minutes: @timeout,
-        on_failure: @on_failure
+        on_failure:         @on_failure
       }
 
       stack_opts['capabilities'] = @capabilities unless @capabilities.empty?
@@ -61,16 +61,23 @@ module Hygroscope
     def update!
       stack_parameters = []
       @parameters.each do |k, v|
-        stack_parameters << {
-          parameter_key: k,
-          parameter_value: v.to_s
-        }
+        stack_parameters << if v == 'HYGROSCOPE_USE_PREVIOUS_VALUE'
+                              {
+                                parameter_key:      k,
+                                use_previous_value: true
+                              }
+                            else
+                              {
+                                parameter_key:   k,
+                                parameter_value: v.to_s
+                              }
+                            end
       end
 
       stack_opts = {
-        stack_name: @name,
+        stack_name:    @name,
         template_body: @template,
-        parameters: stack_parameters
+        parameters:    stack_parameters
       }
 
       stack_opts['capabilities'] = @capabilities unless @capabilities.empty?
@@ -106,8 +113,8 @@ module Hygroscope
       resources = []
       resp.stack_resources.each do |r|
         resources << {
-          name: r.logical_resource_id,
-          type: r.resource_type,
+          name:   r.logical_resource_id,
+          type:   r.resource_type,
           status: r.resource_status
         }
       end

data/lib/hygroscope/template.rb

@@ -28,7 +28,7 @@ module Hygroscope
         cfoo.process(*files)
       end
 
-      fail(TemplateYamlParseError, err.string) unless err.string.empty?
+      raise(TemplateYamlParseError, err.string) unless err.string.empty?
 
       @template = out.string
       @template

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hygroscope
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Silverman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor