chef-provisioning 0.19 → 0.20

data/lib/chef/provisioning/load_balancer_spec.rb

@@ -1,79 +1,14 @@
+require 'chef/provisioning/managed_entry'
+
 class Chef
 module Provisioning
   #
-  # Specification for a machine. Sufficient information to find and contact it
+  # Specification for a image. Sufficient information to find and contact it
   # after it has been set up.
   #
-  # TODO: This is pretty similar to image_spec, generalize this.
-  class LoadBalancerSpec
-    def initialize(load_balancer_data)
-      @load_balancer_data = load_balancer_data
-      # Upgrade from metal to chef_provisioning ASAP.
-      if @load_balancer_data['normal'] && !@load_balancer_data['normal']['chef_provisioning'] && @load_balancer_data['normal']['metal']
-        @load_balancer_data['normal']['chef_provisioning'] = @load_balancer_data['normal'].delete('metal')
-      end
-    end
-
-    attr_reader :load_balancer_data
-    attr_reader :machines
-
-    #
-    # Globally unique identifier for this machine. Does not depend on the machine's
-    # location or existence.
-    #
-    def id
-      raise "id unimplemented"
-    end
-
-    #
-    # Name of the machine. Corresponds to the name in "machine 'name' do" ...
-    #
-    def name
-      load_balancer_data['id']
-    end
-
-    #
-    # Location of this machine. This should be a freeform hash, with enough
-    # information for the driver to look it up and create a Machine object to
-    # access it.
-    #
-    # This MUST include a 'driver_url' attribute with the driver's URL in it.
-    #
-    # chef-provisioning will do its darnedest to not lose this information.
-    #
-    def location
-      load_balancer_data['location']
-    end
-
-    #
-    # Set the location for this machine.
-    #
-    def location=(value)
-      load_balancer_data['location'] =  value
-    end
-
-    # URL to the driver.  Convenience for location['driver_url']
-    def driver_url
-      location ? location['driver_url'] : nil
-    end
-
-
-    def machines
-      load_balancer_data['machines'] || []
-    end
-
-    def machines=(value)
-      load_balancer_data['machines'] = value
-    end
-
-    #
-    # Save this node to the server.  If you have significant information that
-    # could be lost, you should do this as quickly as possible.  Data will be
-    # saved automatically for you after allocate_machine and ready_machine.
-    #
-    def save(action_handler)
-      raise "save unimplemented"
-    end
+  class LoadBalancerSpec < ManagedEntry
+    alias :location :reference
+    alias :location= :reference=
   end
 end
 end

data/lib/chef/provisioning/machine_image_spec.rb

@@ -0,0 +1,34 @@
+require 'chef/provisioning/managed_entry'
+
+class Chef
+module Provisioning
+  #
+  # Specification for a image. Sufficient information to find and contact it
+  # after it has been set up.
+  #
+  class MachineImageSpec < ManagedEntry
+    alias :location :reference
+    alias :location= :reference=
+
+    def from_image
+      data['from_image']
+    end
+    def from_image=(value)
+      data['from_image'] = value
+    end
+    def run_list
+      data['run_list']
+    end
+    def run_list=(value)
+      data['run_list'] = value
+    end
+    def machine_options
+      @machine_options
+    end
+    def machine_options=(value)
+      Chef::Log.warn("Machine options are no longer stored in machine_image_spec.  Drivers that store machine_options will stop working with Provisioning 1.0.")
+      @machine_options = value
+    end
+  end
+end
+end

data/lib/chef/provisioning/machine_spec.rb

@@ -1,33 +1,26 @@
+require 'chef/provisioning/managed_entry'
+
 class Chef
 module Provisioning
   #
   # Specification for a machine. Sufficient information to find and contact it
   # after it has been set up.
   #
-  class MachineSpec
-    def initialize(node)
-      @node = node
+  class MachineSpec < ManagedEntry
+    def initialize(*args)
+      super
+      data['name'] ||= name
       # Upgrade from metal to chef_provisioning ASAP.
-      if node['normal'] && !node['normal']['chef_provisioning'] && node['normal']['metal']
-        node['normal']['chef_provisioning'] = node['normal'].delete('metal')
+      if data['normal'] && !data['normal']['chef_provisioning'] && data['normal']['metal']
+        data['normal']['chef_provisioning'] = data['normal'].delete('metal')
       end
     end
 
-    attr_reader :node
-
-    #
-    # Globally unique identifier for this machine. Does not depend on the machine's
-    # location or existence.
-    #
-    def id
-      raise "id unimplemented"
-    end
+    alias :node :data
 
-    #
-    # Name of the machine. Corresponds to the name in "machine 'name' do" ...
-    #
-    def name
-      node['name']
+    def attrs
+      data['normal'] ||= {}
+      data['normal']['chef_provisioning'] ||= {}
     end
 
     #
