cfn-bridge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8cbad0195cc6723b1376f7116ee26fa15f0d8a6
+  data.tar.gz: 0d6a331241ae011910c7dc6878b4541f6e4fb15d
+SHA512:
+  metadata.gz: abc78980d3551045d36fe688daacbb02a9447dd9346a4ddc2c776c44dcebc30614631b53e1b7346a999d00a4789c48d8e61d5e86e5d520f8118348568fc50db8
+  data.tar.gz: 04fd75107f7b315ab4ff511f56aa5de85204d56ce07509fdf4c8820e6c54803e981ec54d11f3768b1f5ba112c44c0e95ea66363b627b2569ebb3816fefb03e69

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloud-formation-custom-resources.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 The Neat Company
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# cfn-bridge
+
+A bridge to allow you to build custom AWS cloud formation resources.
+
+Check Amazon's page [on custom cloud formation resources](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-walkthrough.html)
+to get more info on how and why you would like to have them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cfn-bridge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cfn-bridge
+
+## Usage
+
+Run:
+
+    $ cfn-bridge start QUEUE_NAME
+
+This will start a worker consuming from `QUEUE_NAME` until the caller calls `CTRL-C` to stop it. `QUEUE_NAME` should be the SQS queue to where the SNS topic is publishing the custom resource messages. An example template that setups the topic and the queue [is available at the repo](spec/files/test-formation.json) and can be used to provide the base topic and queue to use this application.
+
+## Contributing
+
+1. [Fork it](https://github.com/TheNeatCompany/cfn-bridge/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cfn-bridge

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cloud_formation/bridge/cli'
+
+CloudFormation::Bridge::Cli.start(ARGV)

data/cfn-bridge.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloud_formation/bridge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfn-bridge"
+  spec.version       = CloudFormation::Bridge::VERSION
+  spec.authors       = ["Maurício Linhares"]
+  spec.email         = ["mlinhares@neat.com"]
+  spec.summary       = %q{Implements custom operations for CF calls}
+  spec.description   = %q{Implements custom operations for CF calls}
+  spec.homepage      = "https://github.com/TheNeatCompany/cfn-bridge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.6.5'
+  spec.add_development_dependency 'rake', '~> 10.3.2'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'dotenv', '~> 0.11.1'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+
+  spec.add_dependency 'aws-sdk', '~> 1.50.0'
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.1'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'typhoeus', '~> 0.6.9'
+  spec.add_dependency 'rollbar', '~> 1.0.0'
+end

data/lib/cfn-bridge.rb

@@ -0,0 +1 @@
+require 'cloud_formation/bridge/poller'

data/lib/cloud_formation/bridge/cli.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require 'cloud_formation/bridge/poller'
+
+module CloudFormation
+  module Bridge
+    class Cli < Thor
+
+      desc "start QUEUE_NAME", "Starts watching this specific SQS queue"
+      def start(queue_name)
+        poller = CloudFormation::Bridge::Poller.new(queue_name)
+        poller.start
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/errors.rb

@@ -0,0 +1,5 @@
+module CloudFormation
+  module Bridge
+    OperationNotImplementedError = Class.new(StandardError)
+  end
+end

data/lib/cloud_formation/bridge/exception_notifier.rb

@@ -0,0 +1,59 @@
+require 'singleton'
+require 'rollbar'
+
+Rollbar.configure do |config|
+  config.access_token = ENV['ROLLBAR_TOKEN']
+  config.environment = ENV['CFN_ENVIRONMENT'] || 'development'
+  config.enabled = config.environment != 'test'
+end
+
+module CloudFormation
+  module Bridge
+
+    class StdoutExceptionNotifier
+
+      include Singleton
+
+      def report_exception(exception, custom_data = {}, user_data = {})
+        puts "#{exception.message} - #{custom_data.inspect} - #{user_data.inspect}\n#{exception.backtrace.join("\n")}"
+      end
+
+    end
+
+    class RollbarExceptionNotifier
+
+      include Singleton
+
+      def report_exception(exception, custom_data = {}, user_data = {})
+        Rollbar.report_exception(exception, custom_data, user_data)
+      end
+
+    end
+
+    class ExceptionNotifier
+
+      class << self
+
+        def notifier
+          @notifier ||= if ENV['ROLLBAR_TOKEN']
+            RollbarExceptionNotifier.instance
+          else
+            StdoutExceptionNotifier.instance
+          end
+        end
+
+        def notifier=(notifier)
+          @notifier = notifier
+        end
+
+        def report_exception(exception, custom_data = {}, user_data = {})
+          Rollbar.report_exception(exception, custom_data, user_data)
+        end
+
+      end
+
+    end
+
+
+  end
+end

data/lib/cloud_formation/bridge/executor.rb

@@ -0,0 +1,50 @@
+require 'cloud_formation/bridge/exception_notifier'
+require 'cloud_formation/bridge/names'
+require 'cloud_formation/bridge/resources/subscribe_queue_to_topic'
+require 'cloud_formation/bridge/resources/cloud_formation_outputs'
+
+module CloudFormation
+  module Bridge
+    class Executor
+
+      include CloudFormation::Bridge::Names
+
+      DEFAULT_REGISTRY = {
+        "Custom::SubscribeSQSQueueToSNSTopic" =>
+          CloudFormation::Bridge::Resources::SubscribeQueueToTopic.new,
+        "Custom::CloudFormationOutputs" =>
+          CloudFormation::Bridge::Resources::CloudFormationOutputs.new,
+      }
+
+      attr_reader :registry
+
+      def initialize(registry = DEFAULT_REGISTRY)
+        @registry = registry
+      end
+
+      def execute(request)
+
+        begin
+          if resource = registry[request.resource_type]
+            response = if request.create?
+              resource.create(request)
+            elsif request.update?
+              resource.update(request)
+            else
+              resource.delete(request)
+            end
+
+            request.succeed!(response)
+          else
+            request.fail!("Don't know what to do with resource #{request.resource_type}")
+          end
+        rescue => ex
+          ExceptionNotifier.report_exception(ex, request.request)
+          request.fail!(ex.message)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/http_bridge.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+module CloudFormation
+  module Bridge
+    class HttpBridge
+
+      class << self
+
+        def put(url, data)
+          connection = Faraday.new do |f|
+            f.request :json
+            f.request :retry, max: 2, interval: 0.05, interval_randomness: 0.5, backoff_factor: 2
+
+            f.response :raise_error
+            f.response :json, content_type: /javascript|json/
+
+            f.adapter :typhoeus
+          end
+
+          connection.put(url, data, 'Content-Type' => '')
+        end
+
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/names.rb

@@ -0,0 +1,34 @@
+module CloudFormation
+  module Bridge
+    module Names
+
+      module TYPES
+        UPDATE = 'Update'
+        CREATE = 'Create'
+        DELETE = 'Delete'
+        ALL = [UPDATE, CREATE, DELETE]
+      end
+
+      module RESULTS
+        SUCCESS = 'SUCCESS'
+        FAILED = 'FAILED'
+      end
+
+      module FIELDS
+        REQUEST_TYPE = 'RequestType'
+        RESPONSE_URL = 'ResponseURL'
+        STACK_ID = 'StackId'
+        REQUEST_ID = 'RequestId'
+        RESOURCE_TYPE = 'ResourceType'
+        LOGICAL_RESOURCE_ID = 'LogicalResourceId'
+        PHYSICAL_RESOURCE_ID = 'PhysicalResourceId'
+        RESOURCE_PROPERTIES = 'ResourceProperties'
+        OLD_RESOURCE_PROPERTIES = 'OldResourceProperties'
+        STATUS = 'Status'
+        REASON = 'Reason'
+        DATA = 'Data'
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/poller.rb

@@ -0,0 +1,67 @@
+require 'cloud_formation/bridge/executor'
+require 'cloud_formation/bridge/exception_notifier'
+require 'cloud_formation/bridge/request'
+require 'logger'
+
+module CloudFormation
+  module Bridge
+    class Poller
+
+      attr_reader :logger, :running
+
+      def initialize(queue_name, executor = CloudFormation::Bridge::Executor.new, logger = Logger.new(STDOUT))
+        @queue_name = queue_name
+        @executor = executor
+        @logger = logger
+      end
+
+      def start
+        @running = true
+        while @running
+          poll
+        end
+      end
+
+      def stop
+        @running = false
+      end
+
+      def poll
+        message = queue.receive_message
+
+        return unless message
+
+        begin
+          logger.info("Received message #{message.id} - #{message.body}")
+          body = JSON.parse(message.body)
+          request = CloudFormation::Bridge::Request.new(JSON.parse(body["Message"]))
+          @executor.execute(request)
+          message.delete
+          logger.info("Processed message #{message.id}")
+          message
+        rescue => ex
+          logger.info("Failed to process message #{message.id} - #{ex.message}")
+          ExceptionNotifier.report_exception(ex,
+            message: message.body,
+            handle: message.handle,
+            id: message.id,
+            queue: @queue_name,
+          )
+        end
+      end
+
+      def visible_messages
+        queue.visible_messages
+      end
+
+      def queue
+        @queue ||= sqs.queues.named(@queue_name)
+      end
+
+      def sqs
+        @sqs ||= AWS::SQS.new
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/request.rb

@@ -0,0 +1,94 @@
+require 'securerandom'
+require 'cloud_formation/bridge/http_bridge'
+require 'cloud_formation/bridge/names'
+
+module CloudFormation
+  module Bridge
+    class Request
+
+      include CloudFormation::Bridge::Names
+
+      attr_reader :request
+
+      def initialize(request)
+        @request = request
+      end
+
+      def update?
+        request_type == TYPES::UPDATE
+      end
+
+      def create?
+        request_type == TYPES::CREATE
+      end
+
+      def delete?
+        request_type == TYPES::DELETE
+      end
+
+      def request_type
+        request[FIELDS::REQUEST_TYPE]
+      end
+
+      def request_url
+        request[FIELDS::RESPONSE_URL]
+      end
+
+      def stack_id
+        request[FIELDS::STACK_ID]
+      end
+
+      def request_id
+        request[FIELDS::REQUEST_ID]
+      end
+
+      def resource_type
+        request[FIELDS::RESOURCE_TYPE]
+      end
+
+      def logical_resource_id
+        request[FIELDS::LOGICAL_RESOURCE_ID]
+      end
+
+      def physical_resource_id
+        request[FIELDS::PHYSICAL_RESOURCE_ID]
+      end
+
+      def resource_properties
+        request[FIELDS::RESOURCE_PROPERTIES]
+      end
+
+      def old_resource_properties
+        request[FIELDS::OLD_RESOURCE_PROPERTIES]
+      end
+
+      def fail!(message)
+        response = build_response(
+          FIELDS::REASON => message,
+          FIELDS::STATUS => RESULTS::FAILED
+        )
+
+        HttpBridge.put(request_url, response)
+      end
+
+      def succeed!(response)
+        HttpBridge.put(request_url, build_response(response || {}))
+      end
+
+      def build_response(response = {})
+        {
+          FIELDS::STATUS => RESULTS::SUCCESS,
+          FIELDS::PHYSICAL_RESOURCE_ID => response[FIELDS::PHYSICAL_RESOURCE_ID] || physical_resource_id || generate_physical_id,
+          FIELDS::STACK_ID => stack_id,
+          FIELDS::REQUEST_ID => request_id,
+          FIELDS::LOGICAL_RESOURCE_ID => logical_resource_id,
+        }.merge(response)
+      end
+
+      def generate_physical_id
+        "#{logical_resource_id}-#{SecureRandom.uuid}"
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/resources/base.rb

@@ -0,0 +1,31 @@
+require 'cloud_formation/bridge/names'
+
+module CloudFormation
+  module Bridge
+    module Resources
+
+      class Base
+        include CloudFormation::Bridge::Names
+
+        def require_fields(request, fields)
+          empty_fields = fields.select do |field|
+            request.resource_properties[field].nil? ||
+              request.resource_properties[field].strip.empty?
+          end
+
+          unless empty_fields.empty?
+            raise ArgumentError.new("The fields #{empty_fields.inspect} are required for this resource")
+          end
+
+        end
+
+        def update(request)
+          raise CloudFormation::Bridge::OperationNotImplementedError.new(
+            "The resource #{self.class.name} does not implement the update operation - #{request.inspect}")
+        end
+
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/resources/cloud_formation_outputs.rb

@@ -0,0 +1,44 @@
+require 'aws/cloud_formation'
+require 'cloud_formation/bridge/resources/base'
+
+module CloudFormation
+  module Bridge
+    module Resources
+
+      class CloudFormationOutputs < Base
+
+        NAME = 'Name'
+
+        def create(request)
+          require_fields(request, [NAME])
+
+          stack_name = request.resource_properties[NAME]
+
+          stack = stacks[stack_name]
+
+          outputs = stack.outputs.inject({}) do |acc,output|
+            acc[output.key] = output.value
+            acc
+          end
+
+          {
+            FIELDS::DATA => outputs,
+            FIELDS::PHYSICAL_RESOURCE_ID => stack.stack_id,
+          }
+        end
+
+        alias_method :update, :create
+
+        def delete(request)
+          # no need to do anything here
+        end
+
+        def stacks
+          @stacks ||= AWS::CloudFormation.new.stacks
+        end
+
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/resources/subscribe_queue_to_topic.rb

@@ -0,0 +1,66 @@
+require 'cloud_formation/bridge/resources/base'
+require 'aws/sns'
+require 'aws/sqs'
+
+module CloudFormation
+  module Bridge
+    module Resources
+
+      class SubscribeQueueToTopic < Base
+
+        ARN = 'Arn'
+        ENDPOINT = 'Endpoint'
+        PROTOCOL = 'Protocol'
+
+        TOPIC_ARN = 'TopicArn'
+        QUEUE_NAME = 'QueueName'
+
+        REQUIRED_FIELDS = [
+          TOPIC_ARN,
+          QUEUE_NAME,
+        ]
+
+        def create(request)
+          require_fields(request, REQUIRED_FIELDS)
+
+          queue = queues.named(request.resource_properties[QUEUE_NAME])
+          topic = topics[request.resource_properties[TOPIC_ARN]]
+
+          subscription = topic.subscribe(queue)
+
+          {
+            FIELDS::PHYSICAL_RESOURCE_ID => subscription.arn,
+            FIELDS::DATA => {
+              ARN => subscription.arn,
+              ENDPOINT => subscription.endpoint,
+              PROTOCOL => subscription.protocol,
+            },
+          }
+        end
+
+        def delete(request)
+          subscription = subscriptions[request.physical_resource_id]
+          subscription.unsubscribe if subscription && subscription.exists?
+        end
+
+        def topics
+          @topics ||= sns.topics
+        end
+
+        def subscriptions
+          @subscriptions ||= sns.subscriptions
+        end
+
+        def sns
+          @sns ||= AWS::SNS.new
+        end
+
+        def queues
+          @queues ||= AWS::SQS.new.queues
+        end
+
+      end
+
+    end
+  end
+end

data/lib/cloud_formation/bridge/version.rb

@@ -0,0 +1,5 @@
+module CloudFormation
+  module Bridge
+    VERSION = "0.0.1"
+  end
+end