chef 0.7.16 → 0.8.2

data/lib/chef/data_bag_item.rb

@@ -0,0 +1,219 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Nuo Yan (<nuo@opscode.com>)
+# Author:: Christopher Brown (<cb@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/config'
+require 'chef/mixin/params_validate'
+require 'chef/mixin/from_file'
+require 'chef/couchdb'
+require 'chef/data_bag_item'
+require 'extlib'
+require 'json'
+
+class Chef
+  class DataBagItem
+    
+    include Chef::Mixin::FromFile
+    include Chef::Mixin::ParamsValidate
+    include Chef::IndexQueue::Indexable
+    
+    DESIGN_DOCUMENT = {
+      "version" => 1,
+      "language" => "javascript",
+      "views" => {
+        "all" => {
+          "map" => <<-EOJS
+          function(doc) { 
+            if (doc.chef_type == "data_bag_item") {
+              emit(doc.name, doc);
+            }
+          }
+          EOJS
+        },
+        "all_id" => {
+          "map" => <<-EOJS
+          function(doc) { 
+            if (doc.chef_type == "data_bag_item") {
+              emit(doc.name, doc.name);
+            }
+          }
+          EOJS
+        }
+      }
+    }
+
+    attr_accessor :couchdb_rev, :couchdb_id, :couchdb
+    attr_reader :raw_data
+    
+    # Create a new Chef::DataBagItem
+    def initialize(couchdb=nil)
+      @couchdb_rev = nil
+      @couchdb_id = nil
+      @data_bag = nil
+      @raw_data = Mash.new
+      @couchdb = couchdb || Chef::CouchDB.new
+    end
+
+    def chef_server_rest
+      Chef::REST.new(Chef::Config[:chef_server_url])      
+    end
+
+    def self.chef_server_rest
+      Chef::REST.new(Chef::Config[:chef_server_url])      
+    end
+
+    def raw_data
+      @raw_data
+    end
+
+    def raw_data=(new_data)
+      raise ArgumentError, "Data Bag Items must contain a Hash or Mash!" unless new_data.kind_of?(Hash) || new_data.kind_of?(Mash)
+      raise ArgumentError, "Data Bag Items must have an id key in the hash! #{new_data.inspect}" unless new_data.has_key?("id")
+      raise ArgumentError, "Data Bag Item id does not match alphanumeric/-/_!" unless new_data["id"] =~ /^[\-[:alnum:]_]+$/
+      @raw_data = new_data
+    end
+
+    def data_bag(arg=nil) 
+      set_or_return(
+        :data_bag,
+        arg,
+        :regex => /^[\-[:alnum:]_]+$/
+      )
+    end
+
+    def name
+      object_name
+    end
+
+    def object_name
+      raise ArgumentError, "You must have an 'id' or :id key in the raw data" unless raw_data.has_key?('id')
+      raise ArgumentError, "You must have declared what bag this item belongs to!" unless data_bag
+      
+      id = raw_data['id']
+      "data_bag_item_#{data_bag}_#{id}"
+    end
+
+    def self.object_name(data_bag_name, id)
+      "data_bag_item_#{data_bag_name}_#{id}"
+    end
+
+    def to_hash
+      result = self.raw_data
+      result["chef_type"] = "data_bag_item"
+      result["data_bag"] = self.data_bag
+      result["_rev"] = @couchdb_rev if @couchdb_rev
+      result
+    end
+
+    # Serialize this object as a hash 
+    def to_json(*a)
+      result = {
+        "name" => self.object_name,
+        "json_class" => self.class.name,
+        "chef_type" => "data_bag_item",
+        "data_bag" => self.data_bag,
+        "raw_data" => self.raw_data
+      }
+      result["_rev"] = @couchdb_rev if @couchdb_rev
+      result.to_json(*a)
+    end
+    
+    # Create a Chef::DataBagItem from JSON
+    def self.json_create(o)
+      bag_item = new
+      bag_item.data_bag(o["data_bag"])
+      o.delete("data_bag")
+      o.delete("chef_type")
+      o.delete("json_class")
+      o.delete("name")
+      if o.has_key?("_rev")
+        bag_item.couchdb_rev = o["_rev"] 
+        o.delete("_rev")
+      end
+      if o.has_key?("_id")
+        bag_item.couchdb_id = o["_id"]
+        bag_item.index_id = bag_item.couchdb_id
+        o.delete("_id")
+      end
+      bag_item.raw_data = Mash.new(o["raw_data"])
+      bag_item
+    end
+
+    # The Data Bag Item behaves like a hash - we pass all that stuff along to @raw_data.
+    def method_missing(method_symbol, *args, &block) 
+      self.raw_data.send(method_symbol, *args, &block)
+    end
+    
+    # Load a Data Bag Item by name from CouchDB
+    def self.cdb_load(data_bag, name, couchdb=nil)
+      (couchdb || Chef::CouchDB.new).load("data_bag_item", object_name(data_bag, name))
+    end
+    
+    # Load a Data Bag Item by name via RESTful API
+    def self.load(data_bag, name)
+      Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("data/#{data_bag}/#{name}")
+    end
+    
+    # Remove this Data Bag Item from CouchDB
+    def cdb_destroy
+      Chef::Log.debug "destroying data bag item: #{self.inspect}"
+      @couchdb.delete("data_bag_item", object_name, @couchdb_rev)
+    end
+    
+    def destroy(data_bag=data_bag, databag_item=name)
+      chef_server_rest.delete_rest("data/#{data_bag}/#{databag_item}")
+    end
+     
+    # Save this Data Bag Item to CouchDB
+    def cdb_save
+      @couchdb_rev = @couchdb.store("data_bag_item", object_name, self)["rev"]
+    end
+    
+    # Save this Data Bag Item via RESTful API
+    def save(item_id=@raw_data['id'])
+      r = chef_server_rest
+      begin
+        r.put_rest("data/#{data_bag}/#{item_id}", @raw_data)
+      rescue Net::HTTPServerException => e
+        raise e unless e.response.code == "404"
+        r.post_rest("data/#{data_bag}", @raw_data) 
+      end
+      self
+    end
+    
+    # Create this Data Bag Item via RESTful API
+    def create
+      chef_server_rest.post_rest("data/#{data_bag}", @raw_data) 
+      self
+    end 
+    
+    # Set up our CouchDB design document
+    def self.create_design_document(couchdb=nil)
+      (couchdb || Chef::CouchDB.new).create_design_document("data_bag_items", DESIGN_DOCUMENT)
+    end
+    
+    # As a string
+    def to_s
+      "data_bag_item[#{@name}]"
+    end
+
+  end
+end
+
+

