summaryrefslogtreecommitdiffstats
path: root/document/src/tests/base/documentid_test.cpp
blob: adb999d7430b81644689f5622233430635e2d40e (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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// Unit tests for documentid.

#include <vespa/document/base/documentid.h>
#include <vespa/document/base/idstringexception.h>
#include <vespa/vespalib/testkit/testapp.h>

using namespace document;
using vespalib::string;

namespace {

const string ns = "namespace";
const string ns_id = "namespaceid";
const string type = "my_type";

void checkId(const string &id, IdString::Type t,
             const string &ns_str, const string local_id) {
    DocumentId doc_id(id);
    EXPECT_EQUAL(t, doc_id.getScheme().getType());
    EXPECT_EQUAL(ns_str, doc_id.getScheme().getNamespace());
    EXPECT_EQUAL(local_id, doc_id.getScheme().getNamespaceSpecific());
    EXPECT_EQUAL(id, doc_id.getScheme().toString());
}

template <typename IdType>
const IdType &getAs(const DocumentId &doc_id) {
    const IdType *id_str = dynamic_cast<const IdType *>(&doc_id.getScheme());
    ASSERT_TRUE(id_str);
    return *id_str;
}

template <typename IdType>
void checkUser(const string &id, int64_t user_id) {
    DocumentId doc_id(id);
    EXPECT_EQUAL(user_id, getAs<IdType>(doc_id).getUserId());
}

void checkOrdering(const string &id, uint64_t ordering) {
    DocumentId doc_id(id);
    EXPECT_EQUAL(ordering, getAs<OrderDocIdString>(doc_id).getOrdering());
}

void checkGroup(const string &id, const string &group) {
    DocumentId doc_id(id);
    EXPECT_EQUAL(group, getAs<GroupDocIdString>(doc_id).getGroup());
}

void checkType(const string &id, const string &doc_type) {
    DocumentId doc_id(id);
    ASSERT_TRUE(doc_id.hasDocType());
    EXPECT_EQUAL(doc_type, doc_id.getDocType());
}

TEST("require that doc id can be parsed") {
    const string id = "doc:" + ns + ":" + ns_id;
    checkId(id, IdString::DOC, ns, ns_id);
}

TEST("require that userdoc id can be parsed") {
    const string id = "userdoc:" + ns + ":1234:" + ns_id;
    checkId(id, IdString::USERDOC, ns, ns_id);
    checkUser<UserDocIdString>(id, 1234);
}

TEST("require that orderdoc id can be parsed") {
    const string id = "orderdoc(31,19):" + ns + ":1234:1268182861:" + ns_id;
    checkId(id, IdString::ORDERDOC, ns, ns_id);
    checkUser<OrderDocIdString>(id, 1234);
    checkOrdering(id, 1268182861);
}

TEST("require that groupdoc id can be parsed") {
    const string group = "mygroup";
    const string id = "groupdoc:" + ns + ":" + group + ":" + ns_id;
    checkId(id, IdString::GROUPDOC, ns, ns_id);
    checkGroup(id, group);
}

TEST("require that id id can be parsed") {
    const string id = "id:" + ns + ":" + type + "::" + ns_id;
    checkId(id, IdString::ID, ns, ns_id);
    checkType(id, type);
}

TEST("require that we allow ':' in namespace specific part") {
    const string nss=":a:b:c:";
    string id="id:" + ns + ":" + type + "::" + nss;
    checkId(id, IdString::ID, ns, nss);
    checkType(id, type);

    id="doc:" + ns + ":" + nss;
    checkId(id, IdString::DOC, ns, nss);

    id="userdoc:" + ns + ":123:" + nss;
    checkId(id, IdString::USERDOC, ns, nss);
    checkUser<UserDocIdString>(id, 123);

    id="groupdoc:" + ns + ":123:" + nss;
    checkId(id, IdString::GROUPDOC, ns, nss);
    checkGroup(id, "123");

    id="orderdoc(5,2):" + ns + ":42:007:" + nss;
    checkId(id, IdString::ORDERDOC, ns, nss);
}

TEST("require that id id can specify location") {
    DocumentId id("id:ns:type:n=12345:foo");
    EXPECT_EQUAL(12345u, id.getScheme().getLocation());
    EXPECT_EQUAL(12345u, getAs<IdIdString>(id).getNumber());
}

TEST("require that id id's n key must be a 64-bit number") {
    EXPECT_EXCEPTION(DocumentId("id:ns:type:n=abc:foo"), IdParseException,
                     "'n'-value must be a 64-bit number");
    DocumentId("id:ns:type:n=18446744073709551615:foo");  // ok
    EXPECT_EXCEPTION(DocumentId("id:ns:type:n=18446744073709551616:foo"),
                     IdParseException, "'n'-value out of range");
}

TEST("require that id id can specify group") {
    DocumentId id1("id:ns:type:g=mygroup:foo");
    DocumentId id2("id:ns:type:g=mygroup:bar");
    DocumentId id3("id:ns:type:g=other group:baz");
    EXPECT_EQUAL(id1.getScheme().getLocation(), id2.getScheme().getLocation());
    EXPECT_NOT_EQUAL(id1.getScheme().getLocation(),
                     id3.getScheme().getLocation());
    EXPECT_EQUAL("mygroup", getAs<IdIdString>(id1).getGroup());
}

TEST("require that id id location is specified by local id only by default") {
    DocumentId id1("id:ns:type::locationspec");
    DocumentId id2("id:ns:type:g=locationspec:bar");
    EXPECT_EQUAL("locationspec", id1.getScheme().getNamespaceSpecific());
    EXPECT_EQUAL("bar", id2.getScheme().getNamespaceSpecific());
    EXPECT_EQUAL(id1.getScheme().getLocation(), id2.getScheme().getLocation());
}

TEST("require that local id can be empty") {
    const string id = "userdoc:" + ns + ":1234:";
    checkId(id, IdString::USERDOC, ns, "");
    checkUser<UserDocIdString>(id, 1234);
}

TEST("require that document ids can be assigned") {
    DocumentId id1("userdoc:" + ns + ":1234:");
    DocumentId id2 = id1;
    checkId(id2.toString(), IdString::USERDOC, ns, "");
    checkUser<UserDocIdString>(id2.toString(), 1234);
}

TEST("require that illegal ids fail") {
    EXPECT_EXCEPTION(DocumentId("idg:foo:bar:baz"), IdParseException,
                     "No scheme separator ':' found");
    EXPECT_EXCEPTION(DocumentId("id:"), IdParseException, "too short");
    EXPECT_EXCEPTION(DocumentId("id:ns"), IdParseException,
                     "No namespace separator ':' found");
    EXPECT_EXCEPTION(DocumentId("id:ns:type"), IdParseException,
                     "No document type separator ':' found");
    EXPECT_EXCEPTION(DocumentId("id:ns:type:kv_pair"), IdParseException,
                     "No key/value-pairs separator ':' found");
    EXPECT_EXCEPTION(DocumentId("id:ns:type:k=foo:bar"), IdParseException,
                     "Illegal key 'k'");
    EXPECT_EXCEPTION(DocumentId("id:ns:type:n=0,n=1:bar"), IdParseException,
                     "Illegal key combination in n=0,n=1");
    EXPECT_EXCEPTION(DocumentId("id:ns:type:g=foo,g=ba:bar"), IdParseException,
                     "Illegal key combination in g=foo,g=ba");
    EXPECT_EXCEPTION(DocumentId("id:ns:type:n=0,g=foo:bar"), IdParseException,
                     "Illegal key combination in n=0,g=foo");
}

TEST("require that key-value pairs in id id are preserved") {
    const string id_str1 = "id:ns:type:n=1:foo";
    EXPECT_EQUAL(id_str1, DocumentId(id_str1).toString());

    const string id_str2 = "id:ns:type:g=mygroup:foo";
    EXPECT_EQUAL(id_str2, DocumentId(id_str2).toString());
}

void verifyGroupLocation(string s, string group, uint64_t location) {
    DocumentId d(s);
    EXPECT_TRUE(d.getScheme().hasGroup());
    EXPECT_EQUAL(s, d.toString());
    EXPECT_EQUAL(group, d.getScheme().getGroup());
    EXPECT_EQUAL(location, d.getScheme().getLocation()&0xffffffff);
}

TEST("require that = is handled correctly in group ids") {
    TEST_DO(verifyGroupLocation("id:x:foo:g=X:bar",  "X",  0xb89b1202));
    TEST_DO(verifyGroupLocation("id:x:foo:g=X=:bar", "X=", 0xb61ca7e1));
    TEST_DO(verifyGroupLocation("id:x:foo:g=X=:foo", "X=", 0xb61ca7e1));
}

TEST("require that id strings reports features (hasNumber, hasGroup)") {
    DocumentId none("id:ns:type::foo");
    EXPECT_FALSE(none.getScheme().hasNumber());
    EXPECT_FALSE(none.getScheme().hasGroup());
    EXPECT_EQUAL("foo", none.getScheme().getNamespaceSpecific());

    none = DocumentId("doc:ns:foo");
    EXPECT_FALSE(none.getScheme().hasNumber());
    EXPECT_FALSE(none.getScheme().hasGroup());
    EXPECT_EQUAL("foo", none.getScheme().getNamespaceSpecific());

    DocumentId user("id:ns:type:n=42:foo");
    EXPECT_TRUE(user.getScheme().hasNumber());
    EXPECT_FALSE(user.getScheme().hasGroup());
    EXPECT_EQUAL(42u, user.getScheme().getNumber());
    EXPECT_EQUAL("foo", user.getScheme().getNamespaceSpecific());

    user = DocumentId("userdoc:ns:42:foo");
    EXPECT_TRUE(user.getScheme().hasNumber());
    EXPECT_FALSE(user.getScheme().hasGroup());
    EXPECT_EQUAL(42u, user.getScheme().getNumber());
    EXPECT_EQUAL("foo", user.getScheme().getNamespaceSpecific());

    DocumentId group("id:ns:type:g=mygroup:foo");
    EXPECT_FALSE(group.getScheme().hasNumber());
    EXPECT_TRUE(group.getScheme().hasGroup());
    EXPECT_EQUAL("mygroup", group.getScheme().getGroup());
    EXPECT_EQUAL("foo", group.getScheme().getNamespaceSpecific());

    group = DocumentId("groupdoc:ns:mygroup:foo");
    EXPECT_FALSE(group.getScheme().hasNumber());
    EXPECT_TRUE(group.getScheme().hasGroup());
    EXPECT_EQUAL("mygroup", group.getScheme().getGroup());
    EXPECT_EQUAL("foo", group.getScheme().getNamespaceSpecific());

    DocumentId order("orderdoc(5,2):ns:42:007:foo");
    EXPECT_TRUE(order.getScheme().hasNumber());
    EXPECT_TRUE(order.getScheme().hasGroup());
    EXPECT_EQUAL(42u, order.getScheme().getNumber());
    EXPECT_EQUAL("42", order.getScheme().getGroup());
    EXPECT_EQUAL("foo", order.getScheme().getNamespaceSpecific());
}

}  // namespace

TEST_MAIN() { TEST_RUN_ALL(); }