xapian-core/tests/harness/testutils.h

   1 /** @file testutils.h
   2  * @brief Xapian-specific test helper functions and macros.
   3  */
   4 /* Copyright 1999,2000,2001 BrightStation PLC
   5  * Copyright 2002,2003,2007,2008,2015 Olly Betts
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  20  * USA
  21  */
  22
  23 #ifndef OM_HGUARD_TESTUTILS_H
  24 #define OM_HGUARD_TESTUTILS_H
  25
  26 #include "testsuite.h"
  27 #include <xapian.h>
  28
  29 // ######################################################################
  30 // Useful display operators
  31
  32 std::ostream &operator<<(std::ostream &os,
  33                          const std::vector<Xapian::docid> &ints);
  34
  35 // ######################################################################
  36 // Useful comparison operators
  37
  38 // Test that the weights and docids in two mset ranges are the same.
  39 bool
  40 mset_range_is_same(const Xapian::MSet &mset1, unsigned int first1,
  41                    const Xapian::MSet &mset2, unsigned int first2,
  42                    unsigned int count);
  43
  44 // Test that the weights in two mset ranges are the same, ignoring docids.
  45 bool
  46 mset_range_is_same_weights(const Xapian::MSet &mset1, unsigned int first1,
  47                            const Xapian::MSet &mset2, unsigned int first2,
  48                            unsigned int count);
  49
  50 bool operator==(const Xapian::MSet &first, const Xapian::MSet &second);
  51
  52 inline bool operator!=(const Xapian::MSet &first, const Xapian::MSet &second)
  53 {
  54     return !(first == second);
  55 }
  56
  57
  58 void mset_expect_order(const Xapian::MSet &A,
  59                        Xapian::docid d1 = 0, Xapian::docid d2 = 0,
  60                        Xapian::docid d3 = 0, Xapian::docid d4 = 0,
  61                        Xapian::docid d5 = 0, Xapian::docid d6 = 0,
  62                        Xapian::docid d7 = 0, Xapian::docid d8 = 0,
  63                        Xapian::docid d9 = 0, Xapian::docid d10 = 0,
  64                        Xapian::docid d11 = 0, Xapian::docid d12 = 0);
  65
  66 void test_mset_order_equal(const Xapian::MSet &mset1,
  67                            const Xapian::MSet &mset2);
  68
  69 // ######################################################################
  70 // Useful test macros
  71
  72 /// Check MSet M has size S.
  73 #define TEST_MSET_SIZE(M, S) TEST_AND_EXPLAIN(((M).size() == (S)), \
  74         "MSet '" STRINGIZE(M) "' is not of expected size: was '" << \
  75         (M).size() << "' expected '" << (S) << "':\n" << \
  76         "Full mset was:\n" << (M))
  77
  78 /// Check that a piece of code throws an expected exception.
  79 #define TEST_EXCEPTION(a,b) do {\
  80         expected_exception = STRINGIZE(a);\
  81         if (strncmp(expected_exception, "Xapian::", 8) == 0)\
  82             expected_exception += 8;\
  83         if (verbose)\
  84             tout << "Expecting exception " << expected_exception << endl;\
  85         try {b;FAIL_TEST(TESTCASE_LOCN(Expected #a));}\
  86         catch (const a &e) {\
  87             if (verbose)\
  88                 tout << "Caught expected " << expected_exception\
  89                      << " exception: " << e.get_description() << endl;\
  90         }\
  91         expected_exception = NULL;\
  92     } while (0)
  93
  94 #endif // OM_HGUARD_TESTUTILS_H