stackup 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e377001f70e0991601d52f67ddabf4ab13606eff27583f58433a9d4806a74191
-  data.tar.gz: 7c6f3d425651c9ef3266bf32c815efd01a4c052eeb7cd46c9c6fcf3c4541da6b
+  metadata.gz: c15ca8477932ab203176cf7047ba309edae07fe35c36cdf797353d747bb74e5b
+  data.tar.gz: 195ebfa65f7fa5a3836abf59e855fe803f97e1dbc28965800f89c88f5b56a22d
 SHA512:
-  metadata.gz: 3cb0be656aa5c84d209b6b840628d6dd0668c358147fb8cae30bd9e388b7df57161ed623d8c4158353fd791b4a669b20e60d49ab64f9a5582a6ad9ae29b1a78d
-  data.tar.gz: f987a896bc1e2b58d802e6134f1e8808d22bf38daeda11c8f84926e2c2ea76bdb2a60ce68e212b13b178d494c3cc12dec79b2d644ec60940a88d15e30ff992e1
+  metadata.gz: 8439adf18ef0d019ea73e2205b9c0d33848f2151c48ef45e5b6f8552492d860bf0ad9477d625d62163537da997fc18c763310731a4f8735860e6edc4cf121b91
+  data.tar.gz: 8022894472208a085f0224c71e2e2bbfb9d896673c6fbd5a5af259c970383c8edec14cba14cc5cc576e8d203a15e1121bb682321ab5c79a224b3a6ac52ceb996

data/CHANGES.md

@@ -1,5 +1,13 @@
 # CHANGES
 
+## 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

data/README.md

@@ -155,7 +155,11 @@ This is to provide backwards compatibility with previously deployed stacks and m
 
 `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
 

data/bin/stackup

@@ -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/stack.rb

@@ -119,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

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "1.4.6".freeze
+  VERSION = "1.5.0".freeze
 
 end

data/spec/stackup/rake_tasks_spec.rb

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

data/spec/stackup/stack_spec.rb

@@ -270,7 +270,7 @@ describe Stackup::Stack do
 
         it "converts them to an Array, that uses symbols as keys" do
           expected_tags = [
-            { :key => "foo", :value => "bar" },
+            { :key => "foo", :value => "bar" }
           ]
           create_or_update
           expect(cf_client).to have_received(:create_stack) do |options|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Mike Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation