aboutsummaryrefslogtreecommitdiffstats
path: root/document/src/test/java/com/yahoo/document/datatypes/ReferenceFieldValueTestCase.java
blob: 9ff15339ab4b53a29fbf55cceddd95f2de14ecec (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
215
216
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.document.datatypes;

import com.yahoo.document.DataType;
import com.yahoo.document.DocumentId;
import com.yahoo.document.DocumentType;
import com.yahoo.document.Field;
import com.yahoo.document.ReferenceDataType;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

/**
 * @author vekterli
 * @since 6.65
 */
public class ReferenceFieldValueTestCase {

    private static DocumentType createDocumentType(String name) {
        DocumentType type = new DocumentType(name);
        type.addField(new Field("foo", DataType.STRING));
        return type;
    }

    private static ReferenceDataType createReferenceType(String documentTypeName, int id) {
        return new ReferenceDataType(createDocumentType(documentTypeName), id);
    }

    private static ReferenceDataType referenceTypeFoo() {
        return createReferenceType("foo", 1234);
    }

    private static ReferenceDataType referenceTypeFooDifferentId() {
        return createReferenceType("foo", 5678);
    }

    private static ReferenceDataType referenceTypeBar() {
        return createReferenceType("bar", 7654);
    }

    private static DocumentId docId(String idString) {
        return new DocumentId(idString);
    }

    @Test
    public void default_constructed_reference_is_empty_and_bound_to_type() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        assertFalse(value.getDocumentId().isPresent());
        assertEquals(referenceTypeFoo(), value.getDataType());
    }

    @Test
    public void factory_method_creates_empty_reference_bound_to_type() {
        ReferenceFieldValue value = ReferenceFieldValue.createEmptyWithType(referenceTypeFoo());
        assertFalse(value.getDocumentId().isPresent());
        assertEquals(referenceTypeFoo(), value.getDataType());
    }

    @Test
    public void reference_can_be_constructed_with_id() {
        DocumentId id = docId("id:ns:foo::itsa-me");
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo(), id);
        assertTrue(value.getDocumentId().isPresent());
        assertEquals(id, value.getDocumentId().get());
    }

    @Test
    public void can_explicitly_set_new_id_for_existing_reference() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        DocumentId newId = docId("id:ns:foo::wario-time");
        value.setDocumentId(newId);
        assertTrue(value.getDocumentId().isPresent());
        assertEquals(newId, value.getDocumentId().get());
    }

    @Test
    public void can_assign_new_id_for_existing_reference() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        DocumentId newId = docId("id:ns:foo::wario-time");
        value.assign(newId);
        assertTrue(value.getDocumentId().isPresent());
        assertEquals(newId, value.getDocumentId().get());
    }

    // This is legacy behaviour and does not smell entirely nice.
    @Test
    public void assigning_null_implies_clearing_id() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        value.assign(null);
        assertFalse(value.getDocumentId().isPresent());
    }

    @Test(expected = IllegalArgumentException.class)
    public void assigning_non_reference_field_value_instance_throws_exception() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        value.assign("nope!");
    }

    @Test
    public void can_assign_empty_reference_field_value_instance_to_existing_reference() {
        ReferenceFieldValue existing = new ReferenceFieldValue(referenceTypeFoo());
        ReferenceFieldValue newValue = new ReferenceFieldValue(referenceTypeFoo());
        // Logically a no-op, but still worth testing.
        existing.assign(newValue);
        assertEquals(newValue, existing);
    }

    @Test
    public void can_assign_reference_field_value_instance_with_id_to_existing_reference() {
        ReferenceFieldValue existing = new ReferenceFieldValue(referenceTypeFoo());
        ReferenceFieldValue newValue = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        existing.assign(newValue);
        assertEquals(newValue, existing);
    }

    @Test
    public void assigning_reference_field_with_different_type_to_existing_reference_throws_exception() {
        ReferenceFieldValue existing = new ReferenceFieldValue(referenceTypeFoo());
        ReferenceFieldValue newValue = new ReferenceFieldValue(referenceTypeBar());
        try {
            existing.assign(newValue);
            fail();
        } catch (IllegalArgumentException e) {
            assertEquals("Can't assign reference of type Reference<bar> to reference of type Reference<foo>",
                    e.getMessage());
        }
    }

    @Test
    public void reference_value_can_be_cleared() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::yoshi-egg-feast"));
        value.clear();
        assertFalse(value.getDocumentId().isPresent());
    }

    @Test
    public void references_with_different_type_ids_are_not_equal() {
        ReferenceFieldValue lhs = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        ReferenceFieldValue rhs = new ReferenceFieldValue(referenceTypeFooDifferentId(), docId("id:ns:foo::toad"));
        assertNotEquals(lhs, rhs);
    }

    @Test
    public void references_with_different_document_ids_are_not_equal() {
        ReferenceFieldValue lhs = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::peach"));
        ReferenceFieldValue rhs = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::bowser"));
        assertNotEquals(lhs, rhs);
    }

    @Test
    public void references_with_same_type_and_id_are_equal() {
        ReferenceFieldValue lhs = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        ReferenceFieldValue rhs = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        assertEquals(lhs, rhs);
    }
    @Test
    public void references_with_same_type_and_no_id_are_equal() {
        ReferenceFieldValue lhs = new ReferenceFieldValue(referenceTypeFoo());
        ReferenceFieldValue rhs = new ReferenceFieldValue(referenceTypeFoo());
        assertEquals(lhs, rhs);
    }

    @Test
    public void hash_code_takes_type_and_id_into_account() {
        ReferenceFieldValue fooField = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        ReferenceFieldValue barField = new ReferenceFieldValue(referenceTypeBar(), docId("id:ns:bar::toad"));
        ReferenceFieldValue fooFieldWithDifferentId = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::luigi"));

        // ... with a very high probability:
        assertNotEquals(fooField.hashCode(), barField.hashCode());
        assertNotEquals(fooField.hashCode(), fooFieldWithDifferentId.hashCode());
        assertNotEquals(barField.hashCode(), fooFieldWithDifferentId.hashCode());
    }

    @Test(expected = IllegalArgumentException.class)
    public void reference_constructor_requires_that_id_has_same_document_type_as_data_type() {
        new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:bar::mismatch"));
    }

    @Test(expected = IllegalArgumentException.class)
    public void reference_doc_id_setter_requires_that_id_has_same_document_type_as_data_type() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        value.setDocumentId(docId("id:ns:bar::mismatch"));
    }

    @Test(expected = IllegalArgumentException.class)
    public void assigning_new_id_for_existing_reference_requires_that_id_has_same_document_type_as_data_type() {
        ReferenceFieldValue value = new ReferenceFieldValue(referenceTypeFoo());
        DocumentId newId = docId("id:ns:bar::mama-mia");
        value.assign(newId);
    }

    @Test
    public void exposed_wrapped_value_is_null_for_empty_reference() {
        ReferenceFieldValue nullRef = new ReferenceFieldValue(referenceTypeFoo());
        assertNull(nullRef.getWrappedValue());
    }

    @Test
    public void expose_wrapped_value_is_doc_id_for_non_empty_reference() {
        ReferenceFieldValue idRef = new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad"));
        assertEquals(docId("id:ns:foo::toad"), idRef.getWrappedValue());
    }

    @Test
    public void that_toString_provides_value() {
        assertEquals("Optional.empty", new ReferenceFieldValue(referenceTypeFoo()).toString());
        assertEquals("Optional[id:ns:foo::toad]", new ReferenceFieldValue(referenceTypeFoo(), docId("id:ns:foo::toad")).toString());
    }

}