choria-mcorpc-support 0.0.1

data/lib/mcollective/application/completion.rb

@@ -0,0 +1,104 @@
+module MCollective
+  class Application::Completion<MCollective::Application
+    description "Helper for shell completion systems"
+
+    exclude_argument_sections "common", "filter", "rpc"
+
+    option :list_agents,
+           :description => "List all known agents",
+           :arguments => "--list-agents",
+           :required => false,
+           :type => :boolean
+
+    option :list_actions,
+           :description => "List all actions for an agent",
+           :arguments => "--list-actions",
+           :required => false,
+           :type => :boolean
+
+    option :list_inputs,
+           :description => "List all inputs for an action",
+           :arguments => "--list-inputs",
+           :required => false,
+           :type => :boolean
+
+    option :list_applications,
+           :description => "List all known applications",
+           :arguments => "--list-applications",
+           :required => false,
+           :type => :boolean
+
+    option :agent,
+           :description => "The agent to operate on",
+           :arguments => "--agent AGENT",
+           :required => false
+
+    option :action,
+           :description => "The action to operate on",
+           :arguments => "--action ACTION",
+           :required => false
+
+    def list_agents
+      if options[:verbose]
+        PluginManager.find(:agent, "ddl").each do |agent|
+          begin
+            ddl = DDL.new(agent)
+            puts "%s:%s" % [ agent, ddl.meta[:description] ]
+          rescue
+          end
+        end
+      else
+        PluginManager.find(:agent, "ddl").each {|p| puts p}
+      end
+    end
+
+    def list_actions
+      abort "Please specify an agent to list actions for" unless configuration[:agent]
+
+      if options[:verbose]
+        ddl = DDL.new(configuration[:agent], :agent)
+
+        ddl.actions.sort.each do |action|
+          puts "%s:%s" % [action, ddl.action_interface(action)[:description]]
+        end
+      else
+        DDL.new(configuration[:agent], :agent).actions.sort.each {|a| puts a}
+      end
+    rescue
+    end
+
+    def list_inputs
+      abort "Please specify an action and agent to list inputs for" unless configuration[:agent] && configuration[:action]
+
+      if options[:verbose]
+        ddl = DDL.new(configuration[:agent], :agent)
+        action = ddl.action_interface(configuration[:action])
+        action[:input].keys.sort.each do |input|
+          puts "%s:%s" % [input, action[:input][input][:description]]
+        end
+      else
+        DDL.new(configuration[:agent], :agent).action_interface(configuration[:action])[:input].keys.sort.each {|i| puts i}
+      end
+    rescue
+    end
+
+    def list_applications
+      if options[:verbose]
+        Applications.list.each do |app|
+          puts "%s:%s" % [app, Applications[app].application_description]
+        end
+      else
+        Applications.list.each {|a| puts a}
+      end
+    end
+
+    def main
+      actions = configuration.keys.map{|k| k.to_s}.grep(/^list_/)
+
+      abort "Please choose either --list-[agents|actions|inputs|applications]" if actions.empty?
+      abort "Please choose only one of --list-[agents|actions|inputs|applications]" if actions.size > 1
+
+      send actions.first
+    end
+  end
+end

data/lib/mcollective/application/describe_filter.rb

