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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchdefinition.processing;
import com.yahoo.searchdefinition.Search;
import com.yahoo.searchdefinition.SearchBuilder;
import com.yahoo.searchdefinition.document.ImportedField;
import com.yahoo.searchdefinition.parser.ParseException;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import java.util.ArrayList;
import java.util.List;
import static org.junit.Assert.assertEquals;
import static com.yahoo.config.model.test.TestUtil.joinLines;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
/**
* @author geirst
*/
public class ImportedFieldsTestCase {
@Test
public void fields_can_be_imported_from_referenced_document_types() throws ParseException {
Search search = buildAdSearch(joinLines(
"search ad {",
" document ad {",
" field campaign_ref type reference<campaign> { indexing: attribute }",
" field person_ref type reference<person> { indexing: attribute }",
" }",
" import field campaign_ref.budget as my_budget {}",
" import field person_ref.name as my_name {}",
"}"));
assertEquals(2, search.importedFields().get().fields().size());
assertSearchContainsImportedField("my_budget", "campaign_ref", "campaign", "budget", search);
assertSearchContainsImportedField("my_name", "person_ref", "person", "name", search);
}
@Rule
public ExpectedException exception = ExpectedException.none();
@Test
public void field_reference_spec_must_include_dot() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("Illegal field reference spec 'campaignrefbudget': Does not include a single '.'");
buildAdSearch(joinLines(
"search ad {",
" document ad {}",
" import field campaignrefbudget as budget {}",
"}"));
}
private static Search buildAdSearch(String sdContent) throws ParseException {
SearchBuilder builder = new SearchBuilder();
builder.importString(joinLines("search campaign {",
" document campaign {",
" field budget type int { indexing: attribute }",
" }",
"}"));
builder.importString(joinLines("search person {",
" document person {",
" field name type string { indexing: attribute }",
" }",
"}"));
builder.importString(sdContent);
builder.build();
return builder.getSearch("ad");
}
private static void check_struct_import(ParentSdBuilder parentBuilder) throws ParseException {
Search search = buildChildSearch(parentBuilder.build(), joinLines("search child {",
" document child {",
" field parent_ref type reference<parent> {",
" indexing: attribute | summary",
" }",
" }",
" import field parent_ref.elem_array as my_elem_array {}",
" import field parent_ref.elem_map as my_elem_map {}",
" import field parent_ref.str_int_map as my_str_int_map {}",
"}"));
assertEquals(parentBuilder.countAttrs(), search.importedFields().get().fields().size());
checkImportedField("my_elem_array.name", "parent_ref", "parent", "elem_array.name", search, parentBuilder.elem_array_name_attr);
checkImportedField("my_elem_array.weight", "parent_ref", "parent", "elem_array.weight", search, parentBuilder.elem_array_weight_attr);
checkImportedField("my_elem_map.key", "parent_ref", "parent", "elem_map.key", search, parentBuilder.elem_map_key_attr);
checkImportedField("my_elem_map.value.name", "parent_ref", "parent", "elem_map.value.name", search, parentBuilder.elem_map_value_name_attr);
checkImportedField("my_elem_map.value.weight", "parent_ref", "parent", "elem_map.value.weight", search, parentBuilder.elem_map_value_weight_attr);
checkImportedField("my_str_int_map.key", "parent_ref", "parent", "str_int_map.key", search, parentBuilder.str_int_map_key_attr);
checkImportedField("my_str_int_map.value", "parent_ref", "parent", "str_int_map.value", search, parentBuilder.str_int_map_value_attr);
}
@Test
public void check_struct_import() throws ParseException {
check_struct_import(new ParentSdBuilder());
check_struct_import(new ParentSdBuilder().elem_array_weight_attr(false).elem_map_value_weight_attr(false));
check_struct_import(new ParentSdBuilder().elem_array_name_attr(false).elem_map_value_name_attr(false));
}
@Test
public void check_illegal_stroct_import_missing_array_of_struct_attributes() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("For search 'child', import field 'my_elem_array' (nested to 'my_elem_array'): Field 'elem_array' via reference field 'parent_ref': Is not a struct containing an attribute field.");
check_struct_import(new ParentSdBuilder().elem_array_name_attr(false).elem_array_weight_attr(false));
}
@Test
public void check_illegal_struct_import_missing_map_of_struct_key_attribute() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("For search 'child', import field 'my_elem_map' (nested to 'my_elem_map.key'): Field 'elem_map.key' via reference field 'parent_ref': Is not an attribute field. Only attribute fields supported");
check_struct_import(new ParentSdBuilder().elem_map_key_attr(false));
}
@Test
public void check_illegal_struct_import_missing_map_of_struct_value_attributes() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("For search 'child', import field 'my_elem_map' (nested to 'my_elem_map.value'): Field 'elem_map.value' via reference field 'parent_ref': Is not a struct containing an attribute field.");
check_struct_import(new ParentSdBuilder().elem_map_value_name_attr(false).elem_map_value_weight_attr(false));
}
@Test
public void check_illegal_struct_import_missing_map_of_primitive_key_attribute() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("For search 'child', import field 'my_str_int_map' (nested to 'my_str_int_map.key'): Field 'str_int_map.key' via reference field 'parent_ref': Is not an attribute field. Only attribute fields supported");
check_struct_import(new ParentSdBuilder().str_int_map_key_attr(false));
}
@Test
public void check_illegal_struct_import_missing_map_of_primitive_value_attribute() throws ParseException {
exception.expect(IllegalArgumentException.class);
exception.expectMessage("For search 'child', import field 'my_str_int_map' (nested to 'my_str_int_map.value'): Field 'str_int_map.value' via reference field 'parent_ref': Is not an attribute field. Only attribute fields supported");
check_struct_import(new ParentSdBuilder().str_int_map_value_attr(false));
}
private static class ParentSdBuilder {
private boolean elem_array_name_attr;
private boolean elem_array_weight_attr;
private boolean elem_map_key_attr;
private boolean elem_map_value_name_attr;
private boolean elem_map_value_weight_attr;
private boolean str_int_map_key_attr;
private boolean str_int_map_value_attr;
public ParentSdBuilder() {
elem_array_name_attr = true;
elem_array_weight_attr = true;
elem_map_key_attr = true;
elem_map_value_name_attr = true;
elem_map_value_weight_attr = true;
str_int_map_key_attr = true;
str_int_map_value_attr = true;
}
public ParentSdBuilder elem_array_name_attr(boolean v) { elem_array_name_attr = v; return this; }
public ParentSdBuilder elem_array_weight_attr(boolean v) { elem_array_weight_attr = v; return this; }
public ParentSdBuilder elem_map_key_attr(boolean v) { elem_map_key_attr = v; return this; }
public ParentSdBuilder elem_map_value_name_attr(boolean v) { elem_map_value_name_attr = v; return this; }
public ParentSdBuilder elem_map_value_weight_attr(boolean v) { elem_map_value_weight_attr = v; return this; }
public ParentSdBuilder str_int_map_key_attr(boolean v) { str_int_map_key_attr = v; return this; }
public ParentSdBuilder str_int_map_value_attr(boolean v) { str_int_map_value_attr = v; return this; }
public String build() {
return joinLines("search parent {",
" document parent {",
" struct elem {",
" field name type string {}",
" field weight type int {}",
" }",
" field elem_array type array<elem> {",
" indexing: summary",
" struct-field name {",
structFieldSpec(elem_array_name_attr, true),
" }",
" struct-field weight {",
structFieldSpec(elem_array_weight_attr, false),
" }",
" }",
" field elem_map type map<string, elem> {",
" indexing: summary",
" struct-field key {",
structFieldSpec(elem_map_key_attr, true),
" }",
" struct-field value.name {",
structFieldSpec(elem_map_value_name_attr, true),
" }",
" struct-field value.weight {",
structFieldSpec(elem_map_value_weight_attr, false),
" }",
" }",
" field str_int_map type map<string, int> {",
" indexing: summary",
" struct-field key {",
structFieldSpec(str_int_map_key_attr, true),
" }",
" struct-field value {",
structFieldSpec(str_int_map_value_attr, false),
" }",
" }",
" }",
"}");
}
private static String structFieldSpec(boolean isAttribute, boolean isFastSearch) {
List<String> result = new ArrayList<String>();
if (isAttribute) {
result.add(" indexing: attribute");
if (isFastSearch) {
result.add(" attribute: fast-search");
}
}
return String.join("\n", result);
}
private static int b2i(boolean b) {
return b ? 1 : 0;
}
public int countAttrs() {
int elem_array_attr_count = b2i(elem_array_name_attr) + b2i(elem_array_weight_attr);
int elem_map_attr_count = b2i(elem_map_key_attr) + b2i(elem_map_value_name_attr) + b2i(elem_map_value_weight_attr);
int str_int_map_attr_count = b2i(str_int_map_key_attr) + b2i(str_int_map_value_attr);
return elem_array_attr_count + elem_map_attr_count + str_int_map_attr_count;
}
}
private static Search buildChildSearch(String parentSdContent, String sdContent) throws ParseException {
SearchBuilder builder = new SearchBuilder();
builder.importString(parentSdContent);
builder.importString(sdContent);
builder.build();
return builder.getSearch("child");
}
private static void assertSearchNotContainsImportedField(String fieldName, Search search) {
ImportedField importedField = search.importedFields().get().fields().get(fieldName);
assertNull(importedField);
}
private static void assertSearchContainsImportedField(String fieldName,
String referenceFieldName,
String referenceDocType,
String targetFieldName,
Search search) {
ImportedField importedField = search.importedFields().get().fields().get(fieldName);
assertNotNull(importedField);
assertEquals(fieldName, importedField.fieldName());
assertEquals(referenceFieldName, importedField.reference().referenceField().getName());
assertEquals(referenceDocType, importedField.reference().targetSearch().getName());
assertEquals(targetFieldName, importedField.targetField().getName());
}
private static void checkImportedField(String fieldName, String referenceFieldName, String referenceDocType,
String targetFieldName, Search search, boolean present) {
if (present) {
assertSearchContainsImportedField(fieldName, referenceFieldName, referenceDocType, targetFieldName, search);
} else {
assertSearchNotContainsImportedField(fieldName, search);
}
}
}
|
