chef-solr 0.8.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.rdoc

@@ -0,0 +1,7 @@
+= chef-solr
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Adam Jacob. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "chef-solr"
+    gem.summary = %Q{Search indexing for Chef}
+    gem.email = "adam@opscode.com"
+    gem.homepage = "http://wiki.opscode.com/display/chef"
+    gem.authors = ["Adam Jacob"]
+    gem.add_dependency "libxml-ruby", ">=1.1.3"
+    gem.add_dependency "uuidtools", ">=2.0.0"
+    gem.add_dependency "chef", IO.read("VERSION").strip
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.executables = [ 'chef-solr', 'chef-solr-indexer', 'chef-solr-rebuild' ]
+    gem.files = [
+      "README.rdoc",
+      "Rakefile",
+      "VERSION"
+    ]
+    gem.files.include %w{ README.rdoc Rakefile VERSION bin/* lib/**/* solr/* spec/**/* }
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it from gemcutter with: sudo gem install gemcutter jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = %w{-fs --color}
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chef-solr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.8.2

data/bin/chef-solr

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@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.
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "chef", "lib")))
+
+require 'rubygems'
+require 'chef/solr/application/solr'
+
+Chef::Solr::Application::Solr.new.run
+

data/bin/chef-solr-indexer

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@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.
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "chef", "lib")))
+
+require 'rubygems'
+require 'chef/solr/application/indexer'
+
+Chef::Solr::Application::Indexer.new.run
+

data/bin/chef-solr-rebuild

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@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.
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "chef", "lib")))
+
+require 'rubygems'
+require 'chef/solr/application/rebuild'
+
+Chef::Solr::Application::Rebuild.new.run
+

data/lib/chef/solr.rb