@@ -0,0 +1,87 @@
+module MCollective
+  class Application::Describe_filter<Application
+    exclude_argument_sections "common", "rpc"
+
+    description "Display human readable interpretation of filters"
+
+    usage "mco describe_filter -S <filter> -F <filter> -C <filter>"
+
+    def describe_s_filter(stack)
+      indent = "  "
+      old_indent = "  "
+      puts "-S Query expands to the following instructions:"
+      puts
+      stack.each do |token|
+        if token.keys[0] == "statement"
+          if token.values[0] =~ /(<=|>=|=|=~|=)/
+            op = $1
+            k,v = token.values[0].split(op)
+            puts indent + get_fact_string(k, v, op)
+          else
+            puts indent + get_class_string(token.values[0])
+          end
+        elsif token.keys[0] == "fstatement"
+          v = token.values[0]
+          result_string = indent + "Execute the Data Query '#{v["name"]}'"
+          if v["params"]
+            result_string += " with parameters (#{v["params"]})"
+          end
+          result_string += ". "
+          result_string += "Check if the query's '#{v["value"]}' value #{v["operator"]} '#{v["r_compare"]}'  "
+          puts result_string
+        elsif token.keys[0] == "("
+          puts indent + "("
+          old_indent = indent
+          indent *= 2
+        elsif token.keys[0] == ")"
+          indent = old_indent
+          puts indent + ")"
+        else
+          puts indent + token.keys[0].upcase
+        end
+      end
+    end
+
+    def describe_f_filter(facts)
+      puts "-F filter expands to the following fact comparisons:"
+      puts
+      facts.each do |f|
+        puts "  " + get_fact_string(f[:fact], f[:value], f[:operator])
+      end
+    end
+
+    def describe_c_filter(classes)
+      puts "-C filter expands to the following class checks:"
+      puts
+      classes.each do |c|
+        puts "  " + get_class_string(c)
+      end
+    end
+
+    def main
+      if !(@options[:filter]["fact"].empty?)
+        describe_f_filter(@options[:filter]["fact"])
+        puts
+      end
+
+      if !(@options[:filter]["cf_class"].empty?)
+        describe_c_filter(@options[:filter]["cf_class"])
+        puts
+      end
+
+      if !(@options[:filter]["compound"].empty?)
+        describe_s_filter(@options[:filter]["compound"][0])
+        puts
+      end
+    end
+
+    private
+    def get_fact_string(fact, value, op)
+      "Check if fact '#{fact}' #{op} '#{value}'"
+    end
+
+    def get_class_string(classname)
+      "Check if class '#{classname}' is present on the host"
+    end
+  end
+end

data/lib/mcollective/application/facts.rb

@@ -0,0 +1,62 @@
+class MCollective::Application::Facts<MCollective::Application
+  description "Reports on usage for a specific fact"
+
+  def post_option_parser(configuration)
+    configuration[:fact] = ARGV.shift if ARGV.size > 0
+  end
+
+  def validate_configuration(configuration)
+    raise "Please specify a fact to report for" unless configuration.include?(:fact)
+  end
+
+  def show_single_fact_report(fact, facts, verbose=false)
+    puts("Report for fact: #{fact}\n\n")
+
+    field_size = MCollective::Util.field_size(facts.keys)
+    facts.keys.sort.each do |k|
+      printf("        %-#{field_size}s found %d times\n", k, facts[k].size)
+
+      if verbose
+        puts
+
+        facts[k].sort.each do |f|
+          puts("            #{f}")
+        end
+
+        puts
+      end
+    end
+  end
+
+  def main
+    rpcutil = rpcclient("rpcutil")
+    rpcutil.progress = false
+
+    facts = {}
+
+    rpcutil.get_fact(:fact => configuration[:fact]) do |resp|
+      begin
+        value = resp[:body][:data][:value]
+        if value
+          if facts.include?(value)
+            facts[value] << resp[:senderid]
+          else
+            facts[value] = [ resp[:senderid] ]
+          end
+        end
+      rescue Exception => e
+        STDERR.puts "Could not parse facts for #{resp[:senderid]}: #{e.class}: #{e}"
+      end
+    end
+
+    if facts.empty?
+      puts "No values found for fact #{configuration[:fact]}\n"
+    else
+      show_single_fact_report(configuration[:fact], facts, options[:verbose])
+    end
+
+    printrpcstats
+
+    halt rpcutil.stats
+  end
+end

data/lib/mcollective/application/find.rb

