cuffsert 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1be8dd08dce49cf000289c1a1e198026bf48e2c5
-  data.tar.gz: 3e0846cd94c5273d1ef260105b962c3c3196d6cc
+  metadata.gz: 5e2a534e878fbb69920af515d5829138351c4937
+  data.tar.gz: 9697ef60c78c97f5823f089d8efd67f95723a411
 SHA512:
-  metadata.gz: 75340fd814849e4c1f42f6ec007eac89d20d2f925b599cdaf9ad32e489638ac00808a9879e2361f8c5d5833a2082b3b0f3992f90e2c061d8efa0f3e7ad6e4e3a
-  data.tar.gz: 92da57f24fb3c7443462404602d22b9a28c615ecd258e648e4bf22640e3441224e48465266f766ffc930b0a639a885e2ba674de7109e602e457d647431c150fa
+  metadata.gz: 37643076b4d503a37ac1d12f997c27230a90904386157fcad1b4a668b126b886091f775e4244c9442d62f027e0b40fac9b7cc94e6c5b60c219563cc46da6690d
+  data.tar.gz: 46a6d4ba65176322eb3da8c3abb4fe5641ba0157d7885670410849b324880b5090b4c457251d6fed61feb2230e75a1e2e0126d2c49685b22ed28fc327ad702cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cuffsert (0.11.0)
+    cuffsert (0.12.0)
       aws-sdk-cloudformation (~> 1.3.0)
       aws-sdk-s3 (~> 1.8.0)
       colorize

data/README.md

@@ -14,7 +14,11 @@ If `./my-template.json` has no parameters the above command would create the sta
 
 If you also want to provide a value for a stack parameter (whether on creation or update), you can use `-p key=value` to pass parameters. For all other parameters, cuffsert will tell CloudFormation to use the existing value.
 
-Cuffsert can not (yet) be executed without a template in order to only change parameters.
+Cuffsert can also be executed by naming an existing stack and no template in order to only change parameters, e.g.
+
+```bash
+cuffsert -n my-stack -p MyDesiredCapacity=8
+```
 
 ## Parameters under version control
 

data/bin/cuffdown

@@ -1,55 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'cuffsert/metadata'
-require 'cuffsert/rxcfclient'
-require 'yaml'
+require 'cuffdown/main'
 
-module CuffDown
-  def self.parameters(stack)
-    (stack[:parameters] || []).map do |param|
-      {
-        'Name' => param[:parameter_key],
-        'Value' => param[:parameter_value],
-      }
-    end
-  end
-
-  def self.tags(stack)
-    (stack[:tags] || []).map do |param|
-      {
-        'Name' => param[:key],
-        'Value' => param[:value],
-      }
-    end
-  end
-
-  def self.dump(name, params, tags, output)
-    result = {
-      'Format' => 'v1',
-      'Suffix' => name,
-      'Parameters' => params,
-      'Tags' => tags,
-    }
-    YAML.dump(result, output)
-  end
-
-  def self.run(args)
-    meta = CuffSert::StackConfig.new
-    meta.stackname = args[0]
-    client = CuffSert::RxCFClient.new
-    stack = client.find_stack_blocking(meta)
-    unless stack
-      STDERR.puts "No such stack #{meta.stackname}"
-      exit(1)
-    end
-    stack = stack.to_h
-    self.dump(
-      stack[:stack_name],
-      self.parameters(stack),
-      self.tags(stack),
-      STDOUT
-    )
-  end
-end
-
-CuffDown.run(ARGV)
+CuffDown.run(ARGV, STDOUT)

data/lib/cuffbase.rb

@@ -1,6 +1,12 @@
 require 'yaml'
 
 module CuffBase
+  def self.shared_cli_args(opts, args)
+    opts.on('--region=aws_region', 'AWS region, overrides env variable AWS_REGION') do |region|
+      args[:aws_region] = region
+    end
+  end
+
   def self.empty_from_template(io)
     self.template_parameters(io) {|_| nil }
   end

data/lib/cuffdown/main.rb

