solr_makr 0.0.4 → 0.5.1

data/lib/solr_makr/application_dispatch.rb

@@ -0,0 +1,85 @@
+module SolrMakr
+  class ApplicationDispatch
+    include SolrMakr::AbstractRunner
+
+    action! :setup, interaction: :SetUpLocalConfiguration do |action|
+      action.description 'Setup the config directory for solr-makr.'
+    end
+
+    action! :create_collection, requires_name: true, specifies_configset: true do |action|
+      action.description 'Create a new collection'
+
+      action.option :config_name, type: String, short_name: 'C' do |o|
+        o.description     = "Key of the configset in zookeeper"
+        o.default_value   = :name
+        o.value_name      = 'NAME'
+      end
+
+      action.option :number_of_shards, type: Integer do |o|
+        o.description = 'Number of shards for this collection'
+        o.value_name  = 'SHARDS'
+        o.default_value = 1
+      end
+
+      action.option :replication_factor, type: Integer do |o|
+        o.description   = 'How many replicas to create'
+        o.value_name    = 'FACTOR'
+        o.default_value = 1
+      end
+
+      action.option :max_shards_per_node, type: Integer do |o|
+        o.description   = 'How many shards per solr node'
+        o.value_name    = 'MAX'
+        o.default_value = 1
+      end
+    end
+
+    action! :delete_collection, requires_name: true do |action|
+      action.description 'Delete a collection'
+    end
+
+    action! :reload_collection, requires_name: true do |action|
+      action.description 'Reload a collection'
+    end
+
+    action! :fetch_collection_list, command_name: 'list' do |action|
+      action.description 'List all collections'
+    end
+
+    action! :push_config, requires_name: true, specifies_configset: true do |action|
+      action.description 'Push a new configuration to zookeeper'
+
+      action.option :reload do |o|
+        o.description   = 'Whether to reload all configurations that use this when updating'
+        o.default_value = false
+      end
+    end
+
+    action! :write_yaml, command_name: 'yaml', requires_name: true do |action|
+      action.description 'Generate a YAML configuration suitable for use with sunspot'
+
+      action.option :config_name, type: String, short_name: 'C' do |o|
+        o.description     = "Key of the configset in zookeeper"
+        o.default_value   = :name
+        o.value_name      = 'NAME'
+      end
+
+      action.option :environment, type: String, short_name: 'e' do |o|
+        o.description   = 'Rails environment'
+        o.default_value = proc { SunspotConfiguration.default_environment }
+        o.value_name    = 'ENV'
+      end
+
+      action.option :output, type: String, short_name: 'o' do |o|
+        o.description   = 'Write configuration to file'
+        o.value_name    = 'FILE'
+      end
+
+      action.option :log_level, type: String do |o|
+        o.description   = "Sunspot's log level"
+        o.default_value = proc { SunspotConfiguration.default_log_level }
+        o.value_name    = 'LEVEL'
+      end
+    end
+  end
+end

data/lib/solr_makr/collection.rb

@@ -0,0 +1,17 @@
+module SolrMakr
+  class Collection
+    include Virtus.model strict: true
+
+    attribute :name, String
+    attribute :managed, Boolean, lazy: true, default: :detect_if_managed?
+
+    def detect_if_managed?
+      false
+    end
+
+    # @return [(String, Boolean)]
+    def to_table_row
+      [name, managed?]
+    end
+  end
+end

data/lib/solr_makr/commands.rb

@@ -1,5 +1,19 @@
 module SolrMakr
   # @api private
   module Commands
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :AbstractCommand
+      autoload :Buffer
+      autoload :CreateCollection
+      autoload :DeleteCollection
+      autoload :Execute
+      autoload :FetchCollectionList
+      autoload :PushConfig
+      autoload :ReloadCollection
+      autoload :SetUpLocalConfiguration
+      autoload :WriteYaml
+    end
   end
 end

data/lib/solr_makr/commands/abstract_command.rb

