collins-cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 087cbec35df74ca5deb78665d0d40547483968d3
+  data.tar.gz: dcc8cc251bc58b3e6ca6df9881de6eeffef00caf
+SHA512:
+  metadata.gz: 5d3b4860eede427118996a3740233e494df10b0bc46c94a2394f01d78fb1d20b3796a528d8353900bb8774f655f7bf9e86d24594c331b7fa56ac22b71471b319
+  data.tar.gz: 19aa32592ffcf6cac34565ae87ca37bcd35c7ecc182138c2464bcceba65898258ac25fb11853f3d29fb627fe16c589fe5824bba081c7e60e6e70ff7857a6a4a8

data/README.md

@@ -0,0 +1,173 @@
+collins-cli
+===========
+
+CLI scripts for interacting with Collins API
+
+[![Gem Version](https://badge.fury.io/rb/collins-cli.svg)](http://badge.fury.io/rb/collins-cli)
+
+## Overview
+
+Main entry point is the ```collins``` binary.
+
+    Usage: collins <command> [options]
+    Available commands:
+      query, find:        Search for assets in Collins
+      modify, set:        Add and remove attributes, change statuses, and log to assets
+      log:                Display log messages on assets
+      provision, action:  Provision, control power status, allocate IPs, update IPMI info
+
+## Searching - collins-find
+
+    Usage: collins-find [options] [hostnamepattern]
+    Query options:
+        -t, --tag TAG[,...]              Assets with tag[s] TAG
+        -T, --type TYPE                  Only show assets with type TYPE
+        -n, --nodeclass NODECLASS[,...]  Assets in nodeclass NODECLASS
+        -p, --pool POOL[,...]            Assets in pool POOL
+        -s, --size SIZE                  Number of assets to return (Default: 9999)
+        -r, --role ROLE[,...]            Assets in primary role ROLE
+        -R, --secondary-role ROLE[,...]  Assets in secondary role ROLE
+        -i, --ip-address IP[,...]        Assets with IP address[es]
+        -S STATUS[:STATE][,...],         Asset status (and optional state after :)
+            --status
+        -a attribute[:value[,...]],      Arbitrary attributes and values to match in query. : between key and value
+            --attribute
+    
+    Table formatting:
+        -H, --show-header                Show header fields in output
+        -c, --columns ATTRIBUTES         Attributes to output as columns, comma separated (Default: tag,hostname,nodeclass,status,pool,primary_role,secondary_role)
+        -x, --extra-columns ATTRIBUTES   Show these columns in addition to the default columns, comma separated
+        -f, --field-separator SEPARATOR  Separator between columns in output (Default:      )
+    
+    Robot formatting:
+        -l, --link                       Output link to assets found in web UI
+        -j, --json                       Output results in JSON (NOTE: This probably wont be what you expected)
+        -y, --yaml                       Output results in YAML
+    
+    Extra options:
+            --expire SECONDS             Timeout in seconds (0 == forever)
+        -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+        -h, --help                       Help
+    
+    Examples:
+        Query for devnodes in DEVEL pool that are VMs
+          cf -n develnode -p DEVEL
+        Query for asset 001234, and show its system_password
+          cf -t 001234 -x system_password
+        Query for all decommissioned VM assets
+          cf -a is_vm:true -S decommissioned
+        Query for hosts matching hostname '^web6-'
+          cf ^web6-
+        Query for all develnode6 nodes with a value for PUPPET_SERVER
+          cf -n develnode6 -a puppet_server -H
+
+## Logging - collins-log
+
+    Usage: collins-log [options]
+        -a, --all                        Show logs from ALL assets
+        -n, --number LINES               Show the last LINES log entries. (Default: 20)
+        -t, --tags TAGS                  Tags to work on, comma separated
+        -f, --follow                     Poll for logs every 2 seconds
+        -s, --severity SEVERITY[,...]    Log severities to return (Defaults to all). Use !SEVERITY to exclude one.
+        -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+        -h, --help                       Help
+    
+    Severities:
+      EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, NOTE
+    
+    Examples:
+      Show last 20 logs for an asset
+        collins-log -t 001234
+      Show last 100 logs for an asset
+        collins-log -t 001234 -n100
+      Show last 10 logs for 2 assets that are ERROR severity
+        collins-log -t 001234,001235 -n10 -sERROR
+      Show last 10 logs all assets that are not note or informational severity
+        collins-log -a -n10 -s'!informational,!note'
+      Show last 10 logs for all web nodes that are provisioned having verification in the message
+        cf -S provisioned -n webnode$ | collins-log -n10 -s debug | grep -i verification
+
+## Modification - collins-modify
+
+    Usage: collins-modify [options]
+        -a attribute:value,              Set attribute=value. : between key and value. attribute will be uppercased.
+            --set-attribute
+        -d, --delete-attribute attribute Delete attribute.
+        -S, --set-status status[:state]  Set status (and optionally state) to status:state. Requires --reason
+        -r, --reason REASON              Reason for changing status/state.
+        -l, --log MESSAGE                Create a log entry.
+        -L, --level LEVEL                Set log level. Default level is NOTE.
+        -t, --tags TAGS                  Tags to work on, comma separated
+        -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+        -h, --help                       Help
+    
+    Allowed values (uppercase or lowercase is accepted):
+      Status (-S,--set-status):
+        ALLOCATED, CANCELLED, DECOMMISSIONED, INCOMPLETE, MAINTENANCE, NEW, PROVISIONED, PROVISIONING, UNALLOCATED
+      States (-S,--set-status):
+        ALLOCATED ->
+          CLAIMED, SPARE, RUNNING_UNMONITORED, UNMONITORED
+        MAINTENANCE ->
+          AWAITING_REVIEW, HARDWARE_PROBLEM, HW_TESTING, HARDWARE_UPGRADE, IPMI_PROBLEM, MAINT_NOOP, NETWORK_PROBLEM, RELOCATION, PROVISIONING_PROBLEM
+        ANY ->
+          RUNNING, STARTING, STOPPING, TERMINATED
+      Log levels (-L,--level):
+        EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, NOTE
+    
+    Examples:
+      Set an attribute on some hosts:
+        collins-modify -t 001234,004567 -a my_attribute:true
+      Delete an attribute on some hosts:
+        collins-modify -t 001234,004567 -d my_attribute
+      Delete and add attribute at same time:
+        collins-modify -t 001234,004567 -a new_attr:test -d old_attr
+      Set machine into maintenace noop:
+        collins-modify -t 001234 -S maintenance:maint_noop -r "I do what I want"
+      Set machine back to allocated:
+        collins-modify -t 001234 -S allocated:running -r "Back to allocated"
+      Set machine back to new without setting state:
+        collins-modify -t 001234 -S new -r "Dunno why you would want this"
+      Create a log entry:
+        collins-modify -t 001234 -l'computers are broken and everything is horrible' -Lwarning
+      Read from stdin:
+        cf -n develnode | collins-modify -d my_attribute
+        cf -n develnode -S allocated | collins-modify -a collectd_version:5.2.1-52
+        echo -e "001234\n001235\n001236"| collins-modify -a test_attribute:'hello world'
+
+## Actions - collins-action
+
+    Usage: collins-action [options]
+    Actions:
+        -P, --provision                  Provision assets (see Provisioning flags).
+        -S, --power-status               Show IPMI power status.
+        -A, --power-action ACTION        Perform IPMI power ACTION on assets
+    
+    Provisioning Flags:
+        -n, --nodeclass NODECLASS        Nodeclass to provision as. (Required)
+        -p, --pool POOL                  Provision with pool POOL.
+        -r, --role ROLE                  Provision with primary role ROLE.
+        -R, --secondary-role ROLE        Provision with secondary role ROLE.
+        -s, --suffix SUFFIX              Provision with suffix SUFFIX.
+        -a, --activate                   Activate server on provision (useful with SL plugin) (Default: ignored)
+        -b, --build-contact USER         Build contact. (Default: gabe)
+    
+    General:
+        -t, --tags TAG[,...]             Tags to work on, comma separated
+        -C, --config CONFIG              Use specific Collins config yaml for Collins::Client
+        -h, --help                       Help
+    
+    Examples:
+      Provision some machines:
+        cf -Sunallocated -arack_position:716|collins-action -P -napiwebnode6 -RALL
+      Show power status:
+        cf ^dev6-gabe|collins-action -S
+      Power cycle a bunch of machines:
+        collins-action -t 001234,004567,007890 -A reboot
+
+## TODO
+
+I know the architecture is BRUTAL. This was all organically created; I need to refactor stuff out into libraries to facilitate code sharing between the utilities
+
+* Implement IP allocation in collins-action
+* Implement IPMI stuff in collins-action
+* Share code between binaries

data/bin/collins

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+ALLOWED_ACTIONS = {
+  :find => ['query','find'],
+  :modify => ['modify','set'],
+  :log => ['log'],
+  :action => ['provision','action']
+}
+action = ARGV.shift
+target,_ = ALLOWED_ACTIONS.select {|k,v| v.any? {|handle| ! %r|^#{action}|.match(handle).nil? } }.first
+if action.nil? || target.nil?
+  abort <<_MESSAGE_
+Usage: #{File.basename(File.realpath($0))} <command> [options]
+Available commands:
+  query, find:        Search for assets in Collins
+  modify, set:        Add and remove attributes, change statuses, and log to assets
+  log:                Display log messages on assets
+  provision, action:  Provision, control power status, allocate IPs, update IPMI info
+_MESSAGE_
+end
+exec File.join(__dir__,"collins-#{target}"), *ARGV

data/bin/collins-action

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+# collins-action
+# provision and manage assets in collins easily from the CLI
+
+require 'collins_auth'
+require 'yaml'
+require 'optparse'
+require 'etc'
+require 'colorize'
+
+SUCCESS = "SUCCESS".colorize(:color => :green)
+ERROR = "ERROR".colorize(:color => :red)
+ALLOWABLE_POWER_ACTIONS = ['reboot','rebootsoft','reboothard','on','off','poweron','poweroff','identify']
+options = {
+  :timeout => 120,
+  :build_contact => Etc.getlogin,
+  :provision => { }
+}
+
+basename = File.basename(File.realpath($0))
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{basename} [options]"
+  #TODO -s to show provisoining_profiles
+  #TODO update IPMI stuff with ipmi_update
+  #TODO create IPMI with ipmi_create
+  #TODO implement IP allocation
+  opts.separator "Actions:"
+  opts.on('-P','--provision',"Provision assets (see Provisioning flags).") {|v| options[:mode] = :provision }
+  opts.on('-S','--power-status',"Show IPMI power status.") {|v| options[:mode] = :power_status }
+  opts.on('-A','--power-action ACTION',String,"Perform IPMI power ACTION on assets"){|v| options[:mode] = :power ; options[:power_action] = v}
+
+  opts.separator ""
+  opts.separator "Provisioning Flags:"
+  opts.on('-n','--nodeclass NODECLASS',String,"Nodeclass to provision as. (Required)") {|v| options[:provision][:nodeclass] = v }
+  opts.on('-p','--pool POOL',String,"Provision with pool POOL.") {|v| options[:provision][:pool] = v }
+  opts.on('-r','--role ROLE',String,"Provision with primary role ROLE.") {|v| options[:provision][:primary_role] = v }
+  opts.on('-R','--secondary-role ROLE',String,"Provision with secondary role ROLE.") {|v| options[:provision][:secondary_role] = v }
+  opts.on('-s','--suffix SUFFIX',String,"Provision with suffix SUFFIX.") {|v| options[:provision][:suffix] = v }
+  opts.on('-a','--activate',"Activate server on provision (useful with SL plugin) (Default: ignored)") {|v| options[:provision][:activate] = true }
+  opts.on('-b','--build-contact USER',String,"Build contact. (Default: #{options[:build_contact]})") {|v| options[:build_contact] = v }
+
+  opts.separator ""
+  opts.separator "General:"
+  opts.on('-t','--tags TAG[,...]',Array,"Tags to work on, comma separated") {|v| options[:tags] = v.map(&:to_sym)}
+  opts.on('-C','--config CONFIG',String,'Use specific Collins config yaml for Collins::Client') {|v| options[:config] = v}
+  opts.on('-h','--help',"Help") {puts opts ; exit 0}
+
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator <<_EXAMPLES_
+  Provision some machines:
+    cf -Sunallocated -arack_position:716|#{basename} -P -napiwebnode6 -RALL
+  Show power status:
+    cf ^dev6-gabe|#{basename} -S
+  Power cycle a bunch of machines:
+    #{basename} -t 001234,004567,007890 -A reboot
+_EXAMPLES_
+end.parse!
+
+if ARGV.size > 0
+  # anything else left in ARGV is garbage
+  puts "Not sure what I am supposed to do with these arguments: #{ARGV.join(' ')}"
+  puts parser
+  exit 1
+end
+
+
+abort "See --help for #{basename} usage" unless [:provision, :power_status, :power].include? options[:mode]
+abort "You need to specify at least a nodeclass when provisioning" if options[:mode] == :provision && options[:provision][:nodeclass].nil?
+if options[:mode] == :power
+  # convert what we allow to be specified to what collins::power allows
+  options[:power_action] = 'rebootsoft' if options[:power_action] == 'reboot'
+  abort "Unknown power action #{options[:power_action]}, expecting one of #{ALLOWABLE_POWER_ACTIONS.join(',')}" unless ALLOWABLE_POWER_ACTIONS.include? options[:power_action]
+  begin
+    options[:power_action] = Collins::Power.normalize_action options[:power_action]
+  rescue => e
+    abort "Unknown power action #{options[:power_action]}! #{e.message}"
+  end
+end
+
+if options[:tags].nil? or options[:tags].empty?
+  # read tags from stdin. first field on the line is the tag
+  input = ARGF.readlines
+  options[:tags] = input.map{|l| l.split(/\s+/)[0] rescue nil}.compact.uniq
+end
+
+begin
+  @collins = Collins::Authenticator.setup_client timeout: options[:timeout], config_file: options[:config], prompt: true
+rescue => e
+  abort "Unable to set up Collins client! #{e.message}"
+end
+
+def api_call desc, method, *varargs
+  success,message = begin
+    [@collins.send(method,*varargs),nil]
+  rescue => e
+    [false,e.message]
+  end
+  puts "#{success ? SUCCESS : ERROR}: #{desc}#{message.nil? ? nil : " (%s)" % e.message}"
+  success
+end
+
+action_successes = []
+options[:tags].each do |t|
+  case options[:mode]
+  when :provision
+    action_string = "#{t} provisioning with #{options[:provision].map{|k,v| "#{k}:#{v}"}.join(" ")} by #{options[:build_contact]}... "
+    printf action_string
+    begin
+      res = @collins.provision(t, options[:provision][:nodeclass], options[:build_contact], options[:provision])
+      puts (res ? SUCCESS : ERROR )
+      action_successes << res
+    rescue => e
+      puts "#{ERROR} (#{e.message})"
+      action_successes << false
+    end
+  when :power_status
+    begin
+      s = @collins.power_status(t)
+      puts "#{SUCCESS}: #{t} power status is #{s}"
+    rescue => e
+      puts "#{ERROR}: Unable to query power status for #{t}#{e.message.nil? ? nil : " (%s)" % e.message}"
+    end
+  when :power
+    action_successes << api_call("#{t} performing #{options[:power_action]}", :power!, t, options[:power_action])
+  end
+end
+
+exit action_successes.all? ? 0 : 1
+

data/bin/collins-find

@@ -0,0 +1,225 @@
+#!/usr/bin/env ruby
+# stands for collins-find
+# look up hosts quickly from collins from the CLI
+
+require 'collins_auth'
+require 'yaml'
+require 'json'
+require 'optparse'
+
+#TODO: querying for :status or :state with -a status:maintenance doesnt play nice with -Smaintenance,allocated
+#TODO: we construct the query for states and statuses only from the parameters to --status (ignoring any -a attributes)
+#TODO: add a formatting option to display the assets in a different way (not a table)
+
+# this gets stuffed into the collins find call
+query_opts = {
+  :operation => 'AND',
+  :size => 9999,
+}
+# these are all the attributes we search for
+# may be converted into a CQL query
+search_attrs = { }
+options = {
+  :display          => :table,           # how to display the results
+  :separator        => "\t",
+  :attributes       => {},            # additional attributes to query for
+  :columns          => [:tag, :hostname, :nodeclass, :status, :pool, :primary_role, :secondary_role],
+  :column_override  => [],       # if set, these are the columns to display
+  :timeout          => 120,
+  :show_header      => false,        # if the header for columns should be displayed
+  :config           => nil           # collins config to give to setup_client
+}
+
+
+basename = File.basename(File.realpath($0))
+abort "See --help for #{basename} usage" if ARGV.empty?
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{basename} [options] [hostnamepattern]"
+  opts.separator "Query options:"
+  opts.on('-t','--tag TAG[,...]',Array, "Assets with tag[s] TAG") {|v| search_attrs[:tag] = v}
+  opts.on('-T','--type TYPE',String, "Only show assets with type TYPE") {|v| search_attrs[:type] = v}
+  opts.on('-n','--nodeclass NODECLASS[,...]',Array, "Assets in nodeclass NODECLASS") {|v| search_attrs[:nodeclass] = v}
+  opts.on('-p','--pool POOL[,...]',Array, "Assets in pool POOL") {|v| search_attrs[:pool] = v}
+  opts.on('-s','--size SIZE',Integer, "Number of assets to return (Default: #{query_opts[:size]})") {|v| query_opts[:size] = v}
+  opts.on('-r','--role ROLE[,...]',Array,"Assets in primary role ROLE") {|v| search_attrs[:primary_role] = v}
+  opts.on('-R','--secondary-role ROLE[,...]',Array,"Assets in secondary role ROLE") {|v| search_attrs[:secondary_role] = v}
+  opts.on('-i','--ip-address IP[,...]',Array,"Assets with IP address[es]") {|v| search_attrs[:ip_address] = v}
+  opts.on('-S','--status STATUS[:STATE][,...]',Array,"Asset status (and optional state after :)") do |v|
+    # in order to know what state was paired with what status, lets store the original params
+    # so the query constructor can create the correct CQL query
+    options[:status_state] = v
+    search_attrs[:status], search_attrs[:state] = v.inject([[],[]]) do |memo,s|
+      status,state = s.split(':')
+      memo[0] << status.upcase if not status.nil? and not status.empty?
+      memo[1] << state.upcase if not state.nil? and not state.empty?
+      memo
+    end
+  end
+  opts.on('-a','--attribute attribute[:value[,...]]',String,"Arbitrary attributes and values to match in query. : between key and value") do |x|
+    x.split(',').each do |p|
+      a,v = p.split(':')
+      a = a.to_sym
+      if not search_attrs[a].nil? and not search_attrs[a].is_a? Array
+        # its a single value, turn it into an array
+        search_attrs[a] = [search_attrs[a]]
+      end
+      if search_attrs[a].is_a? Array
+        # already multivalue, append
+        search_attrs[a] << v
+      else
+        search_attrs[a] = v
+      end
+    end
+  end
+
+  opts.separator ""
+  opts.separator "Table formatting:"
+  opts.on('-H','--show-header',"Show header fields in output") {options[:show_header] = true}
+  opts.on('-c','--columns ATTRIBUTES',Array,"Attributes to output as columns, comma separated (Default: #{options[:columns].map(&:to_s).join(',')})") {|v| options[:column_override] = v.map(&:to_sym)}
+  opts.on('-x','--extra-columns ATTRIBUTES',Array,"Show these columns in addition to the default columns, comma separated") {|v| options[:columns].push(v.map(&:to_sym)).flatten! }
+  opts.on('-f','--field-separator SEPARATOR',String,"Separator between columns in output (Default: #{options[:separator]})") {|v| options[:separator] = v}
+
+  opts.separator ""
+  opts.separator "Robot formatting:"
+  opts.on('-l','--link',"Output link to assets found in web UI") {options[:display] = :link}
+  opts.on('-j','--json',"Output results in JSON (NOTE: This probably wont be what you expected)") {options[:display] = :json}
+  opts.on('-y','--yaml',"Output results in YAML") {options[:display] = :yaml}
+
+  opts.separator ""
+  opts.separator "Extra options:"
+  opts.on('--expire SECONDS',Integer,"Timeout in seconds (0 == forever)") {|v| options[:timeout] = v}
+  opts.on('-C','--config CONFIG',String,'Use specific Collins config yaml for Collins::Client') {|v| options[:config] = v}
+  opts.on('-h','--help',"Help") {puts opts ; exit 0}
+
+  opts.separator ""
+  opts.separator <<_EXAMPLES_
+Examples:
+    Query for devnodes in DEVEL pool that are VMs
+      cf -n develnode -p DEVEL
+    Query for asset 001234, and show its system_password
+      cf -t 001234 -x system_password
+    Query for all decommissioned VM assets
+      cf -a is_vm:true -S decommissioned
+    Query for hosts matching hostname '^web6-'
+      cf ^web6-
+    Query for all develnode6 nodes with a value for PUPPET_SERVER
+      cf -n develnode6 -a puppet_server -H
+_EXAMPLES_
+end.parse!
+
+# hostname is the final option, no flags
+search_attrs[:hostname] = ARGV.shift
+# fix bug where assets wont get found if they dont have that meta attribute
+search_attrs.delete(:hostname) if search_attrs[:hostname].nil?
+
+# if nothing passed to us, lets not search for EVERYTHING
+#abort "You need to query for _something_, see --help" if
+#  selector_keys.all? {|key| options[key].nil?} and options[:attributes].empty?
+
+# for any search attributes, lets not pass arrays of 1 element
+# as that will confuse as_query?
+search_attrs.each do |k,v|
+  if v.is_a? Array
+    search_attrs[k] = v.first if v.length == 1
+    search_attrs[k] = nil if v.empty?
+  end
+end
+
+def as_query?(attrs)
+  attrs.any?{|k,v| v.is_a? Array}
+end
+
+def convert_to_query(op, attrs, options)
+  # we want to support being able to query -Smaintenance:noop,:running,:provisioning_problem
+  # and not have the states ored together. Handle status/state pairs separately
+  basic_query = attrs.reject {|k,v| [:status,:state].include?(k)}.map do |k,v|
+    next if v.nil?
+    if v.is_a? Array
+      "(" + v.map{|x| "#{k} = #{x}"}.join(' OR ') + ")"
+    else
+      "#{k} = #{v}"
+    end
+  end.compact.join(" #{op} ")
+  # because they are provided in pairs, lets handle them together
+  # create the (( STATUS = maintenance AND STATE = noop) OR (STATE = provisioning_problem)) query
+  if options[:status_state]
+    status_query = options[:status_state].flat_map do |ss|
+      h = {}
+      h[:status], h[:state] = ss.split(':')
+      h[:status] = nil if h[:status].nil? or h[:status].empty?
+      h[:state] = nil if h[:state].nil? or h[:state].empty?
+      "( " + h.map {|k,v| v.nil? ? nil : "#{k.to_s.upcase} = #{v}"}.compact.join(" AND ") + " )"
+    end.compact.join(' OR ')
+    status_query = "( #{status_query} )"
+  end
+  [basic_query,status_query].reject {|q| q.nil? or q.empty?}.join(" #{op} ")
+end
+
+def display_as_robot_talk(assets, format = :json)
+  puts assets.send("to_#{format}".to_sym)
+end
+def display_as_table(assets, columns, separator, show_header = false)
+  # lets figure out how wide each column is, including header
+  column_width_pairs = columns.map do |column|
+    # grab all attributes == column and figure out max width
+    width = assets.map{|a| (column == :state) ?  a.send(column).label.to_s.length : a.send(column).to_s.length}.max
+    width = [width, column.to_s.length].max if show_header
+    [column,width]
+  end
+  column_width_map = Hash[column_width_pairs]
+
+  if show_header
+    $stderr.puts column_width_map.map{|c,w| "%-#{w}s" % c}.join(separator)
+  end
+  assets.each do |a|
+    puts column_width_map.map {|c,w| v = (c == :state) ?  a.send(c).label : a.send(c) ; "%-#{w}s" % v }.join(separator)
+  end
+end
+def display_as_link assets, client
+  assets.each do |a|
+    puts "#{client.host}/asset/#{a.tag}"
+  end
+end
+
+# merge search_attrs into query
+if as_query?(search_attrs)
+  query_opts[:query] = convert_to_query(query_opts[:operation], search_attrs, options)
+  #puts "Query: #{query_opts[:query]}"
+else
+  query_opts.merge!(search_attrs)
+end
+
+begin
+  collins = Collins::Authenticator.setup_client timeout: options[:timeout], config_file: options[:config], prompt: true
+rescue => e
+  abort "Unable to set up Collins client! #{e.message}"
+end
+
+begin
+  assets = collins.find(query_opts)
+  if assets.length > 0
+    case options[:display]
+    when :table
+      # if the user passed :column_override, respect that absolutely. otherwise, the columns to display
+      # should be options[:columns] + any extra attributes queried for. this way ```cf -c hostname -a is_vm:true```
+      # wont return 2 columns; only the one you asked for
+      columns = if options[:column_override].empty?
+                  options[:columns].concat(search_attrs.keys).compact.uniq
+                else
+                  options[:column_override]
+                end
+      display_as_table(assets,columns,options[:separator],options[:show_header])
+    when :link
+      display_as_link assets, collins
+    when :json,:yaml
+      display_as_robot_talk(assets,options[:display])
+    else
+      abort "I don't know how to display assets in #{options[:display]} format!"
+    end
+  else
+    abort "No assets found"
+  end
+rescue => e
+  abort "Error querying collins: #{e.message}"
+end
+

data/bin/collins-log

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+# stands for collins-log
+# looks at logs on assets
+
+# TODO: make poll_wait tunable
+# TODO: add options to sort ascending or descending on date
+# TODO: implement searching logs (is this really useful?)
+# TODO: add duplicate line detection and compression (...)
+
+require 'collins_auth'
+require 'yaml'
+require 'optparse'
+require 'colorize'
+require 'set'
+
+log_levels = Collins::Api::Logging::Severity.constants.map(&:to_s)
+
+@options = {
+  :tags => [],
+  :show_all => false,
+  :poll_wait => 2,
+  :follow => false,
+  :severities => [],
+  :timeout => 20,
+  :sev_colors => {
+    'EMERGENCY'     => {:color => :red, :background => :light_blue},
+    'ALERT'         => {:color => :red},
+    'CRITICAL'      => {:color => :black, :background => :red},
+    'ERROR'         => {:color => :red},
+    'WARNING'       => {:color => :yellow},
+    'NOTICE'        => {},
+    'INFORMATIONAL' => {:color => :green},
+    'DEBUG'         => {:color => :blue},
+    'NOTE'          => {:color => :light_cyan},
+  },
+  :config => nil
+}
+@search_opts = {
+  :size => 20,
+  :filter => nil,
+}
+
+basename = File.basename(File.realpath($0))
+abort "See --help for #{basename} usage" if ARGV.empty?
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{basename} [options]"
+  opts.on('-a','--all',"Show logs from ALL assets") {|v| @options[:show_all] = true}
+  opts.on('-n','--number LINES',Integer,"Show the last LINES log entries. (Default: #{@search_opts[:size]})") {|v| @search_opts[:size] = v}
+  opts.on('-t','--tags TAGS',Array,"Tags to work on, comma separated") {|v| @options[:tags] = v}
+  opts.on('-f','--follow',"Poll for logs every #{@options[:poll_wait]} seconds") {|v| @options[:follow] = true}
+  opts.on('-s','--severity SEVERITY[,...]',Array,"Log severities to return (Defaults to all). Use !SEVERITY to exclude one.") {|v| @options[:severities] = v.map(&:upcase) }
+  #opts.on('-i','--interleave',"Interleave all log entries (Default: groups by asset)") {|v| options[:interleave] = true}
+  opts.on('-C','--config CONFIG',String,'Use specific Collins config yaml for Collins::Client') {|v| @options[:config] = v}
+  opts.on('-h','--help',"Help") {puts opts ; exit 0}
+  opts.separator ""
+  opts.separator <<_EOE_
+Severities:
+  #{Collins::Api::Logging::Severity.to_a.map{|s| s.colorize(@options[:sev_colors][s])}.join(", ")}
+
+Examples:
+  Show last 20 logs for an asset
+    #{basename} -t 001234
+  Show last 100 logs for an asset
+    #{basename} -t 001234 -n100
+  Show last 10 logs for 2 assets that are ERROR severity
+    #{basename} -t 001234,001235 -n10 -sERROR
+  Show last 10 logs all assets that are not note or informational severity
+    #{basename} -a -n10 -s'!informational,!note'
+  Show last 10 logs for all web nodes that are provisioned having verification in the message
+    cf -S provisioned -n webnode\$ | #{basename} -n10 -s debug | grep -i verification
+_EOE_
+end.parse!
+
+
+abort "Log severities #{@options[:severities].join(',')} are invalid! Use one of #{log_levels.join(', ')}" unless @options[:severities].all? {|l| Collins::Api::Logging::Severity.valid?(l.tr('!','')) }
+@search_opts[:filter] = @options[:severities].join(';')
+
+if @options[:tags].empty? and not @options[:show_all]
+  # read tags from stdin. first field on the line is the tag
+  input = ARGF.readlines
+  @options[:tags] = input.map{|l| l.split(/\s+/)[0] rescue nil}.compact.uniq
+end
+
+abort "You need to give me some assets to display logs; see --help" if @options[:tags].empty? and not @options[:show_all]
+
+begin
+  @collins = Collins::Authenticator.setup_client timeout: @options[:timeout], config_file: @options[:config], prompt: true
+rescue => e
+  abort "Unable to set up Collins client! #{e.message}"
+end
+
+def output_logs(logs)
+  # colorize output before computing width of fields
+  logs.map! do |l|
+    l.TYPE = @options[:sev_colors].has_key?(l.TYPE) ? l.TYPE.colorize(@options[:sev_colors][l.TYPE]) : l.TYPE
+    l
+  end
+  # show newest last
+  sorted_logs = logs.sort_by {|l| l.CREATED }
+  tag_width = sorted_logs.map{|l| l.ASSET_TAG.length}.max
+  sev_width = sorted_logs.map{|l| l.TYPE.length}.max
+  time_width = sorted_logs.map{|l| l.CREATED.length}.max
+  sorted_logs.each do |l|
+    puts "%-#{time_width}s: %-#{sev_width}s %-#{tag_width}s %s" % [l.CREATED, l.TYPE, l.ASSET_TAG, l.MESSAGE]
+  end
+end
+
+def grab_logs
+  if @options[:tags].empty?
+    begin
+      @collins.all_logs(@search_opts)
+    rescue => e
+      $stderr.puts "Unable to fetch logs:".colorize(@options[:sev_colors]['WARNING']) + " #{e.message}"
+      []
+    end
+  else
+    @options[:tags].flat_map do |t|
+      begin
+        @collins.logs(t, @search_opts)
+      rescue => e
+        $stderr.puts "Unable to fetch logs for #{t}:".colorize(@options[:sev_colors]['WARNING']) + " #{e.message}"
+        []
+      end
+    end
+  end
+end
+
+begin
+  all_logs = grab_logs
+  logs_seen = all_logs.map(&:ID).to_set
+  output_logs(all_logs)
+  while @options[:follow]
+    sleep @options[:poll_wait]
+    logs = grab_logs
+    new_logs = logs.reject {|l| logs_seen.include?(l.ID)}
+    output_logs(new_logs)
+    logs_seen = logs_seen | new_logs.map(&:ID)
+  end
+rescue Interrupt => e
+  exit 0
+end
+
+

data/bin/collins-modify

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+# stands for collins-modify
+# perform actions on asset attribtues in collins easily
+
+require 'collins_auth'
+require 'yaml'
+require 'optparse'
+
+SUCCESS = "SUCCESS"
+ERROR   = "ERROR"
+VALID_STATUSES = ["ALLOCATED","CANCELLED","DECOMMISSIONED","INCOMPLETE","MAINTENANCE","NEW","PROVISIONED","PROVISIONING","UNALLOCATED"]
+#TODO: this shouldnt be hardcoded. we should pull this from the API instead?
+# should elegantly support user-defined states without changing this script
+VALID_STATES = {
+  "ALLOCATED" => ["CLAIMED","SPARE","RUNNING_UNMONITORED","UNMONITORED"],
+  "MAINTENANCE" => ["AWAITING_REVIEW","HARDWARE_PROBLEM","HW_TESTING","HARDWARE_UPGRADE","IPMI_PROBLEM","MAINT_NOOP","NETWORK_PROBLEM","RELOCATION",'PROVISIONING_PROBLEM'],
+  "ANY" => ["RUNNING","STARTING","STOPPING","TERMINATED"],
+}
+log_levels = Collins::Api::Logging::Severity.constants.map(&:to_s)
+
+options = {
+  :query_size => 9999,
+  :attributes => {},
+  :delete_attributes => [],
+  :log_level  => 'NOTE',
+  :timeout    => 120,
+  :config     => nil
+}
+basename = File.basename(File.realpath($0))
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{basename} [options]"
+  opts.on('-a','--set-attribute attribute:value',String,"Set attribute=value. : between key and value. attribute will be uppercased.") do |x|
+    if not x.include? ':'
+      puts '--set-attribute requires attribute:value, missing :value'
+      puts opts.help
+      exit 1
+    end
+    a,v = x.split(':')
+    options[:attributes][a.upcase.to_sym] = v
+  end
+  opts.on('-d','--delete-attribute attribute',String,"Delete attribute.") {|v| options[:delete_attributes] << v.to_sym }
+  opts.on('-S','--set-status status[:state]',String,'Set status (and optionally state) to status:state. Requires --reason') do |v|
+    status,state = v.split(':')
+    options[:status] = status.upcase if not status.nil? and not status.empty?
+    options[:state] = state.upcase if not state.nil? and not state.empty?
+  end
+  opts.on('-r','--reason REASON',String,"Reason for changing status/state.") {|v| options[:reason] = v }
+  opts.on('-l','--log MESSAGE',String,"Create a log entry.") do |v|
+    options[:log_message] = v
+  end
+  opts.on('-L','--level LEVEL',String, log_levels + log_levels.map(&:downcase),"Set log level. Default level is #{options[:log_level]}.") do |v|
+    options[:log_level] = v.upcase
+  end
+  opts.on('-t','--tags TAGS',Array,"Tags to work on, comma separated") {|v| options[:tags] = v.map(&:to_sym)}
+  opts.on('-C','--config CONFIG',String,'Use specific Collins config yaml for Collins::Client') {|v| options[:config] = v}
+  opts.on('-h','--help',"Help") {puts opts ; exit 0}
+  opts.separator ""
+  opts.separator "Allowed values (uppercase or lowercase is accepted):"
+  opts.separator <<_EOF_
+  Status (-S,--set-status):
+    #{VALID_STATUSES.join(', ')}
+  States (-S,--set-status):
+    #{VALID_STATES.keys.map {|k| "#{k} ->\n      #{VALID_STATES[k].join(', ')}"}.join "\n    "}
+  Log levels (-L,--level):
+    #{log_levels.join(', ')}
+_EOF_
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator <<_EOF_
+  Set an attribute on some hosts:
+    #{basename} -t 001234,004567 -a my_attribute:true
+  Delete an attribute on some hosts:
+    #{basename} -t 001234,004567 -d my_attribute
+  Delete and add attribute at same time:
+    #{basename} -t 001234,004567 -a new_attr:test -d old_attr
+  Set machine into maintenace noop:
+    #{basename} -t 001234 -S maintenance:maint_noop -r "I do what I want"
+  Set machine back to allocated:
+    #{basename} -t 001234 -S allocated:running -r "Back to allocated"
+  Set machine back to new without setting state:
+    #{basename} -t 001234 -S new -r "Dunno why you would want this"
+  Create a log entry:
+    #{basename} -t 001234 -l'computers are broken and everything is horrible' -Lwarning
+  Read from stdin:
+    cf -n develnode | #{basename} -d my_attribute
+    cf -n develnode -S allocated | #{basename} -a collectd_version:5.2.1-52
+    echo -e "001234\\n001235\\n001236"| #{basename} -a test_attribute:'hello world'
+_EOF_
+end.parse!
+
+if ARGV.size > 0
+  # anything else left in ARGV is garbage
+  puts "Not sure what I am supposed to do with these arguments: #{ARGV.join(' ')}"
+  puts parser
+  exit 1
+end
+
+abort "See --help for #{basename} usage" if options[:attributes].empty? and options[:delete_attributes].empty? and options[:status].nil? and options[:log_message].nil?
+abort "You need to provide a --reason when changing asset states!" if not options[:status].nil? and options[:reason].nil?
+#TODO this is never checked because we are making option parser vet our options for levels. Catch OptionParser::InvalidArgument?
+abort "Log level #{options[:log_level]} is invalid! Use one of #{log_levels.join(', ')}" unless Collins::Api::Logging::Severity.valid?(options[:log_level])
+
+# if any statuses or states, validate them against allowed values
+unless options[:status].nil?
+  abort "Invalid status #{options[:status]} (Should be in #{VALID_STATUSES.join(', ')})" unless VALID_STATUSES.include? options[:status]
+states_for_status = VALID_STATES["ANY"].concat((VALID_STATES[options[:status]].nil?) ? [] : VALID_STATES[options[:status]])
+  abort "State #{options[:state]} doesn't apply to status #{options[:status]} (Should be one of #{states_for_status.join(', ')})" unless options[:state].nil? or states_for_status.include?(options[:state])
+end
+
+if options[:tags].nil? or options[:tags].empty?
+  # read tags from stdin. first field on the line is the tag
+  input = ARGF.readlines
+  options[:tags] = input.map{|l| l.split(/\s+/)[0] rescue nil}.compact.uniq
+end
+
+begin
+  @collins = Collins::Authenticator.setup_client timeout: options[:timeout], config_file: options[:config], prompt: true
+rescue => e
+  abort "Unable to set up Collins client! #{e.message}"
+end
+
+def api_call desc, method, *varargs
+  success,message = begin
+    [@collins.send(method,*varargs),nil]
+  rescue => e
+    [false,e.message]
+  end
+  puts "#{success ? SUCCESS : ERROR}: #{desc}#{message.nil? ? nil : " (%s)" % e.message}"
+  success
+end
+
+exit_clean = true
+options[:tags].each do |t|
+  if options[:log_message]
+    exit_clean = api_call("#{t} create #{options[:log_level].downcase} log #{options[:log_message].inspect}", :log!, t, options[:log_message], options[:log_level]) && exit_clean
+  end
+  options[:attributes].each do |k,v|
+    exit_clean = api_call("#{t} set #{k}=#{v}", :set_attribute!, t, k, v) && exit_clean
+  end
+  options[:delete_attributes].each do |k|
+    exit_clean = api_call("#{t} delete #{k}", :delete_attribute!, t, k) && exit_clean
+  end
+  if options[:status]
+    exit_clean = api_call("#{t} set status to #{options[:status]}#{options[:state] ? ":#{options[:state]}" : ''}", :set_status!, t, :status => options[:status], :state => options[:state], :reason => options[:reason]) && exit_clean
+  end
+end
+
+exit exit_clean ? 0 : 1
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: collins-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gabe Conradi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: collins_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: collins_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+description: CLI utilities to interact with the Collins API
+email:
+- gabe@tumblr.com
+- gummybearx@gmail.com
+executables:
+- collins
+- collins-action
+- collins-find
+- collins-log
+- collins-modify
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/collins
+- bin/collins-action
+- bin/collins-find
+- bin/collins-log
+- bin/collins-modify
+- README.md
+homepage: http://github.com/byxorna/collins-cli
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: CLI utilities to interact with the Collins API
+test_files: []