elastomer-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eca5b5a54ecb727c3c790ff26332120568610f89
+  data.tar.gz: 69141e48ad5496d14d41f8259516834c751e28f1
+SHA512:
+  metadata.gz: 56022b1a27992c308a84102f064343001bef7253aa0be850fede460a77a949a84ec26db618a72e0001c4bc6ae7c85404442f5d70c2ccafca4d0c891a1ed6116f
+  data.tar.gz: 9fb869355b3338152b626b0b58db7694d44ed8812af56a8cf95fbff036869737f34c7497fe818cc1c85604813771f7787e8ad3f37ab8976090396634d6c030a1

data/.gitignore

@@ -0,0 +1,22 @@
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/gems

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0-github

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.0 (2014-06-24)
+- First rubygems release
+- New commands
+  - `cluster health`
+  - `cluster settings`
+  - `cluster allocation <command>`
+  - `node hot_threads`
+  - `node list`

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elastomer-cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GitHub Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Elastomer::Cli
+
+A command-line interface to your ES cluster.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elastomer-cli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastomer-cli
+
+## Usage
+
+`bin/elastomer help`
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/elastomer-cli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/bin/elastomer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'elastomer/cli'
+
+Elastomer::CLI.start

data/elastomer-cli.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastomer/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastomer-cli"
+  spec.version       = Elastomer::Cli::VERSION
+  spec.authors       = ["Grant Rodgers"]
+  spec.email         = ["grant.rodgers@github.com"]
+  spec.summary       = %q{Command line interface for elastomer}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/github/elastomer-cli"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "terminal-table"
+  spec.add_runtime_dependency "elastomer-client", "~> 0.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/elastomer/cli/application.rb

@@ -0,0 +1,11 @@
+module Elastomer
+  module CLI
+    class Application < Base
+
+      desc "cluster SUBCOMMAND ...ARGS", "execute cluster commands"
+      subcommand "cluster", Cluster
+      desc "node SUBCOMMAND ...ARGS", "execute node commands"
+      subcommand "node", Node
+    end
+  end
+end

data/lib/elastomer/cli/base.rb

@@ -0,0 +1,20 @@
+module Elastomer
+  module CLI
+    class Base < Thor
+      class_option :url
+      class_option :read_timeout
+      class_option :open_timeout
+
+      protected
+      def client
+        # Elastomer::Client requires symbol keys, but options returns
+        # string keys
+        @client ||= Elastomer::Client.new(
+                      :url => options[:url] || 'http://localhost:9200',
+                      :read_timeout => options[:read_timeout],
+                      :open_timeout => options[:open_timeout]
+                    )
+      end
+    end
+  end
+end

data/lib/elastomer/cli/cluster.rb

@@ -0,0 +1,96 @@
+module Elastomer
+  module CLI
+    class Cluster < Base
+      desc "health", "get cluster health"
+      def health
+        response = cluster.health
+        puts Terminal::Table.new(
+          :headings => ['CLUSTER HEALTH', ""],
+          :rows => [
+            ['Name',                  response["cluster_name"]],
+            ['Status',                response["status"]],
+            ['Timed Out',             response["timed_out"]],
+            ['Number of Nodes',       response["number_of_nodes"]],
+            ['Number of Data Nodes',  response["number_of_data_nodes"]],
+            ['Active Primary Shards', response["active_primary_shards"]],
+            ['Active Shards',         response["active_shards"]],
+            ['Relocating Shards',     response["relocating_shards"]],
+            ['Initializing Shards',   response["initializing_shards"]],
+            ['Unassigned Shards',     response["unassigned_shards"]]
+        ])
+      end
+
+      desc "settings", "show persistent and transient cluster settings"
+      def settings
+        response = cluster.get_settings(:flat_settings => true)
+
+        persistent_settings = response["persistent"].collect do |key, value|
+          [key, value]
+        end
+        transient_settings = response["transient"].collect do |key, value|
+          [key, value]
+        end
+
+        puts Terminal::Table.new(
+          :headings => ['SETTING NAME', "VALUE"],
+          :rows => [
+            ['PERSISTENT', '']
+          ] + persistent_settings + [
+            ['TRANSIENT', '']
+          ] + transient_settings
+        )
+
+      end
+
+      desc "allocation", "control shard allocation"
+      long_desc <<-LONGDESC
+        Manage cluster allocation settings.
+
+        For Elasticsearch clusters running 0.90.x, valid options are:
+          - enable
+          - disable
+
+        For Elasticsearch clusters running 1.x, valid options are:
+          - all (alias: enable)
+          - primaries
+          - new_primaries
+          - none (alias: disable)
+      LONGDESC
+      def allocation(command)
+        if client.version =~ /^0.90/
+          setting = "cluster.routing.allocation.disable_allocation"
+          value = case command
+          when 'enable'
+            false
+          when 'disable'
+            true
+          else
+            raise Thor::Error, "ERROR: Unknown allocation command: #{command}"
+          end
+        elsif client.version =~ /^1./
+          setting = "cluster.routing.allocation.enable"
+          value = case command
+          when 'enable'
+            'all'
+          when 'disable'
+            'none'
+          when 'all', 'primaries', 'new_primaries', 'none'
+            command
+          else
+            raise Thor::Error, "ERROR: Unknown allocation command: #{command}"
+          end
+        else
+          raise Thor::Error, "ERROR: Unknown Elasticsearch version: #{client.version}"
+          return
+        end
+        cluster.update_settings("persistent" => {setting => value})
+        puts "Successfully set #{setting}=#{value}"
+      end
+
+      private
+      def cluster
+        client.cluster
+      end
+    end
+  end
+end