@@ -0,0 +1,60 @@
+module SolrMakr
+  module Commands
+    module AbstractCommand
+      extend ActiveSupport::Concern
+      include SolrMakr::BufferInteraction
+      include SolrMakr::Utility
+
+      included do
+        set_callback :validate, :after, :invalid_buffer_if_errors!
+
+        object :buffer, class: 'SolrMakr::Commands::Buffer', default: proc { SolrMakr::Commands::Buffer.new }
+
+        delegate :directory, :settings, :cache, to: :local_configuration, prefix: true
+      end
+
+      # @return [SolrMakr::Configsets::Directory]
+      def fetch_configset(name)
+        SolrMakr.local_configuration.configsets[name]
+      end
+
+      def local_configuration
+        SolrMakr::LocalConfiguration
+      end
+
+      attr_lazy_reader :solr_client do
+        SolrMakr::SolrAPI::Client.new
+      end
+
+      # @param [SolrMakr::SolrAPI::Response] response
+      def expect_success!(response, success_message: nil, error_message: nil, halt_on_error: true, &on_failure)
+        if response.success?
+          if success_message.present?
+            buffer.ok success_message
+          end
+        else
+          errors.add '[solr]', response.failure
+
+          buffer.exit_status = 1
+
+          if error_message.present?
+            buffer.logger.error error_message
+          elsif block_given?
+            yield response
+          end
+
+          throw :interrupt, response if halt_on_error
+        end
+
+        return response
+      end
+
+      private
+      def invalid_buffer_if_errors!
+        if buffer.success? && errors.any?
+          buffer.exit_status = 1
+        end
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/buffer.rb

@@ -0,0 +1,98 @@
+module SolrMakr
+  module Commands
+    # Captures output for buffers
+    #
+    # @api private
+    class Buffer
+      def initialize(context: nil, **options)
+        @context  = context
+
+        @output   = StringIO.new
+
+        @logger   = Logger.new @output
+
+        @logger.formatter = default_formatter
+
+        @exit_status = 0
+      end
+
+      attr_reader :context
+      attr_reader :output
+      attr_reader :logger
+      attr_reader :exit_status
+
+      delegate :log, :debug, :error, :warn, :fatal, :info, to: :logger
+      delegate :write, to: :output
+
+      def import(buffer)
+        write buffer.to_s
+
+        unless buffer.success?
+          self.exit_status = buffer.exit_status
+        end
+
+        return self
+      end
+
+      def error!(status: 1, message: nil)
+        if message.present?
+          logger.error message
+        end
+
+        if exit_status != status
+          self.exit_status = status
+        end
+      end
+
+      def ok(message = 'OK')
+        print "\u2713 #{message}"
+      end
+
+      alias_method :success, :ok
+
+      def failure(message)
+        print "\u2717 #{message}"
+      end
+
+      def issue(message)
+        print "\u2757 #{message}"
+      end
+
+      def separator!
+        write "\n\n"
+      end
+
+      def print(*lines)
+        lines.each { |line| write line }
+
+        write "\n"
+      end
+
+      def exit_status=(new_retval)
+        @exit_status = Integer(new_retval) rescue -1
+      end
+
+      def success?
+        @exit_status.zero?
+      end
+
+      def to_s
+        output.string
+      end
+
+      # @return [Proc]
+      def default_formatter
+        proc do |severity, time, progname, message|
+          context_name = progname.presence || context.presence || SolrMakr::BIN_NAME
+
+          [].tap do |parts|
+            parts << severity
+            parts << "[#{time.iso8601}]" unless STDOUT.tty?
+            parts << "[#{context_name}]" if context_name.present?
+            parts << message
+          end.join(' ') + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/create_collection.rb

@@ -0,0 +1,57 @@
+module SolrMakr
+  module Commands
+    class CreateCollection < ActiveInteraction::Base
+      include AbstractCommand
+
+      string :name,         description: 'name of the collection'
+      string :config_name,  description: 'the name to use in zookeeper',  default: nil
+      string :configset,    description: 'local configset to base on',    default: proc { SolrMakr.configuration.default_configset }
+
+      integer :number_of_shards,    default: 1
+      integer :replication_factor,  default: 1
+      integer :max_shards_per_node, default: 1
+
+      def execute
+        configset_directory = fetch_configset(configset)
+
+        unless remote_configset_exists?
+          buffer.print ". Zookeeper configuration `#{config_name}` does not exist... creating"
+
+          compose_buffer SolrMakr::Configsets::PushToZookeeper, name: remote_configset_name, directory: configset_directory
+        end
+
+        expect_success! solr_client.create(params_for_create)
+
+        buffer.ok "Created collection: #{name}"
+      end
+
+      # @api private
+      # @return [Hash]
+      def params_for_create
+        {
+          name:                 name,
+          config_name:          remote_configset_name,
+          number_of_shards:     number_of_shards,
+          replication_factor:   replication_factor,
+          max_shards_per_node:  max_shards_per_node
+        }
+      end
+
+      # @!attribute [r] remote_configset_name
+      # @return [String]
+      attr_lazy_reader :remote_configset_name do
+        config_name.presence || name
+      end
+
+      attr_lazy_reader :remote_configset do
+        SolrMakr::Configsets::Remote.new name: remote_configset_name
+      end
+
+      attr_lazy_reader :remote_configset_exists do
+        remote_configset.exists?
+      end
+
+      alias_method :remote_configset_exists?, :remote_configset_exists
+    end
+  end
+end

