choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/util/playbook/tasks/base.rb

@@ -0,0 +1,45 @@
+module MCollective
+  module Util
+    class Playbook
+      class Tasks
+        class Base
+          attr_accessor :description
+          attr_writer :fail_ok
+
+          include TemplateUtil
+
+          def initialize(playbook)
+            @playbook = playbook
+            @fail_ok = false
+
+            startup_hook
+          end
+
+          def startup_hook; end
+
+          def to_s
+            "#<%s description: %s>" % [self.class, t(description)]
+          end
+
+          def run_task(result)
+            validate_configuration!
+
+            result.timed_run(self)
+          end
+
+          def run
+            raise(StandardError, "run not implemented", caller)
+          end
+
+          def validate_configuration!
+            raise(StandardError, "validate_configuration! not implemented", caller)
+          end
+
+          def from_hash(properties)
+            raise(StandardError, "from_hash not implemented", caller)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/util/playbook/tasks/graphite_event_task.rb

@@ -0,0 +1,64 @@
+require "uri"
+
+module MCollective
+  module Util
+    class Playbook
+      class Tasks
+        class Graphite_eventTask < Base
+          def run
+            webhook_task.run
+          end
+
+          def request
+            {
+              "what" => @what,
+              "tags" => @tags.join(","),
+              "when" => Time.now.to_i,
+              "data" => @data
+            }
+          end
+
+          def webhook_task
+            return @_webhook if @_webhook
+
+            @_webhook = Tasks::WebhookTask.new(@playbook)
+
+            @_webhook.from_hash(
+              "description" => @description,
+              "headers" => @headers,
+              "uri" => @graphite,
+              "method" => "POST",
+              "data" => request
+            )
+
+            @_webhook
+          end
+
+          def validate_configuration!
+            raise("The 'what' property is required") unless @what
+            raise("The 'data' property is required") unless @data
+            raise("The 'graphite' property is required") if @graphite == ""
+            raise("'tags' should be an array") unless @tags.is_a?(Array)
+            raise("'headers' should be a hash") unless @headers.is_a?(Hash)
+            raise("The graphite url should be either http or https") unless ["http", "https"].include?(@uri.scheme)
+          end
+
+          def to_execution_result(results)
+            r = webhook_task.to_execution_result(results)
+            r["type"] = "graphite"
+            r
+          end
+
+          def from_hash(properties)
+            @what = properties["what"]
+            @data = properties["data"]
+            @graphite = properties.fetch("graphite", "")
+            @headers = properties.fetch("headers", {})
+            @tags = properties.fetch("tags", ["choria"])
+            @uri = URI.parse(@graphite)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/util/playbook/tasks/mcollective_task.rb

