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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model.application.validation;
import com.yahoo.config.application.api.ApplicationPackage;
import com.yahoo.config.application.api.DeployLogger;
import com.yahoo.config.model.NullConfigModelRegistry;
import com.yahoo.config.model.api.ValidationParameters;
import com.yahoo.config.model.api.ValidationParameters.CheckRouting;
import com.yahoo.config.model.deploy.DeployState;
import com.yahoo.config.model.test.MockApplicationPackage;
import com.yahoo.vespa.model.VespaModel;
import com.yahoo.vespa.model.content.utils.ContentClusterBuilder;
import org.junit.jupiter.api.Test;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.util.List;
import java.util.logging.Level;
import static com.yahoo.config.model.test.TestUtil.joinLines;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* @author geirst
*/
public class ComplexFieldsValidatorTestCase {
@Test
void throws_exception_when_unsupported_complex_fields_have_struct_field_attributes() throws IOException, SAXException {
Throwable exception = assertThrows(IllegalArgumentException.class, () -> {
createModelAndValidate(joinLines("search test {",
" document test {",
" struct s { field f1 type array<int> {} }",
" field struct_array type array<s> {",
" struct-field f1 { indexing: attribute }",
" }",
" field struct_map type map<string,s> {",
" struct-field key { indexing: attribute }",
" struct-field value.f1 { indexing: attribute }",
" }",
" }",
"}"));
});
assertTrue(exception.getMessage().contains(getExpectedMessage("struct_array (struct_array.f1), struct_map (struct_map.value.f1)")));
}
@Test
void throws_exception_when_nested_struct_array_is_specified_as_struct_field_attribute() throws IOException, SAXException {
Throwable exception = assertThrows(IllegalArgumentException.class, () -> {
createModelAndValidate(joinLines(
"schema test {",
"document test {",
"struct topic {",
" field id type string {}",
" field label type string {}",
"}",
"struct docTopic {",
" field id type string {}",
" field topics type array<topic> {}",
"}",
"field docTopics type array<docTopic> {",
" indexing: summary",
" struct-field id { indexing: attribute }",
" struct-field topics { indexing: attribute }",
"}",
"}",
"}"));
});
assertEquals("For schema 'test': Field 'docTopics.topics' of type 'array<topic>' cannot be an attribute." +
" Instead specify the struct fields to be searchable as attribute",
exception.getMessage());
}
@Test
void throws_exception_when_struct_field_inside_nested_struct_array_is_specified_as_attribute() throws IOException, SAXException {
Throwable exception = assertThrows(IllegalArgumentException.class, () -> {
createModelAndValidate(joinLines(
"schema test {",
"document test {",
"struct item {",
"field name type string {}",
"field color type string {}",
"field type type string {}",
"}",
"struct itembox {",
"field items type array<item> {}",
"}",
"field cabinet type map<string, itembox> {",
"struct-field key { indexing: attribute }",
"struct-field value.items {",
"struct-field name { indexing: attribute }",
"struct-field color { indexing: attribute }",
"}",
"}",
"}",
"}"));
});
assertTrue(exception.getMessage().contains(getExpectedMessage("cabinet (cabinet.value.items.name, cabinet.value.items.color)")));
}
private String getExpectedMessage(String unsupportedFields) {
return "For cluster 'mycluster', search 'test': " +
"The following complex fields do not support using struct field attributes: " +
unsupportedFields + ". " +
"Only supported for the following complex field types: array or map of struct with primitive types, map of primitive types";
}
private class MyLogger implements DeployLogger {
public StringBuilder message = new StringBuilder();
@Override
public void log(Level level, String message) {
this.message.append(message);
}
}
@Test
void logs_warning_when_complex_fields_have_struct_fields_with_index() throws IOException, SAXException {
var logger = new MyLogger();
createModelAndValidate(joinLines(
"schema test {",
"document test {",
"struct topic {",
" field id type string {}",
" field label type string {}",
" field desc type string {}",
"}",
"field topics type array<topic> {",
" indexing: summary",
" struct-field id { indexing: index }",
" struct-field label { indexing: index | attribute }",
" struct-field desc { indexing: attribute }",
"}",
"}",
"}"), logger);
assertTrue(logger.message.toString().contains(
"For cluster 'mycluster', schema 'test': " +
"The following complex fields have struct fields with 'indexing: index' which is not supported and has no effect: " +
"topics (topics.id, topics.label). " +
"Remove setting or change to 'indexing: attribute' if needed for matching."));
}
@Test
void validation_passes_when_only_supported_struct_field_attributes_are_used() throws IOException, SAXException {
createModelAndValidate(joinLines("search test {",
" document test {",
" struct s1 {",
" field f1 type string {}",
" field f2 type int {}",
" }",
" struct s2 {",
" field f3 type string {}",
" field f4 type array<int> {}",
" field f5 type array<s1> {}",
" }",
" field struct_array type array<s2> {",
" struct-field f3 { indexing: attribute }",
" }",
" field struct_map type map<string,s2> {",
" struct-field key { indexing: attribute }",
" struct-field value.f3 { indexing: attribute }",
" }",
" }",
"}"));
}
private static void createModelAndValidate(String schema) throws IOException, SAXException {
createModelAndValidate(schema, null);
}
private static void createModelAndValidate(String schema, DeployLogger logger) throws IOException, SAXException {
DeployState deployState = createDeployState(servicesXml(), schema, logger);
VespaModel model = new VespaModel(new NullConfigModelRegistry(), deployState);
ValidationParameters validationParameters = new ValidationParameters(CheckRouting.FALSE);
new Validation().validate(model, validationParameters, deployState);
}
private static DeployState createDeployState(String servicesXml, String schema, DeployLogger logger) {
ApplicationPackage app = new MockApplicationPackage.Builder()
.withServices(servicesXml)
.withSchemas(List.of(schema))
.build();
var builder = new DeployState.Builder().applicationPackage(app);
if (logger != null) {
builder.deployLogger(logger);
}
return builder.build();
}
private static String servicesXml() {
return joinLines("<services version='1.0'>",
new ContentClusterBuilder().getXml(),
"</services>");
}
}
|