data/lib/chef/exceptions.rb

@@ -32,5 +32,8 @@ class Chef
     class Group < RuntimeError; end
     class Link < RuntimeError; end
     class Mount < RuntimeError; end
+    class CouchDBNotFound < RuntimeError; end
+    class PrivateKeyMissing < RuntimeError; end
+    class CannotWritePrivateKey < RuntimeError; end
   end
 end

data/lib/chef/index_queue.rb

@@ -0,0 +1,29 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "singleton"
+require "bunny"
+
+require "chef/index_queue/amqp_client"
+require "chef/index_queue/indexable"
+require "chef/index_queue/consumer"
+
+class Chef
+  module IndexQueue
+  end
+end

data/lib/chef/index_queue/amqp_client.rb

@@ -0,0 +1,106 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  module IndexQueue
+    class AmqpClient
+      include Singleton
+
+      def initialize
+        reset!
+      end
+
+      def reset!
+        @amqp_client && amqp_client.connected? && amqp_client.stop
+        @amqp_client = nil
+        @exchange = nil
+        @queue = nil
+      end
+      
+      def stop
+        @queue && @queue.subscription && @queue.unsubscribe
+        @amqp_client && @amqp_client.stop
+      end
+      
+      def amqp_client
+        unless @amqp_client
+          begin
+            @amqp_client = Bunny.new(amqp_opts)
+            Chef::Log.debug "Starting AMQP connection with client settings: #{@amqp_client.inspect}"
+            @amqp_client.start
+            @amqp_client.qos(:prefetch_count => 1)
+          rescue Bunny::ServerDownError => e
+            Chef::Log.fatal "Could not connect to rabbitmq. Is it running, reachable, and configured correctly?"
+            raise e
+          rescue Bunny::ProtocolError => e
+            Chef::Log.fatal "Connection to rabbitmq refused. Check your rabbitmq configuration and chef's amqp* settings"
+            raise e
+          end
+        end
+        @amqp_client
+      end
+
+      def exchange
+        @exchange ||= amqp_client.exchange("chef-indexer", :durable => true, :type => :fanout)
+      end
+      
+      def queue
+        unless @queue
+          @queue = amqp_client.queue("chef-index-consumer-" + consumer_id, :durable => durable_queue?)
+          @queue.bind(exchange)
+        end
+        @queue
+      end
+      
+      def disconnected!
+        @amqp_client = nil
+        reset!
+      end
+
+      def send_action(action, data)
+        begin
+          exchange.publish({"action" => action.to_s, "payload" => data}.to_json)
+        rescue Bunny::ServerDownError, Bunny::ConnectionError, Errno::ECONNRESET => e
+          Chef::Log.error("Disconnected from the AMQP Broker, cannot queue data to the indexer")
+          disconnected!
+          raise e
+        end
+      end
+
+      private
+      
+      def durable_queue?
+        !!Chef::Config[:amqp_consumer_id]
+      end
+      
+      def consumer_id
+        Chef::Config[:amqp_consumer_id] || UUIDTools::UUID.random_create.to_s
+      end
+
+      def amqp_opts
+        { :spec   => '08',
+          :host   => Chef::Config[:amqp_host],
+          :port   => Chef::Config[:amqp_port],
+          :user   => Chef::Config[:amqp_user],
+          :pass   => Chef::Config[:amqp_pass],
+          :vhost  => Chef::Config[:amqp_vhost]}
+      end
+
+    end
+  end
+end

