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 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
|
"""test_class_snapshot_list"""
from unittest import TestCase
from unittest.mock import Mock
import yaml
from es_client.exceptions import FailedValidation
from curator import SnapshotList
from curator.exceptions import ConfigurationError, FailedExecution, MissingArgument, NoSnapshots
# Get test variables and constants from a single source
from . import testvars
class TestSnapshotListClientAndInit(TestCase):
def test_init_bad_client(self):
client = 'not a real client'
self.assertRaises(TypeError, SnapshotList, client)
def test_init_no_repo_exception(self):
client = Mock()
self.assertRaises(MissingArgument, SnapshotList, client)
def test_init_get_snapshots_exception(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get.side_effect = testvars.fake_fail
client.snapshot.get_repository.return_value = {}
self.assertRaises(
FailedExecution,
SnapshotList, client, repository=testvars.repo_name
)
def test_init(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(testvars.snapshots['snapshots'],sl.all_snapshots)
self.assertEqual(
['snap_name','snapshot-2015.03.01'], sorted(sl.snapshots)
)
class TestSnapshotListOtherMethods(TestCase):
def test_empty_list(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(2, len(sl.snapshots))
sl.snapshots = []
self.assertRaises(NoSnapshots, sl.empty_list_check)
def test_working_list(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(['snap_name', 'snapshot-2015.03.01'], sl.working_list())
class TestSnapshotListAgeFilterName(TestCase):
def test_get_name_based_ages_match(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl._get_name_based_ages('%Y.%m.%d')
self.assertEqual(1425168000,
sl.snapshot_info['snapshot-2015.03.01']['age_by_name']
)
def test_get_name_based_ages_no_match(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl._get_name_based_ages('%Y.%m.%d')
self.assertIsNone(sl.snapshot_info['snap_name']['age_by_name'])
class TestSnapshotListStateFilter(TestCase):
def test_success_inclusive(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_state(state='SUCCESS')
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
def test_success_exclusive(self):
client = Mock()
client.snapshot.get.return_value = testvars.inprogress
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_state(state='SUCCESS', exclude=True)
self.assertEqual(['snapshot-2015.03.01'], sorted(sl.snapshots))
def test_invalid_state(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(ValueError, sl.filter_by_state, state='invalid')
class TestSnapshotListRegexFilters(TestCase):
def test_filter_by_regex_prefix(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='prefix', value='sna')
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='prefix', value='sna', exclude=True)
self.assertEqual([], sl.snapshots)
def test_filter_by_regex_middle(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='regex', value='shot')
self.assertEqual(
['snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='regex', value='shot', exclude=True)
self.assertEqual([], sl.snapshots)
def test_filter_by_regex_prefix_exclude(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='prefix', value='snap_', exclude=True)
self.assertEqual(['snapshot-2015.03.01'], sl.snapshots)
def test_filter_by_regex_timestring(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='timestring', value='%Y.%m.%d')
self.assertEqual(
['snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='timestring', value='%Y.%m.%d', exclude=True)
self.assertEqual([], sl.snapshots)
def test_filter_by_regex_no_value(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
self.assertRaises(ValueError, sl.filter_by_regex, kind='prefix', value=None)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
sl.filter_by_regex(kind='prefix', value=0)
self.assertEqual([], sl.snapshots)
def test_filter_by_regex_bad_kind(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'],
sorted(sl.snapshots)
)
self.assertRaises(
ValueError, sl.filter_by_regex, kind='invalid', value=None)
class TestSnapshotListFilterByAge(TestCase):
def test_filter_by_age_missing_direction(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(MissingArgument,
sl.filter_by_age, unit='days', unit_count=1
)
def test_filter_by_age_bad_direction(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(ValueError, sl.filter_by_age, unit='days',
unit_count=1, direction="invalid"
)
def test_filter_by_age_invalid_source(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(ValueError, sl.filter_by_age, unit='days',
source='invalid', unit_count=1, direction="older"
)
def test_filter_by_age__name_no_timestring(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(MissingArgument,
sl.filter_by_age,
source='name', unit='days', unit_count=1, direction='older'
)
def test_filter_by_age__name_older_than_now(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(source='name', direction='older',
timestring='%Y.%m.%d', unit='days', unit_count=1
)
self.assertEqual(['snapshot-2015.03.01'], sl.snapshots)
def test_filter_by_age__name_younger_than_now(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(source='name', direction='younger',
timestring='%Y.%m.%d', unit='days', unit_count=1
)
self.assertEqual([], sl.snapshots)
def test_filter_by_age__name_younger_than_past_date(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(source='name', direction='younger',
timestring='%Y.%m.%d', unit='seconds', unit_count=0,
epoch=1422748800
)
self.assertEqual(['snapshot-2015.03.01'], sl.snapshots)
def test_filter_by_age__name_older_than_past_date(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(source='name', direction='older',
timestring='%Y.%m.%d', unit='seconds', unit_count=0,
epoch=1456963200
)
self.assertEqual(['snapshot-2015.03.01'], sl.snapshots)
def test_filter_by_age__creation_date_older_than_now(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(direction='older', unit='days', unit_count=1)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'], sorted(sl.snapshots))
def test_filter_by_age__creation_date_younger_than_now(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(direction='younger',
timestring='%Y.%m.%d', unit='days', unit_count=1
)
self.assertEqual([], sl.snapshots)
def test_filter_by_age__creation_date_younger_than_past_date(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(direction='younger',
timestring='%Y.%m.%d', unit='seconds', unit_count=0,
epoch=1422748801
)
self.assertEqual(['snapshot-2015.03.01'], sl.snapshots)
def test_filter_by_age__creation_date_older_than_past_date(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_by_age(direction='older',
timestring='%Y.%m.%d', unit='seconds', unit_count=0,
epoch=1425168001
)
self.assertEqual(['snap_name'], sl.snapshots)
class TestIterateFiltersSnaps(TestCase):
def test_no_filters(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo.iterate_filters({})
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'], sorted(slo.snapshots)
)
def test_no_filtertype(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = {'filters': [{'no_filtertype':'fail'}]}
self.assertRaises(
FailedValidation, slo.iterate_filters, config)
def test_invalid_filtertype_class(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = {'filters': [{'filtertype':12345.6789}]}
self.assertRaises(
FailedValidation, slo.iterate_filters, config)
def test_invalid_filtertype(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = yaml.load(testvars.invalid_ft, Loader=yaml.FullLoader)['actions'][1]
self.assertRaises(
FailedValidation,
slo.iterate_filters, config
)
def test_age_filtertype(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = yaml.load(testvars.snap_age_ft, Loader=yaml.FullLoader)['actions'][1]
slo.iterate_filters(config)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'], sorted(slo.snapshots))
def test_pattern_filtertype(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = yaml.load(testvars.snap_pattern_ft, Loader=yaml.FullLoader)['actions'][1]
slo.iterate_filters(config)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'], sorted(slo.snapshots))
def test_none_filtertype(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
config = yaml.load(testvars.snap_none_ft, Loader=yaml.FullLoader)['actions'][1]
slo.iterate_filters(config)
self.assertEqual(
['snap_name', 'snapshot-2015.03.01'], sorted(slo.snapshots))
class TestSnapshotListFilterCount(TestCase):
def test_missing_count(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(MissingArgument, slo.filter_by_count)
def test_without_age(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo.filter_by_count(count=1)
self.assertEqual(['snap_name'], slo.snapshots)
def test_without_age_reversed(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo.filter_by_count(count=1, reverse=False)
self.assertEqual(['snapshot-2015.03.01'], slo.snapshots)
def test_with_age(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo.filter_by_count(
count=1, source='creation_date', use_age=True
)
self.assertEqual(['snap_name'], slo.snapshots)
def test_with_age_reversed(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo.filter_by_count(
count=1, source='creation_date', use_age=True, reverse=False
)
self.assertEqual(['snapshot-2015.03.01'], slo.snapshots)
def test_sort_by_age(self):
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
slo = SnapshotList(client, repository=testvars.repo_name)
slo._calculate_ages()
slo.age_keyfield = 'invalid'
snaps = slo.snapshots
slo._sort_by_age(snaps)
self.assertEqual(['snapshot-2015.03.01'], slo.snapshots)
class TestSnapshotListPeriodFilter(TestCase):
def test_bad_args(self):
unit = 'days'
range_from = -1
range_to = -2
timestring = '%Y.%m.%d'
epoch = 1456963201
expected = FailedExecution
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(expected, sl.filter_period, unit=unit,
range_from=range_from, range_to=range_to, source='name',
timestring=timestring, epoch=epoch
)
def test_in_range(self):
unit = 'days'
range_from = -2
range_to = 2
epoch = 1425168000
expected = ['snapshot-2015.03.01']
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_period(source='name', range_from=range_from, epoch=epoch,
range_to=range_to, timestring='%Y.%m.%d', unit=unit,
)
self.assertEqual(expected, sl.snapshots)
def test_not_in_range(self):
unit = 'days'
range_from = 2
range_to = 4
epoch = 1425168000
expected = []
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.filter_period(
source='name', range_from=range_from, epoch=epoch,
range_to=range_to, timestring='%Y.%m.%d', unit=unit,
)
self.assertEqual(expected, sl.snapshots)
def test_no_creation_date(self):
unit = 'days'
range_from = -2
range_to = 2
epoch = 1456963201
expected = []
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
sl.snapshot_info['snap_name']['start_time_in_millis'] = None
sl.snapshot_info['snapshot-2015.03.01']['start_time_in_millis'] = None
sl.filter_period(source='creation_date', range_from=range_from,
epoch=epoch, range_to=range_to, unit=unit,
)
self.assertEqual(expected, sl.snapshots)
def test_invalid_period_type(self):
unit = 'days'
range_from = -1
range_to = -2
timestring = '%Y.%m.%d'
epoch = 1456963201
expected = ValueError
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(expected, sl.filter_period, unit=unit, period_type='invalid',
range_from=range_from, range_to=range_to, source='name',
timestring=timestring, epoch=epoch
)
def test_invalid_range_from(self):
unit = 'days'
range_from = -1
range_to = 'invalid'
timestring = '%Y.%m.%d'
epoch = 1456963201
expected = ConfigurationError
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(expected, sl.filter_period, unit=unit, period_type='relative',
range_from=range_from, range_to=range_to, source='name',
timestring=timestring, epoch=epoch
)
def test_missing_absolute_date_values(self):
unit = 'days'
range_from = -1
range_to = 'invalid'
timestring = '%Y.%m.%d'
epoch = 1456963201
expected = ConfigurationError
client = Mock()
client.snapshot.get.return_value = testvars.snapshots
client.snapshot.get_repository.return_value = testvars.test_repo
sl = SnapshotList(client, repository=testvars.repo_name)
self.assertRaises(expected, sl.filter_period, unit=unit, period_type='absolute',
range_from=range_from, range_to=range_to, source='name',
timestring=timestring, epoch=epoch
)
|