@@ -0,0 +1,23 @@
+class MCollective::Application::Find<MCollective::Application
+  description "Find hosts using the discovery system matching filter criteria"
+
+  def main
+    mc = rpcclient("rpcutil")
+
+    starttime = Time.now
+
+    mc.detect_and_set_stdin_discovery
+
+    nodes = mc.discover
+
+    discoverytime = Time.now - starttime
+
+    STDERR.puts if options[:verbose]
+
+    nodes.each {|c| puts c}
+
+    STDERR.puts "\nDiscovered %s nodes in %.2f seconds using the %s discovery plugin" % [nodes.size, discoverytime, mc.client.discoverer.discovery_method] if options[:verbose]
+
+    nodes.size > 0 ? exit(0) : exit(1)
+  end
+end

data/lib/mcollective/application/help.rb

@@ -0,0 +1,28 @@
+module MCollective
+  class Application::Help<Application
+    description "Application list and help"
+    usage "rpc help [application name]"
+
+    def post_option_parser(configuration)
+      configuration[:application] = ARGV.shift if ARGV.size > 0
+    end
+
+    def main
+      if configuration.include?(:application)
+        puts Applications[configuration[:application]].help
+      else
+        puts "The Marionette Collective version #{MCollective.version}"
+        puts
+
+        Applications.list.sort.each do |app|
+          begin
+            puts "  %-15s %s" % [app, Applications[app].application_description]
+          rescue
+          end
+        end
+
+        puts
+      end
+    end
+  end
+end

data/lib/mcollective/application/inventory.rb