data/lib/chef/index_queue/consumer.rb

@@ -0,0 +1,76 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  module IndexQueue
+    module Consumer
+      module ClassMethods
+        def expose(*methods)
+          @exposed_methods = Array(@exposed_methods)
+          @exposed_methods += methods
+        end
+        
+        def exposed_methods
+          @exposed_methods || []
+        end
+        
+        def whitelisted?(method_name)
+          exposed_methods.include?(method_name)
+        end
+      end
+      
+      def self.included(including_class)
+        including_class.send(:extend, ClassMethods)
+      end
+      
+      def run
+        Chef::Log.debug("Starting Index Queue Consumer")
+        AmqpClient.instance.queue # triggers connection setup
+        
+        begin
+          AmqpClient.instance.queue.subscribe(:ack => true, :timeout => false) do |message|
+            call_action_for_message(message)
+          end
+        rescue Bunny::ConnectionError, Errno::ECONNRESET, Bunny::ServerDownError
+          AmqpClient.instance.disconnected!
+          Chef::Log.warn "Connection to rabbitmq lost. attempting to reconnect"
+          sleep 1
+          retry
+        end
+      end
+      alias :start :run
+      
+      def call_action_for_message(message)
+        amqp_payload  = JSON.parse(message[:payload])
+        action        = amqp_payload["action"].to_sym
+        app_payload   = amqp_payload["payload"]
+        assert_method_whitelisted(action)
+        send(action, app_payload)
+      end
+      
+      private
+      
+      def assert_method_whitelisted(method_name)
+        unless self.class.whitelisted?(method_name)
+          raise ArgumentError, "non-exposed method #{method_name} called via index queue"
+        end
+      end
+      
+    end
+  end
+end

data/lib/chef/index_queue/indexable.rb

@@ -0,0 +1,74 @@
+#
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+class Chef
+  module IndexQueue
+    module Indexable
+      
+      module ClassMethods
+        
+        def index_object_type(explicit_type_name=nil)
+          @index_object_type = explicit_type_name.to_s if explicit_type_name
+          @index_object_type
+        end
+        
+        # Resets all metadata used for indexing to nil. Used for testing
+        def reset_index_metadata!
+          @index_object_type = nil
+        end
+        
+      end
+
+      def self.included(including_class)
+        including_class.send(:extend, ClassMethods)
+      end
+      
+      attr_accessor :index_id
+      
+      def index_object_type
+        self.class.index_object_type || Mixin::ConvertToClassName.snake_case_basename(self.class.name)
+      end
+      
+      def with_indexer_metadata(with_metadata={})
+        # changing input param symbol keys to strings, as the keys in hash that goes to solr are expected to be strings [cb]
+        with_metadata.each do |key,value|
+          with_metadata[key.to_s] = with_metadata.delete(key)
+        end
+
+        with_metadata["type"]     ||= self.index_object_type
+        with_metadata["id"]       ||= self.index_id
+        with_metadata["database"] ||= Chef::Config[:couchdb_database]
+        with_metadata["item"]     ||= self
+
+        raise ArgumentError, "Type, Id, or Database missing in index operation: #{with_metadata.inspect}" if (with_metadata["id"].nil? or with_metadata["type"].nil?)
+        with_metadata        
+      end
+      
+      def add_to_index(metadata={})
+        Chef::Log.debug("pushing item to index queue for addition: #{self.with_indexer_metadata(metadata)}")
+        AmqpClient.instance.send_action(:add, self.with_indexer_metadata(metadata))
+      end
+
+      def delete_from_index(metadata={})
+        Chef::Log.debug("pushing item to index queue for deletion: #{self.with_indexer_metadata(metadata)}")
+        AmqpClient.instance.send_action(:delete, self.with_indexer_metadata(metadata))
+      end
+      
+    end
+  end
+end