convection 0.2.32 → 0.2.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f916acd8ca0393e33372be95052b9e9bec6085ba
-  data.tar.gz: 68fdb161218ff72237d6319eeb7afc91ee8a9a23
+  metadata.gz: 70262a473c642f00cc51b9077ca02c2617194320
+  data.tar.gz: bba7acb1a3242c6b354a384e9924f33c8a69ce13
 SHA512:
-  metadata.gz: 3e74cbb7c38420ecd793f817b49bba6fb5ccc0f8b08ea0e0f70727d86753225108eaa21b6cc71665038fc3dd33be9dec6d471b9565d417e9b4a30ec7bf18bb21
-  data.tar.gz: d0695a09dfefbdd5ed9730b5d11185897e9c2914d27ae5721516679be5d9f7726a009bcf191005d98d61f687fa751dbe3d73de7efd949a478902ae3da8cd971f
+  metadata.gz: df10a72ab338b4e6dec65b93942a0577d53db0d88bbe30e820a1536918192a8adee745b016c4067e3973a1bffccac2ee3cf9016d0930e3a52774185e7bca1edc
+  data.tar.gz: 61f8a1e4761e464a1a3a18139c02caa49839d93fb89be9cc68affe13d4baa9dc2bfbbd47cdcea31e442d4e1d154e6878da50dae25304fa09ce6f7850949eb677

data/.rubocop.yml

@@ -4,7 +4,6 @@ AllCops:
   Include:
     - lib/**/*
     - bin/**/*
-    - test/**/*
     - Gemfile
     - Rakefile
     - Thorfile

data/.rubocop_todo.yml

@@ -70,13 +70,12 @@ Style/Alias:
 Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/convection/model/template.rb'
-    - 'test/test_helper.rb'
+    - 'spec/**/*'
 
 # Offense count: 4
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
     - 'lib/convection/model/attributes.rb'
     - 'lib/convection/model/mixin/colorize.rb'
     - 'lib/convection/model/template/condition.rb'

data/Gemfile

@@ -5,9 +5,10 @@ gemspec
 
 group :development do
   gem 'bundler', '~> 1.7'
-  gem 'minitest'
+  gem 'rspec'
   gem 'rake', '~> 10.0'
   gem 'rubocop', '~> 0.40.0'
   gem 'simplecov'
   gem 'thor-scmversion', '= 1.7.0'
+  gem 'yard'
 end

data/Rakefile

@@ -1,12 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/test_*.rb'
-end
-
-task :default => [:test, :rubocop]
+task :default => [:spec, :rubocop]

data/lib/convection.rb

@@ -7,8 +7,8 @@ module Convection
       Model::Template.new(*args, &block)
     end
 
-    def stack(*args)
-      Control::Stack.new(*args)
+    def stack(*args, &block)
+      Control::Stack.new(*args, &block)
     end
   end
 end

data/lib/convection/control/stack.rb

@@ -52,6 +52,9 @@ module Convection
 
       ## Internal status
       NOT_CREATED = 'NOT_CREATED'.freeze
+      TASK_COMPLETE = 'TASK_COMPLETE'.freeze
+      TASK_FAILED = 'TASK_FAILED'.freeze
+      TASK_IN_PROGRESS = 'TASK_IN_PROGRESS'.freeze
 
       def initialize(name, template, options = {}, &block)
         @name = name
@@ -177,6 +180,26 @@ module Convection
         @template.diff(@current_template)
       end
 
+      def resource_changes?
+        ours = { 'Resources' => @template.resources.map(&:render) }
+        thiers = { 'Resources' => @current_template['Resources'] }
+
+        ours.diff(thiers).any?
+      end
+
+      def resource_dependent_changes?
+        ours = {
+          'Conditions' => @template.conditions.map(&:render),
+          'Outputs' => @template.outputs.map(&:render)
+        }
+        theirs = {
+          'Conditions' => @current_template['Conditions'],
+          'Outputs' => @current_template['Outputs']
+        }
+
+        ours.diff(theirs).any?
+      end
+
       ##
       # Controllers
       ##
