humidifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49e71afc90f25c69c4186ef0d296bb6a4709c8c4
-  data.tar.gz: 249d24a729f0d5c92dee6987eefc974c6ff947c6
+  metadata.gz: 9de50c50176d088372a188ac60aea7e4087f2389
+  data.tar.gz: f613c462e5ee7ed74403409d7b6b82ff87eb4632
 SHA512:
-  metadata.gz: b483ce9400693c726c93a8a50aa703fc446d2dc20d7efa8c7dd03a3ad1e10f13ccc1a030679103ef0c05fd701b423a7d592b1d37dec0d0f18f41e4c1cc52160b
-  data.tar.gz: 244bf6664b9b54a2ecf69d72a19df94d10c65e464fc0912f12773d7729e9417816eabe25b6b38bbcb53274c093a66088eb1adaaeed927f70b36ff5ef53dcb274
+  metadata.gz: 9c7fcc5768d0f2a7d2cbeefbb3f6a3497a5977542e1990d9d811284b72a5f04d9ffc1bd45c153a4a4dcd4ac6a281c3f5ff3fc46af38bbf006ba75bb59e2c100a
+  data.tar.gz: 586ecf805909463042c9310272bd348a5c8c33273fc5860115151644a2297496e8db7f35489b73c59eb009f0b121a755e0febd0d9f8d037125573d78120d5bd0

data/README.md

@@ -59,6 +59,17 @@ Humidifier itself contains a registry of all possible resources that it supports
 
 Resources have an `aws_name` method to see how AWS references them. They also contain a `props` method that contains a hash of the name that Humidifier uses to reference the prop pointing to the appropriate prop object.
 
+### Large templates
+
+When templates are especially large (larger than 51,200 bytes), they cannot be uploaded directly through the AWS SDK. You can configure Humidifier to seemlessly upload the templates to S3 and reference them using an S3 URL instead by:
+
+```ruby
+Humidifier.configure do |config|
+  config.s3_bucket = 'my.s3.bucket'
+  config.s3_prefix = 'my-prefix/' # optional
+end
+```
+
 ## Development
 
 To get started, ensure you have ruby installed, version 2.0 or later. From there, install the `bundler` gem: `gem install bundler` and then `bundle install` in the root of the repository.

data/lib/humidifier/aws_adapters/base.rb

@@ -9,8 +9,7 @@ module Humidifier
       # Create a CFN stack
       def create(payload)
         try_valid do
-          params = { stack_name: payload.name, template_body: payload.to_cf }.merge(payload.options)
-          response = client.create_stack(params)
+          response = client.create_stack(payload.create_params)
           payload.id = response.stack_id
           response
         end
@@ -18,7 +17,7 @@ module Humidifier
 
       # Delete a CFN stack
       def delete(payload)
-        client.delete_stack({ stack_name: payload.identifier }.merge(payload.options))
+        client.delete_stack(payload.delete_params)
         true
       end
 
@@ -29,15 +28,18 @@ module Humidifier
 
       # Update a CFN stack
       def update(payload)
-        try_valid do
-          params = { stack_name: payload.identifier, template_body: payload.to_cf }.merge(payload.options)
-          client.update_stack(params)
-        end
+        try_valid { client.update_stack(payload.update_params) }
+      end
+
+      # Upload a CFN stack to S3 so that it can be referenced via template_url
+      def upload(payload)
+        Humidifier.config.ensure_upload_configured!(payload)
+        upload_object(payload, "#{Humidifier.config.s3_prefix}#{payload.identifier}.json")
       end
 
       # Validate a template in CFN
       def valid?(payload)
-        try_valid { client.validate_template({ template_body: payload.to_cf }.merge(payload.options)) }
+        try_valid { client.validate_template(payload.validate_params) }
       end
 
       %i[create delete deploy update].each do |method|

data/lib/humidifier/aws_adapters/sdkv1.rb

@@ -47,6 +47,12 @@ module Humidifier
         response
       end
 
