chef-provisioning-aws 3.0.4 → 3.0.6

data/lib/chef/provisioning/aws_driver/aws_rds_resource.rb

@@ -1,11 +1,9 @@
-require_relative 'aws_resource'
+require_relative "aws_resource"
 
 module Chef::Provisioning::AWSDriver
-class AWSRDSResource < AWSResource
-
-  def rds_tagging_type
-    raise "You must add the RDS resource type lookup from http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"
+  class AWSRDSResource < AWSResource
+    def rds_tagging_type
+      raise "You must add the RDS resource type lookup from http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN"
+    end
   end
-
-end
 end

data/lib/chef/provisioning/aws_driver/aws_resource.rb

@@ -1,212 +1,209 @@
-require 'aws-sdk'
-require 'chef/provisioning/aws_driver/super_lwrp'
-require 'chef/provisioning/chef_managed_entry_store'
+require "aws-sdk"
+require "chef/provisioning/aws_driver/super_lwrp"
+require "chef/provisioning/chef_managed_entry_store"
 # Enough resources will eventually require this that we put 1 require in here
-require 'chef/provisioning/aws_driver/aws_taggable'
+require "chef/provisioning/aws_driver/aws_taggable"
 
 # Common AWS resource - contains metadata that all AWS resources will need
 class Chef
-module Provisioning
-module AWSDriver
-  class AWSResource < Chef::Provisioning::AWSDriver::SuperLWRP
-    actions :create, :destroy, :purge, :nothing
-    default_action :create
-
-    def initialize(name, run_context=nil)
-      name = name.public_send(self.class.aws_sdk_class_id) if name.is_a?(self.class.aws_sdk_class)
-      super
-      if run_context
-        driver run_context.chef_provisioning.current_driver
-        chef_server run_context.cheffish.current_chef_server
-      end
-    end
-
-    # Backwards compatibility for action :destroy
-    def action(*args)
-      if args == [ :delete ]
-        super(:destroy)
-      else
-        super
-      end
-    end
+  module Provisioning
+    module AWSDriver
+      class AWSResource < Chef::Provisioning::AWSDriver::SuperLWRP
+        actions :create, :destroy, :purge, :nothing
+        default_action :create
+
+        def initialize(name, run_context = nil)
+          name = name.public_send(self.class.aws_sdk_class_id) if name.is_a?(self.class.aws_sdk_class)
+          super
+          if run_context
+            driver run_context.chef_provisioning.current_driver
+            chef_server run_context.cheffish.current_chef_server
+          end
+        end
 
-    # In Chef < 12.4 we need to define this method.  In > 12.4 this method is
-    # already defined for us so we don't need to overwrite it.
-    unless defined?(:action=)
-      def action=(value)
-        action(value)
-      end
-    end
+        # Backwards compatibility for action :destroy
+        def action(*args)
+          if args == [:delete]
+            super(:destroy)
+          else
+            super
+          end
+        end
 
-    #
-    # The desired driver.
-    #
-    attribute :driver, kind_of: Chef::Provisioning::Driver,
-                       coerce: (proc do |value|
-                                 case value
-                                 when nil, Chef::Provisioning::Driver
-                                   value
-                                 else
-                                   run_context.chef_provisioning.driver_for(value)
-                                 end
-                               end)
-
-    #
-    # The Chef server on which any IDs should be looked up.
-    #
-    attribute :chef_server, kind_of: Hash
-
-    #
-    # The managed entry store.
-    #
-    attribute :managed_entry_store, kind_of: Chef::Provisioning::ManagedEntryStore,
-                                default: lazy { Chef::Provisioning::ChefManagedEntryStore.new(chef_server) }
-
-    #
-    # Get the current AWS object.  This should return the aws_object even if it has
-    # a status like 'deleted' or 'inactive'.  If there is an aws_object, we return it.
-    # Callers will need to check the status if they care.
-    #
-    def aws_object
-      raise NotImplementedError, :aws_object
-    end
+        # In Chef < 12.4 we need to define this method.  In > 12.4 this method is
+        # already defined for us so we don't need to overwrite it.
+        unless defined?(:action=)
+          def action=(value)
+            action(value)
+          end
+        end
 
