elasticsearch-extensions 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 929b42632d0c89e1007c16e6d08d465df863ad58
-  data.tar.gz: 8ebc114b63d1cf9d64346a7da06d4fc385a401f6
+  metadata.gz: 7248c6fbddfe31ef013db4c097d59ba4427df2e3
+  data.tar.gz: 565df7537b10de2a83cbf0181a65b7580901ba83
 SHA512:
-  metadata.gz: 053e210e305b080280e75ef955a5a6b7981cadc604cab50250308ce6a335ea0ef06e5eef655e11789b78a501604bc7399a4b747e4db6ab292812c209a7cf014e
-  data.tar.gz: c19de28219676b133fe3850cadadd42087c9ebc3da86da055563e3e2be68c5bfa1e4d7c4aff79b68cdc629acc7dbf8674b751d4f97336558f8dff36f81deecdd
+  metadata.gz: 5d56926d940b28be59070ab4d98adaba0beedb9228ca8df892db425e9066342bb54b29ed6f4ef7b94b6f1d94214df876e451aae3313092ef1c277b20d8241266
+  data.tar.gz: 397ab511b86ae27c15c77037df6c8d598e618299bf1683d7927c0cb6bc72823e7a212285ae052c7d1d613bdabdd6518fcdcb74a3f7a3ed4c4b5436117f859158

data/lib/elasticsearch/extensions/reindex.rb

@@ -68,7 +68,8 @@ module Elasticsearch
       #
       #     reindex = Elasticsearch::Extensions::Reindex.new \
       #                 source: { index: 'test1', client: client },
-      #                 target: { index: 'test2', transform: lambda { |doc| doc['_source']['category'].upcase! } }
+      #                 target: { index: 'test2' },
+      #                 transform: lambda { |doc| doc['_source']['category'].upcase! }
       #
       #
       # The reindexing process works by "scrolling" an index and sending

data/lib/elasticsearch/extensions/test/cluster.rb

@@ -7,6 +7,7 @@ require 'json'
 require 'ansi'
 
 STDOUT.sync = true
+STDERR.sync = true
 
 class String
 
@@ -24,9 +25,20 @@ module Elasticsearch
       # A convenience Ruby class for starting and stopping an Elasticsearch cluster,
       # eg. for integration tests
       #
-      # @example Start a cluster with default configuration
+      # @example Start a cluster with default configuration,
+      #          assuming `elasticsearch` is on $PATH.
+      #
+      #      require 'elasticsearch/extensions/test/cluster'
+      #      Elasticsearch::Extensions::Test::Cluster.start
+      #
+      # @example Start a cluster with a specific Elasticsearch launch script,
+      #          eg. from a downloaded `.tar.gz` distribution
+      #
+      #      system 'wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.1.1.tar.gz'
+      #      system 'tar -xvf elasticsearch-5.1.1.tar.gz'
+      #
       #      require 'elasticsearch/extensions/test/cluster'
-      #      Elasticsearch::Extensions::Test::Cluster::Cluster.new.start
+      #      Elasticsearch::Extensions::Test::Cluster.start command: 'elasticsearch-5.1.1/bin/elasticsearch'
       #
       # @see Cluster#initialize
       #
@@ -185,6 +197,7 @@ module Elasticsearch
           # @option arguments [Integer] :timeout      Timeout when starting the cluster (default: 30)
           # @option arguments [String]  :network_host The host that nodes will bind on and publish to
           # @option arguments [Boolean] :clear_cluster Wipe out cluster content on startup (default: true)
+          # @option arguments [Boolean] :quiet         Disable printing to STDERR (default: false)
           #
           # You can also use environment variables to set the constructor options (see source).
           #
@@ -205,6 +218,7 @@ module Elasticsearch
             @arguments[:timeout]           ||= ENV.fetch('TEST_CLUSTER_TIMEOUT',   30).to_i
             @arguments[:number_of_nodes]   ||= ENV.fetch('TEST_CLUSTER_NODES',     2).to_i
             @arguments[:network_host]      ||= ENV.fetch('TEST_CLUSTER_NETWORK_HOST', __default_network_host)
+            @arguments[:quiet]             ||= ! ENV.fetch('QUIET', '').empty?
 
             @clear_cluster = !!@arguments[:clear_cluster] || (ENV.fetch('TEST_CLUSTER_CLEAR', 'true') != 'false')
 
@@ -239,22 +253,23 @@ module Elasticsearch
           #
           def start
             if self.running?
