summaryrefslogtreecommitdiff
path: root/lib/chef/event_loggers/base.rb
blob: f5bd0f3864add539f7f8f429301cfb6c60b848af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#
# Author:: Jay Mundrawala (<jdm@getchef.com>)
#
# Copyright:: Copyright 2014-2016, Chef Software, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "chef/event_dispatch/base"

class Chef
  module EventLoggers
    class UnknownEventLogger < StandardError; end
    class UnavailableEventLogger < StandardError; end

    def self.event_loggers_by_name
      @event_loggers_by_name ||= {}
    end

    def self.register(name, logger)
      event_loggers_by_name[name.to_s] = logger
    end

    def self.by_name(name)
      event_loggers_by_name[name]
    end

    def self.available_event_loggers
      event_loggers_by_name.select do |key, val|
        val.available?
      end.keys
    end

    def self.new(name)
      event_logger_class = by_name(name.to_s) or
        raise UnknownEventLogger, "No event logger found for #{name} (available: #{available_event_loggers.join(', ')})"
      raise UnavailableEventLogger unless available_event_loggers.include? name.to_s
      event_logger_class.new
    end

    class Base < EventDispatch::Base
      def self.short_name(name)
        Chef::EventLoggers.register(name, self)
      end

      # Returns true if this implementation of EventLoggers can be used
      def self.available?
        false
      end
    end
  end
end