-    def aws_object_id
-      @aws_object_id ||= begin
-        o = aws_object
-        o.public_send(self.class.aws_sdk_class_id) if o
-      end
-    end
+        #
+        # The desired driver.
+        #
+        attribute :driver, kind_of: Chef::Provisioning::Driver,
+                           coerce: (proc do |value|
+                                      case value
+                                      when nil, Chef::Provisioning::Driver
+                                        value
+                                      else
+                                        run_context.chef_provisioning.driver_for(value)
+                                      end
+                                    end)
+
+        #
+        # The Chef server on which any IDs should be looked up.
+        #
+        attribute :chef_server, kind_of: Hash
+
+        #
+        # The managed entry store.
+        #
+        attribute :managed_entry_store, kind_of: Chef::Provisioning::ManagedEntryStore,
+                                        default: lazy { Chef::Provisioning::ChefManagedEntryStore.new(chef_server) }
+
+        #
+        # Get the current AWS object.  This should return the aws_object even if it has
+        # a status like 'deleted' or 'inactive'.  If there is an aws_object, we return it.
+        # Callers will need to check the status if they care.
+        #
+        def aws_object
+          raise NotImplementedError, :aws_object
+        end
 
-    #
-    # Look up an AWS options list, translating standard names using the appropriate
-    # classes.
-    #
-    # For example, `load_balancer_options` is passed into `lookup_options`, and if
-    # it looks like this: `{ subnets: `[ 'subnet1', 'subnet2' ] }`, then
-    # `AWSResource.lookup_options` will translate each ID with
-    # `AwsSubnet.get_aws_object('subnet1')`, which supports Chef names
-    # (`mysubnet`) as well as AWS subnet Ids (`subnet-1234abcd`) or AWS objects
-    # (`::Aws::EC2::Subnet`).
-    #
-    # Keys that represent non-AWS-objects (such as `timeout`) are left alone.
-    #
-    def self.lookup_options(options = Hash.new, **handler_options)
-      options = options.dup
-      options.each do |name, value|
-        if name.to_s.end_with?('s')
-          handler_name = :"#{name[0..-2]}"
-          if aws_option_handlers[handler_name]
-            options[name] = [options[name]].flatten.map { |value| aws_option_handlers[handler_name].get_aws_object_id(value, **handler_options) }
+        def aws_object_id
+          @aws_object_id ||= begin
+            o = aws_object
+            o.public_send(self.class.aws_sdk_class_id) if o
           end
-        else
-          handler_name = name.to_sym
-          if aws_option_handlers[handler_name]
-            options[handler_name] = aws_option_handlers[handler_name].get_aws_object_id(value, **handler_options)
+        end
+
+        #
+        # Look up an AWS options list, translating standard names using the appropriate
+        # classes.
+        #
+        # For example, `load_balancer_options` is passed into `lookup_options`, and if
+        # it looks like this: `{ subnets: `[ 'subnet1', 'subnet2' ] }`, then
+        # `AWSResource.lookup_options` will translate each ID with
+        # `AwsSubnet.get_aws_object('subnet1')`, which supports Chef names
+        # (`mysubnet`) as well as AWS subnet Ids (`subnet-1234abcd`) or AWS objects
+        # (`::Aws::EC2::Subnet`).
+        #
+        # Keys that represent non-AWS-objects (such as `timeout`) are left alone.
+        #
+        def self.lookup_options(options = {}, **handler_options)
+          options = options.dup
+          options.each do |name, value|
+            if name.to_s.end_with?("s")
+              handler_name = :"#{name[0..-2]}"
+              if aws_option_handlers[handler_name]
+                options[name] = [options[name]].flatten.map { |value| aws_option_handlers[handler_name].get_aws_object_id(value, **handler_options) }
+              end
+            else
+              handler_name = name.to_sym
+              if aws_option_handlers[handler_name]
+                options[handler_name] = aws_option_handlers[handler_name].get_aws_object_id(value, **handler_options)
+              end
+            end
           end
+          options
         end
-      end
-      options
-    end
 
-    def self.get_aws_object(value, resource: nil, run_context: nil, driver: nil, managed_entry_store: nil, required: true)
-      return nil if value.nil?
+        def self.get_aws_object(value, resource: nil, run_context: nil, driver: nil, managed_entry_store: nil, required: true)
+          return nil if value.nil?
 