@@ -194,12 +217,16 @@ module Convection
             block.call(Model::Event.new(:complete, "Stack #{ name } has no changes", :info)) if block
             get_status
             return
+          elsif !resource_changes? && resource_dependent_changes?
+            message = "Stack #{ name } has no convergable changes (you must update Resources to update Conditions, Metadata, or Outputs)"
+            block.call(Model::Event.new(UPDATE_FAILED, message, :warn)) if block
+            get_status
+            return
           end
 
           ## Execute before update tasks
           @tasks[:before_update].delete_if do |task|
-            task.call(self)
-            task.success?
+            run_task(:before_update, task, &block)
           end
 
           ## Update
@@ -209,8 +236,7 @@ module Convection
         else
           ## Execute before create tasks
           @tasks[:before_create].delete_if do |task|
-            task.call(self)
-            task.success?
+            run_task(:before_create, task, &block)
           end
 
           ## Create
@@ -229,8 +255,7 @@ module Convection
         ## Execute after create tasks
         after_task_type = existing_stack ? :after_update : :after_create
         @tasks[after_task_type].delete_if do |task|
-          task.call(self)
-          task.success?
+          run_task(after_task_type, task, &block)
         end
       rescue Aws::Errors::ServiceError => e
         @errors << e
@@ -239,8 +264,7 @@ module Convection
       def delete(&block)
         ## Execute before delete tasks
         @tasks[:before_delete].delete_if do |task|
-          task.call(self)
-          task.success?
+          run_task(:before_delete, task, &block)
         end
 
         @cf_client.delete_stack(
@@ -254,8 +278,7 @@ module Convection
 
         ## Execute after delete tasks
         @tasks[:after_delete].delete_if do |task|
-          task.call(self)
-          task.success?
+          run_task(:after_delete, task, &block)
         end
       rescue Aws::Errors::ServiceError => e
         @errors << e
@@ -426,6 +449,22 @@ module Convection
           }
         end
       end
+
+      def run_task(phase, task, &block)
+        phase = phase.to_s.split.join(' ')
+        block.call(Model::Event.new(TASK_IN_PROGRESS, "Task (#{phase}) #{task} in progress for stack #{name}.", :info)) if block
+
+        task.call(self)
+        return task.success? unless block
+
+        if task.success?
+          block.call(Model::Event.new(TASK_COMPLETE, "Task (#{phase}) #{task} successfully completed for stack #{name}.", :info))
+          true
+        else
+          block.call(Model::Event.new(TASK_FAILED, "Task (#{phase}) #{task} failed to complete for stack #{name}.", :error))
+          false
+        end
+      end
     end
   end
 end

data/lib/convection/model/event.rb

@@ -14,11 +14,12 @@ module Convection
       attr_accessor :level
       attr_accessor :timestamp
       colorize :level,
-               :green => [:info, :success, Control::Stack::CREATE_COMPLETE, Control::Stack::UPDATE_COMPLETE, Control::Stack::UPDATE_ROLLBACK_COMPLETE],
+               :green => [:info, :success, Control::Stack::CREATE_COMPLETE, Control::Stack::UPDATE_COMPLETE, Control::Stack::UPDATE_ROLLBACK_COMPLETE,
+                          Control::Stack::TASK_COMPLETE],
                :red => [:error, :fail, Control::Stack::CREATE_FAILED, Control::Stack::ROLLBACK_FAILED,
                         Control::Stack::DELETE_FAILED, Control::Stack::UPDATE_FAILED,
                         Control::Stack::UPDATE_ROLLBACK_IN_PROGRESS, Control::Stack::UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS,
-                        Control::Stack::UPDATE_ROLLBACK_FAILED],
+                        Control::Stack::UPDATE_ROLLBACK_FAILED, Control::Stack::TASK_FAILED],
                :default => :yellow
 
       class << self

data/lib/convection/model/template.rb