@@ -0,0 +1,67 @@
+require 'cuffbase'
+require 'cuffsert/metadata'
+require 'cuffsert/rxcfclient'
+require 'optparse'
+require 'yaml'
+
+module CuffDown
+  def self.parse_cli_args(argv)
+    args = {}
+    parser = OptionParser.new do |opts|
+      opts.banner = 'Output CuffSert-formatted metadata from an existing stack.'
+      opts.separator('')
+      opts.separator('Usage: cuffdown stack-name')
+      CuffBase.shared_cli_args(opts, args)
+    end
+    stackname, _ = parser.parse(argv)
+    args[:stackname] = stackname
+    args
+  end
+
+  def self.parameters(stack)
+    (stack[:parameters] || []).map do |param|
+      {
+        'Name' => param[:parameter_key],
+        'Value' => param[:parameter_value],
+      }
+    end
+  end
+
+  def self.tags(stack)
+    (stack[:tags] || []).map do |param|
+      {
+        'Name' => param[:key],
+        'Value' => param[:value],
+      }
+    end
+  end
+
+  def self.dump(name, params, tags, output)
+    result = {
+      'Format' => 'v1',
+      'Suffix' => name,
+      'Parameters' => params,
+      'Tags' => tags,
+    }
+    YAML.dump(result, output)
+  end
+
+  def self.run(argv, output)
+    cli_args = self.parse_cli_args(argv)
+    meta = CuffSert::StackConfig.new
+    meta.stackname = cli_args[:stackname]
+    client = CuffSert::RxCFClient.new(cli_args[:aws_region])
+    stack = client.find_stack_blocking(meta)
+    unless stack
+      STDERR.puts "No such stack #{meta.stackname}"
+      exit(1)
+    end
+    stack = stack.to_h
+    self.dump(
+      stack[:stack_name],
+      self.parameters(stack),
+      self.tags(stack),
+      output
+    )
+  end
+end

data/lib/cuffsert/actions.rb

@@ -16,17 +16,31 @@ module CuffSert
     end
 
     def upload_template_if_oversized(cfargs)
-      if cfargs[:template_body].nil? && cfargs[:template_url].nil?
+      if needs_template_upload?(cfargs)
         raise 'Template bigger than 51200; please supply --s3-upload-prefix' unless @s3client
         uri, progress = @s3client.upload(@meta.stack_uri)
-        [CuffSert.s3_uri_to_https(uri).to_s, progress]
+        [CuffSert.s3_uri_to_https(uri, @meta.aws_region).to_s, progress]
       else
         [nil, Rx::Observable.empty]
       end
     end
+
+    private
+
+    def needs_template_upload?(cfargs)
+      cfargs[:template_body].nil? &&
+        cfargs[:template_url].nil? &&
+        !cfargs[:use_previous_template]
+    end
   end
 
   class CreateStackAction < BaseAction
+    def validate!
+      if @meta.stack_uri.nil?
+        raise "You need to pass a template to create #{@meta.stackname}" # in #{@meta.aws_region}."
+      end
+    end
+
     def as_observable
       cfargs = CuffSert.as_create_stack_args(@meta)
       upload_uri, maybe_upload = upload_template_if_oversized(cfargs)
@@ -48,43 +62,61 @@ module CuffSert
   end
 
   class UpdateStackAction < BaseAction
+    def validate!
+      if @meta.stack_uri.nil?
+        if @meta.parameters.empty? && @meta.tags.empty?
+          raise "Stack update without template needs at least one parameter (-p) or tag (-t)."
+        end
+      end
+    end
+
     def as_observable
-      cfargs = CuffSert.as_update_change_set(@meta)
+      cfargs = CuffSert.as_update_change_set(@meta, @stack)
       upload_uri, maybe_upload = upload_template_if_oversized(cfargs)
       cfargs[:template_url] = upload_uri if upload_uri
       maybe_upload
