stackup 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 018537d107f8cc0049863b56dd604f8c881217c9
-  data.tar.gz: b62b34f99958d38df0d44d4a46af577832eb4174
+  metadata.gz: a1cf0223b3b4769f8f08fb90e944721f19911105
+  data.tar.gz: 809c9e18e59c5a0f92b37cd43c33dd30bbda1a1e
 SHA512:
-  metadata.gz: fe03ddbff07fbb42c2781268e131b16dfc08942bdb5b2079d6905f58b720b091d8b7c461b6413c8b1cc42e7c080d7d560a8d2d369b0a9536b033fd9ba609304d
-  data.tar.gz: 49a82e6317772a3e32322d65bc438bdcc550b0d6f61cfdf2cc06fcfa0b258135be7247fbe6f31665a6d7b6a33b5608a54a64bcc7d7f49a479a489adf75348ad6
+  metadata.gz: b38f0de16a9a86c5f037dae464562c27c246556e9db6bad43a0494b8c305ef159117bac4c275627dfac0284fd0666e1dbe688500829f84836f0c5bc66076ff6a
+  data.tar.gz: 2a933cc8523a7e410e14b43345993157e070f0690286f9498bbe855201c17cd803ee7c98cd5169f2e6a1d8670f31d0a7dd39629f667c0ef5e3c848598fd01988

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stackup (0.1.0)
+    stackup (0.2.0)
       aws-sdk (~> 2.0)
       clamp (~> 1.0)
       console_logger
@@ -10,22 +10,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    aws-sdk (2.1.26)
-      aws-sdk-resources (= 2.1.26)
-    aws-sdk-core (2.1.26)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    aws-sdk (2.1.27)
+      aws-sdk-resources (= 2.1.27)
+    aws-sdk-core (2.1.27)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.1.26)
-      aws-sdk-core (= 2.1.26)
+    aws-sdk-resources (2.1.27)
+      aws-sdk-core (= 2.1.27)
     byebug (6.0.2)
     clamp (1.0.0)
     console_logger (1.0.0)
     diff-lcs (1.2.5)
     jmespath (1.1.3)
     multi_json (1.11.2)
-    parser (2.2.2.5)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
     rainbow (2.0.0)
@@ -43,7 +43,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    rubocop (0.32.0)
+    rubocop (0.34.2)
       astrolabe (~> 1.3)
       parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
@@ -62,4 +62,4 @@ DEPENDENCIES
   stackup!
 
 BUNDLED WITH
-   1.10.6
+   1.10.5

data/README.md

@@ -1,40 +1,63 @@
 # stackup
 