@@ -0,0 +1,344 @@
+class MCollective::Application::Inventory<MCollective::Application
+  description "General reporting tool for nodes, collectives and subcollectives"
+
+  option :script,
+         :description    => "Script to run",
+         :arguments      => ["--script SCRIPT"]
+
+  option :collectives,
+         :description    => "List all known collectives",
+         :arguments      => ["--list-collectives", "--lc"],
+         :default        => false,
+         :type           => :bool
+
+  option :collectivemap,
+         :description    => "Create a DOT graph of all collectives",
+         :arguments      => ["--collective-graph MAP", "--cg MAP", "--map MAP"]
+
+  def post_option_parser(configuration)
+    configuration[:node] = ARGV.shift if ARGV.size > 0
+  end
+
+  def validate_configuration(configuration)
+    unless configuration[:node] || configuration[:script] || configuration[:collectives] || configuration[:collectivemap]
+      raise "Need to specify either a node name, script to run or other options"
+    end
+  end
+
+  # Get all the known collectives and nodes that belong to them
+  def get_collectives
+    util = rpcclient("rpcutil")
+    util.progress = false
+
+    collectives = {}
+    nodes = 0
+    total = 0
+
+    util.collective_info do |r, cinfo|
+      begin
+        if cinfo[:data] && cinfo[:data][:collectives]
+          cinfo[:data][:collectives].each do |collective|
+            collectives[collective] ||= []
+            collectives[collective]  << cinfo[:sender]
+          end
+
+          nodes += 1
+          total += 1
+        end
+      end
+    end
+
+    {:collectives => collectives, :nodes => nodes, :total_nodes => total}
+  end
+
+  # Writes a crude DOT graph to a file
+  def collectives_map(file)
+    File.open(file, "w") do |graph|
+      puts "Retrieving collective info...."
+      collectives = get_collectives
+
+      graph.puts 'graph {'
+
+      collectives[:collectives].keys.sort.each do |collective|
+        graph.puts '   subgraph "%s" {' % [ collective ]
+
+        collectives[:collectives][collective].each do |member|
+          graph.puts '      "%s" -- "%s"' % [ member, collective ]
+        end
+
+        graph.puts '   }'
+      end
+
+      graph.puts '}'
+
+      puts "Graph of #{collectives[:total_nodes]} nodes has been written to #{file}"
+    end
+  end
+
+  # Prints a report of all known sub collectives
+  def collectives_report
+    collectives = get_collectives
+
+    puts "   %-30s %s" % [ "Collective", "Nodes" ]
+    puts "   %-30s %s" % [ "==========", "=====" ]
+
+    collectives[:collectives].sort_by {|key,count| count.size}.each do |collective|
+      puts "   %-30s %d" % [ collective[0], collective[1].size ]
+    end
+
+    puts
+    puts "   %30s %d" % [ "Total nodes:", collectives[:nodes] ]
+    puts
+  end
+
+  def node_inventory
+    node = configuration[:node]
+
+    util = rpcclient("rpcutil")
+    util.identity_filter node
+    util.progress = false
+
+    nodestats = util.custom_request("daemon_stats", {}, node, {"identity" => node}).first
+
+    unless nodestats
+      STDERR.puts "Did not receive any results from node #{node}"
+      exit 1
+    end
+
+    unless nodestats[:statuscode] == 0
+      STDERR.puts "Failed to retrieve daemon_stats from #{node}: #{nodestats[:statusmsg]}"
+    else
+      util.custom_request("inventory", {}, node, {"identity" => node}).each do |resp|
+        unless resp[:statuscode] == 0
+          STDERR.puts "Failed to retrieve inventory for #{node}: #{resp[:statusmsg]}"
+          next
+        end
+
+        data = resp[:data]
+
+        begin
+          puts "Inventory for #{resp[:sender]}:"
+          puts
+
+          nodestats = nodestats[:data]
+
+          puts "   Server Statistics:"
+          puts "                      Version: #{nodestats[:version]}"
+          puts "                   Start Time: #{Time.at(nodestats[:starttime])}"
+          puts "                  Config File: #{nodestats[:configfile]}"
+          puts "                  Collectives: #{data[:collectives].join(', ')}" if data.include?(:collectives)
+          puts "              Main Collective: #{data[:main_collective]}" if data.include?(:main_collective)
+          puts "                   Process ID: #{nodestats[:pid]}"
+          puts "               Total Messages: #{nodestats[:total]}"
+          puts "      Messages Passed Filters: #{nodestats[:passed]}"
+          puts "            Messages Filtered: #{nodestats[:filtered]}"
+          puts "             Expired Messages: #{nodestats[:ttlexpired]}"
+          puts "                 Replies Sent: #{nodestats[:replies]}"
+          puts "         Total Processor Time: #{nodestats[:times][:utime]} seconds"
+          puts "                  System Time: #{nodestats[:times][:stime]} seconds"
+
+          puts
+
+          puts "   Agents:"
+          if data[:agents].size > 0
+            data[:agents].sort.in_groups_of(3, "") do |agents|
+              puts "      %-15s %-15s %-15s" % agents
+            end
+          else
+            puts "      No agents installed"
+          end
+
+          puts
+
+          puts "   Data Plugins:"
+          if data[:data_plugins].size > 0
+            data[:data_plugins].sort.in_groups_of(3, "") do |plugins|
+              puts "      %-15s %-15s %-15s" % plugins.map{|p| p.gsub("_data", "")}
+            end
+          else
+            puts "      No data plugins installed"
+          end
+
+          puts
+
+          puts "   Configuration Management Classes:"
+          if data[:classes].size > 0
+            field_size = MCollective::Util.field_size(data[:classes], 30)
+            fields_num = MCollective::Util.field_number(field_size)
+            format = "   " + (" %-#{field_size}s" * fields_num)
+
+            data[:classes].sort.in_groups_of(fields_num, "") do |klasses|
+              puts format % klasses
+            end
+          else
+            puts "      No classes applied"
+          end
+
+          puts
+
+          puts "   Facts:"
+          if data[:facts].size > 0
+            data[:facts].sort_by{|f| f[0]}.each do |f|
+              puts "      #{f[0]} => #{f[1]}"
+            end
+          else
+            puts "      No facts known"
+          end
+
+          break
+        rescue Exception => e
+          STDERR.puts "Failed to display node inventory: #{e.class}: #{e}"
+        end
+      end
+    end
+
+    halt util.stats
+  end
+
+  # Helpers to create a simple DSL for scriptlets
+  def format(fmt)
+    @fmt = fmt
+  end
+
+  def fields(&blk)
+    @flds = blk
+  end
+
+  def identity
+    @node[:identity]
+  end
+
+  def facts
+    @node[:facts]
+  end
+
+  def classes
+    @node[:classes]
+  end
+
+  def agents
+    @node[:agents]
+  end
+
+  def page_length(len)
+    @page_length = len
+  end
+
+  def page_heading(fmt)
+    @page_heading = fmt
+  end
+
+  def page_body(fmt)
+    @page_body = fmt
+  end
+
+  # Expects a simple printf style format and apply it to
+  # each node:
+  #
+  #    inventory do
+  #        format "%s:\t\t%s\t\t%s"
+  #
+  #        fields { [ identity, facts["serialnumber"], facts["productname"] ] }
+  #    end
+  def inventory(&blk)
+    raise "Need to give a block to inventory" unless block_given?
+
+    blk.call if block_given?
+
+    raise "Need to define a format" if @fmt.nil?
+    raise "Need to define inventory fields" if @flds.nil?
+
+    util = rpcclient("rpcutil")
+    util.progress = false
+
+    util.inventory do |t, resp|
+      @node = {:identity => resp[:sender],
+        :facts    => resp[:data][:facts],
+        :classes  => resp[:data][:classes],
+        :agents   => resp[:data][:agents]}
+
+      puts @fmt % @flds.call
+    end
+  end
+
+  # Use the ruby formatr gem to build reports using Perls formats
+  #
+  # It is kind of ugly but brings a lot of flexibility in report
+  # writing without building an entire reporting language.
+  #
+  # You need to have formatr installed to enable reports like:
+  #
+  #    formatted_inventory do
+  #        page_length 20
+  #
+  #        page_heading <<TOP
+  #
+  #                Node Report @<<<<<<<<<<<<<<<<<<<<<<<<<
+  #                            time
+  #
+  #    Hostname:         Customer:     Distribution:
+  #    -------------------------------------------------------------------------
+  #    TOP
+  #
+  #        page_body <<BODY
+  #
+  #    @<<<<<<<<<<<<<<<< @<<<<<<<<<<<< @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+  #    identity,    facts["customer"], facts["lsbdistdescription"]
+  #                                    @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+  #                                    facts["processor0"]
+  #    BODY
+  #    end
+  def formatted_inventory(&blk)
+    require 'formatr'
+
+    raise "Need to give a block to formatted_inventory" unless block_given?
+
+    blk.call if block_given?
+
+    raise "Need to define page body format" if @page_body.nil?
+
+    body_fmt = FormatR::Format.new(@page_heading, @page_body)
+    body_fmt.setPageLength(@page_length)
+    time = Time.now
+
+    util = rpcclient("rpcutil")
+    util.progress = false
+
+    util.inventory do |t, resp|
+      @node = {:identity => resp[:sender],
+        :facts    => resp[:data][:facts],
+        :classes  => resp[:data][:classes],
+        :agents   => resp[:data][:agents]}
+
+      body_fmt.printFormat(binding)
+    end
+  rescue Exception => e
+    STDERR.puts "Could not create report: #{e.class}: #{e}"
+    exit 1
+  end
+
+  @fmt = nil
+  @flds = nil
+  @page_heading = nil
+  @page_body = nil
+  @page_length = 40
+
+  def main
+    if configuration[:script]
+      if File.exist?(configuration[:script])
+        eval(File.read(configuration[:script]))
+      else
+        raise "Could not find script to run: #{configuration[:script]}"
+      end
+
+    elsif configuration[:collectivemap]
+      collectives_map(configuration[:collectivemap])
+
+    elsif configuration[:collectives]
+      collectives_report
+
+    else
+      node_inventory
+    end
+  end
+end