aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/test/java/com/yahoo/search/query/profile/types/test/OverrideTestCase.java
blob: 69d577719c5350feff0469313cc8393588bb7510 (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.query.profile.types.test;

import com.yahoo.jdisc.http.HttpRequest.Method;
import com.yahoo.container.jdisc.HttpRequest;
import com.yahoo.component.ComponentId;
import com.yahoo.search.Query;
import com.yahoo.search.query.profile.DimensionValues;
import com.yahoo.search.query.profile.QueryProfile;
import com.yahoo.search.query.profile.QueryProfileRegistry;
import com.yahoo.search.query.profile.compiled.CompiledQueryProfileRegistry;
import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.FieldType;
import com.yahoo.search.query.profile.types.QueryProfileType;
import com.yahoo.search.query.profile.types.QueryProfileTypeRegistry;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

/**
 * Tests overriding of field values
 *
 * @author bratseth
 */
public class OverrideTestCase {

    private QueryProfileTypeRegistry registry;

    private QueryProfileType type, user;

    @BeforeEach
    public void setUp() {
        type=new QueryProfileType(new ComponentId("testtype"));
        user=new QueryProfileType(new ComponentId("user"));
        registry=new QueryProfileTypeRegistry();
        registry.register(type);
        registry.register(user);

        addTypeFields(type);
        addUserFields(user);
    }

    private void addTypeFields(QueryProfileType type) {
        boolean overridable=true;
        type.addField(new FieldDescription("myString", FieldType.fromString("string",registry),false,!overridable));
        type.addField(new FieldDescription("myInteger",FieldType.fromString("integer",registry)));
        type.addField(new FieldDescription("myLong",FieldType.fromString("long",registry)));
        type.addField(new FieldDescription("myFloat",FieldType.fromString("float",registry)));
        type.addField(new FieldDescription("myDouble",FieldType.fromString("double",registry)));
        type.addField(new FieldDescription("myQueryProfile",FieldType.fromString("query-profile",registry)));
        type.addField(new FieldDescription("myUserQueryProfile", FieldType.fromString("query-profile:user",registry),false,!overridable));
    }

    private void addUserFields(QueryProfileType user) {
        boolean overridable=true;
        user.addField(new FieldDescription("myUserString",FieldType.fromString("string",registry),false,!overridable));
        user.addField(new FieldDescription("myUserInteger",FieldType.fromString("integer",registry)));
    }

    /** Check that a simple non-overridable string cannot be overridden */
    @Test
    void testSimpleUnoverridable() {
        QueryProfileRegistry registry = new QueryProfileRegistry();
        QueryProfile test = new QueryProfile("test");
        test.setType(type);
        test.set("myString", "finalString", (QueryProfileRegistry) null);
        registry.register(test);
        registry.freeze();

        // Assert request assignment does not work
        Query query = new Query(HttpRequest.createTestRequest("?myString=newValue", Method.GET), registry.compile().getComponent("test"));
        assertEquals(0, query.errors().size());
        assertEquals("finalString", query.properties().get("myString"));

        // Assert direct assignment does not work
        query.properties().set("myString", "newValue");
        assertEquals("finalString", query.properties().get("myString"));
    }

    /** Check that a query profile cannot be overridden */
    @Test
    void testUnoverridableQueryProfile() {
        QueryProfileRegistry registry = new QueryProfileRegistry();

        QueryProfile test = new QueryProfile("test");
        test.setType(type);
        registry.register(test);

        QueryProfile myUser = new QueryProfile("user");
        myUser.setType(user);
        myUser.set("myUserInteger", 1, registry);
        myUser.set("myUserString", "userValue", registry);
        test.set("myUserQueryProfile", myUser, registry);
        registry.register(myUser);

        QueryProfile otherUser = new QueryProfile("otherUser");
        otherUser.setType(user);
        otherUser.set("myUserInteger", 2, registry);
        registry.register(otherUser);

        CompiledQueryProfileRegistry cRegistry = registry.compile();

        Query query = new Query(HttpRequest.createTestRequest("?myUserQueryprofile=otherUser", Method.GET), cRegistry.getComponent("test"));
        assertEquals(0, query.errors().size());
        assertEquals(1, query.properties().get("myUserQueryProfile.myUserInteger"));
    }

    /** Check that non-overridables are protected also in nested untyped references */
    @Test
    void testUntypedNestedUnoverridable() {
        QueryProfileRegistry registry = new QueryProfileRegistry();
        QueryProfile topMap = new QueryProfile("topMap");
        registry.register(topMap);

        QueryProfile subMap = new QueryProfile("topSubMap");
        topMap.set("subMap", subMap, registry);
        registry.register(subMap);

        QueryProfile test = new QueryProfile("test");
        test.setType(type);
        subMap.set("test", test, registry);
        registry.register(test);

        QueryProfile myUser = new QueryProfile("user");
        myUser.setType(user);
        myUser.set("myUserString", "finalValue", registry);
        test.set("myUserQueryProfile", myUser, registry);
        registry.register(myUser);

        registry.freeze();
        Query query = new Query(HttpRequest.createTestRequest("?subMap.test.myUserQueryProfile.myUserString=newValue", Method.GET), registry.compile().getComponent("topMap"));
        assertEquals(0, query.errors().size());
        assertEquals("finalValue", query.properties().get("subMap.test.myUserQueryProfile.myUserString"));

        query.properties().set("subMap.test.myUserQueryProfile.myUserString", "newValue");
        assertEquals("finalValue", query.properties().get("subMap.test.myUserQueryProfile.myUserString"));
    }

    /** Tests overridability in an inherited field */
    @Test
    void testInheritedNonOverridableInType() {
        QueryProfileRegistry registry = new QueryProfileRegistry();

        QueryProfile test = new QueryProfile("test");
        test.setType(type);
        test.set("myString", "finalString", (QueryProfileRegistry) null);
        registry.register(test);

        QueryProfile profile = new QueryProfile("profile");
        profile.addInherited(test);
        registry.register(profile);

        registry.freeze();

        Query query = new Query(HttpRequest.createTestRequest("?myString=newString", Method.GET), registry.compile().getComponent("test"));

        assertEquals(0, query.errors().size());
        assertEquals("finalString", query.properties().get("myString"));

        query.properties().set("myString", "newString");
        assertEquals("finalString", query.properties().get("myString"));
    }

    /** Tests overridability in an inherited field */
    @Test
    void testInheritedNonOverridableInProfile() {
        QueryProfileRegistry registry = new QueryProfileRegistry();
        QueryProfile test = new QueryProfile("test");
        test.setType(type);
        test.set("myInteger", 1, registry);
        test.setOverridable("myInteger", false, DimensionValues.empty);
        registry.register(test);

        QueryProfile profile = new QueryProfile("profile");
        profile.addInherited(test);
        registry.register(profile);

        registry.freeze();

        Query query = new Query(HttpRequest.createTestRequest("?myInteger=32", Method.GET), registry.compile().getComponent("test"));

        assertEquals(0, query.errors().size());
        assertEquals(1, query.properties().get("myInteger"));

        query.properties().set("myInteger", 32);
        assertEquals(1, query.properties().get("myInteger"));
    }

}