-        .concat(@cfclient.prepare_update(cfargs))
-        .flat_map do |change_set|
-          if change_set.is_a? Aws::CloudFormation::Types::DescribeChangeSetOutput
-            Rx::Observable.concat(
-              Rx::Observable.of(change_set),
-              Rx::Observable.defer {
-                if change_set[:status] == 'FAILED'
-                  Rx::Observable.concat(
-                    @cfclient.abort_update(change_set[:change_set_id]),
-                    Abort.new("Update failed: #{change_set[:status_reason]}").as_observable
-                  )
-                elsif @confirmation.call(@meta, :update, change_set)
-                  Rx::Observable.concat(
-                    @cfclient.update_stack(change_set[:stack_id], change_set[:change_set_id]),
-                    Done.new.as_observable
-                  )
-                else
-                  Rx::Observable.concat(
-                    @cfclient.abort_update(change_set[:change_set_id]),
-                    Abort.new('User abort!').as_observable
-                  )
-                end
-              }
-            )
+        .concat(@cfclient.prepare_update(cfargs).map {|change_set| CuffSert::ChangeSet.new(change_set) })
+        .flat_map(&method(:on_event))
+    end
+
+    private
+
+    def on_event(event)
+      Rx::Observable.concat(
+        Rx::Observable.just(event),
+        Rx::Observable.defer do
+          case event
+          when CuffSert::ChangeSet
+            on_changeset(event.message)
           else
-            Rx::Observable.just(change_set)
+            Rx::Observable.empty
           end
         end
+      )
+    end
+
+    def on_changeset(change_set)
+      if change_set[:status] == 'FAILED'
+        message = "Update failed: #{change_set[:status_reason]}"
+        @cfclient.abort_update(change_set[:change_set_id])
+          .concat(Abort.new(message).as_observable)
+      elsif @confirmation.call(@meta, :update, change_set)
+        @cfclient.update_stack(change_set[:stack_id], change_set[:change_set_id])
+          .concat(Done.new.as_observable)
+      else
+        @cfclient.abort_update(change_set[:change_set_id])
+          .concat(Abort.new('User abort!').as_observable)
+      end
     end
   end
 
   class RecreateStackAction < BaseAction
+    def validate!
+      if @meta.stack_uri.nil?
+        raise "You need to pass a template to re-create #{@meta.stackname}" # in #{@meta.aws_region}."
+      end
+    end
+
     def as_observable
       crt_args = CuffSert.as_create_stack_args(@meta)
       del_args = CuffSert.as_delete_stack_args(@stack)

data/lib/cuffsert/cfarguments.rb

@@ -33,7 +33,10 @@ module CuffSert
       end
     end
 
-    cfargs.merge!(self.template_parameters(meta))
+    if meta.stack_uri
+      cfargs.merge!(self.template_parameters(meta))
+    end
+    cfargs
   end
 
   def self.as_create_stack_args(meta)
@@ -46,11 +49,26 @@ module CuffSert
     cfargs
   end
 
-  def self.as_update_change_set(meta)
+  def self.as_update_change_set(meta, stack)
     cfargs = self.as_cloudformation_args(meta)
-    cfargs[:use_previous_template] = false
     cfargs[:change_set_name] = meta.stackname
     cfargs[:change_set_type] = 'UPDATE'
+    if cfargs[:use_previous_template] = meta.stack_uri.nil?
+      Array(stack[:parameters]).each do |param|
+        key = param[:parameter_key]
+        unless meta.parameters.include?(key)
+          cfargs[:parameters] ||= []
+          cfargs[:parameters] << {:parameter_key => key, :use_previous_value => true}
+        end
+      end
+      if !meta.tags.empty?
+        Array(stack[:tags]).each do |tag|
+          unless meta.tags.include?(tag[:key])
+            cfargs[:tags] << tag
+          end
+        end
+      end
+    end
     cfargs
   end
 
@@ -58,8 +76,7 @@ module CuffSert
     { :stack_name => stack[:stack_id] }
   end
 
