cfn-flow 0.2.1 → 0.5.0

data/lib/cfn-flow/git.rb

@@ -1,4 +1,5 @@
 # Git helper module
+# TODO: extract as plugin
 class CfnFlow::Git
   class << self
 

data/lib/cfn-flow/template.rb

@@ -1,64 +1,78 @@
-class CfnFlow::Template
-  attr_reader :from, :prefix, :bucket
-  def initialize(opts={})
-    unless [:from, :prefix, :bucket].all? {|arg| opts.key?(arg) }
-      raise ArgumentError.new("Must pass :from, :prefix, and :bucket")
+module CfnFlow
+  class Template
+
+    # Tag for JSON/YAML loading errors
+    module Error; end
+
+    attr_reader :local_path
+    def initialize(local_path)
+      @local_path = local_path
     end
-    @from, @prefix, @bucket = opts[:from], opts[:prefix], opts[:bucket]
-  end
 
-  def yaml?
-    from.end_with?('.yml')
-  end
+    def yaml?
+      local_path.end_with?('.yml')
+    end
 
-  def json?
-    ! yaml?
-  end
+    def json?
+      ! yaml?
+    end
 
-  # Determine if this file is a CFN template
-  def is_cfn_template?
-    from_data.is_a?(Hash) && from_data.key?('Resources')
-  end
+    # Determine if this file is a CFN template
+    def is_cfn_template?
+      local_data.is_a?(Hash) && local_data.key?('Resources')
+    end
 
-  # Returns a response object if valid, or raises an
-  # Aws::CloudFormation::Errors::ValidationError with an error message
-  def validate!
-    cfn.validate_template(template_body: to_json)
-  end
+    # Returns a response object if valid, or raises an
+    # Aws::CloudFormation::Errors::ValidationError with an error message
+    def validate!
+      cfn.validate_template(template_body: to_json)
+    end
 
