stackup 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d5247909e33849cd8ebd01a050d97d446e1e27
-  data.tar.gz: c791ab2604455fb5786ca2c6c3162fa9520e7e87
+  metadata.gz: 70cf1deee1c8dc53041f2d6ff6cb31fdc9dac4f7
+  data.tar.gz: 54fad33244ba8fe2c0935a95efed3ca897feb65b
 SHA512:
-  metadata.gz: 10b971d636c818efe634cca634a30fffe672517b2e05fa46648f7e17eada5320e94f15bac14125917bc8527978068a4f582f00cc154319f4c2c045e0c37446b7
-  data.tar.gz: de309273aa1a1c05a968e4ae12793a35a027d87360bc7612e627f001a828d77d4f84f1ce350c5b941def64f46205c292a791411198d64a3e2b9b4cd9cc0e5a91
+  metadata.gz: 8c250dadcf6d56e74423b0c191bd21c52e2790a0c7f73c15f2c506c4213be26582033642b7dadc6979cf62f2e41653cfd31e66e48c442942eccb6352fd410553
+  data.tar.gz: cbc82bd3c82c85795636cd0e1e2febc30bc9ee307427f9b7f5c6cb1d51e633e7eb43335878061c686a8380f949314ffc8bcca316f58718b53b1f9c08c5151f9a

data/CHANGES.md

@@ -1,4 +1,8 @@
-## 0.9.4 (2016-09-26)
+## 1.0.0 (2016-10-07)
+
+* Add support for CloudFormation YAML extensions (e.g. `!Ref`).
+
+## 0.9.5 (2016-09-26)
 
 * Add `--with-role` option, to assume a role for stack operations.
 

data/README.md

@@ -37,8 +37,6 @@ Called with `--list`, it will list stacks:
     foo-bar-test
     zzz-production
 
-The command-line support inputs (template and parameters) in either JSON or YAML format.
-
 ### Stack create/update
 
 Use sub-command "up" to create or update a stack, as appropriate:
@@ -102,6 +100,12 @@ Parameters and tags may be specified via files, or as a Hash, e.g.
       t.tags = { "environment" => "production" }
     end
 
+## YAML support
+
+Stackup supports input files (template, parameters, tags) in either JSON or YAML format.
+
+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.
+
 ## Docker image
 
 Stackup is also published as a Docker image. Basic usage is:

data/bin/stackup

@@ -9,7 +9,7 @@ require "securerandom"
 require "stackup"
 require "stackup/differ"
 require "stackup/version"
-require "yaml"
+require "stackup/yaml"
 
 $stdout.sync = true
 $stderr.sync = true
@@ -127,7 +127,7 @@ Clamp do
   end
 
   def load_data(file)
-    YAML.load_file(file)
+    Stackup::YAML.load_file(file)
   rescue Errno::ENOENT
     signal_error "no such file: #{file.inspect}"
   end

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "0.9.5"
+  VERSION = "1.0.0"
 
 end

data/lib/stackup/yaml.rb

@@ -0,0 +1,61 @@
+require "yaml"
+
+module Stackup
+
+  # Modified YAML parsing, to support CloudFormation YAML shortcuts
+  #
+  module YAML
+
+    class << self
+
+      # Dump Ruby object +o+ to a YAML string.
+      #
+      def dump(*args)
+        ::YAML.dump(*args)
+      end
+
+      # Load YAML stream/string into a Ruby data structure.
+      #
+      # Supports CloudFormation extensions:
+      #
+      #   `!Ref blah` as a shortcut for `{ "Ref" => blah }`
+      #   `!Foo blah` as a shortcut for `{ "Fn::Foo" => blah }`
+      #
+      def load(yaml, filename = nil)
+        tree = ::YAML.parse(yaml, filename)
+        return tree unless tree
+        CloudFormationToRuby.create.accept(tree)
+      end
+
+      # Load YAML file into a Ruby data structure.
+      #
+      # Supports CloudFormation extensions as per `load`.
+      #
+      def load_file(filename)
+        File.open(filename, 'r:bom|utf-8') do |f|
+          load(f, filename)
+        end
+      end
+
+    end
+
+    # Custom Psych node visitor, with CloudFormation extensions.
+    #
+    class CloudFormationToRuby < Psych::Visitors::ToRuby
+
+      def accept(target)
+        case target.tag
+        when "!Ref"
+          { "Ref" => super }
+        when /^!(\w+)$/
+          { "Fn::#{$1}" => super }
+        else
+          super
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/stackup/yaml_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+require "stackup/yaml"
+
+describe Stackup::YAML do
+
+  describe ".load" do
+
+    let(:data) do
+      described_class.load(input)
+    end
+
+    context "with plain YAML" do
+
+      let(:input) do
+        <<-YAML
+        Outputs:
+          Foo: "bar"
+        YAML
+      end
+
+      it "loads as normal" do
+        expect(data).to eql(
+          "Outputs" => {
+            "Foo" => "bar"
+          }
+        )
+      end
+
+    end
+
+    context "with a !Ref" do
+
+      let(:input) do
+        <<-YAML
+        Outputs:
+          Foo: !Ref "Bar"
+        YAML
+      end
+
+      it "expands to Ref" do
+        expect(data).to eql(
+          "Outputs" => {
+            "Foo" => {
+              "Ref" => "Bar"
+            }
+          }
+        )
+      end
+
+    end
+
+    context "with a !Ref" do
+
+      let(:input) do
+        <<-YAML
+        Outputs:
+          Foo: !GetAtt ["Bar", "Baz"]
+        YAML
+      end
+
+      it "expands to Ref" do
+        expect(data).to eql(
+          "Outputs" => {
+            "Foo" => {
+              "Fn::GetAtt" => [
+                "Bar",
+                "Baz"
+              ]
+            }
+          }
+        )
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -104,11 +104,13 @@ files:
 - lib/stackup/stack_watcher.rb
 - lib/stackup/utils.rb
 - lib/stackup/version.rb
+- lib/stackup/yaml.rb
 - spec/spec_helper.rb
 - spec/stackup/parameters_spec.rb
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb
 - spec/stackup/utils_spec.rb
+- spec/stackup/yaml_spec.rb
 homepage: https://github.com/realestate-com-au/stackup
 licenses:
 - MIT
@@ -129,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Manage CloudFormation stacks
@@ -139,3 +141,4 @@ test_files:
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb
 - spec/stackup/utils_spec.rb
+- spec/stackup/yaml_spec.rb