@@ -39,43 +32,26 @@ module Provisioning
     #
     # chef-provisioning will do its darnedest to not lose this information.
     #
-    def location
-      chef_provisioning_attr('location')
+    def reference
+      attrs['reference'] || attrs['location']
     end
 
     #
     # Set the location for this machine.
     #
-    def location=(value)
-      set_chef_provisioning_attr('location', value)
+    def reference=(value)
+      attrs.delete('location')
+      attrs['reference'] = value
     end
 
-    # URL to the driver.  Convenience for location['driver_url']
-    def driver_url
-      location ? location['driver_url'] : nil
-    end
+    alias :location :reference
+    alias :location= :reference=
 
-    #
-    # Save this node to the server.  If you have significant information that
-    # could be lost, you should do this as quickly as possible.  Data will be
-    # saved automatically for you after allocate_machine and ready_machine.
-    #
-    def save(action_handler)
-      raise "save unimplemented"
+    def from_image
+      attrs['from_image']
     end
-
-    protected
-
-    def chef_provisioning_attr(attr)
-      if node['normal'] && node['normal']['chef_provisioning']
-        node['normal']['chef_provisioning'][attr]
-      end
-    end
-
-    def set_chef_provisioning_attr(attr, value)
-      node['normal'] ||= {}
-      node['normal']['chef_provisioning'] ||= {}
-      node['normal']['chef_provisioning'][attr] = value
+    def from_image=(value)
+      attrs['from_image'] = value
     end
   end
 end

data/lib/chef/provisioning/managed_entry.rb

@@ -0,0 +1,121 @@
+class Chef
+module Provisioning
+  #
+  # Specification for a managed thing.  Remembers where it was stored, and lets
+  # you stuff reference data in it.
+  #
+  class ManagedEntry
+    def initialize(managed_entry_store, resource_type, name, data=nil)
+      @managed_entry_store = managed_entry_store
+      @resource_type = resource_type
+      @name = name
+      @data = data || {}
+    end
+
+    attr_reader :managed_entry_store
+    attr_reader :resource_type
+    attr_reader :name
+    attr_reader :data
+
+    def attrs
+      data
+    end
+
+    #
+    # Globally unique identifier for this machine. Does not depend on the machine's
+    # reference or existence.
+    #
+    def id
+      managed_entry_store.identifier(resource_type, name)
+    end
+
+    #
+    # Reference to this managed thing.  This should be a freeform hash, with enough
+    # information for the driver to look it up and create a Machine object to
+    # access it.
+    #
+    # This MUST include a 'driver_url' attribute with the driver's URL in it.
+    #
+    # chef-provisioning will do its darnedest to not lose this information.
+    #
+    def reference
+      # Backcompat: old data bags didn't have the "reference" field.  If we have
+      # no reference field in the data, and the data bag is non-empty, return
+      # the root of the data bag.
+      attrs['reference'] || attrs['location'] || (attrs == {} ? nil : attrs)
+    end
+
+    #
+    # Set the reference for this machine.
+    #
+    def reference=(value)
+      self.attrs['reference'] = value
+    end
+
+    # URL to the driver.
+    def driver_url
+      attrs['driver_url'] || (reference ? reference['driver_url'] : nil)
+    end
+    def driver_url=(value)
+      attrs['driver_url'] = value
+    end
+
+    #
+    # Save this node to the server.  If you have significant information that
+    # could be lost, you should do this as quickly as possible.  Data will be
+    # saved automatically for you after allocate_machine and ready_machine.
+    #
+    def save(action_handler)
+      managed_entry_store.save_data(resource_type, name, data, action_handler)
+    end
+
+    def delete(action_handler)
+      managed_entry_store.delete_data(resource_type, name, action_handler)
+    end
+
+
+    #
+    # Subclass interface
+    #
+
+    #
+    # Get the given data
+    #
+    # @param resource_type [Symbol] The type of thing to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+    # @param name [String] The unique identifier of the thing to retrieve
+    #
+    # @return [Hash,Array] The data, or `nil` if the data does not exist.  Will be JSON- and YAML-compatible (Hash, Array, String, Integer, Boolean, Nil)
+    #
+    def get_data(resource_type, name)
+      raise NotImplementedError, :delete_data
+    end
+
+    #
+    # Save the given data
+    #
+    # @param resource_type [Symbol] The type of thing to save (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet ...)
+    # @param name [String] The unique identifier of the thing to save
+    # @param data [Hash,Array] The data to save.  Must be JSON- and YAML-compatible (Hash, Array, String, Integer, Boolean, Nil)
+    #
+    def save_data(resource_type, name, data, action_handler)
+      raise NotImplementedError, :delete_data
+    end
+
+    #
+    # Delete the given data
+    #
+    # @param resource_type [Symbol] The type of thing to delete (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+    # @param name [String] The unique identifier of the thing to delete
+    #
+    # @return [Boolean] Whether anything was deleted or not.
+    #
+    def delete_data(resource_type, name, action_handler)
+      raise NotImplementedError, :delete_data
+    end
+
+    def identifier(resource_type, name)
+      raise NotImplementedError, :identifier
+    end
+  end
+end
+end