+      def upload_object(payload, key)
+        base_module.config(region: AwsShim::REGION)
+        @s3 ||= base_module::S3.new
+        @s3.buckets[Humidifier.config.s3_bucket].objects.create(key, payload.template_body).url_for(:read)
+      end
+
       def unsupported(method)
         puts "WARNING: Cannot #{method} because that functionality is not supported in V1 of aws-sdk."
         false

data/lib/humidifier/aws_adapters/sdkv2.rb

@@ -7,8 +7,7 @@ module Humidifier
       # Create a change set in CFN
       def create_change_set(payload)
         payload.merge(change_set_name: "changeset-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}")
-        params = { stack_name: payload.identifier, template_body: payload.to_cf }.merge(payload.options)
-        try_valid { client.create_change_set(params) }
+        try_valid { client.create_change_set(payload.create_change_set_params) }
       end
 
       # Create a change set if the stack exists, otherwise create the stack
@@ -38,6 +37,13 @@ module Humidifier
 
         response
       end
+
+      def upload_object(payload, key)
+        base_module.config.update(region: AwsShim::REGION)
+        @s3_client ||= base_module::S3::Client.new
+        @s3_client.put_object(body: payload.template_body, bucket: Humidifier.config.s3_bucket, key: key)
+        base_module::S3::Object.new(Humidifier.config.s3_bucket, key).presigned_url(:get)
+      end
     end
   end
 end

data/lib/humidifier/aws_shim.rb

@@ -13,7 +13,7 @@ module Humidifier
 
     # Methods that are sent over to the aws adapter from the stack
     STACK_METHODS = %i[
-      create delete deploy exists? update valid?
+      create delete deploy exists? update upload valid?
       create_and_wait delete_and_wait deploy_and_wait update_and_wait
       create_change_set deploy_change_set
     ].freeze

data/lib/humidifier/configuration.rb

@@ -0,0 +1,29 @@
+module Humidifier
+
+  # a container for user params
+  class Configuration
+
+    UPLOAD_MESSAGE = <<-MSG.freeze
+The %{identifier} stack's body is too large to be use the template_body option, and therefore must use the
+template_url option instead. You can configure Humidifier to do this automatically by setting up the s3 config
+on the top-level Humidifier object like so:
+
+    Humidifier.configure do |config|
+      config.s3_bucket = 'my.s3.bucket'
+      config.s3_prefix = 'my-prefix/' # optional
+    end
+MSG
+
+    attr_accessor :s3_bucket, :s3_prefix
+
+    def initialize(opts = {})
+      self.s3_bucket = opts[:s3_bucket]
+      self.s3_prefix = opts[:s3_prefix]
+    end
+
+    # raise an error unless the s3_bucket field is set
+    def ensure_upload_configured!(payload)
+      raise UPLOAD_MESSAGE.gsub('%{identifier}', payload.identifier) if s3_bucket.nil?
+    end
+  end
+end

data/lib/humidifier/sdk_payload.rb

@@ -3,13 +3,30 @@ module Humidifier
   # The payload sent to the shim methods, representing the stack and the options
   class SdkPayload
 
+    # The maximum size a template body can be before it has to be put somewhere and referenced through a URL
+    MAX_TEMPLATE_BODY_SIZE = 51_200
+
+    # The maximum size a template body can be inside of an S3 bucket
+    MAX_TEMPLATE_URL_SIZE = 460_800
+
     # The maximum amount of time that Humidifier should wait for a stack to complete a CRUD operation
     MAX_WAIT = 600
 
+    # Thrown when a template is too large to use the template_url option
+    class TemplateTooLargeError < StandardError
+      def initialize(bytesize)
+        message = <<-MSG
+Cannot use a template > #{MAX_TEMPLATE_URL_SIZE} bytes (currently #{bytesize} bytes), consider using nested stacks
+(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html)
+MSG
+        super(message)
+      end
+    end
+
     attr_accessor :stack, :options, :max_wait
 
     extend Forwardable