data/lib/elastomer/cli/node.rb

@@ -0,0 +1,33 @@
+module Elastomer
+  module CLI
+    class Node < Base
+      desc "hot_threads", "get hot_threads"
+      def hot_threads
+        response = nodes.hot_threads
+        puts response
+      end
+
+      desc "list", "list all nodes in the cluster"
+      def list
+        response = nodes.info
+        puts Terminal::Table.new(
+          :headings => ['NAME', 'HOSTNAME', 'VERSION', 'HTTP ADDRESS', 'ATTRIBUTES'],
+          :rows => response["nodes"].collect do |node_id, node|
+            [
+              node["name"],
+              node["host"],
+              node["version"],
+              node["http_address"],
+              node["attributes"]
+            ]
+          end
+        )
+      end
+
+      private
+      def nodes
+        client.nodes('_local')
+      end
+    end
+  end
+end

data/lib/elastomer/cli/version.rb

@@ -0,0 +1,5 @@
+module Elastomer
+  module Cli
+    VERSION = "0.1.0"
+  end
+end

data/lib/elastomer/cli.rb

@@ -0,0 +1,19 @@
+require "elastomer/cli/version"
+
+require 'thor'
+require 'terminal-table'
+require 'elastomer/client'
+
+require 'elastomer/cli/base'
+require 'elastomer/cli/cluster'
+require 'elastomer/cli/node'
+
+require 'elastomer/cli/application'
+
+module Elastomer
+  module CLI
+    def self.start(*args)
+      Elastomer::CLI::Application.start(*args)
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -e
+
+cd "$(dirname "$0")/.."
+bundle install --path vendor/gems --quiet "$@"

data/script/cibuild

@@ -0,0 +1,11 @@
+#!/bin/sh
+# Usage: script/cibuild
+# CI build script.
+set -e
+
+cd $(dirname "$0")/..
+PATH="$(pwd)/bin:$(pwd)/script:/usr/share/rbenv/shims:$PATH"
+export RBENV_VERSION="$(cat .ruby-version)"
+
+script/bootstrap
+script/test

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'irb'
+require 'rubygems'
+require 'bundler/setup'
+
+require 'elastomer/cli'
+
+IRB.start

data/script/test

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# run entire test suite
+bundle exec rake test

data/test/application_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe Elastomer::CLI::Application do
+  describe 'global options' do
+    it 'should accept --url' do
+      VCR.use_cassette("default_9201") do
+        elastomer "cluster health --url http://localhost:9201"
+        @out.must_match /Name.*elasticsearch/
+      end
+    end
+
+    it 'should accept timeouts' do
+      Elastomer::CLI::Application.class_options.keys.must_include :read_timeout
+      Elastomer::CLI::Application.class_options.keys.must_include :open_timeout
+    end
+  end
+end

data/test/cluster_test.rb

