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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
# and others. All rights reserved.
#
# 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.
import unittest
import uuid
import os
from snaps import file_utils
from snaps.openstack.create_keypairs import (
KeypairSettings, OpenStackKeypair, KeypairSettingsError)
from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase
from snaps.openstack.utils import nova_utils
__author__ = 'spisarski'
class KeypairSettingsUnitTests(unittest.TestCase):
"""
Tests the construction of the KeypairSettings class
"""
def test_no_params(self):
with self.assertRaises(KeypairSettingsError):
KeypairSettings()
def test_empty_config(self):
with self.assertRaises(KeypairSettingsError):
KeypairSettings(**dict())
def test_small_key_size(self):
with self.assertRaises(KeypairSettingsError):
KeypairSettings(name='foo', key_size=511)
def test_name_only(self):
settings = KeypairSettings(name='foo')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertIsNone(settings.public_filepath)
self.assertIsNone(settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_config_with_name_only(self):
settings = KeypairSettings(**{'name': 'foo'})
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertIsNone(settings.public_filepath)
self.assertIsNone(settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_name_pub_only(self):
settings = KeypairSettings(name='foo', public_filepath='/foo/bar.pub')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertIsNone(settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_config_with_name_pub_only(self):
settings = KeypairSettings(
**{'name': 'foo', 'public_filepath': '/foo/bar.pub'})
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertIsNone(settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_name_priv_only(self):
settings = KeypairSettings(name='foo', private_filepath='/foo/bar')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertIsNone(settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_config_with_name_priv_only(self):
settings = KeypairSettings(
**{'name': 'foo', 'private_filepath': '/foo/bar'})
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertIsNone(settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertIsNone(settings.delete_on_clean)
def test_all_delete_bool(self):
settings = KeypairSettings(
name='foo', public_filepath='/foo/bar.pub',
private_filepath='/foo/bar', delete_on_clean=True,
key_size=999)
self.assertEqual('foo', settings.name)
self.assertEqual(999, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertTrue(settings.delete_on_clean)
def test_all_delete_str_true_cap(self):
settings = KeypairSettings(
name='foo', public_filepath='/foo/bar.pub',
private_filepath='/foo/bar', delete_on_clean='True')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertTrue(settings.delete_on_clean)
def test_all_delete_str_true_lc(self):
settings = KeypairSettings(
name='foo', public_filepath='/foo/bar.pub',
private_filepath='/foo/bar', delete_on_clean='true')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertTrue(settings.delete_on_clean)
def test_all_delete_str_false_cap(self):
settings = KeypairSettings(
name='foo', public_filepath='/foo/bar.pub',
private_filepath='/foo/bar', delete_on_clean='False')
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
def test_all_delete_str_false_lc(self):
settings = KeypairSettings(
name='foo', public_filepath='/foo/bar.pub',
private_filepath='/foo/bar', delete_on_clean='false',
key_size='999')
self.assertEqual('foo', settings.name)
self.assertEqual(999, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
def test_config_all_delete_false_bool(self):
settings = KeypairSettings(
**{'name': 'foo', 'public_filepath': '/foo/bar.pub',
'private_filepath': '/foo/bar', 'delete_on_clean': False,
'key_size': 999})
self.assertEqual('foo', settings.name)
self.assertEqual(999, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
def test_config_all_delete_false_str_cap(self):
settings = KeypairSettings(
**{'name': 'foo', 'public_filepath': '/foo/bar.pub',
'private_filepath': '/foo/bar', 'delete_on_clean': 'False'})
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
def test_config_all_delete_false_str_lc(self):
settings = KeypairSettings(
**{'name': 'foo', 'public_filepath': '/foo/bar.pub',
'private_filepath': '/foo/bar', 'delete_on_clean': 'false'})
self.assertEqual('foo', settings.name)
self.assertEqual(1024, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
def test_config_all_delete_false_str_foo(self):
settings = KeypairSettings(
**{'name': 'foo', 'public_filepath': '/foo/bar.pub',
'private_filepath': '/foo/bar', 'delete_on_clean': 'foo',
'key_size': '999'})
self.assertEqual('foo', settings.name)
self.assertEqual(999, settings.key_size)
self.assertEqual('/foo/bar.pub', settings.public_filepath)
self.assertEqual('/foo/bar', settings.private_filepath)
self.assertFalse(settings.delete_on_clean)
class CreateKeypairsTests(OSIntegrationTestCase):
"""
Tests for the OpenStackKeypair class
"""
def setUp(self):
super(self.__class__, self).__start__()
guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
self.priv_file_path = 'tmp/' + guid
self.pub_file_path = self.priv_file_path + '.pub'
self.nova = nova_utils.nova_client(self.os_creds)
self.keypair_name = guid
self.keypair_creator = None
def tearDown(self):
"""
Cleanup of created keypair
"""
if self.keypair_creator:
self.keypair_creator.clean()
try:
os.remove(self.pub_file_path)
except:
pass
try:
os.remove(self.priv_file_path)
except:
pass
super(self.__class__, self).__clean__()
def test_create_keypair_only(self):
"""
Tests the creation of a generated keypair without saving to file
:return:
"""
self.keypair_creator = OpenStackKeypair(self.os_creds, KeypairSettings(
name=self.keypair_name))
self.keypair_creator.create()
keypair = nova_utils.keypair_exists(self.nova,
self.keypair_creator.get_keypair())
self.assertEqual(self.keypair_creator.get_keypair(), keypair)
def test_create_keypair_large_key(self):
"""
Tests the creation of a generated keypair without saving to file
:return:
"""
self.keypair_creator = OpenStackKeypair(self.os_creds, KeypairSettings(
name=self.keypair_name, key_size=10000))
self.keypair_creator.create()
keypair = nova_utils.keypair_exists(self.nova,
self.keypair_creator.get_keypair())
self.assertEqual(self.keypair_creator.get_keypair(), keypair)
def test_create_delete_keypair(self):
"""
Tests the creation then deletion of an OpenStack keypair to ensure
clean() does not raise an Exception.
"""
# Create Image
self.keypair_creator = OpenStackKeypair(self.os_creds, KeypairSettings(
name=self.keypair_name))
created_keypair = self.keypair_creator.create()
self.assertIsNotNone(created_keypair)
# Delete Image manually
nova_utils.delete_keypair(self.nova, created_keypair)
self.assertIsNone(
nova_utils.get_keypair_by_name(self.nova, self.keypair_name))
# Must not throw an exception when attempting to cleanup non-existent
# image
self.keypair_creator.clean()
self.assertIsNone(self.keypair_creator.get_keypair())
def test_create_keypair_save_pub_only(self):
"""
Tests the creation of a generated keypair and saves the public key only
:return:
"""
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(name=self.keypair_name,
public_filepath=self.pub_file_path))
self.keypair_creator.create()
keypair = nova_utils.keypair_exists(self.nova,
self.keypair_creator.get_keypair())
self.assertEqual(self.keypair_creator.get_keypair(), keypair)
pub_file = None
try:
pub_file = open(os.path.expanduser(self.pub_file_path))
file_key = pub_file.read()
self.assertEqual(self.keypair_creator.get_keypair().public_key,
file_key)
finally:
if pub_file:
pub_file.close()
def test_create_keypair_save_both(self):
"""
Tests the creation of a generated keypair and saves both private and
public key files[
:return:
"""
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path))
self.keypair_creator.create()
keypair = nova_utils.keypair_exists(self.nova,
self.keypair_creator.get_keypair())
self.assertEqual(self.keypair_creator.get_keypair(), keypair)
pub_file = None
try:
pub_file = open(os.path.expanduser(self.pub_file_path))
file_key = pub_file.read()
self.assertEqual(self.keypair_creator.get_keypair().public_key,
file_key)
finally:
if pub_file:
pub_file.close()
self.assertEqual(self.keypair_creator.get_keypair().public_key,
file_key)
self.assertTrue(os.path.isfile(self.priv_file_path))
def test_create_keypair_from_file(self):
"""
Tests the creation of an existing public keypair from a file
:return:
"""
keys = nova_utils.create_keys()
file_utils.save_keys_to_files(keys=keys,
pub_file_path=self.pub_file_path)
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(name=self.keypair_name,
public_filepath=self.pub_file_path))
self.keypair_creator.create()
keypair = nova_utils.keypair_exists(self.nova,
self.keypair_creator.get_keypair())
self.assertEqual(self.keypair_creator.get_keypair(), keypair)
pub_file = None
try:
pub_file = open(os.path.expanduser(self.pub_file_path))
file_key = pub_file.read()
self.assertEqual(self.keypair_creator.get_keypair().public_key,
file_key)
finally:
if pub_file:
pub_file.close()
self.assertEqual(self.keypair_creator.get_keypair().public_key,
file_key)
class CreateKeypairsCleanupTests(OSIntegrationTestCase):
"""
Tests for the OpenStackKeypair#clean method to ensure key files are deleted
when required
"""
def setUp(self):
super(self.__class__, self).__start__()
guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
self.priv_file_path = 'tmp/' + guid
self.pub_file_path = self.priv_file_path + '.pub'
self.nova = nova_utils.nova_client(self.os_creds)
self.keypair_name = guid
self.keypair_creator = None
def tearDown(self):
"""
Cleanup of created keypair
"""
if self.keypair_creator:
self.keypair_creator.clean()
try:
os.remove(self.pub_file_path)
except:
pass
try:
os.remove(self.priv_file_path)
except:
pass
super(self.__class__, self).__clean__()
def test_create_keypair_gen_files_delete_1(self):
"""
Tests the creation of a generated keypair and ensures that the files
are deleted on clean()
:return:
"""
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path))
self.keypair_creator.create()
self.keypair_creator.clean()
self.assertFalse(file_utils.file_exists(self.pub_file_path))
self.assertFalse(file_utils.file_exists(self.priv_file_path))
def test_create_keypair_gen_files_delete_2(self):
"""
Tests the creation of a generated keypair and ensures that the files
are deleted on clean()
:return:
"""
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path, delete_on_clean=True))
self.keypair_creator.create()
self.keypair_creator.clean()
self.assertFalse(file_utils.file_exists(self.pub_file_path))
self.assertFalse(file_utils.file_exists(self.priv_file_path))
def test_create_keypair_gen_files_keep(self):
"""
Tests the creation of a generated keypair and ensures that the files
are not deleted on clean()
:return:
"""
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path, delete_on_clean=False))
self.keypair_creator.create()
self.keypair_creator.clean()
self.assertTrue(file_utils.file_exists(self.pub_file_path))
self.assertTrue(file_utils.file_exists(self.priv_file_path))
def test_create_keypair_exist_files_keep(self):
"""
Tests the creation of an existing public keypair and ensures the files
are not deleted on clean
:return:
"""
keys = nova_utils.create_keys()
file_utils.save_keys_to_files(
keys=keys, pub_file_path=self.pub_file_path,
priv_file_path=self.priv_file_path)
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path, delete_on_clean=False))
self.keypair_creator.create()
self.keypair_creator.clean()
self.assertTrue(file_utils.file_exists(self.pub_file_path))
self.assertTrue(file_utils.file_exists(self.priv_file_path))
def test_create_keypair_exist_files_delete(self):
"""
Tests the creation of an existing public keypair and ensures the files
are deleted on clean
:return:
"""
keys = nova_utils.create_keys()
file_utils.save_keys_to_files(
keys=keys, pub_file_path=self.pub_file_path,
priv_file_path=self.priv_file_path)
self.keypair_creator = OpenStackKeypair(
self.os_creds, KeypairSettings(
name=self.keypair_name, public_filepath=self.pub_file_path,
private_filepath=self.priv_file_path, delete_on_clean=True))
self.keypair_creator.create()
self.keypair_creator.clean()
self.assertFalse(file_utils.file_exists(self.pub_file_path))
self.assertFalse(file_utils.file_exists(self.priv_file_path))
|
