convection 0.2.26 → 0.2.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 973023aa6d5f219238792f3a0c82cab3404b2801
-  data.tar.gz: 4ff627e74f2ec7e9d6c3c076c0992a88a339f874
+  metadata.gz: 50c21a69cf59ef819ba20bcd4336ef17454a9e38
+  data.tar.gz: 805db980ac9b3ad1912d675cee95eff3943bed9d
 SHA512:
-  metadata.gz: 9e9514b28524fdcf080894016117ca4aeb12494c9caf0e68fd0735dbeda32d20ddb4c75c8c600e74de55df20a933da5c6d59936df639541227a705377cf23b3d
-  data.tar.gz: 0cc0ad13e48f372d1e63df73e5ef3dbec8e83e8db8ca321a1666edd3eadac36f4698de531daefdb3b698db92e5129474c76149931de1c3917529edf24a4b9f58
+  metadata.gz: 6189728b8e296fbc1d06db5551021a416ee3581dc2c7a5e0ea3105849e874f1ebd95627e373c4e29277269bdcca8fda8531c070011eec3a6346789b72f0e1023
+  data.tar.gz: 81311736cfd06d59aef0d0d424b3242b914e392522a014319e89152a51bb185ac3e7aa63e5577adcaa77563a50f4cc2ca6561de8984d5cb7350a8f04f9e2d58d

data/.rubocop_todo.yml

@@ -23,6 +23,8 @@ Metrics/AbcSize:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
+  Exclude:
+    - 'lib/convection/control/stack.rb'
   Max: 304
 
 # Offense count: 6
@@ -38,6 +40,8 @@ Metrics/LineLength:
 # Offense count: 32
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
+  Exclude:
+    - 'lib/convection/control/stack.rb'
   Max: 37
 
 # Offense count: 5

data/example/sqs-queue/Cloudfile

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+region 'us-east-1'
+name 'convection-sqs-queue-example'
+
+sqs_queue = template do
+  description 'An example template for setting up a SQS queue with Convection'
+
+  sqs_queue 'ExampleSQSQueue' do
+    delay_seconds 0 # The time in seconds that delivery of messages is queued
+    maximum_message_size 262144 # How many bytes a message can contain before it's rejected
+    message_retention_period 345600 # The time in seconds a message stays in the queue
+    queue_name 'ExampleSQSQueue' # The name of the queue
+    receive_message_wait_time_seconds 0 # Set to non-zero to enable long polling
+    visibility_timeout 30 # The time in seconds the queue will be unavailable once a message is delivered
+  end
+end
+
+stack 'convection-sqs-queue-example', sqs_queue

data/example/sqs-queue/README.md

@@ -0,0 +1,12 @@
+# Creating a SQS queue in AWS #
+
+This example shows how to set up a SQS queue in AWS. The values provided in the
+template match the default values from the [AWS::SQS::Queue][sqs] resource. If
+you leave a property blank, it will use the default value.
+
+Run `convetion diff` to see what the template will create.
+
+Run `convection converge` to create the example SQS queue.
+
+
+[sqs]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html

data/lib/convection/control/stack.rb

@@ -84,7 +84,7 @@ module Convection
         @id = nil
         @outputs = {}
         @resources = {}
-        @tasks = { after_create: [], after_delete: [], before_create: [], before_delete: [] }
+        @tasks = { after_create: [], after_delete: [], after_update: [], before_create: [], before_delete: [], before_update: [] }
         instance_exec(&block) if block
         @current_template = {}
         @last_event_seen = nil
@@ -178,13 +178,21 @@ module Convection
           o[:capabilities] = capabilities
         end
 
-        if exist?
+        # Get the state of existence before creation
+        existing_stack = exist?
+        if existing_stack
           if diff.empty? ## No Changes. Just get resources and move on
             block.call(Model::Event.new(:complete, "Stack #{ name } has no changes", :info)) if block
             get_status
             return
           end
 
+          ## Execute before update tasks
+          @tasks[:before_update].delete_if do |task|
+            task.call(self)
+            task.success?
+          end
+
           ## Update
           @cf_client.update_stack(request_options.tap do |o|
             o[:stack_name] = id
@@ -210,7 +218,8 @@ module Convection
         watch(&block) if block # Block execution on stack status
 
         ## Execute after create tasks
-        @tasks[:after_create].delete_if do |task|
+        after_task_type = existing_stack ? :after_update : :after_create
+        @tasks[after_task_type].delete_if do |task|
           task.call(self)
           task.success?
         end
@@ -282,6 +291,10 @@ module Convection
         @tasks[:after_delete] << task
       end
 
+      def after_update_task(task)
+        @tasks[:after_update] << task
+      end
+
       def before_create_task(task)
         @tasks[:before_create] << task
       end
@@ -290,6 +303,10 @@ module Convection
         @tasks[:before_delete] << task
       end
 
+      def before_update_task(task)
+        @tasks[:before_update] << task
+      end
+
       private
 
       def get_status(stack_name = id)

data/test/convection/tasks/test_after_update_tasks.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class TestAfterUpdateTasks < Minitest::Test
+  include TestHelper
+
+  def setup
+    @template = ::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
+
+  def test_after_update_task_is_registered
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # when - a stack is initialized with a after_update_task
+        task = CollectAvailabilityZonesTask.new
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          after_update_task task
+        end
+
+        # then - the given stack should be present
+        assert_includes stack.tasks[:after_update], task
+      end
+    end
+  end
+
+  def test_after_update_task_is_executed
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # given - a stack initialized with a after_update_task
+        task = CollectAvailabilityZonesTask.new
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          after_update_task task
+        end
+
+        # when - any changes to the stack are applied
+        stub_existence(stack, true) do
+          stack.apply
+        end
+
+        # then - the task should have been executed
+        assert_includes task.availability_zones, 'eu-central-1'
+      end
+    end
+  end
+
+  def test_after_update_task_is_deregistered
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # given - a stack initialized with a after_update_task
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          after_update_task CollectAvailabilityZonesTask.new
+        end
+
+        # when - any changes to the stack are applied
+        stub_existence(stack, true) do
+          stack.apply
+        end
+
+        # then - the task should have been deregistered
+        assert_empty stack.tasks[:after_update]
+      end
+    end
+  end
+end

data/test/convection/tasks/test_before_update_tasks.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class TestBeforeUpdateTasks < Minitest::Test
+  include TestHelper
+
+  def setup
+    @template = ::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
+
+  def test_before_update_task_is_registered
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # when - a stack is initialized with a before_update_task
+        task = CollectAvailabilityZonesTask.new
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          before_update_task task
+        end
+
+        # then - the given stack should be present
+        assert_includes stack.tasks[:before_update], task
+      end
+    end
+  end
+
+  def test_before_update_task_is_executed
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # given - a stack initialized with a before_update_task
+        task = CollectAvailabilityZonesTask.new
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          before_update_task task
+        end
+
+        # when - any changes to the stack are applied
+        stub_existence(stack, true) do
+          stack.apply
+        end
+
+        # then - the task should have been executed
+        assert_includes task.availability_zones, 'eu-central-1'
+      end
+    end
+  end
+
+  def test_before_update_task_is_deregistered
+    Aws::CloudFormation::Client.stub :new, mock_cloudformation_client do
+      Aws::EC2::Client.stub :new, mock_ec2_client do
+        # given - a stack initialized with a before_update_task
+        stack = ::Convection::Control::Stack.new('EC2 VPC Test Stack', @template) do
+          before_update_task CollectAvailabilityZonesTask.new
+        end
+
+        # when - any changes to the stack are applied
+        stub_existence(stack, true) do
+          stack.apply
+        end
+
+        # then - the task should have been deregistered
+        assert_empty stack.tasks[:before_update]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -41,6 +41,7 @@ module TestHelper
     cf_client.expect(:create_stack, nil, any_args)
     cf_client.expect(:delete_stack, nil, any_args)
     cf_client.expect(:describe_stacks, nil)
+    cf_client.expect(:update_stack, nil, any_args)
     def cf_client.describe_stacks(*)
       context = nil # we don't need any request context here.
       raise Aws::CloudFormation::Errors::ValidationError.new(context, 'Stack does not exist.')
@@ -61,4 +62,11 @@ module TestHelper
     ec2_client.expect(:describe_availability_zones, availability_zone_description)
     ec2_client
   end
+
+  # Stub both exist/exist? since aliases are not overridden when stubbing in minitest.
+  def stub_existence(stack, exists, &block)
+    stack.stub(:exist, exists) do
+      stack.stub(:exist?, exists, &block)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convection
 version: !ruby/object:Gem::Version
-  version: 0.2.26
+  version: 0.2.27
 platform: ruby
 authors:
 - John Manero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -102,6 +102,8 @@ files:
 - example/instances.rb
 - example/output/vpc.json
 - example/security-groups.rb
+- example/sqs-queue/Cloudfile
+- example/sqs-queue/README.md
 - example/trust_cloudtrail.rb
 - example/vpc.rb
 - ext/resource_generator.sh
@@ -224,8 +226,10 @@ files:
 - test/convection/model/test_vpc_endpoint.rb
 - test/convection/tasks/test_after_create_tasks.rb
 - test/convection/tasks/test_after_delete_tasks.rb
+- test/convection/tasks/test_after_update_tasks.rb
 - test/convection/tasks/test_before_create_tasks.rb
 - test/convection/tasks/test_before_delete_tasks.rb
+- test/convection/tasks/test_before_update_tasks.rb
 - test/test_helper.rb
 homepage: https://github.com/rapid7/convection
 licenses:
@@ -266,6 +270,8 @@ test_files:
 - test/convection/model/test_vpc_endpoint.rb
 - test/convection/tasks/test_after_create_tasks.rb
 - test/convection/tasks/test_after_delete_tasks.rb
+- test/convection/tasks/test_after_update_tasks.rb
 - test/convection/tasks/test_before_create_tasks.rb
 - test/convection/tasks/test_before_delete_tasks.rb
+- test/convection/tasks/test_before_update_tasks.rb
 - test/test_helper.rb