choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/util/indifferent_hash.rb

@@ -0,0 +1,12 @@
+module MCollective
+  module Util
+    class IndifferentHash < Hash
+      def [](key)
+        return super if key?(key)
+        return self[key.to_s] if key.is_a?(Symbol)
+
+        super
+      end
+    end
+  end
+end

data/lib/mcollective/util/natswrapper.rb

@@ -0,0 +1,242 @@
+require "nats/io/client"
+
+module MCollective
+  module Util
+    # A wrapper class around the Pure Ruby NATS gem
+    #
+    # MCollective has some non compatible expectations about how
+    # message flow works such as having a blocking receive and publish
+    # method it calls when it likes, while typical flow is to pass
+    # a block and then callbacks will be called.
+    #
+    # This wrapper bridges the 2 worlds using ruby Queues to simulate the
+    # blocking receive expectation MCollective has thanks to its initial
+    # design around the Stomp gem.
+    class NatsWrapper
+      attr_reader :subscriptions, :received_queue
+
+      def initialize
+        @received_queue = Queue.new
+        @subscriptions = {}
+        @subscription_mutex = Mutex.new
+        @started = false
+        @client = NATS::IO::Client.new
+      end
+
+      # Has the NATS connection started
+      #
+      # @return [Boolean]
+      def started?
+        @started
+      end
+
+      # Is there a NATS client created
+      #
+      # @return [Boolean]
+      def has_client?
+        !!@client
+      end
+
+      # Retrieves the current connected server
+      #
+      # @return [String,nil]
+      def connected_server
+        return nil unless connected?
+
+        @client.connected_server
+      end
+
+      # Connection stats from the NATS gem
+      #
+      # @return [Hash]
+      def stats
+        return {} unless has_client?
+
+        @client.stats
+      end
+
+      # Client library flavour
+      #
+      # @return [String]
+      def client_flavour
+        "nats-pure"
+      end
+
+      # Client library version
+      #
+      # @return [String]
+      def client_version
+        NATS::IO::VERSION
+      end
+
+      # Connection options from the NATS gem
+      #
+      # @return [Hash]
+      def active_options
+        return {} unless has_client?
+
+        @client.options
+      end
+
+      # Is NATS connected
+      #
+      # @return [Boolean]
+      def connected?
+        has_client? && @client.connected?
+      end
+
+      # Does a backoff sleep up to 2 seconds
+      #
+      # @return [void]
+      def backoff_sleep
+        @backoffcount ||= 1
+
+        if @backoffcount >= 50
+          sleep(2)
+        else
+          sleep(0.04 * @backoffcount)
+        end
+
+        @backoffcount += 1
+      end
+
+      # Logs the NATS server pool for nats-pure
+      #
+      # The current server pool is dynamic as the NATS servers can announce
+      # new cluster members as they join the pool, little helper for logging
+      # the pool on major events
+      #
+      # @return [void]
+      def log_nats_pool
+        return unless has_client?
+
+        servers = @client.server_pool.map do |server|
+          server[:uri].to_s
+        end
+
+        Log.info("Current server pool: %s" % servers.join(", "))
+      end
+
+      # Starts the EM based NATS connection
+      #
+      # @param options [Hash] Options as per {#NATS::IO::Client#connect}
+      def start(options={})
+        # Client connects pretty much soon as it's initialized which is very early
+        # and some applications like 'request_cert' just doesnt need/want a client
+        # since for example there won't be SSL stuff yet, so if a application calls
+        # disconnect very early on this should avoid that chicken and egg
+        return if @force_Stop
+
+        @client.on_reconnect do
+          Log.warn("Reconnected after connection failure: %s" % connected_server)
+          log_nats_pool
+          @backoffcount = 1
+        end
+
+        @client.on_disconnect do |error|
+          if error
+            Log.warn("Disconnected from NATS: %s: %s" % [error.class, error.to_s])
+          else
+            Log.info("Disconnected from NATS for an unknown reason")
+          end
+        end
+
+        @client.on_error do |error|
+          Log.error("Error in NATS connection: %s: %s" % [error.class, error.to_s])
+        end
+
+        @client.on_close do
+          Log.info("Connection to NATS server closed")
+        end
+
+        begin
+          @client.connect(options)
+        rescue ClientTimeoutError
+          raise
+        rescue
+          Log.error("Error during initial NATS setup: %s: %s" % [$!.class, $!.message])
+          Log.debug($!.backtrace.join("\n\t"))
+
+          sleep 1
+
+          Log.error("Retrying NATS initial setup")
+
+          retry
+        end
+
+        sleep(0.01) until connected?
+
+        @started = true
+
+        nil
+      end
+
+      # Stops the NATS connection
+      def stop
+        @force_stop = true
+        @client.close
+      end
+
+      # Receives a message from the receive queue
+      #
+      # This will block until a message is available
+      #
+      # @return [String] received message
+      def receive
+        @received_queue.pop
+      end
+
+      # Public a message
+      #
+      # @param destination [String] the NATS destination
+      # @param payload [String] the string to publish
+      # @param reply [String] a reply destination
+      def publish(destination, payload, reply=nil)
+        server_state = "%s %s" % [connected? ? "connected" : "disconnected", @client.connected_server]
+
+        if reply
+          Log.debug("Publishing to %s reply to %s via %s" % [destination, reply, server_state])
+        else
+          Log.debug("Publishing to %s via %s" % [destination, server_state])
+        end
+
+        @client.publish(destination, payload, reply)
+      end
+
+      # Subscribes to a message source
+      #
+      # @param source_name [String]
+      # @param options [Hash] options as accepted by {NATS::IO::Client#subscribe}
+      def subscribe(source_name, options={})
+        @subscription_mutex.synchronize do
+          Log.debug("Subscribing to %s" % source_name)
+
+          unless @subscriptions.include?(source_name)
+            @subscriptions[source_name] = @client.subscribe(source_name, options) do |msg, _, _|
+              @received_queue << msg
+            end
+          end
+        end
+      end
+
+      # Unsubscribes from a message source
+      #
+      # @param source_name [String]
+      def unsubscribe(source_name)
+        @subscription_mutex.synchronize do
+          if @subscriptions.include?(source_name)
+            @client.unsubscribe(@subscriptions[source_name])
+            @subscriptions.delete(source_name)
+          end
+        end
+      end
+
+      # Test helper
+      #
+      # @private
+      def stub_client(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/mcollective/util/playbook.rb

@@ -0,0 +1,435 @@
+require_relative "playbook/report"
+require_relative "playbook/playbook_logger"
+require_relative "playbook/puppet_logger"
+require_relative "playbook/template_util"
+require_relative "playbook/inputs"
+require_relative "playbook/uses"
+require_relative "playbook/nodes"
+require_relative "playbook/tasks"
+require_relative "playbook/data_stores"
+
+module MCollective
+  module Util
+    class Playbook
+      include TemplateUtil
+
+      attr_accessor :input_data, :context
+      attr_reader :metadata, :report, :data_stores, :uses, :tasks, :logger
+
+      def initialize(loglevel=nil)
+        @loglevel = loglevel
+
+        @report = Report.new(self)
+
+        # @todo dear god this Camel_Snake horror but mcollective requires this
+        # Configures the main MCollective logger with our custom logger
+        @logger = Log.set_logger(Playbook_Logger.new(self))
+
+        @nodes = Nodes.new(self)
+        @tasks = Tasks.new(self)
+        @uses = Uses.new(self)
+        @inputs = Inputs.new(self)
+        @data_stores = DataStores.new(self)
+        @playbook = self
+        @playbook_data = {}
+        @input_data = {}
+
+        @metadata = {
+          "name" => nil,
+          "version" => nil,
+          "author" => nil,
+          "description" => nil,
+          "tags" => [],
+          "on_fail" => "fail",
+          "loglevel" => "info",
+          "run_as" => "choria=deployer"
+        }
+      end
+
+      # Sets a custom logger
+      #
+      # @param logger [Class] the logger instance to configure and use
+      def logger=(logger)
+        @logger = Log.set_logger(logger.new(self))
+      end
+
+      # Loads the playbook data and prepare the runner
+      #
+      # @param data [Hash] playbook data
+      # @return [Playbook]
+      def from_hash(data)
+        in_context("loading") do
+          @playbook_data = data
+
+          @metadata = {
+            "name" => data["name"],
+            "version" => data["version"],
+            "author" => data["author"],
+            "description" => data["description"],
+            "tags" => data.fetch("tags", []),
+            "on_fail" => data.fetch("on_fail", "fail"),
+            "loglevel" => data.fetch("loglevel", "info"),
+            "run_as" => data["run_as"]
+          }
+        end
+
+        set_logger_level
+
+        in_context("inputs") do
+          @inputs.from_hash(data.fetch("inputs", {}))
+        end
+
+        self
+      end
+
+      # Validate the playbook structure
+      #
+      # This is a pretty grim way to do this, ideally AIO would include some JSON Schema
+      # tools but they don't and I don't want to carray a dependency on that now
+      #
+      # @todo use JSON Schema
+      # @raise [StandardError] for invalid playbooks
+      def validate_configuration!
+        in_context("validation") do
+          failed = false
+
+          valid_keys = (@metadata.keys + ["uses", "inputs", "locks", "data_stores", "nodes", "tasks", "hooks", "macros", "$schema"])
+          invalid_keys = @playbook_data.keys - valid_keys
+
+          unless invalid_keys.empty?
+            Log.error("Invalid playbook data items %s found" % invalid_keys.join(", "))
+            failed = true
+          end
+
+          ["name", "version", "author", "description"].each do |item|
+            unless @metadata[item]
+              Log.error("A playbook %s is needed" % item)
+              failed = true
+            end
+          end
+
+          unless ["debug", "info", "warn", "error", "fatal"].include?(@metadata["loglevel"])
+            Log.error("Invalid log level %s, valid levels are debug, info, warn, error, fatal" % @metadata["loglevel"])
+            failed = true
+          end
+
+          unless PluginManager["security_plugin"].valid_callerid?(@metadata["run_as"])
+            Log.error("Invalid callerid %s" % @metadata["run_as"])
+            failed = true
+          end
+
+          ["uses", "nodes", "hooks", "data_stores", "inputs"].each do |key|
+            next unless @playbook_data.include?(key)
+            next if @playbook_data[key].is_a?(Hash)
+
+            Log.error("%s should be a hash" % key)
+            failed = true
+          end
+
+          ["locks", "tasks"].each do |key|
+            next unless @playbook_data.include?(key)
+            next if @playbook_data[key].is_a?(Array)
+
+            Log.error("%s should be a array" % key)
+            failed = true
+          end
+
+          raise("Playbook is not in a valid format") if failed
+        end
+      end
+
+      def prepare
+        prepare_inputs
+
+        prepare_data_stores
+        save_input_data
+
+        obtain_playbook_locks
+
+        prepare_uses
+        prepare_nodes
+        prepare_tasks
+      end
+
+      # Saves data from any inputs that requested they be written to data stores
+      def save_input_data
+        @inputs.save_input_data
+      end
+
+      # Derives a playbook lock from a given lock
+      #
+      # If a lock is in the normal valid format of source/lock
+      # then it's assumed the user gave a full path and knows what
+      # she wants otherwise a path will be constructed using the
+      # playbook name
+      #
+      # @return [String]
+      def lock_path(lock)
+        lock =~ /^[a-zA-Z0-9\-_]+\/.+$/ ? lock : "%s/choria/locks/playbook/%s" % [lock, name]
+      end
+
+      # Obtains the playbook level locks
+      def obtain_playbook_locks
+        Array(@playbook_data["locks"]).each do |lock|
+          Log.info("Obtaining playbook lock %s" % [lock_path(lock)])
+          @data_stores.lock(lock_path(lock))
+        end
+      end
+
+      # Obtains the playbook level locks
+      def release_playbook_locks
+        Array(@playbook_data["locks"]).each do |lock|
+          Log.info("Releasing playbook lock %s" % [lock_path(lock)])
+
+          begin
+            @data_stores.release(lock_path(lock))
+          rescue
+            Log.warn("Lock %s could not be released, ignoring" % lock_path(lock))
+          end
+        end
+      end
+
+      # Runs the playbook
+      #
+      # @param inputs [Hash] input data
+      # @return [Hash] the playbook report
+      def run!(inputs)
+        success = false
+        validate_configuration!
+
+        begin
+          start_time = @report.start!
+
+          @input_data = inputs
+
+          in_context("pre") { Log.info("Starting playbook %s at %s" % [name, start_time]) }
+
+          prepare
+
+          success = in_context("run") { @tasks.run }
+          in_context("post") { Log.info("Done running playbook %s in %s" % [name, seconds_to_human(Integer(@report.elapsed_time))]) }
+
+          release_playbook_locks
+        rescue
+          msg = "Playbook %s failed: %s: %s" % [name, $!.class, $!.to_s]
+
+          Log.error(msg)
+          Log.debug($!.backtrace.join("\n\t"))
+
+          report.finalize(false, msg)
+        end
+
+        report.finalize(success)
+      end
+
+      # Playbook name as declared in metadata
+      #
+      # @return [String]
+      def name
+        metadata_item("name")
+      end
+
+      # Playbook version as declared in metadata
+      #
+      # @return [String]
+      def version
+        metadata_item("version")
+      end
+
+      def loglevel
+        @loglevel || metadata_item("loglevel") || "info"
+      end
+
+      def set_logger_level
+        @logger.set_level(loglevel.intern)
+      end
+
+      # Prepares the data sources from the plabook
+      def prepare_data_stores
+        in_context("pre.stores") { @data_stores.from_hash(t(@playbook_data["data_stores"] || {})).prepare }
+      end
+
+      # Prepares the inputs from the playbook
+      #
+      # @todo same pattern as prepare_uses and nodes
+      # @see Inputs#prepare
+      # @note this should be done first, before any uses, nodes or tasks are prepared
+      def prepare_inputs
+        in_context("prep.inputs") { @inputs.prepare(@input_data) }
+      end
+
+      # Prepares the uses clauses from the playbook
+      #
+      # @see Uses#prepare
+      def prepare_uses
+        in_context("prep.uses") { @uses.from_hash(t(@playbook_data["uses"] || {})).prepare }
+      end
+
+      # Prepares the ode lists from the Playbook
+      #
+      # @see Nodes#prepare
+      def prepare_nodes
+        in_context("prep.nodes") { @nodes.from_hash(t(@playbook_data["nodes"] || {})).prepare }
+      end
+
+      # Prepares the tasks lists `tasks` and `hooks` from the Playbook data
+      #
+      # @see Tasks#prepare
+      def prepare_tasks
+        # we lazy template parse these so that they might refer to run time
+        # state via the template system - like for example in a post task you
+        # might want to reference properties of another rpc request
+        in_context("prep.tasks") do
+          @tasks.from_hash(@playbook_data["tasks"] || [])
+          @tasks.from_hash(@playbook_data["hooks"] || {})
+          @tasks.prepare
+        end
+      end
+
+      # Validates agent versions on nodes
+      #
+      # @param agents [Hash] a hash of agent names and nodes that uses that agent
+      # @raise [StandardError] on failure
+      def validate_agents(agents)
+        @uses.validate_agents(agents)
+      end
+
+      # Retrieves an item from the metadata
+      #
+      # @param item [name, version, author, description, tags, on_fail, loglevel, run_as]
+      # @return [Object] the corresponding item from `@metadata`
+      # @raise [StandardError] for invalid metadata items
+      def metadata_item(item)
+        if @metadata.include?(item)
+          @metadata[item]
+        else
+          raise("Unknown playbook metadata %s" % item)
+        end
+      end
+
+      # (see Nodes#[])
+      def discovered_nodes(nodeset)
+        @nodes[nodeset].clone
+      end
+
+      # A list of known node sets
+      #
+      # @return [Array<String>]
+      def nodes
+        @nodes.keys
+      end
+
+      # (see Inputs#[])
+      def input_value(input)
+        @inputs[input]
+      end
+
+      # A list of known input keys
+      #
+      # @return [Array<String>]
+      def inputs
+        @inputs.keys
+      end
+
+      # List of known input names that have dynamic values
+      #
+      # @return [Array<String>]
+      def dynamic_inputs
+        @inputs.dynamic_keys
+      end
+
+      # List of known input names that have static values
+      #
+      # @return [Array<String>]
+      def static_inputs
+        @inputs.static_keys
+      end
+
+      # Looks up a proeprty of the previous task
+      #
+      # @param property [success, msg, message, data, description]
+      # @return [Object]
+      def previous_task(property)
+        if property == "success"
+          return false unless previous_task_result && previous_task_result.ran
+
+          previous_task_result.success
+        elsif ["msg", "message"].include?(property)
+          return "No previous task were found" unless previous_task_result
+          return "Previous task did not run" unless previous_task_result.ran
+
+          previous_task_result.msg
+        elsif property == "data"
+          return [] unless previous_task_result && previous_task_result.ran
+
+          previous_task_result.data || []
+        elsif property == "description"
+          return "No previous task were found" unless previous_task_result
+
+          previous_task_result.task[:description]
+        elsif property == "runtime"
+          return 0 unless previous_task_result && previous_task_result.ran
+
+          previous_task_result.run_time.round(2)
+        else
+          raise("Cannot retrieve %s for the last task outcome" % property)
+        end
+      end
+
+      # All the task results
+      #
+      # @return [Array<TaskResult>]
+      def task_results
+        @tasks.results
+      end
+
+      # Find the last result from the tasks ran
+      #
+      # @return [TaskResult,nil]
+      def previous_task_result
+        task_results.last
+      end
+
+      # Adds the CLI options for an application based on the playbook inputs
+      #
+      # @see Inputs#add_cli_options
+      # @param application [MCollective::Application]
+      # @param set_required [Boolean]
+      def add_cli_options(application, set_required=false)
+        @inputs.add_cli_options(application, set_required)
+      end
+
+      def in_context(context)
+        old_context = @context
+        @context = context
+
+        yield
+      ensure
+        @context = old_context
+      end
+
+      def seconds_to_human(seconds)
+        days = seconds / 86400
+        seconds -= 86400 * days
+
+        hours = seconds / 3600
+        seconds -= 3600 * hours
+
+        minutes = seconds / 60
+        seconds -= 60 * minutes
+
+        if days > 1
+          "%d days %d hours %d minutes %02d seconds" % [days, hours, minutes, seconds]
+        elsif days == 1
+          "%d day %d hours %d minutes %02d seconds" % [days, hours, minutes, seconds]
+        elsif hours > 0
+          "%d hours %d minutes %02d seconds" % [hours, minutes, seconds]
+        elsif minutes > 0
+          "%d minutes %02d seconds" % [minutes, seconds]
+        else
+          "%02d seconds" % seconds
+        end
+      end
+    end
+  end
+end