stackup 1.4.3 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e367ca4b2044872b8bffc12075970ad962f5542e143a3d8f47cc6cd9ec6773
-  data.tar.gz: a3b4dd683a84e01885ffdc60ec306e18d212e24fefddec660cd451b8ca8c5d23
+  metadata.gz: 7a60dfe3184679f98c43d28590feadf40faa968bf5b75531951510d96d38a02f
+  data.tar.gz: ab5010d36407547ba7c1f5b09e190c776023303227b72881ea80b2b49a41b717
 SHA512:
-  metadata.gz: 1fc1090d8365094a4ec26df52d8f4ba745d5ff9dc275001630d4ebb013a7673105d658749ee0d3214da89c1559c0acbaa3a5f9ee1cb17ab8e643ab16436d0ac0
-  data.tar.gz: 578e511731086edfe83a22245bde31c50ec8c194504772f6f4ae3cd2ac56fe5819e2adfc2c11e34b576e07071207f70b2f3f2c38f61d16a0ca74f639e1668333
+  metadata.gz: cf63917e39f450c29d98e420f872aa5f1d7bd00fbd2543eece6d81795ec64ec349e66ba507230e212d30961a390a8a9f587c0dc45e08b823c78c518f700425ff
+  data.tar.gz: 15a86e361a985ca59c7714025fa47308a4e165b5abdf2f0bf8e3020d13a73636e219a6693b208f6d51e4fed8aa28587e7dbd1dda03a654d471a8a432ca4e4632

data/CHANGES.md

@@ -1,5 +1,26 @@
 # CHANGES
 
+## 1.5.1 (2020-11-16)
+
+* Fix: Recognise that template is in S3 when URL is formatted like `s3.REGION.amazonaws.com`
+
+## 1.5.0 (2020-04-21)
+
+* Feature: --preserve-template-formatting
+
+## 1.4.6 (2019-12-09)
+
+* Fix: Don't error out when receiving tags in AWS style (array of hashes) from YAML or JSON file
+
+## 1.4.5 (2019-10-03)
+
+* Fix: Tags in RakeTasks
+
+## 1.4.4 (2019-10-03)
+
+* Fix: Loading RakeTasks
+* Removes CI support for older rubies
+
 ## 1.4.3 (2019-09-05)
 
 * Add support for CloudFormation capabilities via CLI and Rake

data/README.md

@@ -78,10 +78,12 @@ For more details on usage, see
 
 ### Specifying parameters
 
-Stack parameters can be be read from a file, e.g.
+Stack parameters can be read from a file, e.g.
 
     $ stackup myapp-test up -t template.json -p parameters.json
 
