collins_shell 0.2.14

data/VERSION

@@ -0,0 +1 @@
+0.2.14

data/bin/collins-shell

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+if ENV.key?('COLLINS_DEBUG') && ENV['COLLINS_DEBUG'] then
+HTTP_DEBUG = true
+end
+
+# Make sure we're running a valid version of ruby
+if RUBY_VERSION !~ /^1\.9\./ then
+  puts("We require ruby 1.9.2")
+  exit(1)
+end
+
+if not ENV.key?('HOME') || ENV['HOME'].empty? then
+  puts("No HOME environment found. Exiting")
+  exit(2)
+end
+
+$:.unshift File.join File.dirname(__FILE__), *%w[.. lib]
+# Allows us to use a dev version of collins-client if needed
+$:.unshift File.join File.dirname(__FILE__), *%w[.. .. ruby collins-client lib]
+%w[collins_shell collins_shell/cli].each {|f| require f}
+
+begin
+  CollinsShell::Cli.start
+rescue SystemExit => e
+rescue CollinsShell::ConfigurationError => e
+  cli = CollinsShell::Cli.new
+  cli.say_status("fatal", "your environment is not setup correctly", :red)
+  cli.say_status("message", "#{e.message}")
+  exit(1)
+rescue Exception => e
+  cli = CollinsShell::Cli.new
+  cli.print_error e
+  exit(2)
+end
+exit(0)

data/collins_shell.gemspec