-  def key
-    # Replace leading './' in from
-    File.join(prefix, from.sub(/\A\.\//, ''))
-  end
+    ##
+    # S3 methods
+    def key(release)
+      # Replace leading './' in local_path
+      clean_path = local_path.sub(/\A\.\//, '')
+      File.join(*[s3_prefix, release, clean_path].compact)
+    end
 
-  def upload!
-    s3_object.put(body: to_json)
-  end
+    def s3_object(release)
+      Aws::S3::Object.new(bucket, key(release))
+    end
 
-  def url
-    s3_object.public_url
-  end
+    def url(release)
+      s3_object(release).public_url
+    end
 
-  def from_data
-    # We *could* load JSON as YAML, but that would generate confusing errors
-    # in the case of a JSON syntax error.
-    @from_data ||= yaml? ? YAML.load_file(from) : MultiJson.load(File.read(from))
-  rescue
-    puts "Error loading #{from}"
-    raise $!
-  end
+    def upload(release)
+      s3_object(release).put(body: to_json)
+    end
 
-  def to_json
-    @to_json ||= MultiJson.dump(from_data, pretty: true)
-  end
+    def local_data
+      # We *could* load JSON as YAML, but that would generate confusing errors
+      # in the case of a JSON syntax error.
+      @local_data ||= yaml? ? YAML.load_file(local_path) : MultiJson.load(File.read(local_path))
+    rescue Exception => error
+      # Tag & re-raise any error
+      error.extend(CfnFlow::Template::Error)
+      raise error
+    end
 
-  private
-  def cfn
-    Aws::CloudFormation::Client.new
-  end
+    def to_json
+      @to_json ||= MultiJson.dump(local_data, pretty: true)
+    end
 
-  def s3_object
-    Aws::S3::Object.new(bucket, key)
-  end
+    def bucket
+      CfnFlow.template_s3_bucket
+    end
 
+    def s3_prefix
+      CfnFlow.template_s3_prefix
+    end
+
+    private
+    def cfn
+      CfnFlow.cfn_client
+    end
+  end
 end

data/lib/cfn-flow/version.rb

@@ -0,0 +1,3 @@
+module CfnFlow
+  VERSION = '0.5.0'
+end

data/spec/cfn-flow/cli_spec.rb

@@ -0,0 +1,372 @@
+require_relative '../helper'
+
+describe 'CfnFlow::CLI' do
+  let(:cli) { CfnFlow::CLI }
+  let(:template) { 'spec/data/sqs.yml' }
+
+  before do
+    ENV.update({
+      'CFN_FLOW_BUCKET' => 'test-bucket',
+      'CFN_FLOW_FROM' => 'spec/data',
+      'CFN_FLOW_TO'   => 'test'
+    })
+  end
+
+  describe '#validate' do
+    it 'succeeds' do
+      out, err = capture_io { cli.start [:validate, template] }
+      err.must_be :empty?
+      out.must_match "Validating #{template}... valid."
+    end
+
+    it 'can have multiple templates' do
+      out, _ = capture_io { cli.start [:validate, template, 'spec/data/sqs.template'] }
+      out.split("\n").size.must_equal 2
+    end
+
+    it 'can fail with malformed templates' do
+      _, err = capture_io { cli.start [:validate, 'no/such/template'] }
+      err.must_match 'Error loading template'
+      err.must_match 'Errno::ENOENT'
+    end
+
+    it 'can fail with validation error' do
+      Aws.config[:cloudformation] = {stub_responses: {validate_template: 'ValidationError'}}
+      _, err = capture_io { cli.start [:validate, template] }
+      err.must_match "Invalid template"
+    end
+
+    it 'fails when no templates are passed' do
+      out, err = capture_io { cli.start [:validate] }
+      out.must_equal ''
+      err.must_match 'You must specify a template to validate'
+    end
+  end
+
+  describe '#publish' do
+    it 'succeeds' do
+      out, err = capture_io { cli.start [:publish, template] }
+      err.must_equal ''
+      out.must_match "Validating #{template}... valid."
+      out.must_match "Publishing #{template}"
+    end
+
+    it 'can have multiple templates' do
+      out, _ = capture_io { cli.start [:publish, template, 'spec/data/sqs.template'] }
+      # 2 lines for validating, 2 for publishing
+      out.split("\n").size.must_equal 4
+    end
+
+    it 'uses the dev-name' do
+      out, _ = capture_io { cli.start [:publish, template] }
+      out.must_match("dev/#{ENV['CFN_FLOW_DEV_NAME']}")
+    end
+
+    it 'can take a dev-name argument' do
+      name = 'a-new-dev-name'
+      out, _ = capture_io { cli.start [:publish, template, '--dev-name', name] }
+      out.must_match("dev/#{name}")
+    end
+
+    it 'can take a release argument' do
+      release = 'v2.0'
+      out, _ = capture_io { cli.start [:publish, template, '--release', release] }
+      out.must_match CfnFlow::Template.new(template).url("release/#{release}")
+    end
+
+    it 'can fail with malformed templates' do
+      _, err = capture_io { cli.start [:publish, 'no/such/template'] }
+      err.must_match 'Error loading template'
+      err.must_match 'Errno::ENOENT'
+    end
+
+    it 'can fail with validation error' do
+      Aws.config[:cloudformation] = {stub_responses: {validate_template: 'ValidationError'}}
+      _, err = capture_io { cli.start [:publish, template] }
+      err.must_match "Invalid template"
+    end
+
+    it 'fails when no templates are passed' do
+      out, err = capture_io { cli.start [:publish] }
+      out.must_equal ''
+      err.must_match 'You must specify a template to publish'
+    end
+
+    it 'fails with no release' do
+      ENV.delete('CFN_FLOW_DEV_NAME')
+      _, err = capture_io { cli.start [:publish, template] }
+      err.must_match 'Must specify --release or --dev-name'
+    end
+  end
+
+  describe '#deploy' do
+
+    it 'succeeds' do
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stub_stack_data(stack_name: 'cfn-flow-spec-stack') ] },
+          describe_stack_events: { stack_events: [ stub_event_data ] },
+        }
+      }
+      out, err = capture_io { cli.start [:deploy, 'test-env'] }
+
+      out.must_match "Launching stack #{CfnFlow.config['stack']['stack_name']}"
+      out.must_match "Polling for events..."
+      out.must_match "CREATE_COMPLETE"
+      out.wont_match 'Finding stacks to cleanup'
+      err.must_equal ''
+    end
+
+    it 'can fail with a validation error' do
+      Aws.config[:cloudformation]= {
+        stub_responses: { create_stack: 'ValidationError' }
+      }
+
+      out, err = capture_io { cli.start [:deploy, 'test-env'] }
+      out.must_equal ''
+      err.must_match 'error'
+
+    end
+
+    it 'can cleanup' do
+
+      # Stubbing hacks alert!
+      # The first time we call :describe_stacks, return the stack we launch.
+      # The second time, we're loading 'another-stack' to clean it up
+      stack_stubs = [
+        { stacks: [ stub_stack_data(stack_name: 'cfn-flow-spec-stack') ] },
+        { stacks: [ stub_stack_data(stack_name: 'another-stack') ] }
+      ]
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: stack_stubs,
+          describe_stack_events: { stack_events: [ stub_event_data ] },
+        }
+      }
+
+      Thor::LineEditor.stub :readline, "yes" do
+        out, err = capture_io { cli.start [:deploy, 'production', '--cleanup'] }
+        out.must_match 'Finding stacks to clean up'
+        out.must_match 'Deleted stack another-stack'
+        err.must_equal ''
+      end
+    end
+
+  end
+
+  describe '#list' do
+    it 'has no output with no stacks' do
+      out, err = capture_io { cli.start [:list] }
+      out.must_equal ''
+      err.must_equal ''
+    end
+
+    describe 'with one stack' do
+      before do
+        Aws.config[:cloudformation]= {
+          stub_responses: {
+            describe_stacks: { stacks: [ stub_stack_data ] }
+          }
+        }
+      end
+      it 'should print the stack' do
+        out, err = capture_io { cli.start [:list] }
+        out.must_match(/mystack\s+production\s+CREATE_COMPLETE/)
+        err.must_equal ''
+      end
+
+      it 'should print the header' do
+        out, _ = capture_io { cli.start [:list] }
+        out.must_match(/NAME\s+ENVIRONMENT\s+STATUS/)
+      end
+
+      it 'should print stacks when passed an environment' do
+        out, _ = capture_io { cli.start [:list, 'production'] }
+        out.must_match 'mystack'
+
+        out, _ = capture_io { cli.start [:list, 'none-such-env'] }
+        out.must_equal ''
+      end
+
+      it 'should not print the header with option[no-header]' do
+        out, _ = capture_io { cli.start [:list, '--no-header'] }
+        out.wont_match(/NAME\s+ENVIRONMENT\s+STATUS/)
+      end
+    end
+
+    describe 'with stacks in a different service' do
+      before do
+        Aws.config[:cloudformation]= {
+          stub_responses: {
+            describe_stacks: {
+              stacks: [
+                { stack_name: "mystack",
+                  stack_status: 'CREATE_COMPLETE',
+                  creation_time: Time.now,
+                  tags: [
+                    {key: 'CfnFlowService', value: 'none-such-service'},
+                    {key: 'CfnFlowEnvironment', value: 'production'}
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      end
+
+      it 'has no output' do
+        out, _ = capture_io { cli.start [:list] }
+        out.must_equal ''
+      end
+    end
+  end
+
+  describe '#show' do
+    describe 'with a stack' do
+      before do
+        Aws.config[:cloudformation]= {
+          stub_responses: {
+            describe_stacks: { stacks: [ stub_stack_data ] }
+          }
+        }
+      end
+
+      it 'should print in yaml' do
+        out, err = capture_io { cli.start [:show, 'mystack'] }
+        expected = CfnFlow.cfn_resource.stack('mystack').data.to_hash.to_yaml
+        out.must_equal expected
+        err.must_equal ''
+      end
+
+      it 'handles --json option' do
+        out, _ = capture_io { cli.start [:show, 'mystack', '--json'] }
+        expected = MultiJson.dump(CfnFlow.cfn_resource.stack('mystack').data.to_hash, pretty: true) + "\n"
+        out.must_equal expected
+      end
+    end
+
+    it 'returns an error with missing stacks' do
+      Aws.config[:cloudformation]= {
+        stub_responses: { describe_stacks: 'ValidationError' }
+      }
+      out, err = capture_io { cli.start [:show, 'none-such-stack'] }
+      out.must_equal ''
+      err.must_match 'error'
+    end
+
+    it 'returns an error when stack is not in service' do
+      stack_data = stub_stack_data
+      stack_data[:tags][0][:value] = 'none-such-service'
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stack_data ] }
+        }
+      }
+      out, err = capture_io { cli.start [:show, 'none-such-stack'] }
+      out.must_equal ''
+      err.must_match "not tagged for service #{CfnFlow.service}"
+    end
+  end
+
+  describe '#events' do
+    before do
+      Aws.config[:cloudformation] = {
+        stub_responses: {
+          describe_stack_events: { stack_events: [ stub_event_data ] },
+          describe_stacks: { stacks: [ stub_stack_data ] }
+        }
+      }
+    end
+
+    it 'should show the header by default' do
+      out, _ = capture_io { cli.start [:events, 'mystack'] }
+      out.must_match CfnFlow::EventPresenter.header
+    end
+
+    it 'can omit header' do
+      out, _ = capture_io { cli.start [:events, '--no-headers', 'mystack'] }
+      out.wont_match CfnFlow::EventPresenter.header
+    end
+
+    it 'should show an event' do
+      out, err = capture_io { cli.start [:events, 'mystack'] }
+
+      out.must_match CfnFlow::EventPresenter.new(stub_event).to_s
+      err.must_equal ''
+    end
+
+    describe 'with polling' do
+      before do
+        Aws.config[:cloudformation] = {
+          stub_responses: {
+            describe_stack_events: [
+              { stack_events: [ stub_event_data(resource_status: 'CREATE_IN_PROGRESS') ] },
+              { stack_events: [ stub_event_data(resource_status: 'CREATE_COMPLETE') ] }
+            ],
+            describe_stacks: [
+              { stacks: [ stub_stack_data(stack_status: 'CREATE_IN_PROGRESS') ] },
+              { stacks: [ stub_stack_data(stack_status: 'CREATE_COMPLETE') ] },
+            ]
+          }
+        }
+      end
+
+      it 'should not poll by default' do
+        out, _ = capture_io { cli.start [:events, '--no-header', 'mystack'] }
+        out.must_match 'CREATE_IN_PROGRESS'
+        out.wont_match 'CREATE_COMPLETE'
+      end
+
+      it 'will poll until complete' do
+        out, _ = capture_io {
+          cli.start [:events, '--no-header', '--poll', 'mystack']
+        }
+        out.must_match 'CREATE_IN_PROGRESS'
+        out.must_match 'CREATE_COMPLETE'
+      end
+    end
+
+  end
+
+  describe '#delete' do
+    describe 'with a stack' do
+      before do
+        Aws.config[:cloudformation] = {
+          stub_responses: { describe_stacks: { stacks: [ stub_stack_data ] } }
+        }
+      end
+
+      it 'deletes the stack' do
+        Thor::LineEditor.stub :readline, "yes" do
+          out, err = capture_io { cli.start [:delete, 'mystack'] }
+          out.must_equal "Deleted stack mystack\n"
+          err.must_equal ''
+        end
+      end
+
+      it 'does not delete the stack if you say no' do
+        Thor::LineEditor.stub :readline, "no" do
+          out, err = capture_io { cli.start [:delete, 'mystack'] }
+          out.must_equal ''
+          err.must_equal ''
+        end
+      end
+
+      it 'does not ask when --force is set' do
+          out, err = capture_io { cli.start [:delete, '--force', 'mystack'] }
+          out.must_equal "Deleted stack mystack\n"
+          err.must_equal ''
+      end
+    end
+
+    it 'returns an error for a stack in another service' do
+      Aws.config[:cloudformation] = {
+        stub_responses: { describe_stacks: { stacks: [ stub_stack_data(tags: []) ] } }
+      }
+    out, err = capture_io { cli.start [:delete, 'wrong-stack'] }
+      out.must_equal ''
+      err.must_match 'Stack wrong-stack is not tagged for service'
+    end
+  end
+
+end