cfn-flow 0.2.1 → 0.5.0

data/spec/cfn-flow/event_presenter_spec.rb

@@ -0,0 +1,58 @@
+require_relative '../helper'
+
+describe 'EventPresenter' do
+
+  subject { CfnFlow::EventPresenter }
+  after { CfnFlow::EventPresenter.seen_event_ids.clear }
+
+  let(:event) { stub_event }
+  let(:event_with_reason) { stub_event(resource_status_reason: 'stubbed-reason') }
+
+  describe '.seen_event_ids' do
+    it 'should be a set' do
+      subject.seen_event_ids.must_be_kind_of Set
+    end
+  end
+
+  describe '.present' do
+    it 'should present the right number of events' do
+      events = [event, event_with_reason]
+      result = subject.present(events) {|e| e}
+
+      result.size.must_equal 2
+      result.each {|e| e.must_be_kind_of CfnFlow::EventPresenter }
+    end
+
+    it 'should omit dupe events' do
+      subject.present([event]) {}
+      subject.present([event]) {}.must_equal []
+    end
+
+    it 'should render the status' do
+      out, _ = capture_io do
+        subject.present([event]) { |e| puts e.to_s }
+      end
+
+      out.must_match event.resource_status
+    end
+  end
+
+  describe '#initialize' do
+    it 'should add to .seen_event_ids' do
+      subject.new(event)
+      subject.seen_event_ids.include?(event.id).must_equal true
+    end
+  end
+
+  describe '#to_s' do
+    it 'should show the appropriate details' do
+      str = subject.new(event).to_s
+      str.must_match event.logical_resource_id
+    end
+
+    it 'should show a reason' do
+      str = subject.new(event_with_reason).to_s
+      str.must_match event_with_reason.resource_status_reason
+    end
+  end
+end

data/spec/cfn-flow/template_spec.rb