@@ -0,0 +1,89 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe Elastomer::CLI::Cluster do
+  describe 'health' do
+    it 'should get cluster health' do
+      VCR.use_cassette('default') do
+        elastomer 'cluster health'
+        @out.must_match /Name.*elasticsearch/
+        @out.must_match /Status.*green/
+        @out.must_match /Timed Out.*false/
+        @out.must_match /Number of Nodes.*1/
+        @out.must_match /Number of Data Nodes.*1/
+        @out.must_match /Active Primary Shards.*0/
+        @out.must_match /Active Shards.*0/
+        @out.must_match /Relocating Shards.*0/
+        @out.must_match /Initializing Shards.*0/
+        @out.must_match /Unassigned Shards.*0/
+      end
+    end
+  end
+
+  describe 'settings' do
+    it 'should get persistent and transient cluster settings' do
+      VCR.use_cassette('default') do
+        elastomer 'cluster settings'
+        @out.must_match /PERSISTENT.*indices.ttl.interval\s+|\s*50/m
+        @out.must_match /TRANSIENT.*indices.ttl.interval\s+|\s*60/m
+      end
+    end
+  end
+
+  describe 'allocation' do
+
+    it 'should deny unknown commands' do
+      VCR.use_cassette('default') do
+        elastomer 'cluster allocation foobar'
+        @err.must_match "ERROR: Unknown allocation command: foobar"
+      end
+    end
+
+    it 'should deny unknown versions' do
+      VCR.use_cassette('0.20') do
+        elastomer 'cluster allocation disable'
+        @err.must_match "ERROR: Unknown Elasticsearch version: 0.20.6"
+      end
+    end
+
+    describe '0.90' do
+      it 'should disable allocation' do
+        VCR.use_cassette('0.90') do
+          elastomer 'cluster allocation disable'
+          @out.must_match /cluster.routing.allocation.disable_allocation=true/
+        end
+      end
+
+      it 'should enable allocation' do
+        VCR.use_cassette('0.90') do
+          elastomer 'cluster allocation enable'
+          @out.must_match /cluster.routing.allocation.disable_allocation=false/
+        end
+      end
+    end
+
+    describe '1.x' do
+      it 'should disable allocation' do
+        VCR.use_cassette('1.x') do
+          elastomer 'cluster allocation disable'
+          @out.must_match /PERSISTENT.*cluster.routing.allocation.enable\s+|\s*none/m
+        end
+      end
+
+      it 'should enable allocation' do
+        VCR.use_cassette('1.x') do
+          elastomer 'cluster allocation enable'
+          @out.must_match /PERSISTENT.*cluster.routing.allocation.enable\s+|\s*all/m
+        end
+      end
+
+      it 'should allow new allocation states' do
+        VCR.use_cassette('1.x') do
+          %w{ all primaries new_primaries none }.each do |state|
+            elastomer "cluster allocation #{state}"
+            @out.must_match /PERSISTENT.*cluster.routing.allocation.enable\s+|\s*#{state}/m
+          end
+        end
+      end
+    end
+  end
+end

data/test/fixtures/vcr_cassettes/0_20.yml

@@ -0,0 +1,114 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '167'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "ok" : true,
+          "status" : 200,
+          "name" : "Amun",
+          "version" : {
+            "number" : "0.20.6",
+            "snapshot_build" : false
+          },
+          "tagline" : "You Know, for Search"
+        }
+    http_version: 
+  recorded_at: Wed, 18 Jun 2014 02:23:38 GMT
+- request:
+    method: get
+    uri: http://localhost:9200/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '167'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "ok" : true,
+          "status" : 200,
+          "name" : "Amun",
+          "version" : {
+            "number" : "0.20.6",
+            "snapshot_build" : false
+          },
+          "tagline" : "You Know, for Search"
+        }
+    http_version: 
+  recorded_at: Wed, 18 Jun 2014 02:23:38 GMT
+- request:
+    method: get
+    uri: http://localhost:9200/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '167'
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "ok" : true,
+          "status" : 200,
+          "name" : "Amun",
+          "version" : {
+            "number" : "0.20.6",
+            "snapshot_build" : false
+          },
+          "tagline" : "You Know, for Search"
+        }
+    http_version: 
+  recorded_at: Wed, 18 Jun 2014 02:23:38 GMT
+recorded_with: VCR 2.9.2