+[![Build Status](https://travis-ci.org/realestate-com-au/stackup.svg?branch=master)](https://travis-ci.org/realestate-com-au/stackup)
+
 Stackup attempts to simplify AWS Cloudformation stack creation process in
 ruby projects by providing executable to perform common operations such
 as apply(create/update), delete, recreate on stack along with validations on
-templates. Task executions which enforce a stack change will wait until
-ROLLBACK/COMPLETE or DELETE is signalled on the stack (useful in continuous
-deployment environments to wait until deployment is successful).
+templates. Operations which enforce a stack change will wait until
+the change is complete.
 
 ## Installation
 
     $ gem install stackup
 
-## Usage
+## Command-line usage
 
 The entry-point is the "stackup" command.
 
-The "stack" subcommand lists stacks:
+Most commands operate in the context of a named stack:
+
+    $ stackup STACK-NAME ...
 
-    $ stackup stacks
+Called without stack-name, it will list stacks:
 
-Most other commands operate in the context of a named stack:
+    $ stackup
+    foo-bar-test
+    zzz-production
 
-    $ stackup stack STACK-NAME ...
+### Stack create/update
 
-To create or update a stack, based on a template, use "apply":
+Use sub-command "up" to create or update a stack, as appropriate:
 
-    $ stackup stack myapp-test apply
+    $ stackup myapp-test up template.json
 
 This will:
 
   * update (or create) the named CloudFormation stack, using the specified template
   * monitor events until the stack update is complete
-  * print any stack "outputs"
 
-Other stack subcommands include:
+### Stack deletion
+
+Sub-command "delete" deletes the stack.
+
+### Stack inspection
+
+Inspect details of a stack with:
+
+    $ stackup myapp-test status
+    $ stackup myapp-test resources
+    $ stackup myapp-test outputs
+
+## Programmatic usage
+
+Get a handle to a `Stack` object as follows:
+
+    stack = Stackup.stack("my-stack")
+
+You can pass an `Aws::CloudFormation::Client`, or client config,
+to `Stackup`, e.g.
+
+    stack = Stackup(credentials).stack("my-stack")
 
-    $ stackup stack myapp-test outputs
-    $ stackup stack myapp-test resources
-    $ stackup stack myapp-test delete
+See {Stackup::Stack} for more details.

data/bin/stackup

@@ -4,7 +4,7 @@ $LOAD_PATH << File.expand_path("../../lib", __FILE__)
 
 require "clamp"
 require "console_logger"
-require "stackup/stack"
+require "stackup"
 require "multi_json"
 require "yaml"
 
@@ -14,7 +14,24 @@ Clamp do
 
   option ["-f", "--format"], "FORMAT", "output format", :default => "yaml"
 
-  protected
+  option ["-L", "--list"], :flag, "list stacks" do
+    list_stacks
+    exit 0
+  end
+
+  parameter "NAME", "Name of stack", :attribute_name => :stack_name
+
+  def run(arguments)
+    super(arguments)
+  rescue Stackup::ServiceError => e
+    signal_error e.message
+  rescue Aws::Errors::MissingCredentialsError
+    signal_error "no credentials provided"
+  rescue Aws::CloudFormation::Errors::ExpiredToken => e
+    signal_error e.message
+  end
+
+  private
 
   def logger
     @logger ||= ConsoleLogger.new($stdout, debug?)
@@ -33,62 +50,87 @@ Clamp do
     puts format_data(data)
   end
 
-  subcommand "stack", "Manage a stack." do
+  def stackup
+    Stackup(:logger => logger, :log_level => :debug)
+  end
 
-    parameter "NAME", "Name of stack", :attribute_name => :stack_name
+  def stack
+    stackup.stack(stack_name)
+  end
 
-    def run(*args)
-      super(*args)
-    rescue Stackup::NoSuchStack => e
-      signal_error "stack '#{stack_name}' does not exist"
-    rescue Stackup::StackUpdateError => e
-      signal_error e.message
+  def list_stacks
+    stackup.stack_names.each do |name|
+      puts name
     end
+  end
 
-    private
+  def report_change
+    change = yield
+    puts "Stack #{change}" unless change.nil?
+  end
 
-    def stack
-      Stackup::Stack.new(stack_name, :logger => logger, :log_level => :debug)
-    end
+  subcommand "status", "Print stack status." do
 
-    def report_change
-      change = yield
-      puts "Stack #{change}" unless change.nil?
+    def execute
+      puts stack.status
     end
 
-    subcommand "status", "Print stack status." do
+  end
 
-      def execute
-        puts stack.status
-      end
+  subcommand "up", "Create/update the stack" do
 
-    end
+    option "--disable-rollback", :flag, "disable stack rollback"
 
-    subcommand "up", "Create/update the stack" do
+    parameter "TEMPLATE", "CloudFormation template file",
+              :attribute_name => :template_file
 
-      parameter "TEMPLATE", "CloudFormation template (.json)", :attribute_name => :template_file
+    parameter "[PARAMETERS]", "CloudFormation parameters file",
+              :attribute_name => :parameters_file
 
-      def execute
-        template = File.read(template_file)
-        report_change { stack.create_or_update(template) }
+    def execute
+      options = {}
+      options[:template_body] = load_file(template_file)
+      options[:parameters_file] = load_file(parameters_file) if parameters_file
+      options[:disable_rollback] = disable_rollback?
+      report_change do
+        stack.create_or_update(options)
       end
+    end
+
+    private
 
+    def load_file(file)
+      File.read(file)
+    rescue Errno::ENOENT
+      signal_error "no such file: #{file.inspect}"
     end
 
-    subcommand ["down", "delete"], "Remove the stack." do
+  end
 
-      def execute
-        report_change { stack.delete }
-      end
+  subcommand ["down", "delete"], "Remove the stack." do
 
+    def execute
+      report_change do
+        stack.delete
+      end
     end
 
-    subcommand "outputs", "Stack outputs." do
+  end
+
+  subcommand "cancel-update", "Cancel the update in-progress" do
 
-      def execute
-        display_data(stack.outputs)
+    def execute
+      report_change do
+        stack.cancel_update
       end
+    end
+
+  end
+
+  subcommand "outputs", "Stack outputs." do
 
+    def execute
+      display_data(stack.outputs)
     end
 
   end

data/doc/Stackup/ErrorMappingProxy.html

@@ -0,0 +1,378 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Stackup::ErrorMappingProxy
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Stackup/ErrorMappingProxy.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Stackup.html" title="Stackup (module)">Stackup</a></span></span>
+     &raquo; 
+    <span class="title">ErrorMappingProxy</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Stackup::ErrorMappingProxy
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Stackup::ErrorMappingProxy</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/stackup/error_mapping_proxy.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>An error-mapping proxy for Aws::CloudFormation models.</p>
+
+<p>It exists to convert certain types of `ValidationError`, where useful
+information is hidden inside the “message”, to Stackup exceptions.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (ErrorMappingProxy) <strong>initialize</strong>(delegate) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of ErrorMappingProxy.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(*args) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#respond_to%3F-instance_method" title="#respond_to? (instance method)">- (Boolean) <strong>respond_to?</strong>(method) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="Stackup::ErrorMappingProxy (class)">ErrorMappingProxy</a></span></tt>) <strong>initialize</strong>(delegate) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of ErrorMappingProxy</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stackup/error_mapping_proxy.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_delegate'>delegate</span><span class='rparen'>)</span>
+  <span class='ivar'>@delegate</span> <span class='op'>=</span> <span class='id identifier rubyid_delegate'>delegate</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+<div id="method_missing_details" class="method_details_list">
+  <h2>Dynamic Method Handling</h2>
+  <p class="notice this">
+    This class handles dynamic methods through the <tt>method_missing</tt> method
+    
+  </p>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="method_missing-instance_method">
+  
+    - (<tt>Object</tt>) <strong>method_missing</strong>(*args) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stackup/error_mapping_proxy.rb', line 16</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+  <span class='ivar'>@delegate</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+<span class='kw'>rescue</span> <span class='const'>Aws</span><span class='op'>::</span><span class='const'>CloudFormation</span><span class='op'>::</span><span class='const'>Errors</span><span class='op'>::</span><span class='const'>ValidationError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>No updates are to be performed.</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NoUpdateRequired</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no updates are required</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Stack .* does not exist$</span><span class='regexp_end'>/</span></span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NoSuchStack</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no such stack</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'> can ?not be </span><span class='regexp_end'>/</span></span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>InvalidStateError</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_e'>e</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="respond_to?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>respond_to?</strong>(method) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stackup/error_mapping_proxy.rb', line 31</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
+  <span class='ivar'>@delegate</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Fri Oct  9 11:23:11 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.2).
+</div>
+
+  </body>
+</html>