cuffsert 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac6f917346598ca9866df6ae9806f0db45045430
-  data.tar.gz: bc2fdead5386f5f2615818c9725c73620a56cddd
+  metadata.gz: d02e68aa26e398ea76222c0f564477dce26d44c9
+  data.tar.gz: 0984fe4d90622252665ec5a718d50cd6c0d76399
 SHA512:
-  metadata.gz: cacc8cdef1aa751747562735e9aa8b7c302df010487a79a379b21af716f143017fc1e027442f6275fa189f1e7d94c20bfe6ec878573c85d45fdd6e502d110389
-  data.tar.gz: 79d814fad2ceeed682b769979b5e580da02cdcdc9111306e3d53a95b5b328ed69d032979633a687e34e91b575bca58bd23504ba769cee59055970f96d69cadc8
+  metadata.gz: 61871cff6aadd97c39413dcdc28f7acce5641ab6a7cbc191aa336b6b7307c05ba2f8cbce4843e0ddf1f23086e362149c9e317fa6b760be64d1f4a15d28bba3ed
+  data.tar.gz: 775eebfd1732099b53d309686d0be459529e5f11c507e19d4ffe85e5ecf14edaa7cbcf13aa89db4c3421c6b2b4852deffa44b892d251e4881776ca93b6130fe1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cuffsert (0.9.1)
+    cuffsert (0.10.0)
       aws-sdk
       colorize
       ruby-termios

data/README.md

@@ -2,9 +2,27 @@
 
 The primary goal of cuffsert is to provide a quick "up-arrow-enter" loading of a CloudFormation stack with good feedback, removing the need to click through three pesky screens each time. It figures out whether the stack needs to be created or rolled-back and whether it needs to be deleted first.
 
-Cuffsert allows encoding the metadata and commandline arguments needed to load a template in a versionable file which takes CloudFormation the last mile to really become an infrastructure-as-code platform.
+## Getting started
 