-      if resource
-        run_context         ||= resource.run_context
-        driver              ||= resource.driver
-        managed_entry_store ||= resource.managed_entry_store
-      end
-      if value.is_a?(self)
-        resource = value
-      else
-        resource = new(value, run_context)
-        resource.driver driver if driver
-        resource.managed_entry_store managed_entry_store if managed_entry_store
-      end
+          if resource
+            run_context         ||= resource.run_context
+            driver              ||= resource.driver
+            managed_entry_store ||= resource.managed_entry_store
+          end
+          if value.is_a?(self)
+            resource = value
+          else
+            resource = new(value, run_context)
+            resource.driver driver if driver
+            resource.managed_entry_store managed_entry_store if managed_entry_store
+          end
 
-      result = resource.aws_object
-      if required && result.nil?
-        raise "#{self}[#{value}] does not exist!"
-      end
-      result
-    end
+          result = resource.aws_object
+          raise "#{self}[#{value}] does not exist!" if required && result.nil?
+          result
+        end
 
-    def self.get_aws_object_id(value, **options)
-      aws_object = get_aws_object(value, **options)
-      aws_object.public_send(aws_sdk_class_id) if aws_object
-    end
+        def self.get_aws_object_id(value, **options)
+          aws_object = get_aws_object(value, **options)
+          aws_object.public_send(aws_sdk_class_id) if aws_object
+        end
 
-    protected
-
-    # This supports the introduction of the NOT_PASSED chef constant
-    # in chef 12.5
-    # TODO remove when we make 12.5 and higher a dependency
-    NOT_PASSED = Object.new unless defined?(NOT_PASSED)
-
-    def self.aws_sdk_type(sdk_class,
-                          option_names: nil,
-                          option_name: NOT_PASSED,
-                          load_provider: true,
-                          id: :name,
-                          aws_id_prefix: nil)
-      self.resource_name = convert_to_snake_case(self.name.split('::')[-1])
-      @aws_sdk_class = sdk_class
-      @aws_sdk_class_id = id
-      @aws_id_prefix = aws_id_prefix
-
-      # Go ahead and require the provider since we're here anyway ...
-      require "chef/provider/#{resource_name}" if load_provider
-
-      option_name = :"#{resource_name[4..-1]}" if option_name == NOT_PASSED
-      @aws_sdk_option_name = option_name
-
-      option_names ||= begin
-        option_names = []
-        option_names << aws_sdk_option_name
-        option_names << :"#{option_name}_#{aws_sdk_class_id}" if aws_sdk_class_id
-        option_names
-      end
-      option_names.each do |option_name|
-        aws_option_handlers[option_name] = self
-      end
+        protected
+
+        # This supports the introduction of the NOT_PASSED chef constant
+        # in chef 12.5
+        # TODO remove when we make 12.5 and higher a dependency
+        NOT_PASSED = Object.new unless defined?(NOT_PASSED)
+
+        def self.aws_sdk_type(sdk_class,
+                              option_names: nil,
+                              option_name: NOT_PASSED,
+                              load_provider: true,
+                              id: :name,
+                              aws_id_prefix: nil)
+          self.resource_name = convert_to_snake_case(name.split("::")[-1])
+          @aws_sdk_class = sdk_class
+          @aws_sdk_class_id = id
+          @aws_id_prefix = aws_id_prefix
+
+          # Go ahead and require the provider since we're here anyway ...
+          require "chef/provider/#{resource_name}" if load_provider
+
+          option_name = :"#{resource_name[4..-1]}" if option_name == NOT_PASSED
+          @aws_sdk_option_name = option_name
+
+          option_names ||= begin
+            option_names = []
+            option_names << aws_sdk_option_name
+            option_names << :"#{option_name}_#{aws_sdk_class_id}" if aws_sdk_class_id
+            option_names
+          end
+          option_names.each do |option_name|
+            aws_option_handlers[option_name] = self
+          end
 
-      name = self.name.split('::')[-1]
-      eval("Chef::Provisioning::AWSDriver::Resources::#{name} = self", binding, __FILE__, __LINE__)
-    end
+          name = self.name.split("::")[-1]
+          eval("Chef::Provisioning::AWSDriver::Resources::#{name} = self", binding, __FILE__, __LINE__)
+        end
 
-    def self.aws_sdk_class
-      @aws_sdk_class
-    end
+        class << self
+          attr_reader :aws_sdk_class
+        end
 
-    def self.aws_sdk_class_id
-      @aws_sdk_class_id
-    end
+        class << self
+          attr_reader :aws_sdk_class_id
+        end
 
-    def self.aws_id_prefix
-      @aws_id_prefix
-    end
+        class << self
+          attr_reader :aws_id_prefix
+        end
 
