aboutsummaryrefslogtreecommitdiffstats
path: root/docprocs/src/test/java/com/yahoo/docprocs/indexing/IndexingProcessorTestCase.java
blob: ae7437ed80b1df435c1ed367c116db04a57288ff (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.docprocs.indexing;

import com.yahoo.component.provider.ComponentRegistry;
import com.yahoo.config.subscription.ConfigGetter;
import com.yahoo.docproc.Processing;
import com.yahoo.document.Document;
import com.yahoo.document.DocumentPut;
import com.yahoo.document.DocumentOperation;
import com.yahoo.document.DocumentType;
import com.yahoo.document.DocumentTypeManager;
import com.yahoo.document.DocumentUpdate;
import com.yahoo.document.config.DocumentmanagerConfig;
import com.yahoo.document.datatypes.StringFieldValue;
import com.yahoo.document.update.AssignValueUpdate;
import com.yahoo.document.update.FieldUpdate;
import com.yahoo.document.update.ValueUpdate;
import com.yahoo.language.simple.SimpleLinguistics;
import com.yahoo.vespa.configdefinition.IlscriptsConfig;
import org.junit.Test;

import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;

/**
 * @author Simon Thoresen Hult
 * @author bratseth
 */
public class IndexingProcessorTestCase {

    private static final String CONFIG_ID = "dir:src/test/cfg";

    private final IndexingProcessor indexer = newProcessor(CONFIG_ID);

    @Test
    public void requireThatIndexerForwardsDocumentsOfUnknownType() {
        Document input = new Document(new DocumentType("unknown"), "id:ns:unknown::");
        DocumentOperation output = process(new DocumentPut(input));
        assertTrue(output instanceof DocumentPut);
        assertSame(input, ((DocumentPut)output).getDocument());
    }

    @Test
    public void testPut() {
        // 'combined' gets the value of both
        // 'combinedWithFallback' falls back to an empty string if an input is missing

        {   // Both artist and title are set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentPut input = new DocumentPut(inputType, "id:ns:music::");
            input.getDocument().setFieldValue(inputType.getField("artist"), new StringFieldValue("artist1"));
            input.getDocument().setFieldValue(inputType.getField("title"), new StringFieldValue("title1"));

            Document output = ((DocumentPut)process(input)).getDocument();
            assertEquals("artist1", output.getFieldValue("artist").getWrappedValue());
            assertEquals("title1", output.getFieldValue("title").getWrappedValue());
            assertNull(output.getFieldValue("song"));
            assertEquals("artist1 title1", output.getFieldValue("combined").getWrappedValue());
            assertEquals("artist1 title1", output.getFieldValue("combinedWithFallback").getWrappedValue());
        }

        {   // Just artist is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentPut input = new DocumentPut(inputType, "id:ns:music::");
            input.getDocument().setFieldValue(inputType.getField("artist"), new StringFieldValue("artist1"));

            Document output = ((DocumentPut)process(input)).getDocument();
            assertEquals("artist1", output.getFieldValue("artist").getWrappedValue());
            assertNull(output.getFieldValue("title"));
            assertNull(output.getFieldValue("song"));
            assertNull(output.getFieldValue("combined"));
            assertEquals("artist1 ", output.getFieldValue("combinedWithFallback").getWrappedValue());
        }

        {   // Just title is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentPut input = new DocumentPut(inputType, "id:ns:music::");
            input.getDocument().setFieldValue(inputType.getField("title"), new StringFieldValue("title1"));

            Document output = ((DocumentPut)process(input)).getDocument();
            assertEquals("title1", output.getFieldValue("title").getWrappedValue());
            assertNull(output.getFieldValue("artist"));
            assertNull(output.getFieldValue("song"));
            assertNull(output.getFieldValue("combined"));
            assertEquals(" title1", output.getFieldValue("combinedWithFallback").getWrappedValue());
        }

        {   // Neither title nor artist is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentPut input = new DocumentPut(inputType, "id:ns:music::");
            input.getDocument().setFieldValue(inputType.getField("song"), new StringFieldValue("song1"));

            Document output = ((DocumentPut)process(input)).getDocument();
            assertNull(output.getFieldValue("artist"));
            assertNull(output.getFieldValue("title"));
            assertEquals("song1", output.getFieldValue("song").getWrappedValue());
            assertNull(output.getFieldValue("combined"));
            assertEquals(" ", output.getFieldValue("combinedWithFallback").getWrappedValue());
        }

        {   // None is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentPut input = new DocumentPut(inputType, "id:ns:music::");

            Document output = ((DocumentPut)process(input)).getDocument();
            assertNull(output.getFieldValue("artist"));
            assertNull(output.getFieldValue("title"));
            assertNull(output.getFieldValue("song"));
            assertNull(output.getFieldValue("combined"));
            assertEquals(" ", output.getFieldValue("combinedWithFallback").getWrappedValue());
        }
    }

    @Test
    public void testUpdate() {
        // 'combined' gets the value of artist and title
        // 'combinedWithFallback' falls back to an empty string if an input is missing

        {   // Both artist and title are set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentUpdate input = new DocumentUpdate(inputType, "id:ns:music::");
            input.addFieldUpdate(FieldUpdate.createAssign(inputType.getField("artist"), new StringFieldValue("artist1")));
            input.addFieldUpdate(FieldUpdate.createAssign(inputType.getField("title"), new StringFieldValue("title1")));

            DocumentUpdate output = (DocumentUpdate)process(input);
            assertEquals(4, output.fieldUpdates().size());
            assertAssignment("artist", "artist1", output);
            assertAssignment("title", "title1", output);
            assertAssignment("combined", "artist1 title1", output);
            assertAssignment("combinedWithFallback", "artist1 title1", output);
        }

        {   // Just artist is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentUpdate input = new DocumentUpdate(inputType, "id:ns:music::");
            input.addFieldUpdate(FieldUpdate.createAssign(inputType.getField("artist"), new StringFieldValue("artist1")));

            DocumentUpdate output = (DocumentUpdate)process(input);
            assertEquals(2, output.fieldUpdates().size());
            assertAssignment("artist", "artist1", output);
            assertAssignment("combinedWithFallback", "artist1 ", output);
        }

        {   // Just title is set
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentUpdate input = new DocumentUpdate(inputType, "id:ns:music::");
            input.addFieldUpdate(FieldUpdate.createAssign(inputType.getField("title"), new StringFieldValue("title1")));

            DocumentUpdate output = (DocumentUpdate)process(input);
            assertEquals(2, output.fieldUpdates().size());
            assertAssignment("title", "title1", output);
            assertAssignment("combinedWithFallback", " title1", output);
        }

        {   // Neither title nor artist is set: Should not update embeddings even though it has fallbacks for all
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentUpdate input = new DocumentUpdate(inputType, "id:ns:music::");
            input.addFieldUpdate(FieldUpdate.createAssign(inputType.getField("song"), new StringFieldValue("song1")));

            DocumentUpdate output = (DocumentUpdate)process(input);
            assertEquals(1, output.fieldUpdates().size());
            assertAssignment("song", "song1", output);
        }

        {   // None is set: Should not update anything
            DocumentType inputType = indexer.getDocumentTypeManager().getDocumentType("music");
            DocumentUpdate input = new DocumentUpdate(inputType, "id:ns:music::");

            DocumentUpdate output = (DocumentUpdate)process(input);
            assertNull(output);
        }
    }

    @Test
    public void requireThatIndexerForwardsUpdatesOfUnknownType() {
        DocumentUpdate input = new DocumentUpdate(new DocumentType("unknown"), "id:ns:music::");
        DocumentOperation output = process(input);
        assertSame(input, output);
    }

    private void assertAssignment(String fieldName, String value, DocumentUpdate output) {
        FieldUpdate update = output.getFieldUpdate(fieldName);
        assertNotNull("Update of '" + fieldName + "' exists", update);
        assertEquals(fieldName, update.getField().getName());
        assertEquals(1, update.getValueUpdates().size());
        ValueUpdate<?> combinedAssignment = update.getValueUpdate(0);
        assertTrue(combinedAssignment instanceof AssignValueUpdate);
        assertEquals(new StringFieldValue(value), combinedAssignment.getValue());
    }

    private DocumentOperation process(DocumentOperation input) {
        Processing proc = new Processing();
        proc.getDocumentOperations().add(input);
        indexer.process(proc);

        List<DocumentOperation> operations = proc.getDocumentOperations();
        if (operations.isEmpty()) return null;
        assertEquals(1, operations.size());
        return operations.get(0);
    }

    @SuppressWarnings("deprecation")
    private static IndexingProcessor newProcessor(String configId) {
        return new IndexingProcessor(new DocumentTypeManager(ConfigGetter.getConfig(DocumentmanagerConfig.class, configId)),
                                     ConfigGetter.getConfig(IlscriptsConfig.class, configId),
                                     new SimpleLinguistics(),
                                     new ComponentRegistry<>());
    }
}