-              STDOUT.print "[!] Elasticsearch cluster already running".ansi(:red)
+              __log "[!] Elasticsearch cluster already running".ansi(:red)
               return false
             end
 
             __remove_cluster_data if @clear_cluster
 
-            STDOUT.print "Starting ".ansi(:faint) + arguments[:number_of_nodes].to_s.ansi(:bold, :faint) +
-                         " Elasticsearch nodes..".ansi(:faint)
+            __log "Starting ".ansi(:faint) + arguments[:number_of_nodes].to_s.ansi(:bold, :faint) +
+                  " Elasticsearch #{arguments[:number_of_nodes] < 2 ? 'node' : 'nodes'}..".ansi(:faint), :print
+
             pids = []
 
-            STDERR.puts "Using Elasticsearch version [#{version}]" if ENV['DEBUG']
+            __log "\nUsing Elasticsearch version [#{version}]" if ENV['DEBUG']
 
             arguments[:number_of_nodes].times do |n|
               n += 1
               command =  __command(version, arguments, n)
-              STDERR.puts command.gsub(/ {1,}/, ' ') if ENV['DEBUG']
+              __log command.gsub(/ {1,}/, ' ').ansi(:bold) if ENV['DEBUG']
 
               pid = Process.spawn(command)
               Process.detach pid
@@ -264,7 +279,7 @@ module Elasticsearch
 
             __check_for_running_processes(pids)
             wait_for_green
-            __print_cluster_info
+            __log __cluster_info
 
             return true
           end
@@ -286,7 +301,7 @@ module Elasticsearch
             begin
               nodes = __get_nodes
             rescue Exception => e
-              STDERR.puts "[!] Exception raised when stopping the cluster: #{e.inspect}".ansi(:red)
+              __log "[!] Exception raised when stopping the cluster: #{e.inspect}".ansi(:red)
               nil
             end
 
@@ -295,13 +310,14 @@ module Elasticsearch
             pids  = nodes['nodes'].map { |id, info| info['process']['id'] }
 
             unless pids.empty?
-              STDOUT.print "\nStopping Elasticsearch nodes... ".ansi(:faint)
+              __log "Stopping Elasticsearch nodes... ".ansi(:faint), :print
+
               pids.each_with_index do |pid, i|
                 ['INT','KILL'].each do |signal|
                   begin
                     Process.kill signal, pid
                   rescue Exception => e
-                    STDOUT.print "[#{e.class}] PID #{pid} not found. ".ansi(:red)
+                    __log "[#{e.class}] PID #{pid} not found. ".ansi(:red), :print
                   end
 
                   # Give the system some breathing space to finish...
@@ -313,14 +329,15 @@ module Elasticsearch
                     # `getpgid` will raise error if pid is dead, so if we get here, try next signal
                     next
                   rescue Errno::ESRCH
-                    STDOUT.print "Stopped PID #{pid}".ansi(:green) +
+                    __log "Stopped PID #{pid}".ansi(:green) +
                     (ENV['DEBUG'] ? " with #{signal} signal".ansi(:green) : '') +
-                    ". ".ansi(:green)
+                    ". ".ansi(:green), :print
                     break # pid is dead
                   end
                 end
               end
-              STDOUT.puts
+
+              __log "\n"
             else
               return false
             end
@@ -416,23 +433,35 @@ module Elasticsearch
             jar = Dir.entries(path_to_lib).select { |f| f.start_with? 'elasticsearch' }.first if File.exist? path_to_lib
 
             version = if jar
-              if m = jar.match(/elasticsearch\-(\d+\.\d+.\d+).*/)
+              __log "Determining version from [#{jar}]" if ENV['DEBUG']
+              if m = jar.match(/elasticsearch\-(\d+\.\d+\.\d+).*/)
                 m[1]
               else
                 raise RuntimeError, "Cannot determine Elasticsearch version from jar [#{jar}]"
               end
             else
-              STDERR.puts "[!] Cannot find Elasticsearch .jar from path to command [#{arguments[:command]}], using `#{arguments[:command]} --version`" if ENV['DEBUG']
+              __log "[!] Cannot find Elasticsearch .jar from path to command [#{arguments[:command]}], using `#{arguments[:command]} --version`" if ENV['DEBUG']
 
               unless File.exist? arguments[:command]
