File: test_shrink.py

package info (click to toggle)
elasticsearch-curator 8.0.21-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 2,716 kB
  • sloc: python: 17,838; makefile: 159; sh: 156
file content (368 lines) | stat: -rw-r--r-- 10,974 bytes parent folder | download
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
"""Test shrink action"""

# pylint: disable=C0115, C0116, invalid-name, attribute-defined-outside-init
import os
import logging
from curator.helpers.getters import get_indices
from . import CuratorTestCase
from . import testvars

HOST = os.environ.get('TEST_ES_SERVER', 'http://127.0.0.1:9200')

SHRINK = (
    '---\n'
    'actions:\n'
    '  1:\n'
    '    description: "Act on indices as filtered"\n'
    '    action: shrink\n'
    '    options:\n'
    '      shrink_node: {0}\n'
    '      node_filters:\n'
    '          {1}: {2}\n'
    '      number_of_shards: {3}\n'
    '      number_of_replicas: {4}\n'
    '      shrink_prefix: {5}\n'
    '      shrink_suffix: {6}\n'
    '      delete_after: {7}\n'
    '      wait_for_rebalance: {8}\n'
    '    filters:\n'
    '      - filtertype: pattern\n'
    '        kind: prefix\n'
    '        value: my\n'
)

NO_PERMIT_MASTERS = (
    '---\n'
    'actions:\n'
    '  1:\n'
    '    description: "Act on indices as filtered"\n'
    '    action: shrink\n'
    '    options:\n'
    '      shrink_node: {0}\n'
    '      number_of_shards: {1}\n'
    '      number_of_replicas: {2}\n'
    '      shrink_prefix: {3}\n'
    '      shrink_suffix: {4}\n'
    '      delete_after: {5}\n'
    '    filters:\n'
    '      - filtertype: pattern\n'
    '        kind: prefix\n'
    '        value: my\n'
)

WITH_EXTRA_SETTINGS = (
    '---\n'
    'actions:\n'
    '  1:\n'
    '    description: "Act on indices as filtered"\n'
    '    action: shrink\n'
    '    options:\n'
    '      shrink_node: {0}\n'
    '      node_filters:\n'
    '          {1}: {2}\n'
    '      number_of_shards: {3}\n'
    '      number_of_replicas: {4}\n'
    '      shrink_prefix: {5}\n'
    '      shrink_suffix: {6}\n'
    '      delete_after: {7}\n'
    '      extra_settings:\n'
    '        settings:\n'
    '          {8}: {9}\n'
    '        aliases:\n'
    '          my_alias: {10}\n'
    '      post_allocation:\n'
    '          allocation_type: {11}\n'
    '          key: {12}\n'
    '          value: {13}\n'
    '    filters:\n'
    '      - filtertype: pattern\n'
    '        kind: prefix\n'
    '        value: my\n'
)

COPY_ALIASES = (
    '---\n'
    'actions:\n'
    '  1:\n'
    '    description: "Act on indices as filtered"\n'
    '    action: shrink\n'
    '    options:\n'
    '      shrink_node: {0}\n'
    '      node_filters:\n'
    '          {1}: {2}\n'
    '      number_of_shards: {3}\n'
    '      number_of_replicas: {4}\n'
    '      shrink_prefix: {5}\n'
    '      shrink_suffix: {6}\n'
    '      copy_aliases: {7}\n'
    '      delete_after: {8}\n'
    '    filters:\n'
    '      - filtertype: pattern\n'
    '        kind: prefix\n'
    '        value: my\n'
)

SHRINK_FILTER_BY_SHARDS = (
    '---\n'
    'actions:\n'
    '  1:\n'
    '    description: "Act on indices as filtered"\n'
    '    action: shrink\n'
    '    options:\n'
    '      shrink_node: {0}\n'
    '      node_filters:\n'
    '          {1}: {2}\n'
    '      number_of_shards: {3}\n'
    '      number_of_replicas: {4}\n'
    '      shrink_prefix: {5}\n'
    '      shrink_suffix: {6}\n'
    '      delete_after: {7}\n'
    '      wait_for_rebalance: {8}\n'
    '    filters:\n'
    '      - filtertype: shards\n'
    '        number_of_shards: {9}\n'
    '        shard_filter_behavior: {10}\n'
)