data/lib/chef/provisioning/managed_entry_store.rb

@@ -0,0 +1,136 @@
+require 'chef/provisioning/load_balancer_spec'
+require 'chef/provisioning/machine_spec'
+require 'chef/provisioning/machine_image_spec'
+require 'chef/provisioning/managed_entry'
+
+class Chef
+  module Provisioning
+    class ManagedEntryStore
+      def initialize(chef_run_data)
+        @chef_run_data = chef_run_data
+      end
+
+      #
+      # Get the given data
+      #
+      # @param resource_type [Symbol] The type of thing to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the thing to retrieve
+      #
+      # @return [Hash,Array] The data.  Will be JSON- and YAML-compatible (Hash, Array, String, Integer, Boolean, Nil)
+      #
+      def get_data(resource_type, name)
+        raise NotImplementedError, :get_data
+      end
+
+      #
+      # Save the given data
+      #
+      # @param resource_type [Symbol] The type of thing to save (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet ...)
+      # @param name [String] The unique identifier of the thing to save
+      # @param data [Hash,Array] The data to save.  Must be JSON- and YAML-compatible (Hash, Array, String, Integer, Boolean, Nil)
+      #
+      def save_data(resource_type, name, data, action_handler)
+        raise NotImplementedError, :save_data
+      end
+
+      #
+      # Delete the given data
+      #
+      # @param resource_type [Symbol] The type of thing to delete (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the thing to delete
+      #
+      # @return [Boolean] Whether anything was deleted or not.
+      #
+      def delete_data(resource_type, name, action_handler)
+        raise NotImplementedError, :delete_data
+      end
+
+      #
+      # Get a globally unique identifier for this resource.
+      #
+      # @param resource_type [Symbol] The type of spec to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the spec to retrieve
+      #
+      # @return [String] The identifier.
+      #
+      # @example ChefManagedEntry does this:
+      #   chef_managed_entry_store.identifier(:machine, 'mario') # => https://my.chef.server/organizations/org/nodes/mario
+      #
+      def identifier(resource_type, name)
+        raise NotImplementedError, :identifier
+      end
+
+      #
+      # Get a spec.
+      #
+      # @param resource_type [Symbol] The type of spec to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the spec to retrieve
+      #
+      # @return [ManagedEntry] The entry, or `nil` if the data does not exist.
+      #
+      def get(resource_type, name)
+        data = get_data(resource_type, name)
+        if data
+          new_entry(resource_type, name, data)
+        end
+      end
+
+      #
+      # Get a spec, or create a new one, depending on whether an entry exists.
+      #
+      # @param resource_type [Symbol] The type of spec to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the spec to retrieve
+      #
+      # @return [ManagedEntry] The entry.
+      #
+      def get_or_new(resource_type, name)
+        data = get_data(resource_type, name)
+        new_entry(resource_type, name, data)
+      end
+
+      #
+      # Get a spec, erroring out if the data does not exist.
+      #
+      # @param resource_type [Symbol] The type of spec to retrieve (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the spec to retrieve
+      #
+      # @return [ManagedEntry] The entry.
+      #
+      def get!(resource_type, name)
+        result = get(resource_type, name)
+        if !result
+          raise "#{identifier(resource_type, name)} not found!"
+        end
+        result
+      end
+
+      #
+      # Delete the given spec.
+      #
+      # @param resource_type [Symbol] The type of spec to delete (:machine, :machine_image, :load_balancer, :aws_vpc, :aws_subnet, ...)
+      # @param name [String] The unique identifier of the spec to delete
+      #
+      # @return [Boolean] Whether anything was deleted or not.
+      #
+      def delete(resource_type, name, action_handler)
+        delete_data(resource_type, name, action_handler)
+      end
+
+      #
+      # Create a new managed entry of the given type.
+      #
+      def new_entry(resource_type, name, data=nil)
+        case resource_type
+        when :machine
+          MachineSpec.new(self, resource_type, name, data)
+        when :machine_image
+          MachineImageSpec.new(self, resource_type, name, data)
+        when :load_balancer
+          LoadBalancerSpec.new(self, resource_type, name, data)
+        else
+          ManagedEntry.new(self, resource_type, name, data)
+        end
+      end
+    end
+  end
+end