-                raise Errno::ENOENT, "File [#{arguments[:command]}] does not exist -- did you pass a correct path to the Elasticsearch launch script"
+                __log "File [#{arguments[:command]}] does not exists, checking full path by `which`: ", :print if ENV['DEBUG']
+
+                begin
+                  full_path = `which #{arguments[:command]}`.strip
+                  __log "#{full_path.inspect}\n", :print if ENV['DEBUG']
+                rescue Exception => e
+                  raise RuntimeError, "Cannot determine full path to [#{arguments[:command]}] with 'which'"
+                end
+
+                if full_path.empty?
+                  raise Errno::ENOENT, "Cannot find Elasticsearch launch script from [#{arguments[:command]}] -- did you pass a correct path?"
+                end
               end
 
               output = ''
 
               begin
                 # First, try the new `--version` syntax...
-                STDERR.puts "Running [#{arguments[:command]} --version] to determine version" if ENV['DEBUG']
+                __log "Running [#{arguments[:command]} --version] to determine version" if ENV['DEBUG']
                 rout, wout = IO.pipe
                 pid = Process.spawn("#{arguments[:command]} --version", out: wout)
 
@@ -444,10 +473,12 @@ module Elasticsearch
                 end
               rescue Timeout::Error
                 # ...else, the old `-v` syntax
-                STDERR.puts "Running [#{arguments[:command]} -v] to determine version" if ENV['DEBUG']
+                __log "Running [#{arguments[:command]} -v] to determine version" if ENV['DEBUG']
                 output = `#{arguments[:command]} -v`
               ensure
-                Process.kill('INT', pid) if pid
+                if pid
+                  Process.kill('INT', pid) rescue Errno::ESRCH # Most likely the process has terminated already
+                end
                 wout.close unless wout.closed?
                 rout.close unless rout.closed?
               end
@@ -511,33 +542,33 @@ module Elasticsearch
               Timeout::timeout(timeout) do
                 loop do
                   response = __get_cluster_health(status)
-                  STDERR.puts response if ENV['DEBUG']
+                  __log response if ENV['DEBUG']
 
                   if response && response['status'] == status && ( arguments[:number_of_nodes].nil? || arguments[:number_of_nodes].to_i == response['number_of_nodes'].to_i  )
                     break
                   end
 
-                  STDOUT.print '.'.ansi(:faint)
+                  __log '.'.ansi(:faint), :print
                   sleep 1
                 end
               end
             rescue Timeout::Error => e
               message = "\nTimeout while waiting for cluster status [#{status}]"
               message += " and [#{arguments[:number_of_nodes]}] nodes" if arguments[:number_of_nodes]
-              STDOUT.puts message.ansi(:red, :bold)
+              __log message.ansi(:red, :bold)
               raise e
             end
 
             return true
           end
 
-          # Print information about the cluster on STDOUT
+          # Return information about the cluster
           #
           # @api private
           #
-          # @return Nil
+          # @return String
           #
-          def __print_cluster_info
+          def __cluster_info
             health = JSON.parse(Net::HTTP.get(URI("#{__cluster_url}/_cluster/health")))
             nodes  = if version == '0.90'
               JSON.parse(Net::HTTP.get(URI("#{__cluster_url}/_nodes/?process&http")))
@@ -546,21 +577,23 @@ module Elasticsearch
             end
             master = JSON.parse(Net::HTTP.get(URI("#{__cluster_url}/_cluster/state")))['master_node']
 
-            puts "\n",
-                  ('-'*80).ansi(:faint),
-                 'Cluster: '.ljust(20).ansi(:faint) + health['cluster_name'].to_s.ansi(:faint),
-                 'Status:  '.ljust(20).ansi(:faint) + health['status'].to_s.ansi(:faint),
-                 'Nodes:   '.ljust(20).ansi(:faint) + health['number_of_nodes'].to_s.ansi(:faint)
+            result = ["\n",
+                      ('-'*80).ansi(:faint),
+                      'Cluster: '.ljust(20).ansi(:faint) + health['cluster_name'].to_s.ansi(:faint),
+                      'Status:  '.ljust(20).ansi(:faint) + health['status'].to_s.ansi(:faint),
+                      'Nodes:   '.ljust(20).ansi(:faint) + health['number_of_nodes'].to_s.ansi(:faint)].join("\n")
 
             nodes['nodes'].each do |id, info|
               m = id == master ? '*' : '+'
