aws_cloudformation_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2557da5d307726c403d35dfda7173c9c17d3400c513c017bf6d055f2262a4f0
+  data.tar.gz: 1bc54b9ea4df94a1a199528fa58e49c7aa4069e01c304823d361e4326c6e986c
+SHA512:
+  metadata.gz: 53fc752f5b5af740aec1269900d9919cadc980552f9cdc514552ace3dc4f70656736606afbcd38e5ed5101df51b6d809957f790486ffb314869ca40580d496fd
+  data.tar.gz: 8f47f9b95aca6765eeab448158b45e4f699a53e8eaa0aa18226775a7edaa82e6af4988eb5935c512a1090d1461773e65d2a4698c71bc5cf9ef31e075c4bf4c19

data/.gitignore

@@ -0,0 +1,60 @@
+*.gem
+*.rbc
+*.zip
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+Gemfile.lock
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,12 @@
+dist: xenial
+language: ruby
+cache: bundler
+
+rvm:
+- 2.4.5
+- 2.5.4
+- 2.6.2
+
+script:
+- bundle exec rubocop .
+- bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# aws_cloudformation_helper Changelog
+
+## 0.1.0
+Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in aws_cloudformation_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jeffrey Coe
+
+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,95 @@
+# aws_cloudformation_helper
+[![Build Status](https://travis-ci.org/jeffreycoe/aws_cloudformation_helper.svg?branch=master)](https://travis-ci.org/jeffreycoe/aws_cloudformation_helper)
+[![GitHub](https://img.shields.io/github/license/jeffreycoe/aws_cloudformation_helper)](https://github.com/jeffreycoe/aws_cloudformation_helper/blob/master/LICENSE.txt)
+
+This Ruby gem is to assist with the development of custom resources for CloudFormation using the Ruby runtime.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws_cloudformation_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aws_cloudformation_helper
+
+## Usage
+
+Install this gem into your Lambda environment using bundle install or by bundling this gem in a Lambda layer.
+
+Once the Ruby gem is installed, use the code template below for the main Lambda function to begin:
+```ruby
+require 'aws_cloudformation_helper'
+
+def create
+  # Add code to handle CloudFormation Create event
+end
+
+def delete
+  # Add code to handle CloudFormation Delete event
+end
+
+def update
+  # Add code to handle CloudFormation Update event
+end
+
+def lambda_handler(event:, context:)
+  # Initializes CloudFormation Helper library
+  @cfn_helper = AWS::CloudFormation::Helper.new(self, event, context)
+
+  # Add additional initialization code here
+
+  # Executes the event
+  @cfn_helper.event.execute
+end
+```
+
+The `create`, `delete`, and `update` methods will send a success response to CloudFormation when the method finishes executing, and a failure response will be sent when exceptions are raised.
+
+### Logging
+By default, the logging level is set to :info. To enable another logging level, add a line to the initialization section of the lambda_handler function.  The logger is the standard Ruby logger provided by the Ruby stdlib. 
+
+The stdout and stderr variables can be reassigned to store log entries in another stream or file. By default, the default logger logs to STDOUT and the error logger (only for logger.error messages) logs to STDERR.
+
+See more info here: https://ruby-doc.org/stdlib-2.7.0/libdoc/logger/rdoc/Logger.html
+
+Below is a sample code block on enabling debug logging and redirecting stdout/stderr:
+```ruby
+def lambda_handler(event:, context:)
+  # Initializes CloudFormation Helper library
+  @cfn_helper = AWS::CloudFormation::Helper.new(self, event, context)
+
+  # Add additional initialization code here
+  @cfn_helper.logger.log_level = :debug
+  @cfn_helper.logger.stdout = $stdout
+  @cfn_helper.logger.stderr = $stderr
+
+  # Executes the event
+  @cfn_helper.event.execute
+end
+```
+
+### Event and Context
+
+The event data and context object are available from the `@cfn_helper` variable in the main class.  Access this data by calling `@cfn_helper.event` and `@cfn_helper.context`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jeffreycoe/aws_cloudformation_helper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/aws_cloudformation_helper.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_cloudformation_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aws_cloudformation_helper'
+  spec.version       = AWS::CloudFormation::Helper::Version::GEM_VERSION
+  spec.authors       = ['Jeffrey Coe']
+
+  spec.summary       = 'Assists with the development of custom resources for AWS CloudFormation using the Ruby runtime'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/jeffreycoe/aws_cloudformation_helper'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the allowed_push_host
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/jeffreycoe/aws_cloudformation_helper'
+    spec.metadata['changelog_uri'] = 'https://github.com/jeffreycoe/aws_cloudformation_helper/CHANGELOG.md'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.79'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'aws/cloudformation/helper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aws_cloudformation_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'aws_cloudformation_helper/event'
+require 'aws_cloudformation_helper/logger'
+require 'aws_cloudformation_helper/response'
+require 'aws_cloudformation_helper/version'
+
+module AWS
+  module CloudFormation
+    # Main module
+    class Helper
+      attr_reader :event
+      attr_reader :context
+
+      def initialize(lambda_class, event, context)
+        # Ruby context object: https://docs.aws.amazon.com/lambda/latest/dg/ruby-context.html
+        @context = context
+
+        # Initialize event object
+        @event = Event.new(event, lambda_class.method(:create),
+                           lambda_class.method(:delete), lambda_class.method(:update))
+        Event.instance = @event
+      end
+
+      def self.logger
+        @logger ||= Logger.new
+        @logger
+      end
+
+      def logger
+        self.class.logger
+      end
+    end
+  end
+end

data/lib/aws_cloudformation_helper/event.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module AWS
+  module CloudFormation
+    class Helper
+      # Creates an Event object based on the event data from CloudFormation
+      class Event
+        class << self
+          attr_accessor :instance
+        end
+
+        attr_reader :logical_resource_id
+        attr_reader :physical_resource_id
+        attr_reader :resource_properties
+        attr_reader :resource_type
+        attr_reader :response_url
+        attr_reader :request_id
+        attr_reader :request_type
+        attr_reader :stack_id
+
+        def initialize(event, create_method, delete_method, update_method)
+          parse_event_data(event)
+
+          @cfn_response = AWS::CloudFormation::Helper::Response.new
+          @create_method = create_method
+          @delete_method = delete_method
+          @update_method = update_method
+        end
+
+        def execute
+          Helper.logger.debug("Request Type: #{@request_type}")
+
+          case @request_type.downcase
+          when 'create'
+            execute_create
+          when 'delete'
+            execute_delete
+          when 'update'
+            execute_update
+          else
+            err_msg = "Invalid request type specified. Request Type: #{@request_type}"
+            Helper.logger.error(err_msg)
+            @cfn_response.failure(err_msg)
+            raise err_msg
+          end
+        end
+
+        def execute_create
+          Helper.logger.info('Executing method for create event')
+
+          @create_method.call
+          @cfn_response.success
+        rescue StandardError => e
+          @cfn_response.failure(e)
+          raise e
+        end
+
+        def execute_delete
+          Helper.logger.info('Executing method for delete event')
+
+          @delete_method.call
+          @cfn_response.success
+        rescue StandardError => e
+          @cfn_response.failure(e)
+          raise e
+        end
+
+        def execute_update
+          Helper.logger.info('Executing method for update event')
+
+          @update_method.call
+          @cfn_response.success
+        rescue StandardError => e
+          @cfn_response.failure(e)
+          raise e
+        end
+
+        private
+
+        def parse_event_data(event)
+          raise 'The event object from Lambda is nil.' if event.nil?
+
+          @logical_resource_id = event['LogicalResourceId'].to_s
+          @physical_resource_id = event['PhysicalResourceId'] if event.keys.include?('PhysicalResourceId')
+          @resource_properties = event['ResourceProperties']
+          @resource_type = event['ResourceType'].to_s
+          @response_url = event['ResponseURL'].to_s
+          @request_id = event['RequestId'].to_s
+          @request_type = event['RequestType'].to_s
+          @stack_id = event['StackId'].to_s
+        end
+
+        def valid_json?(json)
+          ::JSON.parse(json)
+          true
+        rescue ::JSON::ParserError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aws_cloudformation_helper/logger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module AWS
+  module CloudFormation
+    class Helper
+      # Main class to handle logging
+      class Logger
+        # https://docs.aws.amazon.com/lambda/latest/dg/ruby-logging.html
+        DEFAULT_LOG_LEVEL = :info
+
+        attr_accessor :log_level
+        attr_accessor :stdout
+        attr_accessor :stderr
+
+        def initialize(log_level = nil, stdout = STDOUT, stderr = STDERR)
+          @log_level = DEFAULT_LOG_LEVEL
+          @log_level = log_level unless log_level.nil?
+          @stdout = stdout
+          @stderr = stderr
+        end
+
+        def error(msg)
+          error_logger.error(msg)
+        end
+
+        def info(msg)
+          logger.info(msg)
+        end
+
+        def warn(msg)
+          logger.warn(msg)
+        end
+
+        def debug(msg)
+          logger.debug(msg)
+        end
+
+        private
+
+        def logger
+          @logger ||= ::Logger.new(@stdout)
+          @logger.level = @log_level
+          @logger
+        end
+
+        def error_logger
+          @logger ||= ::Logger.new(@stderr)
+          @logger.level = @log_level
+          @logger
+        end
+      end
+    end
+  end
+end

data/lib/aws_cloudformation_helper/response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+module AWS
+  module CloudFormation
+    class Helper
+      # Handles sending a response to CloudFormation
+      class Response
+        # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html
+        FAILURE_STATUS = 'FAILED'
+        HTTP_MAX_RETRIES = 3
+        SUCCESS_STATUS = 'SUCCESS'
+
+        def initialize
+          @http_retries = 1
+        end
+
+        def failure(reason = '')
+          Helper.logger.info("Sending #{FAILURE_STATUS} response to CloudFormation")
+          status_code = send_response('PUT', Event.instance.response_url, provider_response(FAILURE_STATUS, reason))
+          err_msg = "Failed to send failure message to CloudFormation pre-signed S3 URL. RC: #{status_code}"
+          raise err_msg if status_code > 400
+        end
+
+        def send_response(method, response_url, body = nil)
+          uri = ::URI.parse(response_url)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == 'https')
+          request = http_request(method, uri, body)
+
+          Helper.logger.debug("Sending #{method} request to URL #{response_url}...")
+          response = http.request(request)
+
+          Helper.logger.debug("HTTP Response: #{response.inspect}")
+          response.code.to_i
+        rescue StandardError => e
+          err_msg = 'Failed to send response to CloudFormation pre-signed S3 URL. '\
+          "(Attempt #{@http_retries} of #{HTTP_MAX_RETRIES}) Error Details: #{e}"
+          Helper.logger.error(err_msg)
+          retry if (@http_retries += 1) <= HTTP_MAX_RETRIES
+          @http_retries = 1
+          err_msg = 'Reached max retry attempts and failed to send message to CloudFormation pre-signed S3 URL.'
+          Helper.logger.error(err_msg)
+          raise e
+        end
+
+        def success(reason = '')
+          Helper.logger.info("Sending #{SUCCESS_STATUS} response to CloudFormation")
+          status_code = send_response('PUT', Event.instance.response_url, provider_response(SUCCESS_STATUS, reason))
+          err_msg = "Failed to send success message to CloudFormation pre-signed S3 URL. RC: #{status_code}"
+          raise err_msg if status_code > 400
+        end
+
+        private
+
+        def http_request(method, uri, body)
+          case method.upcase
+          when 'PUT'
+            request = Net::HTTP::Put.new(uri)
+            request.body = body.to_json
+            request['Content-Type'] = 'application/json'
+          else
+            Helper.logger.error("Invalid HTTP method specified. Method: #{method}")
+          end
+
+          request
+        end
+
+        def physical_resource_id
+          id = generate_physical_id
+          id = Event.instance.physical_resource_id unless Event.instance.physical_resource_id.to_s.empty?
+          id
+        end
+
+        def generate_physical_id
+          random_string = 8.times.map { [*'0'..'9', *'a'..'z'].sample }.join
+          "#{Event.instance.stack_id.split('/')[1]}_#{Event.instance.logical_resource_id}_#{random_string.downcase}"
+        end
+
+        def provider_response(status, reason)
+          {
+            Status: status,
+            Reason: reason.to_s,
+            PhysicalResourceId: physical_resource_id,
+            StackId: Event.instance.stack_id,
+            RequestId: Event.instance.request_id,
+            LogicalResourceId: Event.instance.logical_resource_id,
+            Data: {
+              Result: 'OK'
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/aws_cloudformation_helper/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module AWS
+  module CloudFormation
+    class Helper
+      module Version
+        GEM_VERSION = '0.1.0'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: aws_cloudformation_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeffrey Coe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+description: Assists with the development of custom resources for AWS CloudFormation
+  using the Ruby runtime
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws_cloudformation_helper.gemspec
+- bin/console
+- bin/setup
+- lib/aws_cloudformation_helper.rb
+- lib/aws_cloudformation_helper/event.rb
+- lib/aws_cloudformation_helper/logger.rb
+- lib/aws_cloudformation_helper/response.rb
+- lib/aws_cloudformation_helper/version.rb
+homepage: https://github.com/jeffreycoe/aws_cloudformation_helper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jeffreycoe/aws_cloudformation_helper
+  source_code_uri: https://github.com/jeffreycoe/aws_cloudformation_helper
+  changelog_uri: https://github.com/jeffreycoe/aws_cloudformation_helper/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Assists with the development of custom resources for AWS CloudFormation using
+  the Ruby runtime
+test_files: []