data/lib/solr_makr/commands/delete_collection.rb

@@ -0,0 +1,13 @@
+module SolrMakr
+  module Commands
+    class DeleteCollection < ActiveInteraction::Base
+      include AbstractCommand
+
+      string :name
+
+      def execute
+        expect_success! solr_client.delete(name: name), success_message: "Deleted collection: `#{name}`"
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/execute.rb

@@ -0,0 +1,67 @@
+module SolrMakr
+  module Commands
+    # Execute an application command based on its configuration.
+    class Execute < ActiveInteraction::Base
+      include SolrMakr::BufferInteraction
+      include SolrMakr::Utility
+
+      object :action, class: 'SolrMakr::ApplicationAction'
+
+      array :command_args, default: [] do
+        string
+      end
+
+      object :command_options, class: 'Commander::Command::Options', default: proc { Commander::Command::Options.new }
+
+      # @return [SolrMakr::Commands::Buffer]
+      def execute
+        set_global_options!
+
+        set_default_options!
+
+        validate_options!
+
+        unless errors.any?
+          compose_buffer action.interaction_klass, **raw_options
+        end
+
+        return buffer
+      end
+
+      attr_lazy_reader :verbose do
+        command_options.verbose.present?
+      end
+
+      alias_method :verbose?, :verbose
+
+      # Set global options for the environment.
+      #
+      # @return [void]
+      def set_global_options!
+        compose SolrMakr::SetGlobalOptions, raw_options
+      end
+
+      # Inherit default options for the action if any.
+      #
+      # @return [void]
+      def set_default_options!
+        action.set_default_options!(command_args, command_options)
+      end
+
+      # @return [void]
+      def validate_options!
+        action.option_mapping.each do |option|
+          unless option.valid_in?(command_options)
+            errors.add :base, "Missing required argument: #{option.long_name}"
+          end
+        end
+      end
+
+      # @api private
+      # @return [Hash]
+      def raw_options
+        command_options.__hash__.symbolize_keys
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/fetch_collection_list.rb

@@ -0,0 +1,17 @@
+module SolrMakr
+  module Commands
+    class FetchCollectionList < ActiveInteraction::Base
+      include AbstractCommand
+
+      def execute
+        response = solr_client.list
+
+        collections = response.array(:collections).map do |name|
+          SolrMakr::Collection.new name: name
+        end
+
+        buffer.print default_table(collection: collections, headings: %w[Collection Managed?], if_blank: 'No collections.')
+      end
+    end
+  end
+end

data/lib/solr_makr/commands/push_config.rb

@@ -0,0 +1,36 @@
+module SolrMakr
+  module Commands
+    class PushConfig < ActiveInteraction::Base
+      include AbstractCommand
+
+      string :name,       description: 'the name of the config in zookeeper'
+      string :configset,  description: 'the name of the local configset'
+
+      boolean :reload,    description: 'Whether to reload every collection that depends', default: true
+
+      attr_reader :remote
+
+      def execute
+        configset_directory = fetch_configset(configset)
+
+        compose_buffer SolrMakr::Configsets::PushToZookeeper, name: name, directory: configset_directory
+
+        buffer.ok "Pushed configuration named `#{name}` to zookeeper."
+
+        @remote = SolrMakr::Configsets::Remote.new name: name
+
+        if reload
+          remote.dependent_collections.each do |collection|
+            response = solr_client.reload name: collection
+
+            if response.success?
+              buffer.ok "Reloaded collection: `#{collection}`"
+            else
+              buffer.failure "Couldn't reload collection: `#{collection}`: #{response.failure}"
+            end
+          end
+        end
+      end
+    end
+  end
+end