-              puts ''.ljust(20) +
-                   "#{m} ".ansi(:faint) +
-                   "#{info['name'].ansi(:bold)} ".ansi(:faint) +
-                   "| version: #{info['version'] rescue 'N/A'}, ".ansi(:faint) +
-                   "pid: #{info['process']['id'] rescue 'N/A'}, ".ansi(:faint) +
-                   "address: #{info['http']['bound_address'] rescue 'N/A'}".ansi(:faint)
+              result << ''.ljust(20) +
+                        "#{m} ".ansi(:faint) +
+                        "#{info['name'].ansi(:bold)} ".ansi(:faint) +
+                        "| version: #{info['version'] rescue 'N/A'}, ".ansi(:faint) +
+                        "pid: #{info['process']['id'] rescue 'N/A'}, ".ansi(:faint) +
+                        "address: #{info['http']['bound_address'] rescue 'N/A'}".ansi(:faint)
             end
+
+            result
           end
 
           # Tries to load cluster health information
@@ -598,7 +631,7 @@ module Elasticsearch
           #
           def __check_for_running_processes(pids)
             if `ps -p #{pids.join(' ')}`.split("\n").size < arguments[:number_of_nodes]+1
-              STDERR.puts "", "[!!!] Process failed to start (see output above)".ansi(:red)
+              __log "\n[!!!] Process failed to start (see output above)".ansi(:red)
               exit(1)
             end
           end
@@ -610,6 +643,12 @@ module Elasticsearch
           def __get_nodes
             JSON.parse(Net::HTTP.get(URI("#{__cluster_url}/_nodes/process")))
           end
+
+          # Print to STDERR
+          #
+          def __log(message, mode=:puts)
+           STDERR.__send__ mode, message unless @arguments[:quiet]
+          end
         end
       end
     end

data/lib/elasticsearch/extensions/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Extensions
-    VERSION = "0.0.23"
+    VERSION = "0.0.24"
   end
 end

data/test/test/cluster/unit/cluster_test.rb

@@ -102,6 +102,13 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
         @subject.__remove_cluster_data
       end
 
+      should "not log when :quiet" do
+        c = Cluster::Cluster.new quiet: true
+
+        STDERR.expects(:puts).never
+        c.__log 'QUIET'
+      end
+
       context "when starting a cluster, " do
         should "return false when it's already running" do
           Process.expects(:spawn).never
@@ -127,7 +134,7 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
           c.expects(:wait_for_green).returns(true)
           c.expects(:__check_for_running_processes).returns(true)
           c.expects(:__determine_version).returns('5.0')
-          c.expects(:__print_cluster_info).returns(true)
+          c.expects(:__cluster_info).returns('CLUSTER INFO')
 
           assert_equal true, c.start
         end
@@ -198,8 +205,6 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
         end
 
         should "return true" do
-          @subject.stubs(:__print_cluster_info)
-
           @subject
             .expects(:__get_cluster_health)
             .with('yellow')
@@ -254,6 +259,7 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
 
         should "return version from `elasticsearch --version`" do
           File.expects(:exist?).with('/foo/bar/bin/../lib/').returns(false)
+          File.expects(:exist?).with('/foo/bar/bin/elasticsearch').returns(true)
 
           Process.stubs(:wait)
           Process.expects(:spawn)
@@ -270,7 +276,7 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
         end
 
         should "raise an exception when the version cannot be parsed from .jar" do
-          # Incorrect jar version
+          # Incorrect jar version (no dots)
           File.expects(:exist?).with('/foo/bar/bin/../lib/').returns(true)
           Dir.expects(:entries).with('/foo/bar/bin/../lib/').returns(['elasticsearch-100.jar'])
 
@@ -279,6 +285,7 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
 
         should "raise an exception when the version cannot be parsed from command output" do
           File.expects(:exist?).with('/foo/bar/bin/../lib/').returns(false)
+          File.expects(:exist?).with('/foo/bar/bin/elasticsearch').returns(true)
 
           Process.stubs(:wait)
           Process.expects(:spawn)
@@ -300,6 +307,16 @@ class Elasticsearch::Extensions::TestClusterTest < Test::Unit::TestCase
 
           assert_raise(RuntimeError) { @subject.__determine_version }
         end
+
+        should "raise an exception when the command cannot be found" do
+          @subject = Elasticsearch::Extensions::Test::Cluster::Cluster.new
+
+          File.expects(:exist?).with('./../lib/').returns(false)
+          File.expects(:exist?).with('elasticsearch').returns(false)
+          @subject.expects(:`).returns('')
+
+          assert_raise(Errno::ENOENT) { @subject.__determine_version }
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi