File: session_spec.rb

package info (click to toggle)
puppet-agent 7.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 19,092 kB
  • sloc: ruby: 245,074; sh: 456; makefile: 38; xml: 33
file content (309 lines) | stat: -rw-r--r-- 11,027 bytes parent folder | download | duplicates (2)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
require 'spec_helper'
require 'puppet/http'

describe Puppet::HTTP::Session do
  let(:ssl_context) { Puppet::SSL::SSLContext.new }
  let(:client) { Puppet::HTTP::Client.new(ssl_context: ssl_context) }
  let(:uri) { URI.parse('https://www.example.com') }
  let(:good_service) {
    double('good', url: uri, connect: nil)
  }
  let(:bad_service) {
    create_bad_service
  }

  def create_bad_service(failure_message = 'whoops')
    service = double('bad', url: uri)
    allow(service).to receive(:connect).and_raise(Puppet::HTTP::ConnectionError, failure_message)
    service
  end

  class DummyResolver < Puppet::HTTP::Resolver
    attr_reader :count

    def initialize(service)
      @service = service
      @count = 0
    end

    def resolve(session, name, ssl_context: nil, canceled_handler: nil)
      @count += 1
      return @service if check_connection?(session, @service, ssl_context: ssl_context)
    end
  end

  context 'when routing' do
    it 'returns the first resolved service' do
      resolvers = [DummyResolver.new(bad_service), DummyResolver.new(good_service)]
      session = described_class.new(client, resolvers)
      resolved = session.route_to(:ca)

      expect(resolved).to eq(good_service)
    end

    it 'only resolves once per session' do
      resolver = DummyResolver.new(good_service)
      session = described_class.new(client, [resolver])
      session.route_to(:ca)
      session.route_to(:ca)

      expect(resolver.count).to eq(1)
    end

    it 'raises if there are no more routes' do
      resolvers = [DummyResolver.new(bad_service)]
      session = described_class.new(client, resolvers)

      expect {
        session.route_to(:ca)
      }.to raise_error(Puppet::HTTP::RouteError, 'No more routes to ca')
    end

    it 'logs all routing failures as errors when there are no more routes' do
      resolvers = [DummyResolver.new(create_bad_service('whoops1')), DummyResolver.new(create_bad_service('whoops2'))]
      session = described_class.new(client, resolvers)

      expect {
        session.route_to(:ca)
      }.to raise_error(Puppet::HTTP::RouteError, 'No more routes to ca')

      expect(@logs).to include(an_object_having_attributes(level: :err, message: "Connection to #{uri} failed, trying next route: whoops1"),
                               an_object_having_attributes(level: :err, message: "Connection to #{uri} failed, trying next route: whoops2"))
    end

    it 'accepts an ssl context to use when connecting' do
      alt_context = Puppet::SSL::SSLContext.new
      expect(good_service).to receive(:connect).with(ssl_context: alt_context)

      resolvers = [DummyResolver.new(good_service)]
      session = described_class.new(client, resolvers)
      session.route_to(:ca, ssl_context: alt_context)
    end

    it 'raises for unknown service names' do
      expect {
        session = described_class.new(client, [])
        session.route_to(:westbound)
      }.to raise_error(ArgumentError, "Unknown service westbound")
    end

    it 'routes to the service when given a puppet URL with an explicit host' do
      allow_any_instance_of(Net::HTTP).to receive(:start)

      session = described_class.new(client, [])
      url = URI("puppet://example.com:8140/:modules/:module/path/to/file")
      service = session.route_to(:fileserver, url: url)

      expect(service.url.to_s).to eq("https://example.com:8140/puppet/v3")
    end

    it 'raises a connection error if we cannot connect' do
      allow_any_instance_of(Net::HTTP).to receive(:start).and_raise(Net::OpenTimeout)

      session = described_class.new(client, [])
      url = URI('puppet://example.com:8140/:modules/:module/path/to/file')

      expect {
        session.route_to(:fileserver, url: url)
      }.to raise_error(Puppet::HTTP::ConnectionError,
                       %r{Request to https://example.com:8140/puppet/v3 timed out connect operation after .* seconds})
    end

    it 'resolves the route when given a generic puppet:/// URL' do
      resolvers = [DummyResolver.new(good_service)]
      session = described_class.new(client, resolvers)
      url = URI('puppet:///:modules/:module/path/to/file')
      service = session.route_to(:fileserver, url: url)

      expect(service.url).to eq(good_service.url)
    end
  end

  context 'when resolving using multiple resolvers' do
    let(:session) { client.create_session }

    it "prefers SRV records" do
      Puppet[:use_srv_records] = true
      Puppet[:server_list] = 'foo.example.com,bar.example.com,baz.example.com'
      Puppet[:ca_server] = 'caserver.example.com'

      allow_any_instance_of(Puppet::HTTP::DNS).to receive(:each_srv_record).and_yield('mars.example.srv', 8140)
      service = session.route_to(:ca)

      expect(service.url).to eq(URI("https://mars.example.srv:8140/puppet-ca/v1"))
    end

    it "next prefers :ca_server when explicitly set" do
      Puppet[:use_srv_records] = true
      Puppet[:server_list] = 'foo.example.com,bar.example.com,baz.example.com'
      Puppet[:ca_server] = 'caserver.example.com'

      service = session.route_to(:ca)

      expect(service.url).to eq(URI("https://caserver.example.com:8140/puppet-ca/v1"))
    end

    it "next prefers the first successful connection from server_list" do
      Puppet[:use_srv_records] = true
      Puppet[:server_list] = 'foo.example.com,bar.example.com,baz.example.com'

      allow_any_instance_of(Puppet::HTTP::DNS).to receive(:each_srv_record)
      stub_request(:get, "https://foo.example.com:8140/status/v1/simple/server").to_return(status: 500)
      stub_request(:get, "https://bar.example.com:8140/status/v1/simple/server").to_return(status: 200)

      service = session.route_to(:ca)

      expect(service.url).to eq(URI("https://bar.example.com:8140/puppet-ca/v1"))
    end

    it "does not fallback from server_list to the settings resolver when server_list is exhausted" do
      Puppet[:server_list] = 'foo.example.com'

      expect_any_instance_of(Puppet::HTTP::Resolver::Settings).to receive(:resolve).never
      stub_request(:get, "https://foo.example.com:8140/status/v1/simple/server").to_return(status: 500)

      expect {
        session.route_to(:ca)
      }.to raise_error(Puppet::HTTP::RouteError, "No more routes to ca")
    end

    it "raises when there are no more routes" do
      allow_any_instance_of(Net::HTTP).to receive(:start).and_raise(Errno::EHOSTUNREACH)
      session = client.create_session

      expect {
        session.route_to(:ca)
      }.to raise_error(Puppet::HTTP::RouteError, 'No more routes to ca')
    end

    Puppet::HTTP::Service::SERVICE_NAMES.each do |name|
      it "resolves #{name} using server_list" do
        Puppet[:server_list] = 'apple.example.com'
        req = stub_request(:get, "https://apple.example.com:8140/status/v1/simple/server").to_return(status: 200)

        session.route_to(name)

        expect(req).to have_been_requested
      end
    end

    it 'does not use server_list to resolve the ca service when ca_server is explicitly set' do
      Puppet[:ca_server] = 'banana.example.com'

      expect(session.route_to(:ca).url.to_s).to eq("https://banana.example.com:8140/puppet-ca/v1")
    end

    it 'does not use server_list to resolve the report service when the report_server is explicitly set' do
      Puppet[:report_server] = 'cherry.example.com'

      expect(session.route_to(:report).url.to_s).to eq("https://cherry.example.com:8140/puppet/v3")
    end

    it 'resolves once for all services in a session' do
      Puppet[:server_list] = 'apple.example.com'
      req = stub_request(:get, "https://apple.example.com:8140/status/v1/simple/server").to_return(status: 200)

      Puppet::HTTP::Service::SERVICE_NAMES.each do |name|
        session.route_to(name)
      end

      expect(req).to have_been_requested
    end

    it 'resolves server_list for each new session' do
      Puppet[:server_list] = 'apple.example.com'
      req = stub_request(:get, "https://apple.example.com:8140/status/v1/simple/server").to_return(status: 200)

      client.create_session.route_to(:puppet)
      client.create_session.route_to(:puppet)

      expect(req).to have_been_requested.twice
    end
  end

  context 'when retrieving capabilities' do
    let(:response) { Puppet::HTTP::Response.new(uri, 200, 'OK') }

    let(:session) do
      resolver = DummyResolver.new(good_service)
      described_class.new(client, [resolver])
    end

    it 'raises for unknown service names' do
      expect {
        session = described_class.new(client, [])
        session.supports?(:westbound, 'a capability')
      }.to raise_error(ArgumentError, "Unknown service westbound")
    end

    context 'locales' do
      it 'does not support locales if the cached service has not been resolved' do
        session = described_class.new(client, [])

        expect(session).to_not be_supports(:puppet, 'locales')
      end

      it "supports locales if the cached service's version is 5.3.4 or greater" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return('5.3.4')

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to be_supports(:puppet, 'locales')
      end

      it "does not support locales if the cached service's version is 5.3.3" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return('5.3.3')

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to_not be_supports(:puppet, 'locales')
      end

      it "does not support locales if the cached service's version is missing" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return(nil)

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to_not be_supports(:puppet, 'locales')
      end
    end

    context 'json' do
      it 'does not support json if the cached service has not been resolved' do
        session = described_class.new(client, [])

        expect(session).to_not be_supports(:puppet, 'json')
      end

      it "supports json if the cached service's version is 5 or greater" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return('5.5.12')

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to be_supports(:puppet, 'json')
      end

      it "does not support json if the cached service's version is less than 5.0" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return('4.10.1')

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to_not be_supports(:puppet, 'json')
      end

      it "supports json if the cached service's version is missing" do
        allow(response).to receive(:[]).with('X-Puppet-Version').and_return(nil)

        session.route_to(:puppet)
        session.process_response(response)

        expect(session).to be_supports(:puppet, 'json')
      end
    end
  end
end