src/gromacs/topology/tests/symtab.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Tests for legacy symbol table
  38  *
  39  * \author Paul Bauer <paul.bauer.q@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/topology/symtab.h"
  44
  45 #include <memory>
  46
  47 #include <gtest/gtest.h>
  48
  49 #include "gromacs/utility/strconvert.h"
  50 #include "gromacs/utility/stringutil.h"
  51
  52 #include "testutils/refdata.h"
  53
  54 namespace gmx
  55 {
  56
  57 namespace test
  58 {
  59
  60 namespace
  61 {
  62
  63 class SymtabTest : public ::testing::Test
  64 {
  65     public:
  66         SymtabTest()
  67         {
  68             open_symtab(&symtab_);
  69         }
  70         ~SymtabTest() override
  71         {
  72             done_symtab(&symtab_);
  73             EXPECT_EQ(symtab_.nr, 0);
  74             EXPECT_EQ(symtab_.symbuf, nullptr);
  75         }
  76
  77         //! Get handle to symbol table.
  78         t_symtab *symtab() { return &symtab_; }
  79         //! Dump symtab. Similar to pr_symtab function.
  80         void dumpSymtab();
  81
  82     private:
  83         //! Get reference checker using lazy initialization
  84         TestReferenceChecker *checker()
  85         {
  86             if (!checker_)
  87             {
  88                 checker_ = std::make_unique<TestReferenceChecker>(data_.rootChecker());
  89             }
  90             return checker_.get();
  91         }
  92         //! The symbol table being tested.
  93         t_symtab                              symtab_;
  94         //! Handler for reference data.
  95         TestReferenceData                     data_;
  96         //! Handler for checking reference data.
  97         std::unique_ptr<TestReferenceChecker> checker_;
  98 };
  99
 100 void SymtabTest::dumpSymtab()
 101 {
 102     int                      nr     = symtab_.nr;
 103     t_symbuf                *symbuf = symtab_.symbuf;
 104     std::vector<std::string> symtabDump;
 105     int                      pos = 0;
 106     while (symbuf != nullptr)
 107     {
 108         int i;
 109         for (i = 0; (i < symbuf->bufsize) && (i < nr); i++)
 110         {
 111             symtabDump.emplace_back(formatString("Symtab[%d]=\"%s\"", pos++, symbuf->buf[i]));
 112         }
 113         nr    -= i;
 114         symbuf = symbuf->next;
 115     }
 116     checker()->checkSequence(symtabDump.begin(), symtabDump.end(), "Complete dump of SymbolTable");
 117 }
 118
 119 /*! \brief
 120  * Helper that compares an input to a handle obtained from symtab lookup.
 121  *
 122  * \param[in] symtab Symbol table that contains the entries.
 123  * \param[in] symbol The entry obtained from placing a string in the symbol table.
 124  * \param[in] index  Index into symtab corresponding to an entry.
 125  * \returns Whether to \p symbol and the entry returned by \p index are the same pointer.
 126  */
 127 bool entriesAreEqual(t_symtab *symtab, char **symbol, int index)
 128 {
 129     return symbol == get_symtab_handle(symtab, index);
 130 }
 131
 132 /*! \brief
 133  * Helper function to check internal consistency of symtab lookup.
 134  *
 135  * Checks that placing an entry resulted in valid symbol table, and that
 136  * the index obtained from a call to lookup_symtab returns the correct entry.
 137  *
 138  * \param[in] symtab Symbol table that contains the entries.
 139  * \param[in] symbol The entry obtained from placing a string in the symbol table.
 140  */
 141 void compareSymtabLookupAndHandle(t_symtab *symtab, char **symbol)
 142 {
 143     ASSERT_NE(symtab->symbuf, nullptr);
 144     auto index = lookup_symtab(symtab, symbol);
 145     EXPECT_TRUE(entriesAreEqual(symtab, symbol, index));
 146 }
 147 /*! \brief
 148  *  Check that symbols obtained from symtab compare correctly.
 149  *
 150  *  Helper function to find out if two entries obtained by a symtab lookup
 151  *  are equivalent or not, according to testing criteria.
 152  *
 153  *  \param[in] symtab Symbol table that contains the entries.
 154  *  \param[in] firstSymbol Handle into symtab obtained from placing string in symtab.
 155  *  \param[in] otherSymbol Other handle from obtained from separate string deposit.
 156  *  \param[in] expectedOutcome If the handles should result in equal entries or not.
 157  */
 158 void compareDifferentHandles(t_symtab *symtab,
 159                              char    **firstSymbol,
 160                              char    **otherSymbol,
 161                              bool      expectedOutcome)
 162 {
 163     ASSERT_NE(symtab->symbuf, nullptr);
 164     auto firstIndex = lookup_symtab(symtab, firstSymbol);
 165     auto otherIndex = lookup_symtab(symtab, otherSymbol);
 166     EXPECT_EQ(expectedOutcome, entriesAreEqual(symtab, firstSymbol, otherIndex));
 167     EXPECT_EQ(expectedOutcome, entriesAreEqual(symtab, otherSymbol, firstIndex));
 168 }
 169
 170 TEST_F(SymtabTest, EmptyOnOpen)
 171 {
 172     ASSERT_EQ(0, symtab()->nr);
 173     ASSERT_EQ(nullptr, symtab()->symbuf);
 174 }
 175
 176 TEST_F(SymtabTest, AddSingleEntry)
 177 {
 178     auto fooSymbol = put_symtab(symtab(), "Foo");
 179     ASSERT_EQ(1, symtab()->nr);
 180     compareSymtabLookupAndHandle(symtab(), fooSymbol);
 181     EXPECT_STREQ("Foo", *fooSymbol);
 182 }
 183
 184 TEST_F(SymtabTest, AddTwoDistinctEntries)
 185 {
 186     auto fooSymbol = put_symtab(symtab(), "Foo");
 187     auto barSymbol = put_symtab(symtab(), "Bar");
 188     ASSERT_EQ(2, symtab()->nr);
 189
 190     compareSymtabLookupAndHandle(symtab(), fooSymbol);
 191     compareSymtabLookupAndHandle(symtab(), barSymbol);
 192
 193     EXPECT_NE(fooSymbol, barSymbol);
 194     compareDifferentHandles(symtab(), fooSymbol, barSymbol, false);
 195     EXPECT_STREQ("Foo", *fooSymbol);
 196     EXPECT_STREQ("Bar", *barSymbol);
 197 }
 198
 199 TEST_F(SymtabTest, TryToAddDuplicates)
 200 {
 201     auto fooSymbol = put_symtab(symtab(), "Foo");
 202     auto barSymbol = put_symtab(symtab(), "Bar");
 203     ASSERT_EQ(2, symtab()->nr);
 204
 205     compareSymtabLookupAndHandle(symtab(), fooSymbol);
 206     compareSymtabLookupAndHandle(symtab(), barSymbol);
 207
 208     EXPECT_NE(fooSymbol, barSymbol);
 209     compareDifferentHandles(symtab(), fooSymbol, barSymbol, false);
 210     EXPECT_STREQ("Foo", *fooSymbol);
 211     EXPECT_STREQ("Bar", *barSymbol);
 212
 213     // Insert a duplicate element
 214     auto anotherFooSymbol = put_symtab(symtab(), "Foo");
 215     ASSERT_EQ(2, symtab()->nr);
 216
 217     // Check for correct post-conditions
 218     EXPECT_EQ(fooSymbol, anotherFooSymbol);
 219     EXPECT_STREQ("Foo", *anotherFooSymbol);
 220     EXPECT_STREQ("Foo", *fooSymbol);
 221     EXPECT_STREQ("Bar", *barSymbol);
 222
 223     // Check for correct behaviours with new and old symbols
 224     compareDifferentHandles(symtab(), fooSymbol, anotherFooSymbol, true);
 225     compareDifferentHandles(symtab(), barSymbol, anotherFooSymbol, false);
 226     compareDifferentHandles(symtab(), fooSymbol, barSymbol, false);
 227 }
 228
 229 TEST_F(SymtabTest, AddLargeNumberOfEntries)
 230 {
 231     int                  numStringsToAdd = 7; // Larger than c_maxBufSize limit for size of symbuf.
 232     std::vector<char **> symbolsAdded;
 233     symbolsAdded.reserve(numStringsToAdd);
 234     for (int i = 0; i < numStringsToAdd; ++i)
 235     {
 236         symbolsAdded.push_back(put_symtab(symtab(), toString(i).c_str()));
 237     }
 238     ASSERT_EQ(numStringsToAdd, symtab()->nr);
 239     for (int i = 0; i < numStringsToAdd; ++i)
 240     {
 241         EXPECT_STREQ(toString(i).c_str(), *symbolsAdded[i]);
 242         compareSymtabLookupAndHandle(symtab(), symbolsAdded[i]);
 243     }
 244     // Add something unrelated and check that indices still work afterward.
 245     auto foobarSymbol = put_symtab(symtab(), "foobar");
 246     ASSERT_EQ(numStringsToAdd+1, symtab()->nr);
 247     for (int i = 0; i < numStringsToAdd; ++i)
 248     {
 249         EXPECT_STREQ(toString(i).c_str(), *symbolsAdded[i]);
 250         compareSymtabLookupAndHandle(symtab(), symbolsAdded[i]);
 251     }
 252     compareSymtabLookupAndHandle(symtab(), foobarSymbol);
 253
 254     // Now dump the symtab to see that we can reproduce it if needed.
 255     dumpSymtab();
 256 }
 257
 258 TEST_F(SymtabTest, NoDuplicatesInLargeTable)
 259 {
 260     int                  halfOfStringsToAdd   = 7; // Larger than c_maxBufSize limit for size of symbuf.
 261     int                  totalNumStringsToAdd = 2*halfOfStringsToAdd;
 262     std::vector<char **> symbolsAdded;
 263     symbolsAdded.reserve(halfOfStringsToAdd);
 264     for (int i = 0; i < halfOfStringsToAdd; ++i)
 265     {
 266         symbolsAdded.push_back(put_symtab(symtab(), toString(i).c_str()));
 267     }
 268     ASSERT_EQ(halfOfStringsToAdd, symtab()->nr);
 269
 270     // We now try to mess around in the symtab.
 271     auto bazSymbol = put_symtab(symtab(), "baz");
 272     ASSERT_EQ(halfOfStringsToAdd+1, symtab()->nr);
 273     compareSymtabLookupAndHandle(symtab(), bazSymbol);
 274
 275     // Now try to add more symbols, also including those that are already there.
 276     for (int i = 0; i < totalNumStringsToAdd; i++)
 277     {
 278         symbolsAdded.push_back(put_symtab(symtab(), toString(i).c_str()));
 279     }
 280     ASSERT_EQ(totalNumStringsToAdd+1, symtab()->nr);
 281
 282     //! Check that entries that should be equal are, and new ones are not.
 283     for (int i = 0; i < halfOfStringsToAdd; i++)
 284     {
 285         compareDifferentHandles(symtab(), symbolsAdded[i], symbolsAdded[halfOfStringsToAdd+i], true);
 286         compareDifferentHandles(symtab(), symbolsAdded[i], symbolsAdded[2*halfOfStringsToAdd+i], false);
 287         compareDifferentHandles(symtab(), symbolsAdded[i], bazSymbol, false);
 288     }
 289     compareSymtabLookupAndHandle(symtab(), bazSymbol);
 290     EXPECT_STREQ("baz", *bazSymbol);
 291     dumpSymtab();
 292 }
 293
 294 } // namespace
 295
 296 } // namespace test
 297
 298 } // namespace gmx