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
|
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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.
*/
package org.elasticsearch.cluster.metadata;
import org.apache.logging.log4j.Logger;
import org.elasticsearch.client.Client;
import org.elasticsearch.cluster.service.ClusterService;
import org.elasticsearch.common.logging.Loggers;
import org.elasticsearch.common.settings.Setting;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
import org.elasticsearch.plugins.Plugin;
import org.elasticsearch.script.ScriptService;
import org.elasticsearch.test.ESIntegTestCase;
import org.elasticsearch.threadpool.ThreadPool;
import org.elasticsearch.watcher.ResourceWatcherService;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.UnaryOperator;
import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.hasSize;
@ESIntegTestCase.ClusterScope(scope = ESIntegTestCase.Scope.TEST)
public class TemplateUpgradeServiceIT extends ESIntegTestCase {
@Override
protected Collection<Class<? extends Plugin>> nodePlugins() {
return Collections.singletonList(TestPlugin.class);
}
public static class TestPlugin extends Plugin {
// This setting is used to simulate cluster state updates
static final Setting<Integer> UPDATE_TEMPLATE_DUMMY_SETTING =
Setting.intSetting("tests.update_template_count", 0, Setting.Property.NodeScope, Setting.Property.Dynamic);
protected final Logger logger;
protected final Settings settings;
public TestPlugin(Settings settings) {
this.logger = Loggers.getLogger(getClass(), settings);
this.settings = settings;
}
@Override
public Collection<Object> createComponents(Client client, ClusterService clusterService, ThreadPool threadPool,
ResourceWatcherService resourceWatcherService, ScriptService scriptService,
NamedXContentRegistry xContentRegistry) {
clusterService.getClusterSettings().addSettingsUpdateConsumer(UPDATE_TEMPLATE_DUMMY_SETTING, integer -> {
logger.debug("the template dummy setting was updated to {}", integer);
});
return super.createComponents(client, clusterService, threadPool, resourceWatcherService, scriptService, xContentRegistry);
}
@Override
public UnaryOperator<Map<String, IndexTemplateMetaData>> getIndexTemplateMetaDataUpgrader() {
return templates -> {
templates.put("test_added_template", IndexTemplateMetaData.builder("test_added_template")
.patterns(Collections.singletonList("*")).build());
templates.remove("test_removed_template");
templates.put("test_changed_template", IndexTemplateMetaData.builder("test_changed_template").order(10)
.patterns(Collections.singletonList("*")).build());
return templates;
};
}
@Override
public List<Setting<?>> getSettings() {
return Collections.singletonList(UPDATE_TEMPLATE_DUMMY_SETTING);
}
}
public void testTemplateUpdate() throws Exception {
assertTemplates();
// Change some templates
assertAcked(client().admin().indices().preparePutTemplate("test_dummy_template").setOrder(0)
.setPatterns(Collections.singletonList("*")).get());
assertAcked(client().admin().indices().preparePutTemplate("test_changed_template").setOrder(0)
.setPatterns(Collections.singletonList("*")).get());
assertAcked(client().admin().indices().preparePutTemplate("test_removed_template").setOrder(1)
.setPatterns(Collections.singletonList("*")).get());
AtomicInteger updateCount = new AtomicInteger();
// Wait for the templates to be updated back to normal
assertBusy(() -> {
// the updates only happen on cluster state updates, so we need to make sure that the cluster state updates are happening
// so we need to simulate updates to make sure the template upgrade kicks in
assertAcked(client().admin().cluster().prepareUpdateSettings().setTransientSettings(
Settings.builder().put(TestPlugin.UPDATE_TEMPLATE_DUMMY_SETTING.getKey(), updateCount.incrementAndGet())
).get());
List<IndexTemplateMetaData> templates = client().admin().indices().prepareGetTemplates("test_*").get().getIndexTemplates();
assertThat(templates, hasSize(3));
boolean addedFound = false;
boolean changedFound = false;
boolean dummyFound = false;
for (int i = 0; i < 3; i++) {
IndexTemplateMetaData templateMetaData = templates.get(i);
switch (templateMetaData.getName()) {
case "test_added_template":
assertFalse(addedFound);
addedFound = true;
break;
case "test_changed_template":
assertFalse(changedFound);
changedFound = true;
assertThat(templateMetaData.getOrder(), equalTo(10));
break;
case "test_dummy_template":
assertFalse(dummyFound);
dummyFound = true;
break;
default:
fail("unexpected template " + templateMetaData.getName());
break;
}
}
assertTrue(addedFound);
assertTrue(changedFound);
assertTrue(dummyFound);
});
// Wipe out all templates
assertAcked(client().admin().indices().prepareDeleteTemplate("test_*").get());
assertTemplates();
}
private void assertTemplates() throws Exception {
AtomicInteger updateCount = new AtomicInteger();
// Make sure all templates are recreated correctly
assertBusy(() -> {
// the updates only happen on cluster state updates, so we need to make sure that the cluster state updates are happening
// so we need to simulate updates to make sure the template upgrade kicks in
assertAcked(client().admin().cluster().prepareUpdateSettings().setTransientSettings(
Settings.builder().put(TestPlugin.UPDATE_TEMPLATE_DUMMY_SETTING.getKey(), updateCount.incrementAndGet())
).get());
List<IndexTemplateMetaData> templates = client().admin().indices().prepareGetTemplates("test_*").get().getIndexTemplates();
assertThat(templates, hasSize(2));
boolean addedFound = false;
boolean changedFound = false;
for (int i = 0; i < 2; i++) {
IndexTemplateMetaData templateMetaData = templates.get(i);
switch (templateMetaData.getName()) {
case "test_added_template":
assertFalse(addedFound);
addedFound = true;
break;
case "test_changed_template":
assertFalse(changedFound);
changedFound = true;
assertThat(templateMetaData.getOrder(), equalTo(10));
break;
default:
fail("unexpected template " + templateMetaData.getName());
break;
}
}
assertTrue(addedFound);
assertTrue(changedFound);
});
}
}
|