+These files can be either JSON or YAML format, see [YAML support](#yaml-support) for more information.
+
 Parameters can be specified as simple key-value pairs:
 
 ```json
@@ -116,11 +118,48 @@ Or, you can specify one or more override parameters on the command-line, using `
       -o IndexDoc=index-override.html
       -o ContentDoc=content-override.html
 
+### Specifying tags
+
+Stack tags can be read from a file, e.g.
+
+    $ stackup myapp-test up -t template.json --tags tags.json
+
+These files can be either JSON or YAML format, see [YAML support](#yaml-support) for more information.
+
+Tags are specified as simple key-value pairs:
+
+```json
+{
+  "environment": "dev"
+}
+```
+
+### Acknowledging Capabilities
+
+CloudFormation requires that some stacks explicitly acknowledge certain capabilities before creation. This helps to prevent the creation of stacks with unintended privileges.
+
+If your stack includes IAM resources, you must specify either the `CAPABILITY_IAM` capability, or the `CAPABILITY_NAMED_IAM` capability if they have custom names.
+
+If your stack template contains macros or nested stacks, you must specify the `CAPABILITY_AUTO_EXPAND` capability.
+
+Capabilities can be provided via the `--capability` CLI option.
+
+    $ stackup myapp-test up -t template.json \
+      --capability CAPABILITY_NAMED_IAM \
+      --capability CAPABILITY_AUTO_EXPAND
+
+`stackup` includes defaults to including `CAPABILITY_NAMED_IAM` capability if, and only if, no capabilities are specified.
+This is to provide backwards compatibility with previously deployed stacks and may be removed in a future release.
+
 ### YAML support
 
 `stackup` supports input files (template, parameters, tags) in YAML format, as well as JSON.
 
-It also supports the [abbreviated YAML syntax for Cloudformation functions](https://aws.amazon.com/blogs/aws/aws-cloudformation-update-yaml-cross-stack-references-simplified-substitution/), though unlike the [AWS CLI](https://aws.amazon.com/cli/), Stackup normalises YAML input to JSON before invoking CloudFormation APIs.
+It also supports the [abbreviated YAML syntax for Cloudformation functions](https://aws.amazon.com/blogs/aws/aws-cloudformation-update-yaml-cross-stack-references-simplified-substitution/), though unlike the [AWS CLI](https://aws.amazon.com/cli/), Stackup (by default) normalises YAML input to JSON before invoking CloudFormation APIs.
+
+If you don't want normalisation of the YAML input to JSON, then use the `--preserve-template-formatting` flag to the `up` or `change-set create` commands.
+
+Note: normalisation of S3 / HTTP URL stored templates is never done, as Cloudformation collects these directly.
 
 ### AWS credentials
 
@@ -268,11 +307,11 @@ The release process will push tags to GitHub, push the gem to rubygems and push
 Prerequisites:
 
 * logged into dockerhub via `docker login`. Your user must have permission to push to `realestate/stackup`
-* logged into rubygems via `gem push`. Your user must have permission to push to the `stackup` gem.
+* You must have a rubygems account with permission to push to the `stackup` gem. (`auto/release` will ask for your username and password)
+* You must have cloned this repo via HTTPS and have a github account with permission to push. (`auto/release` will ask for your username and a GitHub personal access token)
 
 To release:
 
 ```
-bundle install
 auto/release
 ```

data/bin/stackup

@@ -41,7 +41,7 @@ Clamp do
   option ["--[no-]wait"], :flag, "wait for stack updates to complete",
          :default => true
 
-  option ["--wait-poll-interval"], "N", "polling interval while waiting for updates",
+  option ["--wait-poll-interval"], "N", "polling interval (in seconds) while waiting for updates",
          :default => 5, &method(:Integer)
 
   option "--debug", :flag, "enable debugging"
@@ -181,6 +181,9 @@ Clamp do
     option ["-T", "--use-previous-template"], :flag,
            "reuse the existing template"
 
+    option ["-P", "--preserve-template-formatting"], :flag,
+           "do not normalise the template when calling the Cloudformation APIs; useful for preserving YAML and comments"
+
     include HasParameters
 
     option "--tags", "FILE", "stack tags file",
@@ -214,6 +217,7 @@ Clamp do
           options[:template_url] = template_source.location
         else
           options[:template] = template_source.data
+          options[:template_orig] = template_source.body
         end
       end
       options[:on_failure] = on_failure
@@ -229,6 +233,7 @@ Clamp do
       options[:role_arn] = service_role_arn if service_role_arn
       options[:use_previous_template] = use_previous_template?
       options[:capabilities] = capability_list
+      options[:preserve] = preserve_template_formatting?
       report_change do
         stack.create_or_update(options)
       end
@@ -274,6 +279,9 @@ Clamp do
       option ["-T", "--use-previous-template"], :flag,
              "reuse the existing template"
 
+      option ["-P", "--preserve-template-formatting"], :flag,
+             "do not normalise the template when calling the Cloudformation APIs; useful for preserving YAML and comments"
+
       option ["--force"], :flag,
              "replace existing change-set of the same name"
 
@@ -296,6 +304,7 @@ Clamp do
             options[:template_url] = template_source.location
           else
             options[:template] = template_source.data
+            options[:template_orig] = template_source.body
           end
         end
         options[:parameters] = parameters
@@ -304,6 +313,7 @@ Clamp do
         options[:use_previous_template] = use_previous_template?
         options[:force] = force?
         options[:capabilities] = capability_list
+        options[:preserve] = preserve_template_formatting?
         report_change do
           change_set.create(options)
         end

data/lib/stackup/change_set.rb

@@ -57,6 +57,9 @@ module Stackup
       options[:change_set_type] = stack.exists? ? "UPDATE" : "CREATE"
       force = options.delete(:force)
       options[:template_body] = MultiJson.dump(options.delete(:template)) if options[:template]
+      # optionally override template_body with the original template to preserve formatting (& comments in YAML)
+      template_orig = options.delete(:template_orig)
+      options[:template_body] = template_orig if options.delete(:preserve)
       options[:parameters] = Parameters.new(options[:parameters]).to_a if options[:parameters]
       options[:tags] = normalize_tags(options[:tags]) if options[:tags]
       options[:capabilities] ||= ["CAPABILITY_NAMED_IAM"]

data/lib/stackup/rake_tasks.rb

@@ -1,7 +1,7 @@
 require "rake/tasklib"
 require "tempfile"
 require "yaml"
-require "Pathname"
+require "pathname"
 
 module Stackup
 
@@ -42,7 +42,7 @@ module Stackup
         data_options = []
         data_options << DataOption.for("--template", template)
         data_options << DataOption.for("--parameters", parameters) if parameters
-        data_options << DataOption.for("--tags", tags) if tag
+        data_options << DataOption.for("--tags", tags) if tags
 
         desc "Update #{stack} stack"
         task "up" => data_options.grep(DataOptionFile).map(&:argument) do

data/lib/stackup/source.rb

@@ -15,7 +15,7 @@ module Stackup
 
     def s3?
       uri.scheme == "https" &&
-        uri.host =~ /(^|\.)s3(-\w+-\w+-\d)?\.amazonaws\.com$/
+        uri.host =~ /(^|\.)s3((\.|-)\w+-\w+-\d)?\.amazonaws\.com$/
     end
 
     def body

data/lib/stackup/stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "aws-sdk-cloudformation"
 require "logger"
 require "multi_json"
@@ -16,10 +18,10 @@ module Stackup
     DEFAULT_WAIT_POLL_INTERVAL = 5 # seconds
 
     def initialize(name, client = {}, options = {})
-      client = Aws::CloudFormation::Client.new(client) if client.is_a?(Hash)
-      @name = name
+      client     = Aws::CloudFormation::Client.new(client) if client.is_a?(Hash)
+      @name      = name
       @cf_client = client
-      @wait = true
+      @wait      = true
       options.each do |key, value|
         public_send("#{key}=", value)
       end
@@ -117,6 +119,9 @@ module Stackup
       if (template_data = options.delete(:template))
         options[:template_body] = MultiJson.dump(template_data)
       end
+      # optionally override template_body with the original template to preserve formatting (& comments in YAML)
+      template_orig = options.delete(:template_orig)
+      options[:template_body] = template_orig if options.delete(:preserve)
       if (parameters = options[:parameters])
         options[:parameters] = Parameters.new(parameters).to_a
       end
@@ -282,7 +287,7 @@ module Stackup
     end
 
     def create(options)
-      options = options.dup
+      options              = options.dup
       options[:stack_name] = name
       options.delete(:stack_policy_during_update_body)
       options.delete(:stack_policy_during_update_url)
@@ -312,7 +317,7 @@ module Stackup
     def event_handler
       @event_handler ||= lambda do |e|
         fields = [e.logical_resource_id, e.resource_status, e.resource_status_reason]
-        time = e.timestamp.localtime.strftime("%H:%M:%S")
+        time   = e.timestamp.localtime.strftime("%H:%M:%S")
         logger.info("[#{time}] #{fields.compact.join(' - ')}")
       end
     end
@@ -369,7 +374,13 @@ module Stackup
           { :key => key, :value => value.to_s }
         end
       else
-        tags
+        tags.map do |tag|
+          if tag.key?("Key")
+            { :key => tag["Key"], :value => tag["Value"].to_s }
+          else
+            { :key => tag[:key], :value => tag[:value].to_s }
+          end
+        end
       end
     end
 
@@ -384,8 +395,8 @@ module Stackup
       handling_cf_errors do
         {}.tap do |result|
           cf_stack.public_send(collection_name).each do |item|
-            key = item.public_send(key_name)
-            value = item.public_send(value_name)
+            key         = item.public_send(key_name)
+            value       = item.public_send(value_name)
             result[key] = value
           end
         end

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "1.4.3".freeze
+  VERSION = "1.5.1".freeze
 
 end

data/spec/stackup/rake_tasks_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "stackup/rake_tasks"
+
+RSpec.describe Stackup::RakeTasks do
+  it "can be required" do
+    expect(described_class).to be_truthy
+  end
+end

data/spec/stackup/source_spec.rb

@@ -124,6 +124,16 @@ describe Stackup::Source do
 
     end
 
+    context "with dot separated bucket and region" do
+
+      let(:s3_url) { "https://bucket.s3.us-east-1.amazonaws.com/cfn/template.yml" }
+
+      it "is S3" do
+        expect(subject).to be_s3
+      end
+
+    end
+
   end
 
 end

data/spec/stackup/stack_spec.rb

@@ -260,6 +260,26 @@ describe Stackup::Stack do
 
       end
 
+      context "with :tags in SDK form as they arrive from file" do
+
+        before do
+          options[:tags] = [
+            { "Key" => "foo", "Value" => "bar" }
+          ]
+        end
+
+        it "converts them to an Array, that uses symbols as keys" do
+          expected_tags = [
+            { :key => "foo", :value => "bar" }
+          ]
+          create_or_update
+          expect(cf_client).to have_received(:create_stack) do |options|
+            expect(options[:tags]).to eq(expected_tags)
+          end
+        end
+
+      end
+
       context "with :tags in SDK form" do
 
         before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.1
 platform: ruby
 authors:
 - Mike Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -110,6 +110,7 @@ files:
 - lib/stackup/yaml.rb
 - spec/spec_helper.rb
 - spec/stackup/parameters_spec.rb
+- spec/stackup/rake_tasks_spec.rb
 - spec/stackup/source_spec.rb
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb
@@ -141,6 +142,7 @@ summary: Manage CloudFormation stacks
 test_files:
 - spec/spec_helper.rb
 - spec/stackup/parameters_spec.rb
+- spec/stackup/rake_tasks_spec.rb
 - spec/stackup/source_spec.rb
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb