stackup 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f70a25b2393218900fde09713ec91cfc485121c2
-  data.tar.gz: 3f6c5693a0b23ab0dd30884f7d42ed45e61ccc68
+  metadata.gz: cd8f6344aa29806003cac476d52ecd7070747ec3
+  data.tar.gz: 1a64e7205d279d0e7922171de005ac6ddcbb08ef
 SHA512:
-  metadata.gz: 2e41add2eb41807de33893aa472613741925e420e9ee327c4bbab879bbb11d9e798fb09c022c0d0820da26f53b6a375564b62771156040bcd6d5da975a6ffb05
-  data.tar.gz: 9131421f4beeca6244df73b7e9302587a6ca9c9e99c17aa8aa43497c3fca0270654bbb40de212807140a70bec462e1a6bc8fb2713933c9c3be164f052f9dc034
+  metadata.gz: abbf1538c8f0a04dcbd72b180803f7eb9211c07ec74eda51078135f40fd31088eaf6a3442688a6a92cee886799374475f7c4ca5ea9a350fc6fb6b6ea2ccc7b33
+  data.tar.gz: 6fd7cb6adb0b1bd846ab7a347be74f630a4ac6514db282d1f5cd3073991ce0155f80b09b100e32fbcd965f1ad30b6ab6d9caf9c7e0342756d6ee7b9c8a34dee8

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 1.1.0 (2017-02-23)
+
+* The `stackup` CLI now allows stack template and policy documents to be specified as URLs.
+  * Template URL must point to a template stored in an Amazon S3 bucket, e.g. `https://s3-ap-southeast-2.amazonaws.com/bucket/template.json`.
+  * Policy URL must point to an object located in an S3 bucket in the same region as the stack.
+
 ## 1.0.4 (2017-01-04)
 
 * Fix #34: make YAML parsing work in ruby-2.0.

data/bin/stackup

@@ -8,6 +8,7 @@ require "multi_json"
 require "securerandom"
 require "stackup"
 require "stackup/differ"
+require "stackup/source"
 require "stackup/version"
 require "stackup/yaml"
 
@@ -55,6 +56,8 @@ Clamp do
 
   def run(arguments)
     super(arguments)
+  rescue Stackup::Source::ReadError => e
+    signal_error e.message
   rescue Stackup::ServiceError => e
     signal_error e.message
   rescue Aws::Errors::MissingCredentialsError
@@ -126,14 +129,10 @@ Clamp do
     puts final_status unless final_status.nil?
   end
 
-  def load_data(file)
-    Stackup::YAML.load_file(file)
-  rescue Errno::ENOENT
-    signal_error "no such file: #{file.inspect}"
-  end
-
-  def load_parameters(file)
-    Stackup::Parameters.new(load_data(file)).to_hash
+  def parameters_from_files
+    parameter_sources.map { |src|
+      Stackup::Parameters.new(src.data).to_hash
+    }.inject(:merge)
   end
 
   subcommand "status", "Print stack status." do
@@ -144,42 +143,58 @@ Clamp do
 
   end
 
-  subcommand "up", "Create/update the stack" do
+  subcommand "up", "Create/update the stack." do
 
-    option ["-t", "--template"], "FILE", "template file",
-           :attribute_name => :template_file
+    option ["-t", "--template"], "FILE", "template source",
+           :attribute_name => :template_source,
+           &Stackup::Source.method(:new)
 
     option ["-T", "--use-previous-template"], :flag,
            "reuse the existing template"
 
     option ["-p", "--parameters"], "FILE", "parameters file (last wins)",
            :multivalued => true,
-           :attribute_name => :parameter_file_list
+           :attribute_name => :parameter_sources,
+           &Stackup::Source.method(:new)
 
     option ["-o", "--override"], "PARAM=VALUE", "parameter overrides",
            :multivalued => true,
            :attribute_name => :override_list
 
     option "--tags", "FILE", "stack tags file",
-           :attribute_name => :tags_file
+           :attribute_name => :tag_source,
+           &Stackup::Source.method(:new)
 
     option "--policy", "FILE", "stack policy file",
-           :attribute_name => :policy_file
+           :attribute_name => :policy_source,
+           &Stackup::Source.method(:new)
 
     option "--on-failure", "ACTION",
            "when stack creation fails: DO_NOTHING, ROLLBACK, or DELETE",
            :default => "ROLLBACK"
 
     def execute
-      unless template_file || use_previous_template?
+      unless template_source || use_previous_template?
         signal_usage_error "Specify either --template or --use-previous-template"
       end
       options = {}
-      options[:template] = load_data(template_file) if template_file
+      if template_source
+        if is_s3_url?(template_source.location)
+          options[:template_url] = template_source.location
+        else
+          options[:template] = template_source.data
+        end
+      end
       options[:on_failure] = on_failure
       options[:parameters] = parameters
-      options[:tags] = load_data(tags_file) if tags_file
-      options[:stack_policy] = load_data(policy_file) if policy_file
+      options[:tags] = tag_source.data if tag_source
+      if policy_source
+        if is_s3_url?(policy_source.location)
+          options[:stack_policy_url] = policy_source.location
+        else
+          options[:stack_policy] = policy_source.data
+        end
+      end
       options[:use_previous_template] = use_previous_template?
       report_change do
         stack.create_or_update(options)
@@ -189,9 +204,7 @@ Clamp do
     private
 
     def parameters
-      hashes = parameter_file_list.map(&method(:load_parameters))
-      hashes << parameter_overrides
-      hashes.inject(:merge)
+      parameters_from_files.merge(parameter_overrides)
     end
 
     def parameter_overrides
@@ -203,36 +216,43 @@ Clamp do
       end
     end
 