@@ -82,6 +82,15 @@ module Convection
         o.instance_exec(&block) if block
         outputs[name] = o
       end
+
+      # @param name [String] the name of the new metadata configuration to set
+      # @param value [Hash] an arbritrary JSON object to set as the
+      #   value of the new metadata configuration
+      def metadata(name = nil, value = nil)
+        return @metadata unless name
+
+        @metadata[name] = Model::Template::Metadata.new(name, value)
+      end
     end
   end
 
@@ -199,6 +208,7 @@ module Convection
         @conditions = Collection.new
         @resources = Collection.new
         @outputs = Collection.new
+        @metadata = Collection.new
       end
 
       def clone(stack_)
@@ -222,7 +232,8 @@ module Convection
           'Mappings' => mappings.map(&:render),
           'Conditions' => conditions.map(&:render),
           'Resources' => resources.map(&:render),
-          'Outputs' => outputs.map(&:render)
+          'Outputs' => outputs.map(&:render),
+          'Metadata' => metadata.map(&:render)
         }
       end
 
@@ -343,3 +354,4 @@ require_relative 'template/resource'
 require_relative 'template/resource_property'
 require_relative 'template/resource_attribute'
 require_relative 'template/output'
+require_relative 'template/metadata'

data/lib/convection/model/template/metadata.rb

@@ -0,0 +1,22 @@
+module Convection
+  module Model
+    class Template
+      ##
+      # Metadata Attribute
+      ##
+      class Metadata
+        attr_accessor :name
+        attr_accessor :value
+
+        def initialize(name, value)
+          @name = name
+          @value = value
+        end
+
+        def render
+          value
+        end
+      end
+    end
+  end
+end

data/lib/convection/model/template/resource/aws_ec2_subnet.rb

@@ -45,6 +45,7 @@ module Convection
           type 'AWS::EC2::Subnet'
           property :availability_zone, 'AvailabilityZone'
           property :vpc, 'VpcId'
+          property :public_ips, 'MapPublicIpOnLaunch'
           cidr_property :network, 'CidrBlock'
 
           def render(*args)

data/lib/convection/model/template/resource/aws_events_rule.rb

@@ -11,6 +11,10 @@ module Convection
           type 'AWS::Events::Rule'
           property :description, 'Description'
           property :domain, 'Domain'
+          # Event patterns are documented as the type "JSON Object".
+          # We can define it here as a Hash. Example usage of the
+          # `event_pattern` method property being used can be found in
+          # the EventsRule spec.
           property :event_pattern, 'EventPattern', :type => :hash
           property :name, 'Name'
           property :role_arn, 'RoleArn'

data/spec/cf_client_context.rb

@@ -0,0 +1,10 @@
+RSpec.shared_context 'with a mock CloudFormation client' do
+  let(:cf_client) do
+    client = double(:cf_client, create_stack: nil, delete_stack: nil, update_stack: nil)
+    allow(client).to receive(:describe_stacks) {
+      fail Aws::CloudFormation::Errors::ValidationError.new(nil, 'Stack does not exist.')
+    }
+
+    client
+  end
+end

data/spec/collect_availability_zones_task_context.rb

@@ -0,0 +1,17 @@
+RSpec.shared_context 'with a CollectAvailabilityZonesTask defined' do
+  class CollectAvailabilityZonesTask
+    attr_writer :availability_zones
+
+    def availability_zones
+      @availability_zones ||= []
+    end
+
+    def call(stack)
+      self.availability_zones += stack.availability_zones
+    end
+
+    def success?
+      availability_zones.any?
+    end
+  end
+end

data/spec/convection/control/stack/after_create_tasks_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Convection::Control
+  describe Stack do
+    let(:template) do
+      Convection.template do
+        description 'EC2 VPC Test Template'
+
+        ec2_vpc 'TargetVPC' do
+          network '10.0.0.0'
+          subnet_length 24
+          enable_dns
+        end
+      end
+    end
+
+    describe 'after create tasks' do
+      include_context 'with a CollectAvailabilityZonesTask defined'
+      include_context 'with a mock CloudFormation client'
+      include_context 'with a mock EC2 client'
+
+      before do
+        allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_client)
+        allow(Aws::EC2::Client).to receive(:new).and_return(ec2_client)
+      end
+      let(:task) { CollectAvailabilityZonesTask.new }
+      subject do
+        scope = self
+        Convection::Control::Stack.new('EC2 VPC Test Stack', template) do
+          after_create_task scope.task
+        end
+      end
+
+      it 'is registered after Stack#apply is called' do
+        expect(subject.tasks[:after_create]).to_not be_empty
+      end
+
+      it 'is executed on Stack#apply' do
+        subject.apply
+
+        expect(task.availability_zones).to include('eu-central-1')
+      end
+
+      it 'is deregistered after Stack#apply is called' do
+        subject.apply
+
+        expect(subject.tasks[:after_create]).to be_empty
+      end
+    end
+  end
+end

data/spec/convection/control/stack/after_delete_tasks_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Convection::Control
+  describe Stack do
+    let(:template) do
+      Convection.template do
+        description 'EC2 VPC Test Template'
+
+        ec2_vpc 'TargetVPC' do
+          network '10.0.0.0'
+          subnet_length 24
+          enable_dns
+        end
+      end
+    end
+
+    describe 'after delete tasks' do
+      include_context 'with a CollectAvailabilityZonesTask defined'
+      include_context 'with a mock CloudFormation client'
+      include_context 'with a mock EC2 client'
+
+      before do
+        allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_client)
+        allow(Aws::EC2::Client).to receive(:new).and_return(ec2_client)
+      end
+      let(:task) { CollectAvailabilityZonesTask.new }
+      subject do
+        scope = self
+        Convection::Control::Stack.new('EC2 VPC Test Stack', template) do
+          after_delete_task scope.task
+        end
+      end
+
+      it 'is registered before Stack#delete is called' do
+        expect(subject.tasks[:after_delete]).to_not be_empty
+      end
+
+      it 'is executed on Stack#delete' do
+        subject.delete
+
+        expect(task.availability_zones).to include('eu-central-1')
+      end
+
+      it 'is deregistered after Stack#delete is called' do
+        subject.delete
+
+        expect(subject.tasks[:after_delete]).to be_empty
+      end
+    end
+  end
+end

data/spec/convection/control/stack/after_update_tasks_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Convection::Control
+  describe Stack do
+    let(:template) do
+      Convection.template do
+        description 'EC2 VPC Test Template'
+
+        ec2_vpc 'TargetVPC' do
+          network '10.0.0.0'
+          subnet_length 24
+          enable_dns
+        end
+      end
+    end
+
+    describe 'after update tasks' do
+      include_context 'with a CollectAvailabilityZonesTask defined'
+      include_context 'with a mock CloudFormation client'
+      include_context 'with a mock EC2 client'
+
+      before do
+        allow(Aws::CloudFormation::Client).to receive(:new).and_return(cf_client)
+        allow(Aws::EC2::Client).to receive(:new).and_return(ec2_client)
+      end
+      let(:task) { CollectAvailabilityZonesTask.new }
+      subject do
+        scope = self
+        stack = Convection::Control::Stack.new('EC2 VPC Test Stack', template) do
+          after_update_task scope.task
+        end
+        allow(stack).to receive(:exist).and_return(true)
+        allow(stack).to receive(:exist?).and_return(true)
+        stack
+      end
+
+      it 'is registered after Stack#apply is called' do
+        expect(subject.tasks[:after_update]).to_not be_empty
+      end
+
+      it 'is executed on Stack#apply' do
+        subject.apply
+
+        expect(task.availability_zones).to include('eu-central-1')
+      end
+
+      it 'is deregistered after Stack#apply is called' do
+        subject.apply
+
+        expect(subject.tasks[:after_update]).to be_empty
+      end
+    end
+  end
+end