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
|
#
# Author:: Dominik Richter (<dominik.richter@gmail.com>)
require "helper"
$:.concat Dir["test/fixtures/plugins/*/lib"] # HACK? I honestly can't tell
describe Train do
before do
Train::Plugins.registry.clear
end
let(:default_audit_log_options) {
{
enable_audit_log: {
default: false,
},
audit_log_location: {
required: true,
default: nil,
},
audit_log_app_name: {
default: "train",
},
audit_log_size: {
default: nil,
},
audit_log_frequency: {
default: 0,
},
}
}
describe "#create" do
it "raises an error if the plugin isnt found" do
_ { Train.create("missing") }.must_raise Train::UserError
_ { Train.create("missing") }.must_raise Train::PluginLoadError
end
it "loads a core plugin if it isnt in the registry yet via symbol" do
Kernel.stub :require, true do
ex = Class.new(Train.plugin 1) { name "existing" }
train = Train.create(:existing)
_(train.class).must_equal ex
end
end
it "loads a core plugin if it isnt in the registry yet via string" do
Kernel.stub :require, true do
ex = Class.new(Train.plugin 1) { name "existing" }
train = Train.create("existing")
_(train.class).must_equal ex
end
end
it "loads a gem plugin if it isnt in the registry yet via string" do
# The 'train-test-fixture' gem is located in test/fixtures/plugins/train-test-fixture and is
# lib/train/trainsports, and Train will need to pre-pend 'train-' to the
# transport name to get the gem name.
transport = Train.create("test-fixture")
# Normally one would call transport.class.name, but that's been overridden to be a write-only DSL method
# So use to_s
_(transport.class.to_s).must_equal "TrainPlugins::TestFixture::Transport"
end
end
describe "#options" do
it "raises exception if a given transport plugin isnt found" do
_ { Train.options("missing") }.must_raise Train::UserError
_ { Train.options("missing") }.must_raise Train::PluginLoadError
end
it "provides list of default options of a transport plugin" do
Class.new(Train.plugin 1) { name "none" }
_(Train.options("none")).must_equal(default_audit_log_options)
end
it "provides all options of a transport plugin" do
Class.new(Train.plugin 1) do
name "one"
option :one, required: true, default: 123
end
output = {
one: {
required: true,
default: 123,
},
}.merge(default_audit_log_options)
_(Train.options("one")).must_equal(output)
end
end
describe "#target_config - URI parsing" do
it "configures resolves target" do
org = {
target: "ssh://user:pass@host.com:123/path",
}
res = Train.target_config(org)
_(res[:backend]).must_equal "ssh"
_(res[:host]).must_equal "host.com"
_(res[:user]).must_equal "user"
_(res[:password]).must_equal "pass"
_(res[:port]).must_equal 123
_(res[:target]).must_equal org[:target]
_(res[:path]).must_equal "/path"
_(org.keys).must_equal [:target]
end
it "resolves a target while keeping existing fields" do
org = {
target: "ssh://user:pass@host.com:123/path",
backend: rand,
host: rand,
user: rand,
password: rand,
port: rand,
path: rand,
}
res = Train.target_config(org)
_(res).must_equal org
end
it "resolves a winrm target" do
org = {
target: "winrm://Administrator@192.168.10.140",
backend: "winrm",
host: "192.168.10.140",
user: "Administrator",
password: nil,
port: nil,
path: nil,
}
res = Train.target_config(org)
_(res).must_equal org
end
it "keeps the configuration when incorrect target is supplied" do
org = {
target: "wrong",
}
res = Train.target_config(org)
_(res[:backend]).must_be_nil
_(res[:host]).must_be_nil
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_be_nil
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "always transforms config fields into ruby symbols" do
org = {
"target" => "ssh://user:pass@host.com:123/path",
"backend" => rand,
"host" => rand,
"user" => rand,
"password" => rand,
"port" => rand,
"path" => rand,
}
nu = org.each_with_object({}) do |(x, y), acc|
acc[x.to_sym] = y; acc
end
res = Train.target_config(org)
_(res).must_equal nu
end
it "supports IPv4 URIs" do
org = { target: "mock://1.2.3.4:123" }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_equal "1.2.3.4"
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_equal 123
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "supports IPv6 URIs (with brackets)" do
org = { target: "mock://[abc::def]:123" }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_equal "abc::def"
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_equal 123
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "supports IPv6 URIs (without brackets)" do
org = { target: "mock://FEDC:BA98:7654:3210:FEDC:BA98:7654:3210:123" }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_equal "FEDC:BA98:7654:3210:FEDC:BA98:7654:3210"
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_equal 123
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "supports empty URIs with schema://" do
org = { target: "mock://" }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_be_nil
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_be_nil
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "supports empty URIs with schema:" do
org = { target: "mock:" }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_be_nil
_(res[:user]).must_be_nil
_(res[:password]).must_be_nil
_(res[:port]).must_be_nil
_(res[:path]).must_be_nil
_(res[:target]).must_equal org[:target]
end
it "supports www-form encoded passwords when the option is set" do
raw_password = '+!@#$%^&*()_-\';:"\\|/?.>,<][}{=`~'
encoded_password = Addressable::URI.normalize_component(raw_password, Addressable::URI::CharacterClasses::UNRESERVED)
org = { target: "mock://username:#{encoded_password}@1.2.3.4:100",
www_form_encoded_password: true }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_equal "1.2.3.4"
_(res[:user]).must_equal "username"
_(res[:password]).must_equal raw_password
_(res[:port]).must_equal 100
_(res[:target]).must_equal org[:target]
end
it "ignores www-form-encoded password value when there is no password" do
org = { target: "mock://username@1.2.3.4:100",
www_form_encoded_password: true }
res = Train.target_config(org)
_(res[:backend]).must_equal "mock"
_(res[:host]).must_equal "1.2.3.4"
_(res[:user]).must_equal "username"
_(res[:password]).must_be_nil
_(res[:port]).must_equal 100
_(res[:target]).must_equal org[:target]
end
it "it raises UserError on invalid URIs (invalid scheme)" do
org = { target: "123://invalid_scheme.example.com/" }
_ { Train.target_config(org) }.must_raise Train::UserError
end
it "unpacks the query values as options to inspec" do
org = {
target: "ssh://user:pass@host.com:123/path?bastion_host=stronghold.example.org&bastion_user=bulwark",
}
res = Train.target_config(org)
_(res[:backend]).must_equal "ssh"
_(res[:host]).must_equal "host.com"
_(res[:user]).must_equal "user"
_(res[:password]).must_equal "pass"
_(res[:port]).must_equal 123
_(res[:target]).must_equal org[:target]
_(res[:path]).must_equal "/path"
_(res[:bastion_host]).must_equal "stronghold.example.org"
_(res[:bastion_user]).must_equal "bulwark"
_(org.keys).must_equal [:target]
end
end
describe "#validate_backend" do
it "just returns the backend if it is provided" do
x = rand
_(Train.validate_backend({ backend: x })).must_equal x
end
it "returns the local backend if nothing was provided" do
_(Train.validate_backend({})).must_equal "local"
end
it "returns the default backend if nothing was provided" do
x = rand
_(Train.validate_backend({}, x)).must_equal x
end
it "fails if no backend was given but a target is provided" do
_ { Train.validate_backend({ target: rand }) }.must_raise Train::UserError
end
it "fails if no backend was given but a host is provided" do
_ { Train.validate_backend({ host: rand }) }.must_raise Train::UserError
end
end
end
|