@@ -0,0 +1,95 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "collins_shell"
+  s.version = "0.2.14"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blake Matheny"]
+  s.date = "2012-10-31"
+  s.description = "Provides basic CLI for interacting with Collins API"
+  s.email = "bmatheny@tumblr.com"
+  s.executables = ["collins-shell"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".pryrc",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/collins-shell",
+    "collins_shell.gemspec",
+    "lib/collins_shell.rb",
+    "lib/collins_shell/asset.rb",
+    "lib/collins_shell/cli.rb",
+    "lib/collins_shell/console.rb",
+    "lib/collins_shell/console/asset.rb",
+    "lib/collins_shell/console/cache.rb",
+    "lib/collins_shell/console/command_helpers.rb",
+    "lib/collins_shell/console/commands.rb",
+    "lib/collins_shell/console/commands/cat.rb",
+    "lib/collins_shell/console/commands/cd.rb",
+    "lib/collins_shell/console/commands/io.rb",
+    "lib/collins_shell/console/commands/iterators.rb",
+    "lib/collins_shell/console/commands/tail.rb",
+    "lib/collins_shell/console/commands/versions.rb",
+    "lib/collins_shell/console/filesystem.rb",
+    "lib/collins_shell/console/options_helpers.rb",
+    "lib/collins_shell/errors.rb",
+    "lib/collins_shell/ip_address.rb",
+    "lib/collins_shell/ipmi.rb",
+    "lib/collins_shell/monkeypatch.rb",
+    "lib/collins_shell/provision.rb",
+    "lib/collins_shell/state.rb",
+    "lib/collins_shell/tag.rb",
+    "lib/collins_shell/thor.rb",
+    "lib/collins_shell/util.rb",
+    "lib/collins_shell/util/asset_printer.rb",
+    "lib/collins_shell/util/asset_stache.rb",
+    "lib/collins_shell/util/log_printer.rb",
+    "lib/collins_shell/util/printer_util.rb"
+  ]
+  s.homepage = "https://github.com/tumblr/collins/tree/master/support/collins-shell"
+  s.licenses = ["APL 2.0"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Shell for Collins API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<collins_client>, ["~> 0.2.7"])
+      s.add_runtime_dependency(%q<highline>, ["~> 1.6.15"])
+      s.add_runtime_dependency(%q<mustache>, ["~> 0.99.4"])
+      s.add_runtime_dependency(%q<pry>, ["~> 0.9.9.6"])
+      s.add_runtime_dependency(%q<rubygems-update>, ["~> 1.8.24"])
+      s.add_runtime_dependency(%q<terminal-table>, ["~> 1.4.5"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0.16.0"])
+    else
+      s.add_dependency(%q<collins_client>, ["~> 0.2.7"])
+      s.add_dependency(%q<highline>, ["~> 1.6.15"])
+      s.add_dependency(%q<mustache>, ["~> 0.99.4"])
+      s.add_dependency(%q<pry>, ["~> 0.9.9.6"])
+      s.add_dependency(%q<rubygems-update>, ["~> 1.8.24"])
+      s.add_dependency(%q<terminal-table>, ["~> 1.4.5"])
+      s.add_dependency(%q<thor>, ["~> 0.16.0"])
+    end
+  else
+    s.add_dependency(%q<collins_client>, ["~> 0.2.7"])
+    s.add_dependency(%q<highline>, ["~> 1.6.15"])
+    s.add_dependency(%q<mustache>, ["~> 0.99.4"])
+    s.add_dependency(%q<pry>, ["~> 0.9.9.6"])
+    s.add_dependency(%q<rubygems-update>, ["~> 1.8.24"])
+    s.add_dependency(%q<terminal-table>, ["~> 1.4.5"])
+    s.add_dependency(%q<thor>, ["~> 0.16.0"])
+  end
+end
+

data/lib/collins_shell.rb

@@ -0,0 +1,3 @@
+$:.unshift File.join File.dirname(__FILE__)
+require 'collins_shell/errors'
+require 'pp'

data/lib/collins_shell/asset.rb

@@ -0,0 +1,198 @@
+require 'collins_shell/thor'
+require 'collins_shell/util'
+require 'collins_shell/util/asset_printer'
+require 'thor'
+require 'thor/group'
+
+module CollinsShell
+
+  class Asset < Thor
+    include ThorHelper
+    include CollinsShell::Util
+    namespace :asset
+    def self.banner task, namespace = true, subcommand = false
+      "#{basename} #{task.formatted_usage(self, true, subcommand).gsub(':',' ')}"
+    end
+
+    desc 'create', 'create an asset in collins'
+    use_collins_options
+    use_tag_option(true)
+    method_option :ipmi, :type => :boolean, :desc => 'Generate IPMI data'
+    method_option :status, :type => :string, :desc => 'Status of asset'
+    method_option :type, :type => :string, :desc => 'Asset type'
+    def create
+      call_collins get_collins_client, "create asset" do |client|
+        asset = client.create! options.tag, :generate_ipmi => options.ipmi, :status => options.status, :type => options.type
+        print_find_results asset, nil
+      end
+    end
+
+    desc 'delete', 'delete an asset in collins (must be cancelled)'
+    use_collins_options
+    use_tag_option(true)
+    method_option :reason, :required => true, :type => :string, :desc => 'Reason to delete asset'
+    def delete
+      call_collins get_collins_client, "delete asset" do |client|
+        if client.delete!(options.tag, :reason => options.reason) then
+          say_success "deleted asset #{options.tag}"
+        else
+          say_error "deleting asset #{options.tag}", :exit => true
+        end
+      end
+    end
+
+    desc 'find', 'find assets using the specified selector'
+    use_collins_options
+    use_selector_option(true)
+    method_option :confirm, :type => :boolean, :default => :true, :desc => 'Require exec confirmation. Defaults to true'
+    method_option :details, :type => :boolean, :desc => 'Output assets how you see them in get'
+    method_option :exec, :type => :string, :desc => 'Execute a command using the data from this asset. Use {{hostname}}, {{ipmi.password}}, etc for substitution'
+    method_option :header, :type => :boolean, :default => true, :desc => 'Display a tag header. Defaults to true'
+    method_option :logs, :type => :boolean, :default => false, :desc => 'Also display asset logs, only used with details (SLOW)'
+    method_option :size, :type => :numeric, :default => 50, :desc => 'Number of results to find. Defaults to 50'
+    method_option :tags, :type => :array, :desc => 'Tags to display of form: tag1 tag2 tag3. e.g. --tags=hostname tag backend_ip_address'
+    method_option :url, :type => :boolean, :default => true, :desc => 'Display a URL along with tags or the default listing'
+    def find
+      client = get_collins_client
+      tags = options.tags || [:stuff] 
+      selector = get_selector options.selector, tags, options["size"], options.remote
+      assets = client.find selector
+      if options.details then
+        assets.each do |asset|
+          if not options.quiet then
+            logs = []
+            if options.logs and not options.exec? then
+              logs = client.logs(asset, :size => 5000, :SORT => "DESC").reverse
+            end
+            printer = CollinsShell::AssetPrinter.new asset, self, :separator => '*',
+                                                                  :logs => logs,
+                                                                  :detailed => !options.exec?
+            puts printer
+          end
+          asset_exec asset, options.exec, options.confirm
+        end
+      else
+        if not options.quiet then
+          print_find_results assets, options.tags, :header => options.header, :url => options.url
+        end
+        assets.each {|asset| asset_exec(asset, options.exec, options.confirm)}
+      end
+    end
+
+    desc 'find_similar TAG', 'get similar unallocated assets for a gven asset'
+    use_collins_options
+    method_option :size, :type => :numeric, :default => 50, :desc => 'number of results to find. Defaults to 50'
+    method_option :details, :type => :boolean, :desc => 'Output assets how you see them in get'
+    method_option :sort, :type => :string, :default => "DESC", :desc => 'sort direction, either ASC or DESC'
+    method_option :sort_type, :type => :string, :default => "distribution", :desc => 'sorting type'
+    method_option :only_unallocated, :type => :boolean, :default => true, :desc => 'only return unallocated assets, defaults to true'
+    def find_similar tag
+      call_collins get_collins_client, "similar asset" do |client|
+        as_asset = Collins::Asset.new(tag)
+        assets = client.find_similar as_asset, options["size"], options["sort"], options.sort_type, options.only_unallocated
+        if options.details then
+          assets.each do |asset|
+            printer = CollinsShell::AssetPrinter.new asset, self, :separator => '*'
+            puts printer
+          end
+        else
+          print_find_results assets, options.tags
+        end
+      end
+    end
+
+    desc 'get TAG', 'get an asset and display its attributes'
+    use_collins_options
+    method_option :confirm, :type => :boolean, :default => :true, :desc => 'Require exec confirmation. Defaults to true'
+    method_option :exec, :type => :string, :desc => 'Execute a command using the data from this asset. Use {{hostname}}, {{ipmi.password}}, etc for substitution'
+    method_option :logs, :type => :boolean, :default => false, :desc => 'Also display asset logs'
+    method_option :remote, :type => :string, :desc => 'Remote location to search. This is a tag in collins corresponding to the datacenter asset'
+    def get tag
+      asset = asset_get tag, options
+      if asset then
+        if not options.quiet then
+          logs = []
+          if options.logs and not options.exec? then
+            logs = call_collins(get_collins_client, "logs") do |client|
+              client.logs(asset, :size => 5000, :sort => "DESC").reverse
+            end
+          end
+          printer = CollinsShell::AssetPrinter.new asset, self, :logs => logs, :detailed => !options.exec?
+          puts printer
+        end
+        asset_exec asset, options.exec, options.confirm
+      else
+        say_error "No such asset #{tag}"
+      end
+    end
+
+    desc 'set_attribute KEY VALUE', 'set an attribute in collins'
+    use_collins_options
+    use_tag_option
+    use_selector_option
+    method_option :json, :type => :boolean, :default => false, :desc => 'Encode as JSON value. Only works for arrays and hashes.'
+    def set_attribute key, value
+      batch_selector_operation Hash[
+        :remote => options.remote,
+        :operation => "set_attribute",
+        :success_message => proc {|asset| "Set attribute on #{asset.tag}"},
+        :error_message => proc{|asset| "Setting attribute on #{asset.tag}"},
+        :confirmation_message => proc do |assets|
+          "You are about to set #{key}=#{value} on #{assets.length} hosts. ARE YOU SURE?"
+        end
+      ] do |client,asset|
+        if options.json then
+          value = JSON.dump(eval(value))
+        end
+        client.set_attribute!(asset, key, value)
+      end
+    end
+
+    desc 'delete_attribute KEY', 'delete an attribute in collins'
+    use_collins_options
+    use_tag_option
+    use_selector_option
+    def delete_attribute key
+      batch_selector_operation Hash[
+        :remote => options.remote,
+        :operation => "delete_attribute",
+        :success_message => proc {|asset| "Delete attribute on #{asset.tag}"},
+        :error_message => proc{|asset| "Delete attribute on #{asset.tag}"},
+        :confirmation_message => proc do |assets|
+          "You are about to delete #{key} on #{assets.length} hosts. ARE YOU SURE?"
+        end
+      ] do |client,asset|
+        client.delete_attribute!(asset, key)
+      end
+    end
+
+    desc 'set_status', 'set status, state, or both on an asset'
+    use_collins_options
+    use_tag_option
+    use_selector_option
+    method_option :reason, :type => :string, :required => true, :desc => 'Reason for changing status'
+    method_option :state, :type => :string, :required => false, :desc => 'Set state of asset as well'
+    method_option :status, :type => :string, :required => false, :desc => 'Set status of asset'
+    def set_status
+      status = options.status
+      state = options.state
+      reason = options.reason
+      if status.nil? && state.nil? then
+        raise ::Collins::ExpectationFailedError.new("set_status requires either a status or a state")
+      end
+      batch_selector_operation Hash[
+        :remote => options.remote,
+        :operation => "set_status",
+        :success_message => proc {|asset| "Set status to #{status} on #{asset.tag}"},
+        :error_message => proc{|asset| "Setting status on #{asset.tag}"},
+        :confirmation_message => proc do |assets|
+          "You are about to set status to #{status} on #{assets.length} hosts. ARE YOU SURE?"
+        end
+      ] do |client,asset|
+        client.set_status!(asset, :reason => reason, :status => status, :state => state)
+      end
+    end
+
+  end
+
+end

data/lib/collins_shell/cli.rb

@@ -0,0 +1,185 @@
+require 'collins_shell/asset'
+require 'collins_shell/console'
+require 'collins_shell/ip_address'
+require 'collins_shell/ipmi'
+require 'collins_shell/provision'
+require 'collins_shell/state'
+require 'collins_shell/tag'
+require 'collins_shell/thor'
+require 'collins_shell/util'
+require 'collins_shell/util/log_printer'
+require 'thor'
+require 'thor/group'
+
+# Need these to support latest method
+require 'rubygems'
+require 'rubygems/spec_fetcher'
+
+module CollinsShell
+
+  class Cli < Thor
+
+    include ThorHelper
+    include CollinsShell::Util
+
+    register(CollinsShell::Asset, 'asset', 'asset <command>', 'Asset related commands')
+    register(CollinsShell::Tag, 'tag', 'tag <command>', 'Tag related commands')
+    register(CollinsShell::IpAddress, 'ip_address', 'ip_address <command>', 'IP address related commands')
+    register(CollinsShell::Ipmi, 'ipmi', 'ipmi <command>', 'IPMI related commands')
+    register(CollinsShell::Provision, 'provision', 'provision <command>', 'Provisioning related commands')
+    register(CollinsShell::State, 'state', 'state <command>', 'State management related commands - use with care')
+
+    desc 'latest', 'check if there is a newer version of collins-shell'
+    def latest
+      puts(get_latest_version)
+    end
+
+    desc 'version', 'current version of collins-shell'
+    def version
+      puts("collins-shell #{get_version}")
+    end
+
+    desc 'power_status', 'check power status on an asset'
+    use_collins_options
+    use_tag_option
+    use_selector_option
+    def power_status
+      batch_selector_operation Hash[
+        :remote => options.remote,
+        :operation => "power_status",
+        :success_message => proc {|asset| "Got power status for #{asset.tag}"},
+        :error_message => proc{|asset| "Error getting power status for #{asset.tag}"},
+        :confirmation_message => proc do |assets|
+          "You are about to check the power status of #{assets.length} hosts. ARE YOU SURE?"
+        end
+      ] do |client,asset|
+        puts('*'*80)
+        begin
+          status = client.power_status(asset)
+          say_success "Power status of #{asset.tag}: #{status}"
+        rescue Exception => e
+          print_error e, "Unable to check power status of #{asset.tag}", false
+        end
+      end
+    end
+
+    desc 'power ACTION', 'perform power action (off, on, rebootSoft, rebootHard, etc) on an asset'
+    use_collins_options
+    use_tag_option(true)
+    method_option :reason, :type => :string, :required => true, :desc => 'Reason for reboot'
+    def power action
+      action = Collins::Power.normalize_action(action)
+      call_collins get_collins_client, "power" do |client|
+        client.log! options.tag, options.reason, 'ALERT'
+        if client.power!(options.tag, action) then
+          say_success "power #{action} on #{options.tag}"
+        else
+          say_error "power #{action} on #{options.tag}", :exit => true
+        end
+      end
+    end
+
+    desc 'log MESSAGE', 'log a message on an asset'
+    use_collins_options
+    use_tag_option
+    use_selector_option
+    method_option :severity, :type => :string, :desc => 'Log severity (EMERGENCY, WARN, etc)'
+    def log message
+      batch_selector_operation Hash[
+        :remote => options.remote,
+        :operation => "log",
+        :success_message => proc {|asset| "Logged to #{asset.tag}"},
+        :error_message => proc{|asset| "Log to #{asset.tag}"},
+        :confirmation_message => proc do |assets|
+          "You are about to log '#{message}' on #{assets.length} hosts. ARE YOU SURE?"
+        end
+      ] do |client,asset|
+        client.log!(asset, message, options.severity)
+      end
+    end
+
+    desc 'logs TAG', 'fetch logs for an asset specified by its tag. Use "all" for all logs'
+    use_collins_options
+    use_page_options(5000)
+    method_option :severity, :type => :array, :desc => 'Severities to include'
+    def logs tag
+      call_collins get_collins_client, "logs" do |client|
+        severity = []
+        if options.severity? then
+          severity = options.severity
+        end
+        params = Hash[
+          :filter => severity.join(';'),
+          :size => options[:size].to_i,
+          :sort => options[:sort]
+        ]
+        logs = client.logs tag, params.merge(:all_tag => 'all')
+        logs.reverse! if options[:sort].to_s.downcase == 'desc'
+        printer = CollinsShell::LogPrinter.new(tag, logs)
+        puts printer.render
+      end
+    end
+
+    desc 'console', 'drop into the interactive collins shell'
+    use_collins_options
+    def console
+      ensure_password
+      CollinsShell::Console.launch(options)
+    end
+
+    no_tasks do
+      def get_version
+        version_file = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))
+        if File.exists?(version_file) then
+          File.read(version_file)
+        else
+          "0.0.0"
+        end
+      end
+
+      def get_latest_version
+        begin
+          Gem.sources = ["http://repo.tumblr.net:9929"]
+          gem = Gem::SpecFetcher.new
+          shell = gem.fetch(Gem::Dependency.new('collins_shell')).flatten.first
+        rescue Exception => e
+          return "Could not retrieve latest gem info from #{Gem.sources.join(',')}"
+        end
+        if shell.nil? then
+          "Could not retrieve latest gem info from repo.tumblr.net"
+        else
+          my_version = Gem::Version.new(get_version)
+          if shell.version == my_version then
+            "You are running the most recent version of collins-shell: #{my_version.to_s}"
+          elsif shell.version > my_version then
+            "Time to upgrade! You are running collins-shell #{my_version.to_s}, latest is #{shell.version.to_s}"
+          else
+            "You are probably a developer. You are running version #{my_version.to_s}, latest published is #{shell.version.to_s}"
+          end
+        end
+      end
+
+      def print_error e, cmd = nil, separator = true
+        cmd = "unable to run command '#{$0} #{ARGV.join(' ')}'" unless cmd
+        say_status("fatal", cmd, :red)
+        say_status("exception", "#{e.message}", :red)
+        is_debug = ARGV.include?("--debug") || ARGV.include?("--trace")
+        if e.is_a?(Collins::RequestError) then
+          puts('*'*80) if separator
+          say_status("details", e.description(is_debug).strip.sub(e.message,""), :red)
+        end
+        if ARGV.include?("--debug") || ARGV.include?("--trace") then
+          say_status("DEBUG", "local backtrace is presented latest to earliest (reverse cronological)")
+          puts("#{e.class.to_s}")
+          e.backtrace.each do |line|
+            file, line, method = line.split(":", 3)
+            puts "\t\t#{method}(#{file}:#{line})"
+          end
+        end
+      end # print_error
+    end # no_tasks
+
+
+  end
+
+end