File Manager

Path: /opt/chef/embedded/lib/ruby/gems/2.7.0/gems/cheffish-16.0.2/lib/cheffish/

Viewing File: chef_run.rb

require_relative "basic_chef_client"

module Cheffish
  class ChefRun
    #
    # @param chef_config A hash with symbol keys that looks suspiciously similar to `Chef::Config`.
    #        Some possible options:
    #        - stdout: <IO object> - where to stream stdout to
    #        - stderr: <IO object> - where to stream stderr to
    #        - log_level: :debug|:info|:warn|:error|:fatal
    #        - log_location: <path|IO object> - where to stream logs to
    #        - verbose_logging: true|false - true if you want verbose logging in :debug
    #
    def initialize(chef_config = {})
      @chef_config = chef_config || {}
    end

    attr_reader :chef_config

    class StringIOTee < StringIO
      def initialize(*streams)
        super()
        @streams = streams.flatten.select { |s| !s.nil? }
      end

      attr_reader :streams

      def write(*args, &block)
        super
        streams.each { |s| s.write(*args, &block) }
      end
    end

    def client
      @client ||= begin
        chef_config = self.chef_config.dup
        chef_config[:log_level] ||= :debug unless chef_config.key?(:log_level)
        chef_config[:verbose_logging] = false unless chef_config.key?(:verbose_logging)
        chef_config[:stdout] = StringIOTee.new(chef_config[:stdout])
        chef_config[:stderr] = StringIOTee.new(chef_config[:stderr])
        chef_config[:log_location] = StringIOTee.new(chef_config[:log_location])
        @client = ::Cheffish::BasicChefClient.new(nil,
          [ event_sink, Chef::Formatters.new(:doc, chef_config[:stdout], chef_config[:stderr]) ],
          chef_config)
      end
    end

    def event_sink
      @event_sink ||= EventSink.new
    end

    #
    # output
    #
    def stdout
      @client ? client.chef_config[:stdout].string : nil
    end

    def stderr
      @client ? client.chef_config[:stderr].string : nil
    end

    def logs
      @client ? client.chef_config[:log_location].string : nil
    end

    def logged_warnings
      logs.lines.select { |l| l =~ /^\[[^\]]*\] WARN:/ }.join("\n")
    end

    def logged_errors
      logs.lines.select { |l| l =~ /^\[[^\]]*\] ERROR:/ }.join("\n")
    end

    def logged_info
      logs.lines.select { |l| l =~ /^\[[^\]]*\] INFO:/ }.join("\n")
    end

    def resources
      client.run_context.resource_collection
    end

    def compile_recipe(&recipe)
      client.load_block(&recipe)
    end

    def converge
      client.converge
      @converged = true
    rescue RuntimeError => e
      @raised_exception = e
      raise
    end

    def reset
      @client = nil
      @converged = nil
      @stdout = nil
      @stderr = nil
      @logs = nil
      @raised_exception = nil
    end

    def converged?
      !!@converged
    end

    def converge_failed?
      @raised_exception.nil? ? false : true
    end

    def updated?
      client.updated?
    end

    def up_to_date?
      !client.updated?
    end

    def output_for_failure_message
      message = ""
      if stdout && !stdout.empty?
        message << "---                    ---\n"
        message << "--- Chef Client Output ---\n"
        message << "---                    ---\n"
        message << stdout
        message << "\n" unless stdout.end_with?("\n")
      end
      if stderr && !stderr.empty?
        message << "---                          ---\n"
        message << "--- Chef Client Error Output ---\n"
        message << "---                          ---\n"
        message << stderr
        message << "\n" unless stderr.end_with?("\n")
      end
      if logs && !logs.empty?
        message << "---                  ---\n"
        message << "--- Chef Client Logs ---\n"
        message << "---                  ---\n"
        message << logs
      end
      message
    end

    class EventSink
      def initialize
        @events = []
      end

      attr_reader :events

      def method_missing(method, *args)
        @events << [ method, *args ]
      end

      def respond_to_missing?(method_name, include_private = false)
        # Chef::EventDispatch::Dispatcher calls #respond_to? to see (basically) if we'll accept an event;
        # obviously, per above #method_missing, we'll accept whatever we're given. if there's a problem, it
        # will surface higher up the stack.
        true
      end
    end
  end
end