src/gromacs/utility/tests/stringutil.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Tests for string utility functions and classes.
  34  *
  35  * For development, the tests can be run with a '-stdout' command-line option
  36  * to print out the help to stdout instead of using the XML reference
  37  * framework.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  40  * \ingroup module_utility
  41  */
  42 #include <string>
  43 #include <vector>
  44
  45 #include <gtest/gtest.h>
  46
  47 #include "gromacs/utility/stringutil.h"
  48
  49 #include "testutils/refdata.h"
  50 #include "testutils/stringtest.h"
  51
  52 namespace
  53 {
  54
  55 /********************************************************************
  56  * Tests for formatString()
  57  */
  58
  59 TEST(FormatStringTest, HandlesBasicFormatting)
  60 {
  61     EXPECT_EQ("12 abc", gmx::formatString("%d %s", 12, "abc"));
  62 }
  63
  64 TEST(FormatStringTest, HandlesLongStrings)
  65 {
  66     std::string longString = gmx::formatString("%*c%d", 2000, 'x', 10);
  67     EXPECT_EQ(2002U, longString.length());
  68     EXPECT_EQ("x10", longString.substr(1999));
  69 }
  70
  71 /********************************************************************
  72  * Tests for concatenateStrings()
  73  */
  74
  75 typedef gmx::test::StringTestBase ConcatenateStringsTest;
  76
  77 TEST_F(ConcatenateStringsTest, HandlesDifferentStringEndings)
  78 {
  79     static const char * const strings[] = {
  80         "First string",
  81         "Second string ",
  82         "Third string\n",
  83         "Fourth string",
  84         ""
  85     };
  86     checkText(gmx::concatenateStrings(strings), "CombinedStrings");
  87 }
  88
  89 /********************************************************************
  90  * Tests for replaceAll() and replaceAllWords()
  91  */
  92
  93 TEST(ReplaceAllTest, HandlesEmptyStrings)
  94 {
  95     EXPECT_EQ("", gmx::replaceAll("", "aaa", "bbbb"));
  96     EXPECT_EQ("", gmx::replaceAllWords("", "aaa", "bbbb"));
  97 }
  98
  99 TEST(ReplaceAllTest, HandlesNoMatches)
 100 {
 101     const std::string text("Text with no matches");
 102     EXPECT_EQ(text, gmx::replaceAll(text, "aaa", "bbbb"));
 103     EXPECT_EQ(text, gmx::replaceAllWords(text, "aaa", "bbbb"));
 104 }
 105
 106 TEST(ReplaceAllTest, HandlesMatchesAtEnds)
 107 {
 108     EXPECT_EQ("bbbbtext", gmx::replaceAll("aaatext", "aaa", "bbbb"));
 109     EXPECT_EQ("textbbbb", gmx::replaceAll("textaaa", "aaa", "bbbb"));
 110     EXPECT_EQ("bbbb text", gmx::replaceAllWords("aaa text", "aaa", "bbbb"));
 111     EXPECT_EQ("text bbbb", gmx::replaceAllWords("text aaa", "aaa", "bbbb"));
 112 }
 113
 114 TEST(ReplaceAllTest, HandlesMultipleMatches)
 115 {
 116     const std::string text("Text aaa with multiple aaa matches");
 117     EXPECT_EQ("Text bbbb with multiple bbbb matches",
 118               gmx::replaceAll(text, "aaa", "bbbb"));
 119     EXPECT_EQ("Text bbbb with multiple bbbb matches",
 120               gmx::replaceAllWords(text, "aaa", "bbbb"));
 121 }
 122
 123 TEST(ReplaceAllTest, HandlesWordBoundaries)
 124 {
 125     const std::string text("Text aaax with one word aaa match");
 126     EXPECT_EQ("Text aaax with one word bbbb match",
 127               gmx::replaceAllWords(text, "aaa", "bbbb"));
 128 }
 129
 130 TEST(ReplaceAllTest, HandlesPossibleRecursiveMatches)
 131 {
 132     const std::string text("Text with recursive aaabbbbbb matches");
 133     EXPECT_EQ("Text with recursive aaaaaabbb matches",
 134               gmx::replaceAll(text, "aaabbb", "aaaaaa"));
 135 }
 136
 137 /********************************************************************
 138  * Tests for TextLineWrapper
 139  */
 140
 141 const char g_wrapText[] = "A quick brown fox jumps over the lazy dog";
 142 const char g_wrapText2[] = "A quick brown fox jumps\nover the lazy dog";
 143 const char g_wrapTextLongWord[]
 144     = "A quick brown fox jumps awordthatoverflowsaline over the lazy dog";
 145 const char g_wrapTextWhitespace[] = " A quick brown   fox jumps  \n over the lazy dog";
 146
 147 typedef gmx::test::StringTestBase TextLineWrapperTest;
 148
 149 TEST_F(TextLineWrapperTest, HandlesEmptyStrings)
 150 {
 151     gmx::TextLineWrapper wrapper;
 152
 153     EXPECT_EQ("", wrapper.wrapToString(""));
 154     EXPECT_EQ("", wrapper.wrapToString("   "));
 155     EXPECT_TRUE(wrapper.wrapToVector("").empty());
 156     EXPECT_TRUE(wrapper.wrapToString("   ").empty());
 157 }
 158
 159 TEST_F(TextLineWrapperTest, HandlesTrailingNewlines)
 160 {
 161     gmx::TextLineWrapper wrapper;
 162
 163     EXPECT_EQ("line", wrapper.wrapToString("line"));
 164     EXPECT_EQ("line\n", wrapper.wrapToString("line\n"));
 165     EXPECT_EQ("line\n\n", wrapper.wrapToString("line\n\n"));
 166     EXPECT_EQ("\n", wrapper.wrapToString("\n"));
 167     EXPECT_EQ("\n\n", wrapper.wrapToString("\n\n"));
 168     {
 169         std::vector<std::string> wrapped(wrapper.wrapToVector("line"));
 170         ASSERT_EQ(1U, wrapped.size());
 171         EXPECT_EQ("line", wrapped[0]);
 172     }
 173     {
 174         std::vector<std::string> wrapped(wrapper.wrapToVector("line\n"));
 175         ASSERT_EQ(1U, wrapped.size());
 176         EXPECT_EQ("line", wrapped[0]);
 177     }
 178     {
 179         std::vector<std::string> wrapped(wrapper.wrapToVector("line\n\n"));
 180         ASSERT_EQ(2U, wrapped.size());
 181         EXPECT_EQ("line", wrapped[0]);
 182         EXPECT_EQ("", wrapped[1]);
 183     }
 184     {
 185         std::vector<std::string> wrapped(wrapper.wrapToVector("\n"));
 186         ASSERT_EQ(1U, wrapped.size());
 187         EXPECT_EQ("", wrapped[0]);
 188     }
 189     {
 190         std::vector<std::string> wrapped(wrapper.wrapToVector("\n\n"));
 191         ASSERT_EQ(2U, wrapped.size());
 192         EXPECT_EQ("", wrapped[0]);
 193         EXPECT_EQ("", wrapped[1]);
 194     }
 195 }
 196
 197 TEST_F(TextLineWrapperTest, WrapsCorrectly)
 198 {
 199     gmx::TextLineWrapper wrapper;
 200
 201     wrapper.setLineLength(10);
 202     checkText(wrapper.wrapToString(g_wrapText), "WrappedAt10");
 203     std::vector<std::string> wrapped(wrapper.wrapToVector(g_wrapText));
 204     checker().checkSequence(wrapped.begin(), wrapped.end(), "WrappedToVector");
 205     wrapper.setLineLength(13);
 206     checkText(wrapper.wrapToString(g_wrapText), "WrappedAt13");
 207     wrapper.setLineLength(14);
 208     checkText(wrapper.wrapToString(g_wrapText), "WrappedAt14");
 209     checkText(wrapper.wrapToString(g_wrapTextLongWord), "WrappedWithLongWord");
 210 }
 211
 212 TEST_F(TextLineWrapperTest, WrapsCorrectlyWithExistingBreaks)
 213 {
 214     gmx::TextLineWrapper wrapper;
 215
 216     checkText(wrapper.wrapToString(g_wrapText2), "WrappedWithNoLimit");
 217     wrapper.setLineLength(10);
 218     checkText(wrapper.wrapToString(g_wrapText2), "WrappedAt10");
 219     wrapper.setLineLength(14);
 220     checkText(wrapper.wrapToString(g_wrapText2), "WrappedAt14");
 221 }
 222
 223 TEST_F(TextLineWrapperTest, WrapsCorrectlyWithExtraWhitespace)
 224 {
 225     gmx::TextLineWrapper wrapper;
 226
 227     wrapper.setLineLength(14);
 228     checkText(wrapper.wrapToString(g_wrapTextWhitespace), "WrappedAt14");
 229 }
 230
 231 } // namespace