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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Copyright:: Copyright 2008-2016, 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/api_client"
require "tempfile"
# DEPRECATION NOTE
#
# This code will be removed in Chef 13 in favor of the code in Chef::ApiClientV1,
# which will be moved to this namespace. New development should occur in
# Chef::ApiClientV1 until the time before Chef 13.
describe Chef::ApiClient do
before(:each) do
@client = Chef::ApiClient.new
end
it "has a name attribute" do
@client.name("ops_master")
expect(@client.name).to eq("ops_master")
end
it "does not allow spaces in the name" do
expect { @client.name "ops master" }.to raise_error(ArgumentError)
end
it "only allows string values for the name" do
expect { @client.name Hash.new }.to raise_error(ArgumentError)
end
it "has an admin flag attribute" do
@client.admin(true)
expect(@client.admin).to be_truthy
end
it "defaults to non-admin" do
expect(@client.admin).to be_falsey
end
it "allows only boolean values for the admin flag" do
expect { @client.admin(false) }.not_to raise_error
expect { @client.admin(Hash.new) }.to raise_error(ArgumentError)
end
it "has a 'validator' flag attribute" do
@client.validator(true)
expect(@client.validator).to be_truthy
end
it "defaults to non-validator" do
expect(@client.validator).to be_falsey
end
it "allows only boolean values for the 'validator' flag" do
expect { @client.validator(false) }.not_to raise_error
expect { @client.validator(Hash.new) }.to raise_error(ArgumentError)
end
it "has a public key attribute" do
@client.public_key("super public")
expect(@client.public_key).to eq("super public")
end
it "accepts only String values for the public key" do
expect { @client.public_key "" }.not_to raise_error
expect { @client.public_key Hash.new }.to raise_error(ArgumentError)
end
it "has a private key attribute" do
@client.private_key("super private")
expect(@client.private_key).to eq("super private")
end
it "accepts only String values for the private key" do
expect { @client.private_key "" }.not_to raise_error
expect { @client.private_key Hash.new }.to raise_error(ArgumentError)
end
describe "when serializing to JSON" do
before(:each) do
@client.name("black")
@client.public_key("crowes")
@json = @client.to_json
end
it "serializes as a JSON object" do
expect(@json).to match(/^\{.+\}$/)
end
it "includes the name value" do
expect(@json).to include(%q{"name":"black"})
end
it "includes the public key value" do
expect(@json).to include(%{"public_key":"crowes"})
end
it "includes the 'admin' flag" do
expect(@json).to include(%q{"admin":false})
end
it "includes the 'validator' flag" do
expect(@json).to include(%q{"validator":false})
end
it "includes the private key when present" do
@client.private_key("monkeypants")
expect(@client.to_json).to include(%q{"private_key":"monkeypants"})
end
it "does not include the private key if not present" do
expect(@json).not_to include("private_key")
end
end
describe "when deserializing from JSON (string) using ApiClient#from_json" do
let(:client_string) do
"{\"name\":\"black\",\"public_key\":\"crowes\",\"private_key\":\"monkeypants\",\"admin\":true,\"validator\":true}"
end
let(:client) do
Chef::ApiClient.from_json(client_string)
end
it "does not require a 'json_class' string" do
expect(Chef::JSONCompat.parse(client_string)["json_class"]).to eq(nil)
end
it "should deserialize to a Chef::ApiClient object" do
expect(client).to be_a_kind_of(Chef::ApiClient)
end
it "preserves the name" do
expect(client.name).to eq("black")
end
it "preserves the public key" do
expect(client.public_key).to eq("crowes")
end
it "preserves the admin status" do
expect(client.admin).to be_truthy
end
it "preserves the 'validator' status" do
expect(client.validator).to be_truthy
end
it "includes the private key if present" do
expect(client.private_key).to eq("monkeypants")
end
end
describe "when deserializing from JSON (hash) using JSONCompat#from_json" do
let(:client_hash) do
{
"name" => "black",
"public_key" => "crowes",
"private_key" => "monkeypants",
"admin" => true,
"validator" => true,
"json_class" => "Chef::ApiClient",
}
end
let(:client) do
Chef::ApiClient.from_hash(Chef::JSONCompat.parse(Chef::JSONCompat.to_json(client_hash)))
end
it "should deserialize to a Chef::ApiClient object" do
expect(client).to be_a_kind_of(Chef::ApiClient)
end
it "preserves the name" do
expect(client.name).to eq("black")
end
it "preserves the public key" do
expect(client.public_key).to eq("crowes")
end
it "preserves the admin status" do
expect(client.admin).to be_truthy
end
it "preserves the 'validator' status" do
expect(client.validator).to be_truthy
end
it "includes the private key if present" do
expect(client.private_key).to eq("monkeypants")
end
end
describe "when loading from JSON" do
before do
end
before(:each) do
client = {
"name" => "black",
"clientname" => "black",
"public_key" => "crowes",
"private_key" => "monkeypants",
"admin" => true,
"validator" => true,
"json_class" => "Chef::ApiClient",
}
@http_client = double("Chef::ServerAPI mock")
allow(Chef::ServerAPI).to receive(:new).and_return(@http_client)
expect(@http_client).to receive(:get).with("clients/black").and_return(client)
@client = Chef::ApiClient.load(client["name"])
end
it "should deserialize to a Chef::ApiClient object" do
expect(@client).to be_a_kind_of(Chef::ApiClient)
end
it "preserves the name" do
expect(@client.name).to eq("black")
end
it "preserves the public key" do
expect(@client.public_key).to eq("crowes")
end
it "preserves the admin status" do
expect(@client.admin).to be_a_kind_of(TrueClass)
end
it "preserves the 'validator' status" do
expect(@client.validator).to be_a_kind_of(TrueClass)
end
it "includes the private key if present" do
expect(@client.private_key).to eq("monkeypants")
end
end
describe "with correctly configured API credentials" do
before do
Chef::Config[:node_name] = "silent-bob"
Chef::Config[:client_key] = File.expand_path("ssl/private_key.pem", CHEF_SPEC_DATA)
end
after do
Chef::Config[:node_name] = nil
Chef::Config[:client_key] = nil
end
let :private_key_data do
File.open(Chef::Config[:client_key], "r") { |f| f.read.chomp }
end
end
describe "when requesting a new key" do
before do
@http_client = double("Chef::ServerAPI mock")
allow(Chef::ServerAPI).to receive(:new).and_return(@http_client)
end
context "and the client does not exist on the server" do
before do
@a_404_response = Net::HTTPNotFound.new("404 not found and such", nil, nil)
@a_404_exception = Net::HTTPClientException.new("404 not found exception", @a_404_response)
expect(@http_client).to receive(:get).with("clients/lost-my-key").and_raise(@a_404_exception)
end
it "raises a 404 error" do
expect { Chef::ApiClient.reregister("lost-my-key") }.to raise_error(Net::HTTPClientException)
end
end
context "and the client exists" do
before do
@api_client_without_key = Chef::ApiClient.new
@api_client_without_key.name("lost-my-key")
expect(@http_client).to receive(:get).with("clients/lost-my-key").and_return(@api_client_without_key)
end
context "and the client exists on a Chef 11-like server" do
before do
@api_client_with_key = Chef::ApiClient.new
@api_client_with_key.name("lost-my-key")
@api_client_with_key.private_key("the new private key")
expect(@http_client).to receive(:put)
.with("clients/lost-my-key", name: "lost-my-key", admin: false, validator: false, private_key: true)
.and_return(@api_client_with_key)
end
it "returns an ApiClient with a private key" do
response = Chef::ApiClient.reregister("lost-my-key")
# no sane == method for ApiClient :'(
expect(response).to eq(@api_client_without_key)
expect(response.private_key).to eq("the new private key")
expect(response.name).to eq("lost-my-key")
expect(response.admin).to be_falsey
end
end
context "and the client exists on a Chef 10-like server" do
before do
@api_client_with_key = { "name" => "lost-my-key", "private_key" => "the new private key" }
expect(@http_client).to receive(:put)
.with("clients/lost-my-key", name: "lost-my-key", admin: false, validator: false, private_key: true)
.and_return(@api_client_with_key)
end
it "returns an ApiClient with a private key" do
response = Chef::ApiClient.reregister("lost-my-key")
# no sane == method for ApiClient :'(
expect(response).to eq(@api_client_without_key)
expect(response.private_key).to eq("the new private key")
expect(response.name).to eq("lost-my-key")
expect(response.admin).to be_falsey
expect(response.validator).to be_falsey
end
end
end
end
end
|