+    def is_s3_url?(location)
+      location =~ %r{^https://s3\w*.amazonaws.com}
+    end
+
   end
 
   subcommand "diff", "Compare template/params to current stack." do
 
-    option ["-t", "--template"], "FILE", "template file",
-           :attribute_name => :template_file
+    option ["-t", "--template"], "FILE", "template source",
+           :attribute_name => :template_source,
+           &Stackup::Source.method(:new)
 
     option ["-p", "--parameters"], "FILE", "parameters file (last wins)",
            :multivalued => true,
-           :attribute_name => :parameter_file_list
+           :attribute_name => :parameter_sources,
+           &Stackup::Source.method(:new)
 
     option "--tags", "FILE", "stack tags file",
-           :attribute_name => :tags_file
+           :attribute_name => :tag_source,
+           &Stackup::Source.method(:new)
 
     option "--diff-format", "FORMAT", "'text', 'color', or 'html'", :default => "color"
 
     def execute
       current = {}
       planned = {}
-      if template_file
+      if template_source
         current["Template"] = stack.template
-        planned["Template"] = load_data(template_file)
+        planned["Template"] = template_source.data
       end
-      unless parameter_file_list.empty?
+      unless parameter_sources.empty?
         current["Parameters"] = existing_parameters.sort.to_h
         planned["Parameters"] = new_parameters.sort.to_h
       end
-      if tags_file
+      if tag_source
         current["Tags"] = stack.tags.sort.to_h
-        planned["Tags"] = load_data(tags_file).sort.to_h
+        planned["Tags"] = tag_source.data.sort.to_h
       end
       signal_usage_error "specify '--template' or '--parameters'" if planned.empty?
       puts differ.diff(current, planned)
@@ -248,10 +268,6 @@ Clamp do
       @existing_parameters ||= stack.parameters
     end
 
-    def parameters_from_files
-      parameter_file_list.map(&method(:load_parameters)).inject(:merge)
-    end
-
     def new_parameters
       existing_parameters.merge(parameters_from_files)
     end
@@ -268,7 +284,7 @@ Clamp do
 
   end
 
-  subcommand "cancel-update", "Cancel the update in-progress" do
+  subcommand "cancel-update", "Cancel the update in-progress." do
 
     def execute
       report_change do
@@ -278,7 +294,7 @@ Clamp do
 
   end
 
-  subcommand "wait", "Wait until stack is stable" do
+  subcommand "wait", "Wait until stack is stable." do
 
     def execute
       puts stack.wait
@@ -286,7 +302,7 @@ Clamp do
 
   end
 
-  subcommand "events", "List stack events" do
+  subcommand "events", "List stack events." do
 
     option ["-f", "--follow"], :flag, "follow new events"
     option ["--data"], :flag, "display events as data"
@@ -376,7 +392,7 @@ Clamp do
 
   end
 
-  subcommand "inspect", "Display stack particulars" do
+  subcommand "inspect", "Display stack particulars." do
 
     def execute
       data = {

data/lib/stackup/source.rb

@@ -0,0 +1,58 @@
+require "aws-sdk-core"
+require "open-uri"
+require "stackup/stack"
+
+module Stackup
+
+  # Represents a source of input, e.g. template, parameter, etc.
+  #
+  class Source
+
+    def initialize(location)
+      @location = location
+    end
+
+    attr_reader :location
+
+    def body
+      @body ||= read
+    end
+
+    def data
+      @data ||= parse_body
+    end
+
+    private
+
+    LOOKS_LIKE_JSON = /^\s*[\{\[]/
+
+    def uri
+      URI(location)
+    end
+
+    def read
+      if uri.scheme
+        uri.read
+      else
+        IO.read(location)
+      end
+    rescue Errno::ENOENT
+      raise ReadError, "no such file: #{location.inspect}"
+    rescue OpenURI::HTTPError => e
+      raise ReadError, "#{e}: #{location.inspect}"
+    end
+
+    def parse_body
+      if body =~ LOOKS_LIKE_JSON
+        MultiJson.load(body)
+      else
+        Stackup::YAML.load(body)
+      end
+    end
+
+    class ReadError < StandardError
+    end
+
+  end
+
+end

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 
 end

data/spec/stackup/source_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+require "multi_json"
+require "stackup/source"
+require "stackup/yaml"
+
+describe Stackup::Source do
+
+  let(:example_dir) { File.expand_path("../../../examples", __FILE__) }
+
+  context "from a JSON file" do
+
+    let(:json_file) { File.join(example_dir, "template.json") }
+
+    subject(:source) { described_class.new(json_file) }
+
+    describe "#body" do
+
+      it "returns JSON body" do
+        expect(subject.body).to eql(File.read(json_file))
+      end
+
+    end
+
+    describe "#data" do
+
+      it "returns parsed JSON" do
+        expect(subject.data).to eql(MultiJson.load(File.read(json_file)))
+      end
+
+    end
+
+  end
+
+  context "from a YAML file" do
+
+    let(:yaml_file) { File.join(example_dir, "template.yml") }
+
+    subject(:source) { described_class.new(yaml_file) }
+
+    describe "#body" do
+
+      it "returns YAML body" do
+        expect(subject.body).to eql(File.read(yaml_file))
+      end
+
+    end
+
+    describe "#data" do
+
+      it "returns parsed YAML" do
+        expect(subject.data).to eql(Stackup::YAML.load_file(yaml_file))
+      end
+
+    end
+
+  end
+
+  context "with a non-existant file" do
+
+    let(:bogus_file) { "notreallythere.json" }
+
+    subject(:source) { described_class.new(bogus_file) }
+
+    describe "#body" do
+
+      it "raises a ReadError" do
+        expect { subject.body }.to raise_error(Stackup::Source::ReadError, %q(no such file: "notreallythere.json"))
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Williams
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: clamp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: console_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -100,6 +100,7 @@ files:
 - lib/stackup/parameters.rb
 - lib/stackup/rake_tasks.rb
 - lib/stackup/service.rb
+- lib/stackup/source.rb
 - lib/stackup/stack.rb
 - lib/stackup/stack_watcher.rb
 - lib/stackup/utils.rb
@@ -107,6 +108,7 @@ files:
 - lib/stackup/yaml.rb
 - spec/spec_helper.rb
 - spec/stackup/parameters_spec.rb
+- spec/stackup/source_spec.rb
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb
 - spec/stackup/utils_spec.rb
@@ -121,23 +123,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Manage CloudFormation stacks
 test_files:
 - spec/spec_helper.rb
 - spec/stackup/parameters_spec.rb
+- spec/stackup/source_spec.rb
 - spec/stackup/stack_spec.rb
 - spec/stackup/stack_watcher_spec.rb
 - spec/stackup/utils_spec.rb