@@ -0,0 +1,212 @@
+#
+# Author:: Adam Jacob (<adam@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 'rubygems'
+require 'chef/mixin/xml_escape'
+require 'chef/log'
+require 'chef/config'
+require 'chef/couchdb'
+require 'chef/role'
+require 'chef/node'
+require 'chef/data_bag'
+require 'chef/data_bag_item'
+require 'chef/api_client'
+require 'chef/openid_registration'
+require 'chef/webui_user'
+require 'net/http'
+require 'libxml'
+require 'uri'
+
+class Chef
+  class Solr
+    include Chef::Mixin::XMLEscape
+
+    attr_accessor :solr_url, :http
+
+    def initialize(solr_url=Chef::Config[:solr_url])
+      @solr_url = solr_url
+      uri = URI.parse(@solr_url)
+      @http = Net::HTTP.new(uri.host, uri.port)
+    end
+
+    def solr_select(database, type, options={})
+      options[:wt] = :ruby
+      options[:indent] = "off"
+      options[:fq] = if type.kind_of?(Array)
+                       "+X_CHEF_database_CHEF_X:#{database} +X_CHEF_type_CHEF_X:#{type[0]} +data_bag:#{type[1]}"
+                     else
+                       "+X_CHEF_database_CHEF_X:#{database} +X_CHEF_type_CHEF_X:#{type}"
+                     end
+      select_url = "/solr/select?#{to_params(options)}"
+      Chef::Log.debug("Sending #{select_url} to Solr")
+      req = Net::HTTP::Get.new(select_url)
+      res = @http.request(req)
+      res.error! unless res.kind_of?(Net::HTTPSuccess)
+      eval(res.body)
+    end
+
+    def post_to_solr(doc)
+      Chef::Log.debug("POSTing document to SOLR:\n#{doc}")
+      req = Net::HTTP::Post.new("/solr/update", "Content-Type" => "text/xml")
+      req.body = doc.to_s
+      res = @http.request(req)
+      unless res.kind_of?(Net::HTTPSuccess)
+        res.error!
+      end
+      res
+    end
+
+    def solr_add(data)
+      data = [data] unless data.kind_of?(Array)
+      
+      Chef::Log.debug("adding to SOLR: #{data.inspect}")
+      xml_document = LibXML::XML::Document.new
+      xml_add = LibXML::XML::Node.new("add")
+      data.each do |doc|
+        xml_doc = LibXML::XML::Node.new("doc")
+        doc.each do |field, values|
+          values = [values] unless values.kind_of?(Array)
+          values.each do |v|
+            xml_field = LibXML::XML::Node.new("field")
+            xml_field["name"] = field
+            xml_field.content = xml_escape(v.to_s)
+            xml_doc << xml_field
+          end
+        end
+        xml_add << xml_doc
+      end
+      xml_document.root = xml_add
+      post_to_solr(xml_document.to_s(:indent => false))
+    end
+
+    def solr_commit(opts={})
+      post_to_solr(generate_single_element("commit", opts))
+    end
+    
+    def solr_optimize(opts={})
+      post_to_solr(generate_single_element("optimize", opts))
+    end
+    
+    def solr_rollback
+      post_to_solr(generate_single_element("rollback"))
+    end
+    
+    def solr_delete_by_id(ids)
+      post_to_solr(generate_delete_document("id", ids))
+    end
+    
+    def solr_delete_by_query(queries)
+      post_to_solr(generate_delete_document("query", queries))
+    end
+
+    def rebuild_index(url=Chef::Config[:couchdb_url], db=Chef::Config[:couchdb_database])
+      solr_delete_by_query("X_CHEF_database_CHEF_X:#{db}")
+      solr_commit
+      
+      results = {}
+      [Chef::ApiClient, Chef::Node, Chef::OpenIDRegistration, Chef::Role, Chef::WebUIUser].each do |klass|
+        results[klass.name] = reindex_all(klass) ? "success" : "failed"
+      end
+      databags = Chef::DataBag.cdb_list(true)
+      Chef::Log.info("Reloading #{databags.size.to_s} #{Chef::DataBag} objects into the indexer")
+      databags.each { |i| i.add_to_index; i.list(true).each { |x| x.add_to_index } } 
+      results[Chef::DataBag.name] = "success" 
+      results
+    end
+
+    private
+    
+    def reindex_all(klass, metadata={})
+      begin
+        items = klass.cdb_list(true)
+        Chef::Log.info("Reloading #{items.size.to_s} #{klass.name} objects into the indexer")
+        items.each { |i| i.add_to_index }
+      rescue Net::HTTPServerException => e
+        # 404s are okay, there might not be any of that kind of object...
+        if e.message =~ /Not Found/
+          Chef::Log.warn("Could not load #{klass.name} objects from couch for re-indexing (this is ok if you don't have any of these)")
+          return false
+        else
+          raise e
+        end
+      rescue Exception => e
+        Chef::Log.fatal("Chef encountered an error while attempting to load #{klass.name} objects back into the index")
+        raise e
+      end
+      true
+    end
+
+    def generate_single_element(elem, opts={})
+      xml_document = LibXML::XML::Document.new
+      xml_elem = LibXML::XML::Node.new(elem)
+      opts.each { |k,v| xml_elem[k.to_s] = xml_escape(v.to_s) }
+      xml_document.root = xml_elem
+      xml_document.to_s(:indent => false)
+    end
+
+    def generate_delete_document(type, list)
+      list = [list] unless list.is_a?(Array)
+      xml_document = LibXML::XML::Document.new
+      xml_delete = LibXML::XML::Node.new("delete")
+      xml_document.root = xml_delete
+      list.each do |id|
+        xml_id = LibXML::XML::Node.new(type)
+        xml_id.content = id.to_s
+        xml_delete << xml_id
+      end
+      xml_document.to_s(:indent => false)
+    end
+
+    # Thanks to Merb!
+    def to_params(params_hash)
+      params = ''
+      stack = []
+
+      params_hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << [k,v]
+        else
+          params << "#{k}=#{escape(v)}&"
+        end
+      end
+
+      stack.each do |parent, hash|
+        hash.each do |k, v|
+          if v.is_a?(Hash)
+            stack << ["#{parent}[#{k}]", escape(v)]
+          else
+            params << "#{parent}[#{k}]=#{escape(v)}&"
+          end
+        end
+      end
+
+      params.chop! # trailing &
+      params
+    end
+
+    # escapes a query key/value for http
+    # Thanks to RSolr!
+    def escape(s)
+      s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n) {
+        '%'+$1.unpack('H2'*$1.size).join('%').upcase
+      }.tr(' ', '+') 
+    end
+
+  end
+end
+