@@ -0,0 +1,356 @@
+module MCollective
+  module Util
+    class Playbook
+      class Tasks
+        class McollectiveTask < Base
+          def startup_hook
+            @properties = {}
+            @post = []
+            @nodes = []
+          end
+
+          # Determines if jgrep is available and loads it
+          #
+          # @return [Boolean]
+          def jgrep?
+            @_jgrep = false
+
+            require "jgrep"
+
+            if JGrep.respond_to?("validate_expression")
+              @_jgrep = true
+            else
+              Log.warn("Please install a version of JGrep greater than or equal to 1.5.0")
+            end
+
+            @_jgrep
+          rescue LoadError
+            @_jgrep = false
+          end
+
+          # Creates and cache an RPC::Client for the configured agent
+          #
+          # @param from_cache [Boolean] when false a new instance is always returned
+          # @return [RPC::Client]
+          def client(from_cache=true)
+            if from_cache
+              @_rpc_client ||= create_and_configure_client
+            else
+              create_and_configure_client
+            end
+          end
+
+          # Creates a new RPC::Client and configures it with the configured settings
+          #
+          # @todo discovery
+          # @return [RPC::Client]
+          def create_and_configure_client
+            client = RPC::Client.new(@agent, :configfile => Util.config_file_for_user, :options => Util.default_options)
+            client.batch_size = @batch_size if @batch_size
+            client.batch_sleep_time = @batch_sleep_time if @batch_sleep_time
+            client.discover(:nodes => @nodes)
+            client.progress = false
+            client
+          end
+
+          # Validates the internal configuration of the task
+          #
+          # @raise [StandardError] on failure of the internal state
+          def validate_configuration!
+            raise("Nodes have to be an array") unless @nodes.is_a?(Array)
+            raise("Nodes need to be supplied, refusing to run against empty node list") if @nodes.empty?
+
+            if @assertion
+              raise("jgrep is required for tasks with an assertion") unless jgrep?
+
+              parse_result = parse_assertion
+
+              unless parse_result == true
+                parse_result.tr!("\n", " ")
+                raise("Could not parse the assertion %s: %s" % [@assertion, parse_result])
+              end
+            end
+          end
+
+          # Parse an action in the form agent.action
+          #
+          # @todo check it complies to format
+          # @param action [String] in the form agent.action
+          # @return [Array<String, String>] the agent and action parts
+          def parse_action(action)
+            action.split(".")
+          end
+
+          # Initialize the task from a hash
+          #
+          # @param data [Hash] input data matching tasks/rpc.json schema
+          # @return [McollectiveTask]
+          def from_hash(data)
+            @nodes = data.fetch("nodes", [])
+            @agent, @action = parse_action(data["action"])
+            @batch_size = data["batch_size"]
+            @batch_sleep_time = data["batch_sleep_time"]
+            @properties = data.fetch("properties", {})
+            @post = data.fetch("post", [])
+            @log_replies = !data.fetch("silent", false)
+            @assertion = data["assert"]
+
+            @_rpc_client = nil
+
+            self
+          end
+
+          # Determines the run result
+          #
+          # @param stats [RPC::Stats]
+          # @param replies [Array<RPC::Result>]
+          # @return [Array<Boolean, String, Array<Hash>>] success, message, rpc replies
+          def run_result(stats, replies)
+            reply_data = replies.map do |reply|
+              {
+                "agent" => reply.agent,
+                "action" => reply.action,
+                "sender" => reply.results[:sender],
+                "statuscode" => reply.results[:statuscode],
+                "statusmsg" => reply.results[:statusmsg],
+                "data" => reply.results[:data],
+                "requestid" => stats.requestid
+              }
+            end
+
+            success = request_success?(stats)
+            assert_failed = -1
+
+            if @assertion && success
+              passed, assert_failed = assert_replies(replies)
+              if passed
+                Log.info("Assertion '%s' passed on all %d nodes" % [@assertion, replies.size])
+              else
+                Log.warn("Assertion '%s' failed on %d/%d nodes" % [@assertion, assert_failed, replies.size])
+                success = false
+              end
+            end
+
+            if success
+              msg = nil
+
+              msg = summary_message(stats) if should_summarize?
+              msg ||= success_message(stats)
+
+              [true, msg, reply_data]
+            elsif assert_failed > -1
+              [false, "Failed request %s for %s#%s assertion failed on %d node(s)" % [stats.requestid, @agent, @action, assert_failed], reply_data]
+            else
+              failed = stats.failcount + stats.noresponsefrom.size
+              [false, "Failed request %s for %s#%s on %d failed node(s)" % [stats.requestid, @agent, @action, failed], reply_data]
+            end
+          end
+
+          def to_execution_result(results)
+            e_result = {}
+
+            results[2].each do |data|
+              result = {
+                "value" => JSON.parse(JSON.dump(data)),
+                "type" => "mcollective",
+                "fail_ok" => @fail_ok
+              }
+
+              unless data["statuscode"] == 0
+                result["error"] = {
+                  "msg" => data["statusmsg"],
+                  "kind" => "choria.playbook/taskerror",
+                  "details" => {
+                    "agent" => @agent,
+                    "action" => @action,
+                    "issue_code" => data["statuscode"]
+                  }
+                }
+              end
+
+              e_result[data["sender"]] = result
+            end
+
+            if client.stats
+              client.stats.noresponsefrom.each do |nr|
+                e_result[nr] = {
+                  "value" => {},
+                  "type" => "mcollective",
+                  "fail_ok" => @fail_ok,
+                  "error" => {
+                    "msg" => "No response from node %s" % nr,
+                    "kind" => "choria.playbook/taskerror",
+                    "details" => {
+                      "agent" => @agent,
+                      "action" => @action
+                    }
+                  }
+                }
+              end
+            end
+
+            e_result
+          end
+
+          # Logs the result of a request
+          #
+          # @param stats [RPC::Stats]
+          # @param replies [Array<RPC::Result>]
+          def log_results(stats, replies)
+            if request_success?(stats)
+              log_success(stats)
+            else
+              log_failure(stats, replies)
+            end
+          end
+
+          # Logs a successfull request
+          #
+          # @param stats [RPC::Stats]
+          def log_success(stats)
+            Log.debug(success_message(stats))
+          end
+
+          # Creates the messages logged on success
+          #
+          # @return [String]
+          def success_message(stats)
+            "Successful request %s for %s#%s in %0.2fs against %d node(s)" % [stats.requestid, @agent, @action, stats.totaltime, stats.okcount]
+          end
+
+          # Creates the summary message
+          #
+          # @param stats [RPC::Stat]
+          # @return [String,nil]
+          def summary_message(stats)
+            summary = {}
+
+            if stats.aggregate_summary.size + stats.aggregate_failures.size > 0
+              stats.aggregate_summary.each do |aggregate|
+                summary.merge!(aggregate.result[:value])
+              end
+            end
+
+            return nil if summary.empty?
+
+            "Summary for %s: %s" % [@description, summary.to_json]
+          end
+
+          # Logs a failed request
+          #
+          # @param stats [RPC::Stats]
+          # @param replies [Array<RPC::Result>]
+          def log_failure(stats, replies)
+            stats ||= client.stats
+
+            Log.warn("Failed request %s for %s#%s in %0.2fs" % [stats.requestid, @agent, @action, stats.totaltime])
+
+            Log.warn("No responses from: %s" % stats.noresponsefrom.join(", ")) unless stats.noresponsefrom.empty?
+
+            if stats.failcount > 0
+              replies.each do |reply|
+                Log.warn("Failed result from %s: %s" % [reply.results[:sender], reply.results[:statusmsg]]) if reply.results[:statuscode] > 0
+              end
+            end
+          end
+
+          def log_reply(reply)
+            if reply.results[:statuscode] == 0
+              return unless @log_replies
+
+              Log.info("%s %s#%s success: %s" % [reply.results[:sender], @agent, @action, reply.results[:data].inspect])
+            else
+              Log.warn("%s %s#%s failure: %s" % [reply.results[:sender], @agent, @action, reply.results[:data].inspect])
+            end
+          end
+
+          # Validates the supplied assertion using JGrep's parser
+          #
+          # @return [true,String] true when its valid, else a string with any errors
+          def parse_assertion
+            return "JGrep not installed" unless jgrep?
+
+            JGrep.validate_expression(@assertion)
+          end
+
+          # Runs the reply data through the assertion, true when all replies match
+          #
+          # @return [Boolean, Integer] boolean indicating overall success, the integer shows how many nodes failed
+          def assert_replies(replies)
+            return [false, replies.size] unless @assertion
+            return [false, replies.size] unless jgrep?
+
+            result = []
+            expected = replies.size
+            jdata = replies.map {|reply| reply.results[:data]}.to_json
+
+            begin
+              Log.debug("Asserting '%s' over %d replies" % [@assertion, replies.size])
+              result = JGrep.jgrep(jdata, @assertion)
+            rescue
+              Log.error("Assertion '%s' could not be matched: %s" % [@asssertion, expected])
+            end
+
+            [result.size == expected, expected - result.size]
+          end
+
+          # Determines if a request was succesfull
+          #
+          # @param stats [RPC::Stats]
+          # @return [Boolean]
+          def request_success?(stats)
+            return false if stats.failcount > 0
+            return false if stats.okcount == 0
+            return false unless stats.noresponsefrom.empty?
+
+            true
+          end
+
+          # Determines if a summary was requested
+          #
+          # @return [Boolean]
+          def should_summarize?
+            @post.include?("summarize")
+          end
+
+          # Converts the string keys to symbols if the DDL is based on symbols
+          #
+          # This is to be compatible with either JSON or non JSON mcollectives
+          #
+          # @param properties [Hash] the properties for the task
+          # @return [Hash] mapped to what the DDL expects
+          def symbolize_basic_input_arguments(properties)
+            input = client.ddl.action_interface(@action)[:input] || {}
+            client.ddl.symbolize_basic_input_arguments(input, properties)
+          end
+
+          # Logs a single RPC reply
+          # Performs a single attempt at calling the agent
+          # @todo should return some kind of task status object
+          # @return [Array<Boolean, String, Array<RPC::Result>>] success, message, rpc replies
+          def run
+            Log.info("Starting request for %s#%s against %d nodes" % [@agent, @action, @nodes.size])
+
+            begin
+              replies = []
+
+              client.send(@action, symbolize_basic_input_arguments(@properties)) do |_, s|
+                replies << s
+                log_reply(s)
+              end
+
+              log_results(client.stats, replies)
+              run_result(client.stats, replies)
+            rescue
+              msg = "Could not create request for %s#%s: %s: %s" % [@agent, @action, $!.class, $!.to_s]
+              Log.debug(msg)
+              Log.debug($!.backtrace.join("\t\n"))
+
+              [false, msg, []]
+            end
+          end
+        end
+      end
+    end
+  end
+end