-  def self.s3_uri_to_https(uri)
-    region = ENV['AWS_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
+  def self.s3_uri_to_https(uri, region)
     bucket = uri.host
     key = uri.path
     host = region == 'us-east-1' ? 's3.amazonaws.com' : "s3-#{region}.amazonaws.com"
@@ -77,7 +94,7 @@ module CuffSert
     template_parameters = {}
 
     if meta.stack_uri.scheme == 's3'
-      template_parameters[:template_url] = self.s3_uri_to_https(meta.stack_uri)
+      template_parameters[:template_url] = self.s3_uri_to_https(meta.stack_uri, meta.aws_region)
     elsif meta.stack_uri.scheme == 'https'
       if meta.stack_uri.host.end_with?('amazonaws.com')
         template_parameters[:template_url] = meta.stack_uri.to_s

data/lib/cuffsert/cli_args.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'cuffbase'
 require 'cuffsert/version'
 
 module CuffSert
@@ -18,7 +19,14 @@ module CuffSert
     parser = OptionParser.new do |opts|
       opts.banner = "Upsert a CloudFormation template, reading creation options and metadata from a yaml file. Currently, parameter values, stack name and stack tags are read from metadata file. Version #{CuffSert::VERSION}."
       opts.separator('')
-      opts.separator('Usage: cuffsert --selector production/us stack.json')
+      opts.separator('Usage:')
+      opts.separator('  cuffsert --name <stackname> stack.json')
+      opts.separator('  cuffsert --name <stackname> {--parameter Name=Value | --tag Name=Value}... [stack.json]')
+      opts.separator('  cuffsert --metadata <metadata.json> --selector <path/in/metadata> stack.json')
+      opts.separator('  cuffsert --metadata <metadata.json> --selector <path/in/metadata> {--parameter Name=Value | --tag Name=Value}... [stack.json]')
+
+      CuffBase.shared_cli_args(opts, args)
+
       opts.on('--metadata path', '-m path', 'Yaml file to read stack metadata from') do |path|
         path = '/dev/stdin' if path == '-'
         unless File.exist?(path)
@@ -60,10 +68,6 @@ module CuffSert
         args[:overrides][:tags][key] = val
       end
 
-      opts.on('--region=aws_region', 'AWS region, overrides env variable AWS_REGION') do |region|
-        args[:aws_region] = region
-      end
-
       opts.on('--s3-upload-prefix=prefix', 'Templates > 51200 bytes are uploaded here. Format: s3://bucket-name/[pre/fix]') do |prefix|
         unless prefix.start_with?('s3://')
           raise "Upload prefix #{prefix} must start with s3://"
@@ -87,13 +91,18 @@ module CuffSert
         args[:force_replace] = true
       end
 
+      opts.on('--ask', 'Always ask for confirmation') do
+        raise 'You can only use one of --yes, --ask and --dry-run' if args[:op_mode]
+        args[:op_mode] = :always_ask
+      end
+
       opts.on('--yes', '-y', 'Don\'t ask to replace and delete stack resources') do
-        raise 'You cannot do --yes and --dry-run at the same time' if args[:op_mode]
+        raise 'You can only use one of --yes, --ask and --dry-run' if args[:op_mode]
         args[:op_mode] = :dangerous_ok
       end
 
       opts.on('--dry-run', 'Describe what would be done') do
-        raise 'You cannot do --yes and --dry-run at the same time' if args[:op_mode]
+        raise 'You can only use one of --yes, --ask and --dry-run' if args[:op_mode]
         args[:op_mode] = :dry_run
       end
 
@@ -109,21 +118,21 @@ module CuffSert
       args
     end
   end
-  
+
   def self.validate_cli_args(cli_args)
     errors = []
-    if cli_args[:stack_path].nil? || cli_args[:stack_path].size != 1
-      errors << 'Requires exactly one template'
+    if cli_args[:stack_path] != nil && cli_args[:stack_path].size > 1
+      errors << 'Require at most one template'
     end
 
     if cli_args[:metadata].nil? && cli_args[:overrides][:stackname].nil?
       errors << 'Without --metadata, you must supply --name to identify stack to update'
     end
-    
+
     if cli_args[:selector] && cli_args[:metadata].nil?
       errors << 'You cannot use --selector without --metadata'
     end
-    
+
     raise errors.join(', ') unless errors.empty?
   end
 end

data/lib/cuffsert/confirmation.rb

@@ -2,6 +2,7 @@ require 'termios'
 
 module CuffSert
   def self.need_confirmation(meta, action, desc)
+    return true if meta.op_mode == :always_ask
     return false if meta.op_mode == :dangerous_ok
     case action
     when :create

data/lib/cuffsert/main.rb

@@ -41,12 +41,13 @@ module CuffSert
     cli_args = CuffSert.parse_cli_args(argv)
     CuffSert.validate_cli_args(cli_args)
     meta = CuffSert.build_meta(cli_args)
-    cfclient = RxCFClient.new(cli_args)
+    cfclient = RxCFClient.new(meta.aws_region)
     action = CuffSert.determine_action(meta, cfclient, force_replace: cli_args[:force_replace]) do |a|
       a.confirmation = CuffSert.method(:confirmation)
-      a.s3client = RxS3Client.new(cli_args) if cli_args[:s3_upload_prefix]
+      a.s3client = RxS3Client.new(cli_args, meta.aws_region) if cli_args[:s3_upload_prefix]
       a.cfclient = cfclient
     end
+    action.validate!
     renderer = CuffSert.make_renderer(cli_args)
     RendererPresenter.new(action.as_observable, renderer)
   end

data/lib/cuffsert/messages.rb

@@ -23,4 +23,5 @@ module CuffSert
       super('Done.')
     end
   end
+  class ChangeSet < Message ; end
 end

data/lib/cuffsert/metadata.rb

@@ -3,10 +3,11 @@ require 'yaml'
 
 module CuffSert
   class StackConfig
-    attr_accessor :stackname, :selected_path, :op_mode, :stack_uri
+    attr_accessor :aws_region, :stackname, :selected_path, :op_mode, :stack_uri
     attr_accessor :suffix, :parameters, :tags
 
     def initialize
+      @aws_region = ENV['AWS_REGION'] || ENV['AWS_DEFAULT_REGION'] || 'us-east-1'
       @selected_path = []
       @op_mode = :normal
       @parameters = {}
@@ -57,7 +58,7 @@ module CuffSert
 
   def self.meta_for_path(metadata, path, target = StackConfig.new)
     target.update_from(metadata)
-    candidate, path = path
+    candidate, *path = path
     key = candidate || metadata[:defaultpath]
     variants = metadata[:variants]
     if key.nil?
@@ -82,8 +83,9 @@ module CuffSert
   private_class_method
 
   def self.meta_defaults(cli_args)
-    if File.exists?(cli_args[:stack_path][0])
-      nil_params = CuffBase.empty_from_template(open(cli_args[:stack_path][0]))
+    stack_path = (cli_args[:stack_path] || [])[0]
+    if stack_path && File.exists?(stack_path)
+      nil_params = CuffBase.empty_from_template(open(stack_path))
     else
       nil_params = {}
     end
@@ -104,9 +106,11 @@ module CuffSert
 
   def self.cli_overrides(meta, cli_args)
     meta.update_from(cli_args[:overrides])
+    meta.aws_region = cli_args[:aws_region] || meta.aws_region
     meta.op_mode = cli_args[:op_mode] || meta.op_mode
-    stack_path = cli_args[:stack_path][0]
-    meta.stack_uri = CuffSert.validate_and_urlify(stack_path)
+    if (stack_path = (cli_args[:stack_path] || [])[0])
+      meta.stack_uri = CuffSert.validate_and_urlify(stack_path)
+    end
     meta
   end
 

data/lib/cuffsert/presenters.rb

@@ -57,8 +57,8 @@ module CuffSert
       case event
       when Aws::CloudFormation::Types::StackEvent
         on_stack_event(event)
-      when Aws::CloudFormation::Types::DescribeChangeSetOutput
-        on_change_set(event)
+      when ::CuffSert::ChangeSet
+        on_change_set(event.message)
       # when [:recreate, Aws::CloudFormation::Types::Stack]
       when Array
         on_stack(*event)

data/lib/cuffsert/rxcfclient.rb

@@ -4,9 +4,9 @@ require 'rx'
 
 module CuffSert
   class RxCFClient
-    def initialize(cli_args, **options)
+    def initialize(aws_region = nil, **options)
       initargs = {retry_limit: 8}
-      initargs[:region] = cli_args[:aws_region] if cli_args[:aws_region]
+      initargs[:region] = aws_region if aws_region
       @cf = options[:aws_cf] || Aws::CloudFormation::Client.new(initargs)
       @max_items = options[:max_items] || 1000
       @pause = options[:pause] || 5

data/lib/cuffsert/rxs3client.rb

@@ -3,10 +3,10 @@ require 'rx'
 
 module CuffSert
   class RxS3Client
-    def initialize(cli_args, client: nil)
+    def initialize(cli_args, aws_region = nil, client: nil)
       @bucket, @path_prefix = split_prefix(cli_args[:s3_upload_prefix])
       initargs = {retry_limit: 8}
-      initargs[:region] = cli_args[:aws_region] if cli_args[:aws_region]
+      initargs[:region] = aws_region if aws_region
       @client = client || Aws::S3::Client.new(initargs)
     end
 

data/lib/cuffsert/version.rb

@@ -1,3 +1,3 @@
 module CuffSert
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuffsert
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Anders Qvist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -173,6 +173,7 @@ files:
 - bin/cuffup
 - cuffsert.gemspec
 - lib/cuffbase.rb
+- lib/cuffdown/main.rb
 - lib/cuffsert/actions.rb
 - lib/cuffsert/cfarguments.rb
 - lib/cuffsert/cfstates.rb