class TestActionFileShrink(CuratorTestCase):
    def builder(self, action_args):
        self.idx = 'my_index'
        suffix = '-shrunken'
        self.target = f'{self.idx}{suffix}'
        self.create_index(self.idx, shards=2)
        self.add_docs(self.idx)
        # add alias in the source index
        self.alias = 'my_alias'
        alias_actions = []
        alias_actions.append({'add': {'index': self.idx, 'alias': self.alias}})
        self.client.indices.update_aliases(actions=alias_actions)
        self.write_config(self.args['configfile'], testvars.client_config.format(HOST))
        self.write_config(self.args['actionfile'], action_args)
        self.invoke_runner()

    def test_shrink(self):
        suffix = '-shrunken'
        self.builder(
            SHRINK.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'True',
            )
        )
        indices = get_indices(self.client)
        assert 1 == len(indices)
        assert indices[0] == self.target

    def test_permit_masters_false(self):
        suffix = '-shrunken'
        self.builder(
            NO_PERMIT_MASTERS.format('DETERMINISTIC', 1, 0, '', suffix, 'True')
        )
        indices = get_indices(self.client)
        assert 1 == len(indices)
        assert indices[0] == self.idx
        assert 1 == self.result.exit_code

    def test_shrink_non_green(self):
        suffix = '-shrunken'
        self.client.indices.create(
            index='just_another_index',
            settings={'number_of_shards': 1, 'number_of_replicas': 1},
        )
        self.builder(
            SHRINK.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'True',
            )
        )
        indices = get_indices(self.client)
        assert 2 == len(indices)
        assert 1 == self.result.exit_code

    def test_shrink_with_extras(self):
        suffix = '-shrunken'
        allocation_type = 'exclude'
        key = '_name'
        value = 'not_this_node'
        self.builder(
            WITH_EXTRA_SETTINGS.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'False',
                'index.codec',
                'best_compression',
                dict(),
                allocation_type,
                key,
                value,
            )
        )
        indices = get_indices(self.client)
        assert 2 == len(indices)
        settings = self.client.indices.get_settings()
        assert (
            value
            == settings[self.target]['settings']['index']['routing']['allocation'][
                allocation_type
            ][key]
        )
        assert (
            ''
            == settings[self.idx]['settings']['index']['routing']['allocation'][
                'require'
            ]['_name']
        )
        assert 'best_compression' == settings[self.target]['settings']['index']['codec']
        # This was erroneously testing for True in previous releases. But the target
        # index should never have had the alias as `copy_aliases` was never set
        # to True for this test.

    def test_shrink_with_copy_alias(self):
        suffix = '-shrunken'
        self.builder(
            COPY_ALIASES.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'True',
            )
        )
        indices = get_indices(self.client)
        assert 1 == len(indices)
        assert indices[0] == self.target
        assert self.client.indices.exists_alias(index=self.target, name=self.alias)

    def test_shrink_without_rebalance(self):
        suffix = '-shrunken'
        self.builder(
            SHRINK.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'False',
            )
        )
        indices = get_indices(self.client)
        assert 1 == len(indices)
        assert indices[0] == self.target

    def test_shrink_implicit_shard_filter(self):
        self.create_index('my_invalid_shrink_index', shards=1)
        self.create_index('my_valid_shrink_index', shards=5)
        suffix = '-shrunken'
        self.builder(
            SHRINK.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'False',
            )
        )

        indices = get_indices(self.client)
        assert 3 == len(indices)
        assert 'my_invalid_shrink_index-shrunken' not in indices
        assert 'my_valid_shrink_index-shrunken' in indices

    def test_shrink_explicit_shard_filter(self):
        self.create_index('my_invalid_shrink_index', shards=3)
        self.create_index('my_valid_shrink_index', shards=5)
        suffix = '-shrunken'
        self.builder(
            SHRINK_FILTER_BY_SHARDS.format(
                'DETERMINISTIC',
                'permit_masters',
                'True',
                1,
                0,
                '',
                suffix,
                'True',
                'False',
                5,
                'greater_than_or_equal',
            )
        )
        indices = get_indices(self.client)
        assert 3 == len(indices)
        assert 'my_invalid_shrink_index-shrunken' not in indices
        assert 'my_valid_shrink_index-shrunken' in indices
        assert 'my_index-shrunken' not in indices


class TestCLIShrink(CuratorTestCase):
    def builder(self):
        self.loogger = logging.getLogger('TestCLIShrink.builder')
        self.idx = 'my_index'
        self.suffix = '-shrunken'
        self.target = f'{self.idx}{self.suffix}'
        self.create_index(self.idx, shards=2)
        self.add_docs(self.idx)
        # add alias in the source index
        self.alias = 'my_alias'
        alias_actions = []
        alias_actions.append({'add': {'index': self.idx, 'alias': self.alias}})
        self.client.indices.update_aliases(actions=alias_actions)
        self.write_config(self.args['configfile'], testvars.client_config.format(HOST))
        self.loogger.debug('Test pre-execution build phase complete.')

    def test_shrink(self):
        self.builder()
        args = self.get_runner_args()
        args += [
            '--config',
            self.args['configfile'],
            'shrink',
            '--shrink_node',
            'DETERMINISTIC',
            '--node_filters',
            '{"permit_masters":"true"}',
            '--number_of_shards',
            "1",
            '--number_of_replicas',
            "0",
            '--shrink_suffix',
            self.suffix,
            '--delete_after',
            '--wait_for_rebalance',
            '--filter_list',
            '{"filtertype":"none"}',
        ]
        assert 0 == self.run_subprocess(args, logname='TestCLIShrink.test_shrink')
        indices = get_indices(self.client)
        assert 1 == len(indices)
        assert indices[0] == self.target