summaryrefslogtreecommitdiff
path: root/src/test/java/com/amazon/carbonado/qe/TestUnionQueryAnalyzer.java
blob: 0278eab00da9a3d46abebda6c29b85472201a1c6 (plain)
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
/*
 * Copyright 2006 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * Licensed 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 com.amazon.carbonado.qe;

import java.util.List;

import junit.framework.TestCase;
import junit.framework.TestSuite;

import com.amazon.carbonado.Repository;
import com.amazon.carbonado.Storable;

import com.amazon.carbonado.info.OrderedProperty;
import com.amazon.carbonado.info.StorableIndex;

import com.amazon.carbonado.filter.Filter;
import com.amazon.carbonado.filter.FilterValues;
import com.amazon.carbonado.filter.PropertyFilter;

import com.amazon.carbonado.repo.toy.ToyRepository;

import com.amazon.carbonado.stored.Address;
import com.amazon.carbonado.stored.Order;
import com.amazon.carbonado.stored.Shipment;
import com.amazon.carbonado.stored.Shipper;

import static com.amazon.carbonado.qe.TestIndexedQueryExecutor.Mock;

/**
 * 
 *
 * @author Brian S O'Neill
 */
public class TestUnionQueryAnalyzer extends TestCase {
    public static void main(String[] args) {
        junit.textui.TestRunner.run(suite());
    }

    public static TestSuite suite() {
        return new TestSuite(TestUnionQueryAnalyzer.class);
    }

    static <S extends Storable> StorableIndex<S> makeIndex(Class<S> type, String... props) {
        return TestOrderingScore.makeIndex(type, props);
    }

    static <S extends Storable> OrderingList<S> makeOrdering(Class<S> type, String... props) {
        return TestOrderingScore.makeOrdering(type, props);
    }

    public TestUnionQueryAnalyzer(String name) {
        super(name);
    }

    public void testNullFilter() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        UnionQueryAnalyzer.Result result = uqa.analyze(null, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
    }

