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
|
/** @file api_metadata.cc
* @brief Test the user metadata functionality.
*/
/* Copyright (C) 2007,2009,2011 Olly Betts
* Copyright (C) 2007,2008,2009 Lemur Consulting Ltd
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#include <config.h>
#include "api_metadata.h"
#include <xapian.h>
#include "apitest.h"
#include "testsuite.h"
#include "testutils.h"
#include <string>
using namespace std;
// Test basic metadata access methods.
DEFINE_TESTCASE(metadata1, writable) {
Xapian::WritableDatabase db = get_writable_database();
TEST_EQUAL(db.get_metadata("foo"), "");
try {
db.set_metadata("foo", "bar");
} catch (const Xapian::UnimplementedError &) {
SKIP_TEST("Metadata not supported by this backend");
}
TEST_EQUAL(db.get_metadata("foo"), "bar");
db.set_metadata("foo", "baz");
TEST_EQUAL(db.get_doccount(), 0);
TEST_EQUAL(db.get_metadata("foo"), "baz");
db.set_metadata("foo", "");
TEST_EQUAL(db.get_metadata("foo"), "");
TEST_EQUAL(db.get_doccount(), 0);
// Check for transparent handling of zero bytes.
db.set_metadata("foo", "value of foo");
db.set_metadata(string("foo\0bar", 7), string(1, '\0'));
db.set_metadata(string("foo\0", 4), string("foo\0bar", 7));
TEST_EQUAL(db.get_metadata("foo"), "value of foo");
TEST_EQUAL(db.get_metadata(string("foo\0bar", 7)), string(1, '\0'));
TEST_EQUAL(db.get_metadata(string("foo\0", 4)), string("foo\0bar", 7));
db.commit();
TEST_EQUAL(db.get_metadata("foo"), "value of foo");
TEST_EQUAL(db.get_metadata(string("foo\0bar", 7)), string(1, '\0'));
TEST_EQUAL(db.get_metadata(string("foo\0", 4)), string("foo\0bar", 7));
return true;
}
// Test that metadata gets applied at same time as other changes.
DEFINE_TESTCASE(metadata2, metadata && !inmemory) {
Xapian::WritableDatabase db = get_writable_database();
Xapian::Database dbr = get_writable_database_as_database();
TEST_EQUAL(db.get_metadata("foo"), "");
db.set_metadata("foo", "bar");
TEST_EQUAL(db.get_metadata("foo"), "bar");
TEST_EQUAL(dbr.get_metadata("foo"), "");
db.commit();
TEST_EQUAL(dbr.get_metadata("foo"), "");
TEST(dbr.reopen());
TEST_EQUAL(db.get_metadata("foo"), "bar");
TEST_EQUAL(dbr.get_metadata("foo"), "bar");
TEST_EQUAL(dbr.get_doccount(), 0);
db.add_document(Xapian::Document());
db.set_metadata("foo", "baz");
TEST_EQUAL(db.get_doccount(), 1);
TEST_EQUAL(db.get_metadata("foo"), "baz");
db.commit();
TEST_EQUAL(dbr.get_metadata("foo"), "bar");
TEST(dbr.reopen());
TEST_EQUAL(dbr.get_metadata("foo"), "baz");
db.set_metadata("foo", "");
TEST_EQUAL(db.get_metadata("foo"), "");
db.commit();
TEST_EQUAL(dbr.get_metadata("foo"), "baz");
TEST(dbr.reopen());
TEST_EQUAL(dbr.get_metadata("foo"), "");
TEST_EQUAL(db.get_doccount(), 1);
return true;
}
// Test the empty metadata keys give an error correctly.
DEFINE_TESTCASE(metadata3, metadata) {
Xapian::WritableDatabase db = get_writable_database();
TEST_EXCEPTION(Xapian::InvalidArgumentError, db.get_metadata(""));
TEST_EXCEPTION(Xapian::InvalidArgumentError, db.set_metadata("", "foo"));
TEST_EXCEPTION(Xapian::InvalidArgumentError, db.get_metadata(""));
return true;
}
// Regression test for adding a piece of metadata on its own before adding
// other things.
DEFINE_TESTCASE(metadata4, metadata && !inmemory) {
Xapian::WritableDatabase db = get_writable_database();
db.set_metadata("foo", "foo");
db.commit();
Xapian::Document doc;
doc.add_posting("foo", 1);
db.add_document(doc);
Xapian::Database dbr(get_writable_database_as_database());
return true;
}
// Test metadata iterators.
DEFINE_TESTCASE(metadata5, writable) {
Xapian::WritableDatabase db = get_writable_database();
// Check that iterator on empty database returns nothing.
Xapian::TermIterator iter;
iter = db.metadata_keys_begin();
TEST_EQUAL(iter, db.metadata_keys_end());
// FIXME: inmemory doesn't implement metadata iterators yet, except in the
// trivial case of there being no keys to iterate.
SKIP_TEST_FOR_BACKEND("inmemory");
try {
db.set_metadata("foo", "val");
} catch (const Xapian::UnimplementedError &) {
SKIP_TEST("Metadata not supported by this backend");
}
db.commit();
// Check iterator on a database with only metadata items.
iter = db.metadata_keys_begin();
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo");
++iter;
TEST(iter == db.metadata_keys_end());
// Check iterator on a database with metadata items and documents.
Xapian::Document doc;
doc.add_posting("foo", 1);
db.add_document(doc);
db.commit();
iter = db.metadata_keys_begin();
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo");
++iter;
TEST(iter == db.metadata_keys_end());
// Check iterator on a database with documents but no metadata. Also
// checks that setting metadata to empty stops the iterator returning it.
db.set_metadata("foo", "");
db.commit();
iter = db.metadata_keys_begin();
TEST(iter == db.metadata_keys_end());
// Check use of a prefix, and skip_to.
db.set_metadata("a", "val");
db.set_metadata("foo", "val");
db.set_metadata("foo1", "val");
db.set_metadata("foo2", "val");
db.set_metadata("z", "val");
db.commit();
iter = db.metadata_keys_begin();
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "a");
++iter;
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo");
++iter;
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo1");
++iter;
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo2");
++iter;
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "z");
++iter;
TEST(iter == db.metadata_keys_end());
iter = db.metadata_keys_begin("foo");
TEST(iter != db.metadata_keys_end("foo"));
TEST_EQUAL(*iter, "foo");
++iter;
TEST(iter != db.metadata_keys_end("foo"));
TEST_EQUAL(*iter, "foo1");
++iter;
TEST(iter != db.metadata_keys_end("foo"));
TEST_EQUAL(*iter, "foo2");
++iter;
TEST(iter == db.metadata_keys_end("foo"));
iter = db.metadata_keys_begin("foo1");
TEST(iter != db.metadata_keys_end("foo1"));
TEST_EQUAL(*iter, "foo1");
++iter;
TEST(iter == db.metadata_keys_end("foo1"));
iter = db.metadata_keys_begin();
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "a");
// Skip to "" should move to the first key.
iter.skip_to("");
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "a");
// This skip_to should skip the "foo" key.
iter.skip_to("foo1");
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo1");
// Check that skipping to the current key works.
iter.skip_to("foo1");
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo1");
// Check that skip_to a key before the current one doesn't move forwards.
iter.skip_to("a");
TEST(iter != db.metadata_keys_end());
TEST_REL(*iter, <=, "foo1");
// Make sure we're back on foo1.
iter.skip_to("foo1");
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo1");
// Check that advancing after a skip_to() works correctly.
++iter;
TEST(iter != db.metadata_keys_end());
TEST_EQUAL(*iter, "foo2");
// Check that skipping to a key after the last key works.
iter.skip_to("zoo");
TEST(iter == db.metadata_keys_end());
return true;
}
/// Regression test of reading after writing but not committing.
DEFINE_TESTCASE(writeread1, writable && metadata) {
Xapian::WritableDatabase db_w = get_writable_database();
db_w.set_metadata("1", "2");
string longitem(20000, 'j');
db_w.set_metadata("2", longitem);
string readitem = db_w.get_metadata("2");
TEST_EQUAL(readitem, longitem);
return true;
}
|