@@ -0,0 +1,140 @@
+require_relative '../helper'
+
+describe 'CfnFlow::Template' do
+
+  let(:template) {
+    CfnFlow::Template.new('spec/data/sqs.template')
+  }
+
+  let(:yml_template) {
+    CfnFlow::Template.new('spec/data/sqs.yml')
+  }
+
+  let(:not_a_template) {
+    CfnFlow::Template.new('spec/data/cfn-flow.yml')
+  }
+
+  let(:release) { 'deadbeef' }
+
+  describe '#initialize' do
+    subject { CfnFlow::Template }
+
+    it('succeeds') do
+      subject.new('f').must_be_kind_of CfnFlow::Template
+    end
+
+    it('requires args') do
+      -> { subject.new }.must_raise(ArgumentError)
+    end
+  end
+
+  describe '#yaml?' do
+    it 'works' do
+      yml_template.yaml?.must_equal true
+      yml_template.json?.must_equal false
+      template.yaml?.must_equal false
+      template.json?.must_equal true
+    end
+  end
+
+  describe '#is_cfn_template?' do
+    it 'works' do
+      yml_template.is_cfn_template?.must_equal true
+      template.is_cfn_template?.must_equal true
+      not_a_template.is_cfn_template?.must_equal false
+    end
+  end
+
+  describe '#bucket' do
+    it 'uses CfnFlow.template_s3_bucket' do
+      template.bucket.must_equal CfnFlow.template_s3_bucket
+    end
+     it 'has the correct value' do
+      template.bucket.must_equal 'test-bucket'
+    end
+  end
+
+  describe '#s3_prefix' do
+    it 'uses CfnFlow.template_s3_prefix' do
+      template.s3_prefix.must_equal CfnFlow.template_s3_prefix
+    end
+     it 'has the correct value' do
+      template.s3_prefix.must_equal 'test-prefix'
+    end
+  end
+
+  describe '#key' do
+    it 'has the correct value' do
+      expected = File.join(template.s3_prefix, release, template.local_path)
+      template.key(release).must_equal expected
+    end
+
+    it "removes leading './'" do
+      CfnFlow::Template.new('./foo').key(release).must_equal "test-prefix/#{release}/foo"
+    end
+
+    it "can have a empty s3_prefix" do
+      CfnFlow.instance_variable_set(:@config, {'templates' => {'s3_bucket' => 'foo'}})
+      expected = File.join(release, template.local_path)
+      template.key(release).must_equal expected
+    end
+  end
+
+  describe '#s3_object' do
+    it 'is an S3::Object' do
+      subject = template.s3_object(release)
+      subject.must_be_kind_of Aws::S3::Object
+      subject.bucket.name.must_equal template.bucket
+      subject.key.must_equal template.key(release)
+    end
+  end
+
+  describe '#url' do
+    it 'is the correct S3 url' do
+      uri = URI.parse(template.url(release))
+      uri.scheme.must_equal 'https'
+      uri.host.must_match(/\A#{template.bucket}\.s3\..+\.amazonaws\.com\z/)
+      uri.path.must_equal('/' + template.key(release))
+    end
+  end
+
+  describe '#upload' do
+    it 'succeeds' do
+      template.upload(release)
+    end
+  end
+
+  describe '#local_data' do
+    it 'should read valid data' do
+      template.local_data.must_be_kind_of Hash
+      template.local_data.must_be_kind_of Hash
+    end
+
+    it 'should raise an error on invalid json data' do
+      -> { CfnFlow::Template.new('spec/data/invalid.json').local_data }.must_raise CfnFlow::Template::Error
+    end
+
+    it 'should raise an error on invalid YAML data' do
+      -> { CfnFlow::Template.new('spec/data/invalid.yml').local_data }.must_raise CfnFlow::Template::Error
+    end
+    it 'should raise an on a missing file' do
+      -> { CfnFlow::Template.new('no/such/file').local_data }.must_raise CfnFlow::Template::Error
+    end
+  end
+
+  describe '#to_json' do
+    it 'should work' do
+      template.to_json.must_equal MultiJson.dump(template.local_data, pretty: true)
+    end
+  end
+
+  describe '#validate!' do
+    it 'succeeds' do
+      template.validate!
+    end
+    it 'can raise an error' do
+      Aws.config[:cloudformation] = {stub_responses: {validate_template: 'ValidationError'}}
+      -> { template.validate! }.must_raise Aws::CloudFormation::Errors::ValidationError
+    end
+  end
+end

data/spec/cfn-flow_spec.rb

@@ -0,0 +1,179 @@
+require_relative 'helper'
+
+describe 'CfnFlow' do
+  subject { CfnFlow }
+
+  describe '.config_path' do
+    it 'should be ./cfn-flow.yml by default' do
+      ENV.delete('CFN_FLOW_CONFIG_PATH')
+      subject.config_path.must_equal 'cfn-flow.yml'
+    end
+
+    it 'can be overridden with ENV[CFN_FLOW_CONFIG_PATH]' do
+      ENV['CFN_FLOW_CONFIG_PATH'] = 'foo/bar'
+      subject.config_path.must_equal 'foo/bar'
+    end
+  end
+
+  describe '.config_loaded?' do
+    it 'should be false by default' do
+      subject.config_loaded?.must_equal false
+    end
+
+    it 'should be true after loading' do
+      subject.load_config
+      subject.config_loaded?.must_equal true
+    end
+  end
+
+  describe '.config' do
+    it('should be a hash') { subject.config.must_be_kind_of(Hash) }
+  end
+
+  describe '.service' do
+    it('raises an error when missing') do
+      subject.instance_variable_set(:@config, {})
+      error = -> { subject.service }.must_raise(Thor::Error)
+      error.message.must_match 'No service name'
+    end
+
+    it('returns the service') do
+      subject.instance_variable_set(:@config, {'service' => 'RoflScaler'})
+      subject.service.must_equal 'RoflScaler'
+    end
+  end
+
+  describe '.stack_params' do
+    it('raises an error when missing') do
+      subject.instance_variable_set(:@config, {})
+      error = -> { subject.stack_params('env') }.must_raise(Thor::Error)
+      error.message.must_match 'No stack defined'
+    end
+
+    it('expands parameters') do
+      stack = {'parameters' => {'ami' => 'ami-12345' } }
+      subject.instance_variable_set(:@config, {'service' => 'myservice', 'stack' => stack})
+      subject.stack_params('env')[:parameters].must_equal [ { parameter_key: 'ami', parameter_value: 'ami-12345' } ]
+    end
+
+    it('expands tags') do
+      stack = {'tags' => {'Deployer' => 'Aaron' } }
+      subject.instance_variable_set(:@config, {'service' => 'myservice', 'stack' => stack})
+      expected = [
+        { key: 'Deployer', value: 'Aaron' },
+        { key: 'CfnFlowService', value: 'myservice' },
+        { key: 'CfnFlowEnvironment', value: 'env' }
+      ]
+
+      subject.stack_params('env')[:tags].must_equal expected
+    end
+
+    it 'appends CfnFlow tags' do
+      subject.instance_variable_set(:@config, {'service' => 'myservice', 'stack' => {}})
+      expected = [
+        { key: 'CfnFlowService', value: 'myservice' },
+        { key: 'CfnFlowEnvironment', value: 'env' }
+      ]
+
+      subject.stack_params('env')[:tags].must_equal expected
+    end
+
+    it 'expands template body' do
+      template_path = 'spec/data/sqs.template'
+      stack = {'template_body' => template_path}
+      subject.instance_variable_set(:@config, {'service' => 'myservice', 'stack' => stack})
+      subject.stack_params('env')[:template_body].must_equal CfnFlow::Template.new(template_path).to_json
+    end
+
+  end
+
+  describe '.template_s3_bucket' do
+    it('raises an error when missing') do
+      subject.instance_variable_set(:@config, {})
+      error = -> { subject.template_s3_bucket }.must_raise(Thor::Error)
+      error.message.must_match 'No s3_bucket defined'
+
+      subject.instance_variable_set(:@config, {'templates' => {}})
+      error = -> { subject.template_s3_bucket }.must_raise(Thor::Error)
+      error.message.must_match 'No s3_bucket defined'
+    end
+
+    it 'succeeds' do
+      subject.instance_variable_set(:@config, {'templates' => {'s3_bucket' => 'hello'}})
+      subject.template_s3_bucket.must_equal 'hello'
+    end
+  end
+
+  describe '.template_s3_prefix' do
+    it('raises an error when missing') do
+      subject.instance_variable_set(:@config, {})
+      error = -> { subject.template_s3_prefix }.must_raise(Thor::Error)
+      error.message.must_match 'No templates defined'
+    end
+
+    it 'succeeds' do
+      subject.instance_variable_set(:@config, {'templates' => {'s3_prefix' => 'hello'}})
+      subject.template_s3_prefix.must_equal 'hello'
+    end
+
+    it 'can be nil' do
+      subject.instance_variable_set(:@config, {'templates' => {}})
+      subject.template_s3_prefix.must_equal nil
+    end
+  end
+
+  describe '.cfn_client' do
+    it 'should work' do
+      subject.cfn_client.must_be_kind_of Aws::CloudFormation::Client
+    end
+
+    describe 'aws region' do
+      it 'should default to the env region' do
+        ENV['AWS_REGION'] = 'env-region'
+        subject.cfn_client.config.region.must_equal 'env-region'
+      end
+
+      it 'can be overridden with config' do
+        ENV['AWS_REGION'] = 'env-region'
+        subject.instance_variable_set(:@config, {region: 'config-region' })
+        subject.cfn_client.config.region.must_equal 'config-region'
+      end
+    end
+
+  end
+
+  describe '.cfn_resource' do
+    it 'should work' do
+      subject.cfn_resource.must_be_kind_of Aws::CloudFormation::Resource
+    end
+
+    it 'should set a retry_limit' do
+      subject.cfn_resource.client.config.retry_limit.must_equal 10
+    end
+
+    describe 'aws region' do
+      it 'should default to the env region' do
+        ENV['AWS_REGION'] = 'env-region'
+        subject.cfn_client.config.region.must_equal 'env-region'
+      end
+
+      it 'can be overridden with config' do
+        ENV['AWS_REGION'] = 'env-region'
+        subject.instance_variable_set(:@config, {region: 'config-region' })
+        subject.cfn_client.config.region.must_equal 'config-region'
+      end
+    end
+  end
+
+  describe '.exit_on_failure?' do
+    it 'is true by default' do
+      CfnFlow.remove_instance_variable(:@exit_on_failure) if CfnFlow.instance_variable_defined?(:@exit_on_failure)
+      CfnFlow.exit_on_failure?.must_equal true
+    end
+
+    it 'can be set' do
+      CfnFlow.exit_on_failure = false
+      CfnFlow.exit_on_failure?.must_equal false
+    end
+  end
+end

data/spec/data/cfn-flow.yml

@@ -1,6 +1,14 @@
 ---
-bucket: test-bucket
-prefix: test-prefix
-from: spec/data
-to: test-to
+service: cfn-flow-specs
 region: us-east-1
+templates:
+  s3_bucket: test-bucket
+  s3_prefix: test-prefix
+
+stack:
+  stack_name: cfn-flow-spec-stack
+  template_body: sqs.yml
+  parameters:
+    AlarmEMail: test@example.com
+  tags:
+    test_tag: hello world

data/spec/data/invalid.json

@@ -0,0 +1 @@
+{

data/spec/data/invalid.yml

@@ -0,0 +1,3 @@
+---
+foo:
+bar

data/spec/helper.rb

@@ -16,23 +16,56 @@ ENV['AWS_REGION'] = 'us-east-1'
 ENV['AWS_ACCESS_KEY_ID'] = 'test-key'
 ENV['AWS_SECRET_ACCESS_KEY'] = 'test-secret'
 ENV['CFN_FLOW_DEV_NAME'] = 'cfn-flow-specs'
+ENV['CFN_FLOW_CONFIG_PATH'] = 'spec/data/cfn-flow.yml'
+ENV['CFN_FLOW_EVENT_POLL_INTERVAL'] = '0'
 
 class Minitest::Spec
-  # From http://git.io/bcfh
-  def capture(stream = :stdout)
-    begin
-      stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
-      yield
-      result = eval("$#{stream}").string
-    ensure
-      eval("$#{stream} = #{stream.upcase}")
-    end
-
-    result
+  before do
+    # Reset env between tests:
+    @orig_env = ENV.to_hash
+
+    # Disable exit on failure so CLI tests don't bomb out
+    CfnFlow.exit_on_failure = false
+  end
+
+  after do
+    # Reset env
+    ENV.clear
+    ENV.update(@orig_env)
+
+    # Reset stubs
+    CfnFlow.clear!
+    Aws.config.delete(:cloudformation)
+  end
+
+  def stub_stack_data(attrs = {})
+    {
+      stack_name: "mystack",
+      stack_status: 'CREATE_COMPLETE',
+      creation_time: Time.now,
+      tags: [
+        {key: 'CfnFlowService', value: CfnFlow.service},
+        {key: 'CfnFlowEnvironment', value: 'production'}
+      ]
+    }.merge(attrs)
+  end
+
+  def stub_event_data(attrs = {})
+    {
+      stack_id: 'mystack',
+      stack_name: 'mystack',
+      event_id: SecureRandom.hex,
+      resource_status: 'CREATE_COMPLETE',
+      logical_resource_id: 'stubbed-resource-id',
+      resource_type: 'stubbed-resource-type',
+      timestamp: Time.now
+    }.merge(attrs)
+  end
+
+  def stub_event(attrs = {})
+    data = stub_event_data(attrs)
+    id = data.delete(:event_id)
+    Aws::CloudFormation::Event.new(id: id, data: data)
   end
 
-  # Reset env between tests
-  before { @orig_env = ENV.to_hash }
-  after  { ENV.clear; ENV.update(@orig_env) }
 end