    public void testSingleSubResult() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class, "shipmentID = ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
    }

    public void testSingleSubResultUnspecifiedDirection() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class, "shipmentID > ?");
        filter = filter.bind();
        OrderingList<Shipment> orderings =
            makeOrdering(Shipment.class, "~shipmentID", "~orderID");
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, orderings);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
        List<OrderedProperty<Shipment>> handled = 
            subResults.get(0).getCompositeScore().getOrderingScore().getHandledOrdering();
        assertEquals(1, handled.size());
        assertEquals("+shipmentID", handled.get(0).toString());
    }

    public void testSimpleUnion() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class,
                                                   "shipmentID = ? | orderID = ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(2, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);
        IndexedQueryAnalyzer<Shipment>.Result res_1 = subResults.get(1);

        assertTrue(res_0.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentID = ?").bind(),
                     res_0.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());

        assertTrue(res_1.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "orderID = ?").bind(),
                     res_1.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "orderID"), res_1.getLocalIndex());
        assertEquals(null, res_1.getForeignIndex());
        assertEquals(null, res_1.getForeignProperty());
        assertEquals(1, res_1.getRemainderOrdering().size());
        assertEquals("+shipmentID", res_1.getRemainderOrdering().get(0).toString());
    }
 
    public void testSimpleUnion2() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class,
                                                   "shipmentID = ? | orderID > ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(2, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);
        IndexedQueryAnalyzer<Shipment>.Result res_1 = subResults.get(1);

        assertTrue(res_0.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentID = ?").bind(),
                     res_0.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());

        // Note: index that has proper ordering is preferred because "orderId > ?"
        // filter does not specify a complete range. It is not expected to actually
        // filter much, so we choose to avoid a large sort instead.
        assertTrue(res_1.handlesAnything());
        assertFalse(res_1.getCompositeScore().getFilteringScore().hasRangeStart());
        assertFalse(res_1.getCompositeScore().getFilteringScore().hasRangeEnd());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_1.getLocalIndex());
        assertEquals(null, res_1.getForeignIndex());
        assertEquals(null, res_1.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());
        // Remainder filter exists because the "orderID" index was not chosen.
        assertEquals(Filter.filterFor(Shipment.class, "orderID > ?").bind(),
                     res_1.getRemainderFilter());
    }

    public void testSimpleUnion3() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class,
                                                   "shipmentID = ? | orderID > ? & orderID <= ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(2, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);
        IndexedQueryAnalyzer<Shipment>.Result res_1 = subResults.get(1);

        assertTrue(res_0.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentID = ?").bind(),
                     res_0.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());

        // Note: index that has proper filtering is preferred because
        // "orderId > ? & orderID <= ?" filter specifies a complete range.
        // We'll have to do a sort, but it isn't expected to be over that many records.
        assertTrue(res_1.handlesAnything());
        assertTrue(res_1.getCompositeScore().getFilteringScore().hasRangeStart());
        assertTrue(res_1.getCompositeScore().getFilteringScore().hasRangeEnd());
        List<PropertyFilter<Shipment>> rangeFilters =
            res_1.getCompositeScore().getFilteringScore().getRangeStartFilters();
        assertEquals(1, rangeFilters.size());
        assertEquals(Filter.filterFor(Shipment.class, "orderID > ?").bind(), rangeFilters.get(0));
        rangeFilters = res_1.getCompositeScore().getFilteringScore().getRangeEndFilters();
        assertEquals(1, rangeFilters.size());
        assertEquals(Filter.filterFor(Shipment.class, "orderID <= ?").bind(), rangeFilters.get(0));
        assertEquals(makeIndex(Shipment.class, "orderID"), res_1.getLocalIndex());
        assertEquals(null, res_1.getForeignIndex());
        assertEquals(null, res_1.getForeignProperty());
        // Sort operation required because the "shipmentID" index was not chosen.
        assertEquals("+shipmentID", res_1.getRemainderOrdering().get(0).toString());
    }

    public void testSimpleUnionUnspecifiedDirection() throws Exception {
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor(Shipment.class,
                                                   "shipmentID > ? | orderID = ?");
        filter = filter.bind();
        OrderingList<Shipment> orderings =
            makeOrdering(Shipment.class, "~shipmentID", "~orderID");
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, orderings);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(2, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);
        IndexedQueryAnalyzer<Shipment>.Result res_1 = subResults.get(1);

        List<OrderedProperty<Shipment>> handled =
            res_0.getCompositeScore().getOrderingScore().getHandledOrdering();
        assertEquals(1, handled.size());
        assertEquals("+shipmentID", handled.get(0).toString());

        handled = res_1.getCompositeScore().getOrderingScore().getHandledOrdering();
        assertEquals(0, handled.size());

        assertTrue(res_0.handlesAnything());
        assertTrue(res_0.getCompositeScore().getFilteringScore().hasRangeStart());
        assertFalse(res_0.getCompositeScore().getFilteringScore().hasRangeEnd());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(1, res_0.getRemainderOrdering().size());
        assertEquals("+orderID", res_0.getRemainderOrdering().get(0).toString());

        assertTrue(res_1.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "orderID = ?").bind(),
                     res_1.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "orderID"), res_1.getLocalIndex());
        assertEquals(null, res_1.getForeignIndex());
        assertEquals(null, res_1.getForeignProperty());
        assertEquals(1, res_1.getRemainderOrdering().size());
        assertEquals("+shipmentID", res_1.getRemainderOrdering().get(0).toString());
    }

    public void testSimpleMerge() throws Exception {
        // Because query has an 'or' operation, the analyzer will initially
        // split this into a union. After futher analysis, it should decide
        // that this offers no benefit and will merge them back.
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor
            (Shipment.class,
             "shipmentID = ? & (shipmentID = ? | orderID = ?)");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);

        assertTrue(res_0.handlesAnything());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentID = ?").bind(),
                     res_0.getCompositeScore().getFilteringScore().getIdentityFilter());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentID = ? | orderID = ?"),
                     res_0.getRemainderFilter().unbind());
    }

    public void testFullScan() throws Exception {
        // Because no indexes were selected, there's no union to perform.
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor
            (Shipment.class, "shipmentNotes = ? | shipperID = ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);

        assertFalse(res_0.handlesAnything());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentNotes = ? | shipperID = ?").bind(),
                     res_0.getRemainderFilter());
    }

    public void testFullScanFallback() throws Exception {
        // Because not all sub-results of union use an index, just fallback to
        // doing a full scan.
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor
            (Shipment.class, "shipmentNotes = ? | orderID = ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(1, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);

        assertFalse(res_0.handlesAnything());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentNotes = ? | orderID = ?").bind(),
                     res_0.getRemainderFilter());
    }

    public void testFullScanExempt() throws Exception {
        // Although not all sub-results use an index, one that does has a join
        // so it is exempt from folding into the full scan.
        UnionQueryAnalyzer uqa =
            new UnionQueryAnalyzer(Shipment.class, TestIndexedQueryAnalyzer.RepoAccess.INSTANCE);
        Filter<Shipment> filter = Filter.filterFor
            (Shipment.class, "shipmentNotes = ? | orderID = ? & order.orderTotal > ?");
        filter = filter.bind();
        UnionQueryAnalyzer.Result result = uqa.analyze(filter, null);
        List<IndexedQueryAnalyzer<Shipment>.Result> subResults = result.getSubResults();

        assertEquals(2, subResults.size());
        IndexedQueryAnalyzer<Shipment>.Result res_0 = subResults.get(0);
        IndexedQueryAnalyzer<Shipment>.Result res_1 = subResults.get(1);

        assertTrue(res_0.handlesAnything());
        assertEquals(makeIndex(Shipment.class, "shipmentID"), res_0.getLocalIndex());
        assertEquals(null, res_0.getForeignIndex());
        assertEquals(null, res_0.getForeignProperty());
        assertEquals(0, res_0.getRemainderOrdering().size());
        assertEquals(Filter.filterFor(Shipment.class, "shipmentNotes = ?").bind(),
                     res_0.getRemainderFilter());

        assertTrue(res_1.handlesAnything());
        assertEquals(makeIndex(Shipment.class, "orderID"), res_1.getLocalIndex());
        assertEquals(null, res_1.getForeignIndex());
        assertEquals(null, res_1.getForeignProperty());
        assertEquals(1, res_1.getRemainderOrdering().size());
        assertEquals("+shipmentID", res_1.getRemainderOrdering().get(0).toString());
        assertEquals(Filter.filterFor(Shipment.class, "order.orderTotal > ?").bind(),
                     res_1.getRemainderFilter());
    }
}