summaryrefslogtreecommitdiff
path: root/spec/unit/event_dispatch/dispatcher_spec.rb
blob: 8499ba13b9396e5ac346e5e96da5bc220640c428 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
#
# Author:: Daniel DeLeo (<dan@chef.io>)
#
# Copyright:: Copyright (c) Chef Software Inc.
# License:: Apache License, Version 2.0
#
# 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 "spec_helper"
require "chef/event_dispatch/dispatcher"

describe Chef::EventDispatch::Dispatcher do

  subject(:dispatcher) { Chef::EventDispatch::Dispatcher.new }

  let(:event_sink) { instance_double("Chef::EventDispatch::Base") }

  it "has no subscribers by default" do
    expect(dispatcher.subscribers).to be_empty
  end

  context "when an event sink is registered" do

    before do
      dispatcher.register(event_sink)
    end

    it "it has the event sink as a subscriber" do
      expect(dispatcher.subscribers.size).to eq(1)
      expect(dispatcher.subscribers.first).to eq(event_sink)
    end

    it "forwards events to the subscribed event sink" do
      # the events all have different arity and such so we just hit a few different events:
      run_status = Chef::RunStatus.new({}, {})
      expect(event_sink).to receive(:run_start).with("12.4.0", run_status)
      dispatcher.run_start("12.4.0", run_status)

      cookbook_version = double("cookbook_version")
      expect(event_sink).to receive(:synchronized_cookbook).with("apache2", cookbook_version)
      dispatcher.synchronized_cookbook("apache2", cookbook_version)

      exception = StandardError.new("foo")
      expect(event_sink).to receive(:recipe_file_load_failed).with("/path/to/file.rb", exception, "myrecipe")
      dispatcher.recipe_file_load_failed("/path/to/file.rb", exception, "myrecipe")
    end

    context "when an event sink has fewer arguments for an event" do
      # Can't use a double because they don't report arity correctly.
      let(:event_sink) do
        Class.new(Chef::EventDispatch::Base) do
          attr_reader :synchronized_cookbook_args
          def synchronized_cookbook(cookbook_name)
            @synchronized_cookbook_args = [cookbook_name]
          end
        end.new
      end

      it "trims the arugment list" do
        cookbook_version = double("cookbook_version")
        dispatcher.synchronized_cookbook("apache2", cookbook_version)
        expect(event_sink.synchronized_cookbook_args).to eq ["apache2"]
      end
    end
  end

  context "when two event sinks have different arguments for an event" do
    let(:event_sink_1) do
      Class.new(Chef::EventDispatch::Base) do
        attr_reader :synchronized_cookbook_args
        def synchronized_cookbook(cookbook_name)
          @synchronized_cookbook_args = [cookbook_name]
        end
      end.new
    end
    let(:event_sink_2) do
      Class.new(Chef::EventDispatch::Base) do
        attr_reader :synchronized_cookbook_args
        def synchronized_cookbook(cookbook_name, cookbook)
          @synchronized_cookbook_args = [cookbook_name, cookbook]
        end
      end.new
    end

    context "and the one with fewer arguments comes first" do
      before do
        dispatcher.register(event_sink_1)
        dispatcher.register(event_sink_2)
      end
      it "trims the arugment list" do
        cookbook_version = double("cookbook_version")
        dispatcher.synchronized_cookbook("apache2", cookbook_version)
        expect(event_sink_1.synchronized_cookbook_args).to eq ["apache2"]
        expect(event_sink_2.synchronized_cookbook_args).to eq ["apache2", cookbook_version]
      end
    end

    context "and the one with fewer arguments comes last" do
      before do
        dispatcher.register(event_sink_2)
        dispatcher.register(event_sink_1)
      end
      it "trims the arugment list" do
        cookbook_version = double("cookbook_version")
        dispatcher.synchronized_cookbook("apache2", cookbook_version)
        expect(event_sink_1.synchronized_cookbook_args).to eq ["apache2"]
        expect(event_sink_2.synchronized_cookbook_args).to eq ["apache2", cookbook_version]
      end
    end
  end

  context "events that queue events" do
    class Accumulator
      def self.sequence
        @sequence ||= []
      end
    end

    let(:event_sink_1) do
      Class.new(Chef::EventDispatch::Base) do
        def synchronized_cookbook(dispatcher, arg)
          dispatcher.enqueue(:event_two, arg)
          Accumulator.sequence << [ :sink_1_event_1, arg ]
        end

        def event_two(arg)
          Accumulator.sequence << [ :sink_1_event_2, arg ]
        end
      end.new
    end
    let(:event_sink_2) do
      Class.new(Chef::EventDispatch::Base) do
        def synchronized_cookbook(dispatcher, arg)
          Accumulator.sequence << [ :sink_2_event_1, arg ]
        end

        def event_two(arg)
          Accumulator.sequence << [ :sink_2_event_2, arg ]
        end
      end.new
    end

    before do
      dispatcher.register(event_sink_1)
      dispatcher.register(event_sink_2)
    end

    it "runs the events in the correct order without interleaving the enqueued event" do
      dispatcher.synchronized_cookbook(dispatcher, "two")
      expect(Accumulator.sequence).to eql([
        [:sink_1_event_1, "two"], # the call to enqueue the event happens here
        [:sink_2_event_1, "two"], # event 1 fully finishes
        [:sink_1_event_2, "two"],
        [:sink_2_event_2, "two"], # then event 2 runs and finishes
      ])
    end
  end
end