-## Usage
+Update a stack from a provided template without changing any parameters on the stack:
+
+```bash
+cuffsert -n my-stack ./my-template.json
+```
+
+If `./my-template.json` has no parameters the above command would create the stack if it did not already exist (so make sure you spell the stack name correctly :).
+
+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.
+
+## Parameters under version control
+
+Cuffsert also allows encoding the parameters (and some commandline arguments) needed to load a template in a YAML file which you can put under versiin control. This takes CloudFormation the last mile to really become an infrastructure-as-code platform.
+
+## Usage with file
+
+cuffsert supports two basic use cases
 
 Given the file cuffsert.yml:
 ```yaml
@@ -61,7 +79,7 @@ Values from deeper levels merged onto values from higher levels to produce a con
 
     cuffsert [--stack-name=name] [--tag=k:v ...] [--parameter=k:v ...]
       [--metadata=directory | yml-file] [--metadata-path=path/to]
-      cloudformation-file | cloudformation-directory
+      cloudformation-file | cloudformation-template
 
 All values set in the metadata file can be overridden on commandline.
 

data/bin/cuffup

@@ -1,46 +1,14 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
-require 'yaml'
+require 'cuffup'
 
-module CuffUp
-  def self.parameters(io)
-    template = YAML.load(io)
-    (template['Parameters'] || [])
-      .map do |key, data|
-        {
-          'Name' => key,
-          'Value' => data['Default'],
-        }
-      end
-  end
-
-  def self.dump(args, input, output)
-    result = {
-      'Format' => 'v1',
-    }
-    result['Parameters'] = input if input.size > 0
-    result['Suffix'] = args[:selector].join('-') if args.include?(:selector)
-    YAML.dump(result, output)
-  end
-
-  def self.run(args, template)
-    self.dump(args, self.parameters(open(template)), STDOUT)
-  end
-end
-
-args = {}
-parser = OptionParser.new do |opts|
-  opts.on('--selector selector', '-s selector', 'Set as sufflx in the generated output') do |selector|
-    args[:selector] = selector.split(/[-,\/]/)
-  end
-end
-
-template = parser.parse(ARGV)
-
-unless template
+args = CuffUp.parse_cli_args(ARGV)
+unless args[:template]
   STDERR.puts("Usage: #{__FILE__} <template>")
   exit(1)
 end
 
-CuffUp.run(args, template[0])
+input = open(args[:template][0])
+output = open(args[:output], 'w')
+
+CuffUp.run(args, input, output)

data/cuffsert.gemspec

@@ -1,6 +1,8 @@
+require File.expand_path('../lib/cuffsert/version', __FILE__)
+
 Gem::Specification.new do |spec|
   spec.name        = 'cuffsert'
-  spec.version     = '0.9.1'
+  spec.version     = CuffSert::VERSION
   spec.summary     = 'Cuffsert provides a quick up-arrow-enter loading of a CloudFormation stack with good feedback'
   spec.description = 'Cuffsert allows encoding the metadata and commandline arguments needed to load a template in a versionable file which takes CloudFormation the last mile to really become an infrastructure-as-code platform.'
   spec.authors     = ['Anders Qvist']

data/lib/cuffbase.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+module CuffBase
+  def self.empty_from_template(io)
+    self.template_parameters(io) {|_| nil }
+  end
+
+  def self.defaults_from_template(io)
+    self.template_parameters(io) {|data| data['Default'] }
+  end
+
+  private_class_method
+
+  def self.template_parameters(io, &block)
+    template = YAML.load(io)
+    parameters = {}
+    (template['Parameters'] || []).each do |key, data|
+      parameters[key] = block.call(data)
+    end
+    parameters
+  end
+end

data/lib/cuffsert/cfarguments.rb

@@ -19,7 +19,11 @@ module CuffSert
 
     unless meta.parameters.empty?
       cfargs[:parameters] = meta.parameters.map do |k, v|
-        {:parameter_key => k, :parameter_value => v.to_s}
+        if v.nil?
+          {:parameter_key => k, :use_previous_value => true}
+        else
+          {:parameter_key => k, :parameter_value => v.to_s}
+        end
       end
     end
 
@@ -41,6 +45,9 @@ module CuffSert
   end
 
   def self.as_create_stack_args(meta)
+    no_value = meta.parameters.select {|_, v| v.nil? }.keys
+    raise "Supply value for #{no_value.join(', ')}" unless no_value.empty?
+
     cfargs = self.as_cloudformation_args(meta)
     cfargs[:timeout_in_minutes] = TIMEOUT
     cfargs[:on_failure] = 'DELETE'

data/lib/cuffsert/cli_args.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'cuffsert/version'
 
 module CuffSert
   STACKNAME_RE = /^[A-Za-z0-9_-]+$/
@@ -15,7 +16,7 @@ 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.'
+      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.on('--metadata path', '-m path', 'Yaml file to read stack metadata from') do |path|
@@ -79,7 +80,7 @@ module CuffSert
         raise 'You cannot do --yes and --dry-run at the same time' 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]
         args[:op_mode] = :dry_run
@@ -89,8 +90,25 @@ module CuffSert
         abort(opts.to_s)
       end
     end
-    
+
     args[:stack_path] = parser.parse(argv)
     args
   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'
+    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/main.rb

@@ -9,31 +9,7 @@ require 'cuffsert/rxcfclient'
 require 'rx'
 require 'uri'
 
-# TODO:
-# - Stop using file: that we anyway need to special-case in cfarguments
-# - default value for meta.metadata when stack_path is local file
-# - selector and metadata are mandatory and need guards accordingly
-# - validate_and_urlify belongs in metadata.rb
-# - execute should use helpers and not know details of statuses
-# - update 'abort' should delete cheangeset and emit the result
-
 module CuffSert
-  def self.validate_and_urlify(stack_path)
-    if stack_path =~ /^[A-Za-z0-9]+:/
-      stack_uri = URI.parse(stack_path)
-    else
-      normalized = File.expand_path(stack_path)
-      unless File.exist?(normalized)
-        raise "Local file #{normalized} does not exist"
-      end
-      stack_uri = URI.join('file:///', normalized)
-    end
-    unless ['s3', 'file'].include?(stack_uri.scheme)
-      raise "Uri #{stack_uri.scheme} is not supported"
-    end
-    stack_uri
-  end
-
   def self.create_stack(client, meta, confirm_create)
     cfargs = CuffSert.as_create_stack_args(meta)
     Rx::Observable.concat(
@@ -112,15 +88,11 @@ module CuffSert
       ProgressbarRenderer.new(STDOUT, STDERR, cli_args)
     end
   end
-  
+
   def self.run(argv)
     cli_args = CuffSert.parse_cli_args(argv)
+    CuffSert.validate_cli_args(cli_args)
     meta = CuffSert.build_meta(cli_args)
-    if cli_args[:stack_path].nil? || cli_args[:stack_path].size != 1
-      raise 'Requires exactly one stack path'
-    end
-    stack_path = cli_args[:stack_path][0]
-    meta.stack_uri = CuffSert.validate_and_urlify(stack_path)
     events = CuffSert.execute(meta, CuffSert.method(:confirmation),
       force_replace: cli_args[:force_replace])
     renderer = CuffSert.make_renderer(cli_args)

data/lib/cuffsert/metadata.rb

@@ -1,3 +1,4 @@
+require 'cuffbase'
 require 'yaml'
 
 module CuffSert
@@ -29,6 +30,22 @@ module CuffSert
     end
   end
 
+  def self.validate_and_urlify(stack_path)
+    if stack_path =~ /^[A-Za-z0-9]+:/
+      stack_uri = URI.parse(stack_path)
+    else
+      normalized = File.expand_path(stack_path)
+      unless File.exist?(normalized)
+        raise "Local file #{normalized} does not exist"
+      end
+      stack_uri = URI.join('file:///', normalized)
+    end
+    unless ['s3', 'file'].include?(stack_uri.scheme)
+      raise "Uri #{stack_uri.scheme} is not supported"
+    end
+    stack_uri
+  end
+
   def self.load_config(io)
     config = YAML.load(io)
     raise 'config does not seem to be a YAML hash?' unless config.is_a?(Hash)
@@ -56,9 +73,8 @@ module CuffSert
   end
 
   def self.build_meta(cli_args)
-    io = open(cli_args[:metadata])
-    config = CuffSert.load_config(io)
     default = self.meta_defaults(cli_args)
+    config = self.metadata_if_present(cli_args)
     meta = CuffSert.meta_for_path(config, cli_args[:selector], default)
     CuffSert.cli_overrides(meta, cli_args)
   end
@@ -66,14 +82,27 @@ module CuffSert
   private_class_method
 
   def self.meta_defaults(cli_args)
+    nil_params = CuffBase.empty_from_template(open(cli_args[:stack_path][0]))
     default = StackConfig.new
-    default.suffix = File.basename(cli_args[:metadata], '.yml')
+    default.update_from({:parameters => nil_params})
+    default.suffix = File.basename(cli_args[:metadata], '.yml') if cli_args[:metadata]
     default
   end
 
+  def self.metadata_if_present(cli_args)
+    if cli_args[:metadata]
+      io = open(cli_args[:metadata])
+      CuffSert.load_config(io)
+    else
+      {}
+    end
+  end
+
   def self.cli_overrides(meta, cli_args)
     meta.update_from(cli_args[:overrides])
     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)
     meta
   end
 

data/lib/cuffsert/version.rb

@@ -0,0 +1,3 @@
+module CuffSert
+  VERSION = '0.10.0'
+end

data/lib/cuffup.rb

@@ -0,0 +1,40 @@
+require 'cuffbase'
+require 'optparse'
+
+module CuffUp
+  def self.parse_cli_args(argv)
+    args = {
+      :output => '/dev/stdout'
+    }
+    parser = OptionParser.new do |opts|
+      opts.on('--output metadata', '-o metadata', 'File to write metadata file to; decaults to stdout') do |f|
+        args[:output] = f
+      end
+
+      opts.on('--selector selector', '-s selector', 'Set as sufflx in the generated output') do |selector|
+        args[:selector] = selector.split(/[-,\/]/)
+      end
+    end
+
+    args[:template] = parser.parse(argv)
+    args
+  end
+
+  def self.parameters(io)
+    CuffBase.defaults_from_template(io)
+    .map {|k, v| {'Name' => k, 'Value' => v} }
+  end
+
+  def self.dump(args, input, output)
+    result = {
+      'Format' => 'v1',
+    }
+    result['Parameters'] = input if input.size > 0
+    result['Suffix'] = args[:selector].join('-') if args.include?(:selector)
+    YAML.dump(result, output)
+  end
+
+  def self.run(args, input, output)
+    self.dump(args, self.parameters(input), output)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuffsert
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Anders Qvist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -158,6 +158,7 @@ files:
 - bin/cuffsert
 - bin/cuffup
 - cuffsert.gemspec
+- lib/cuffbase.rb
 - lib/cuffsert/cfarguments.rb
 - lib/cuffsert/cfstates.rb
 - lib/cuffsert/cli_args.rb
@@ -167,6 +168,8 @@ files:
 - lib/cuffsert/metadata.rb
 - lib/cuffsert/presenters.rb
 - lib/cuffsert/rxcfclient.rb
+- lib/cuffsert/version.rb
+- lib/cuffup.rb
 homepage: https://github.com/bittrance/cuffsert
 licenses:
 - MIT