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
|
#
# Copyright 2018, Noah Kantrowitz
#
# 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 "knife_spec_helper"
require "support/shared/integration/integration_helper"
require "support/shared/context/config"
describe "knife config use", :workstation do
include IntegrationSupport
include KnifeSupport
include_context "default config options"
let(:cmd_args) { [] }
when_the_repository("has a custom env") do
let(:knife_use) do
knife("config", "use", *cmd_args, instance_filter: lambda { |instance|
# Fake the failsafe check because this command doesn't actually process knife.rb.
$__KNIFE_INTEGRATION_FAILSAFE_CHECK << " ole"
allow(File).to receive(:file?).and_call_original
})
end
subject { knife_use.stdout }
around do |ex|
# Store and reset the value of some env vars.
old_chef_home = ENV["CHEF_HOME"]
old_knife_home = ENV["KNIFE_HOME"]
old_home = ENV["HOME"]
old_wd = Dir.pwd
ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
# Clear these out because they are cached permanently.
ChefConfig::PathHelper.class_exec { remove_class_variable(:@@home_dir) }
Chef::Knife::ConfigUse.reset_config_loader!
begin
ex.run
ensure
ENV["CHEF_HOME"] = old_chef_home
ENV["KNIFE_HOME"] = old_knife_home
ENV["HOME"] = old_home
Dir.chdir(old_wd)
ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
ChefConfig::PathHelper.per_tool_home_environment = nil
end
end
before do
# Always run from the temp folder. This can't be in the `around` block above
# because it has to run after the before set in the "with a chef repo" shared context.
directory("repo")
Dir.chdir(path_to("repo"))
ENV[ChefUtils.windows? ? "CD" : "PWD"] = Dir.pwd
ENV["HOME"] = path_to(".")
end
context "with no argument" do
context "with no configuration" do
it { is_expected.to eq "default\n" }
end
context "with --profile" do
let(:cmd_args) { %w{--profile production} }
it { is_expected.to eq "production\n" }
end
context "with an environment variable" do
around do |ex|
old_chef_profile = ENV["CHEF_PROFILE"]
begin
ENV["CHEF_PROFILE"] = "staging"
ex.run
ensure
ENV["CHEF_PROFILE"] = old_chef_profile
end
end
it { is_expected.to eq "staging\n" }
end
context "with a context file" do
before { file(".chef/context", "development\n") }
it { is_expected.to eq "development\n" }
end
context "with a context file under $CHEF_HOME" do
before do
file("chefhome/.chef/context", "other\n")
ENV["CHEF_HOME"] = path_to("chefhome")
end
it { is_expected.to eq "other\n" }
end
context "with a context file under $KNIFE_HOME" do
before do
file("knifehome/.chef/context", "other\n")
ENV["KNIFE_HOME"] = path_to("knifehome")
end
it { is_expected.to eq "other\n" }
end
end
context "with an argument" do
let(:cmd_args) { %w{production} }
before { file(".chef/credentials", <<~EOH) }
[production]
client_name = "testuser"
client_key = "testkey.pem"
chef_server_url = "https://example.com/organizations/testorg"
EOH
it do
is_expected.to eq "Set default profile to production\n"
expect(File.read(path_to(".chef/context"))).to eq "production\n"
end
end
context "with no credentials file" do
let(:cmd_args) { %w{production} }
subject { knife_use.stderr }
it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
end
context "with an empty credentials file" do
let(:cmd_args) { %w{production} }
before { file(".chef/credentials", "") }
subject { knife_use.stderr }
it { is_expected.to eq "FATAL: No profiles found, #{path_to(".chef/credentials")} does not exist or is empty\n" }
end
context "with an wrong argument" do
let(:cmd_args) { %w{staging} }
before { file(".chef/credentials", <<~EOH) }
[production]
client_name = "testuser"
client_key = "testkey.pem"
chef_server_url = "https://example.com/organizations/testorg"
EOH
subject { knife_use }
it { expect { subject }.to raise_error ChefConfig::ConfigurationError, "Profile staging doesn't exist. Please add it to #{path_to(".chef/credentials")} and if it is profile with DNS name check that you are not missing single quotes around it as per docs https://docs.chef.io/workstation/knife_setup/#knife-profiles." }
end
context "with $CHEF_HOME" do
let(:cmd_args) { %w{staging} }
before do
ENV["CHEF_HOME"] = path_to("chefhome"); file("chefhome/tmp", "")
file("chefhome/.chef/credentials", <<~EOH
[staging]
client_name = "testuser"
client_key = "testkey.pem"
chef_server_url = "https://example.com/organizations/testorg"
EOH
)
end
it do
is_expected.to eq "Set default profile to staging\n"
expect(File.read(path_to("chefhome/.chef/context"))).to eq "staging\n"
expect(File.exist?(path_to(".chef/context"))).to be_falsey
end
end
context "with $KNIFE_HOME" do
let(:cmd_args) { %w{development} }
before do
ENV["KNIFE_HOME"] = path_to("knifehome"); file("knifehome/tmp", "")
file("knifehome/.chef/credentials", <<~EOH
[development]
client_name = "testuser"
client_key = "testkey.pem"
chef_server_url = "https://example.com/organizations/testorg"
EOH
)
end
it do
is_expected.to eq "Set default profile to development\n"
expect(File.read(path_to("knifehome/.chef/context"))).to eq "development\n"
expect(File.exist?(path_to(".chef/context"))).to be_falsey
end
end
end
end
|