-    def_delegators :stack, :id=, :identifier, :name, :to_cf
+    def_delegators :stack, :id=, :identifier, :name
 
     def initialize(stack, options)
       self.stack    = stack
@@ -26,5 +43,53 @@ module Humidifier
     def merge(new_options)
       self.options = new_options.merge(options)
     end
+
+    # The body of the template
+    def template_body
+      @template_body ||= stack.to_cf
+    end
+
+    ###
+    # Param sets
+    ###
+
+    # Param set for the #create_change_set SDK method
+    def create_change_set_params
+      { stack_name: stack.identifier }.merge(template_param).merge(options)
+    end
+
+    # Param set for the #create_stack SDK method
+    def create_params
+      { stack_name: stack.name }.merge(template_param).merge(options)
+    end
+
+    # Param set for the #delete_stack SDK method
+    def delete_params
+      { stack_name: stack.identifier }.merge(options)
+    end
+
+    # Param set for the #update_stack SDK method
+    def update_params
+      { stack_name: stack.identifier }.merge(template_param).merge(options)
+    end
+
+    # Param set for the #validate_template SDK method
+    def validate_params
+      template_param.merge(options)
+    end
+
+    private
+
+    def template_param
+      @template_param ||= begin
+        raise TemplateTooLargeError, template_body.bytesize if template_body.bytesize > MAX_TEMPLATE_URL_SIZE
+
+        if template_body.bytesize > MAX_TEMPLATE_BODY_SIZE
+          { template_url: AwsShim.upload(self) }
+        else
+          { template_body: template_body }
+        end
+      end
+    end
   end
 end

data/lib/humidifier/stack.rb

@@ -14,6 +14,7 @@ module Humidifier
     def initialize(opts = {})
       self.name = opts[:name]
       self.id   = opts[:id]
+      self.default_identifier = self.class.next_default_identifier
 
       ENUMERABLE_RESOURCES.values.each { |prop| send(:"#{prop}=", opts.fetch(prop, {})) }
       STATIC_RESOURCES.values.each { |prop| send(:"#{prop}=", opts[prop]) }
@@ -28,7 +29,7 @@ module Humidifier
 
     # The identifier used by the shim to find the stack in CFN, prefers id to name
     def identifier
-      id || name
+      id || name || default_identifier
     end
 
     # A string representation of the stack that's valid for CFN
@@ -46,8 +47,16 @@ module Humidifier
       define_method(method) { |opts = {}| AwsShim.send(method, SdkPayload.new(self, opts)) }
     end
 
+    # Increment the default identifier
+    def self.next_default_identifier
+      @count = (@count || 0) + 1
+      "humidifier-stack-template-#{@count}"
+    end
+
     private
 
+    attr_accessor :default_identifier
+
     def enumerable_resources
       ENUMERABLE_RESOURCES.each_with_object({}) do |(name, prop), list|
         resources = send(prop)

data/lib/humidifier/version.rb

@@ -1,4 +1,4 @@
 module Humidifier
   # Gem version
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/humidifier.rb

@@ -11,6 +11,7 @@ require 'humidifier/props'
 
 require 'humidifier/aws_shim'
 require 'humidifier/condition'
+require 'humidifier/configuration'
 require 'humidifier/loader'
 require 'humidifier/mapping'
 require 'humidifier/output'
@@ -25,6 +26,16 @@ require 'humidifier/version'
 # container module for all gem classes
 module Humidifier
   class << self
+    # the configuration instance
+    def config
+      @config ||= Configuration.new
+    end
+
+    # yield the config object to the block for setting user params
+    def configure
+      yield config
+    end
+
     # convenience method for calling cloudformation functions
     def fn
       Fn

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humidifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Localytics
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,7 @@ files:
 - lib/humidifier/aws_adapters/sdkv2.rb
 - lib/humidifier/aws_shim.rb
 - lib/humidifier/condition.rb
+- lib/humidifier/configuration.rb
 - lib/humidifier/fn.rb
 - lib/humidifier/humidifier.bundle
 - lib/humidifier/loader.rb