-    def self.aws_sdk_option_name
-      @aws_sdk_option_name
-    end
+        class << self
+          attr_reader :aws_sdk_option_name
+        end
 
-    @@aws_option_handlers = {}
-    def self.aws_option_handlers
-      @@aws_option_handlers
-    end
+        @@aws_option_handlers = {}
+        def self.aws_option_handlers
+          @@aws_option_handlers
+        end
 
-    # Add support for aws_id_attribute: true
-    def self.attribute(name, aws_id_attribute: false, **validation_opts)
-      @aws_id_attribute = name if aws_id_attribute
-      super(name, validation_opts)
-    end
+        # Add support for aws_id_attribute: true
+        def self.attribute(name, aws_id_attribute: false, **validation_opts)
+          @aws_id_attribute = name if aws_id_attribute
+          super(name, validation_opts)
+        end
 
-    def self.aws_id_attribute
-      @aws_id_attribute
+        class << self
+          attr_reader :aws_id_attribute
+        end
+      end
     end
   end
-
-end
-end
 end

data/lib/chef/provisioning/aws_driver/aws_resource_with_entry.rb

@@ -1,9 +1,8 @@
-require 'chef/provisioning/aws_driver/aws_resource'
-require 'chef/provisioning/aws_driver/resources'
+require "chef/provisioning/aws_driver/aws_resource"
+require "chef/provisioning/aws_driver/resources"
 
 # Common AWS resource - contains metadata that all AWS resources will need
 class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::AWSDriver::AWSResource
-
   #
   # Dissociate the ID of this object from Chef.
   #
@@ -31,11 +30,9 @@ class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::
   def save_managed_entry(aws_object, action_handler, existing_entry: nil)
     if should_have_managed_entry?
       managed_entry = existing_entry ||
-                      managed_entry_store.new_entry(self.class.managed_entry_type, name)
+        managed_entry_store.new_entry(self.class.managed_entry_type, name)
       updated = update_managed_entry(aws_object, managed_entry)
-      if updated || !existing_entry
-        managed_entry.save(action_handler)
-      end
+      managed_entry.save(action_handler) if updated || !existing_entry
     end
   end
 
@@ -45,11 +42,11 @@ class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::
       if entry
         driver = self.driver
         if entry.driver_url != driver.driver_url
-          # TODO some people don't send us run_context (like Drivers).  We might need
+          # TODO: some people don't send us run_context (like Drivers).  We might need
           # to exit early here if the driver_url doesn't match the provided driver.
           driver = run_context.chef_provisioning.driver_for(entry.driver_url)
         end
-        [ driver, entry.reference[self.class.managed_entry_id_name], entry ]
+        [driver, entry.reference[self.class.managed_entry_id_name], entry]
       end
     end
   end
@@ -57,7 +54,7 @@ class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::
   # Formatted output for logging statements - contains resource type, resource name and aws object id (if available)
   def to_s
     id = get_driver_and_id[1]
-    "#{declared_type}[#{@name}] (#{ id ? id : 'no AWS object id'})"
+    "#{declared_type}[#{@name}] (#{id || 'no AWS object id'})"
   end
 
   protected
@@ -83,14 +80,17 @@ class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::
   def get_driver_and_id
     driver, id, entry = get_id_from_managed_entry
     # If the value isn't already stored, look up the user-specified public_ip
-    driver, id = self.driver, self.public_send(self.class.aws_id_attribute) if !id
-    [ driver, id ]
+    unless id
+      driver = self.driver
+      id = public_send(self.class.aws_id_attribute)
+    end
+    [driver, id]
   end
 
   def self.aws_sdk_type(sdk_class,
                         id: :id,
                         managed_entry_type: nil,
-                        managed_entry_id_name: 'id',
+                        managed_entry_id_name: "id",
                         backcompat_data_bag_name: nil,
                         **options)
     super(sdk_class, id: id, **options)
@@ -101,12 +101,12 @@ class Chef::Provisioning::AWSDriver::AWSResourceWithEntry < Chef::Provisioning::
     end
   end
 
-  def self.managed_entry_type
-    @managed_entry_type
+  class << self
+    attr_reader :managed_entry_type
   end
 
-  def self.managed_entry_id_name
-    @managed_entry_id_name
+  class << self
+    attr_reader :managed_entry_id_name
   end
 
   def should_have_managed_entry?