src/gromacs/utility/tests/textwriter.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2017,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 gmx::TextWriter.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/utility/textwriter.h"
  45
  46 #include <string>
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/utility/stringstream.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 #include "testutils/stringtest.h"
  54
  55 namespace
  56 {
  57
  58 class TextWriterTest : public gmx::test::StringTestBase
  59 {
  60 public:
  61     TextWriterTest() : writer_(&stream_) {}
  62
  63     void checkOutput() { checkText(stream_.toString(), "Output"); }
  64
  65     gmx::StringOutputStream stream_;
  66     gmx::TextWriter         writer_;
  67 };
  68
  69 TEST_F(TextWriterTest, WritesLines)
  70 {
  71     writer_.writeLine("Explicit newline\n");
  72     writer_.writeLine("Implicit newline");
  73     writer_.writeLine(std::string("Explicit newline\n"));
  74     writer_.writeLine(std::string("Implicit newline"));
  75     writer_.writeLine();
  76     checkOutput();
  77 }
  78
  79 TEST_F(TextWriterTest, WritesLinesInParts)
  80 {
  81     writer_.writeString("Partial ");
  82     writer_.writeString("spaced");
  83     writer_.writeString(" line");
  84     writer_.writeLine();
  85     writer_.writeString(std::string("Partial "));
  86     writer_.writeString(std::string("spaced"));
  87     writer_.writeString(std::string(" line"));
  88     writer_.writeLine();
  89     checkOutput();
  90 }
  91
  92 TEST_F(TextWriterTest, WritesWrappedLines)
  93 {
  94     writer_.wrapperSettings().setIndent(2);
  95     writer_.wrapperSettings().setLineLength(15);
  96     writer_.writeLine("Wrapped and indented text");
  97     writer_.writeLine(std::string("Wrapped and indented text"));
  98     writer_.writeLine();
  99     checkOutput();
 100 }
 101
 102 TEST_F(TextWriterTest, WritesLinesInPartsWithWrapper)
 103 {
 104     writer_.wrapperSettings().setLineLength(50);
 105     writer_.writeString("Partial ");
 106     writer_.writeString("spaced");
 107     writer_.writeString(" line");
 108     writer_.writeLine();
 109     writer_.writeString(std::string("Partial "));
 110     writer_.writeString(std::string("spaced"));
 111     writer_.writeString(std::string(" line"));
 112     writer_.writeLine();
 113     checkOutput();
 114 }
 115
 116 TEST_F(TextWriterTest, TracksNewlines)
 117 {
 118     writer_.ensureLineBreak();
 119     writer_.ensureEmptyLine();
 120     writer_.writeString("First line");
 121     writer_.ensureLineBreak();
 122     writer_.ensureLineBreak();
 123     writer_.writeString("Second line");
 124     writer_.ensureEmptyLine();
 125     writer_.writeLine("Third line");
 126     writer_.ensureEmptyLine();
 127     writer_.writeString(std::string("Fourth line\n"));
 128     writer_.ensureLineBreak();
 129     writer_.writeString(std::string("Fifth line\n\n"));
 130     writer_.ensureEmptyLine();
 131     writer_.writeString(std::string("Sixth line"));
 132     writer_.ensureEmptyLine();
 133     checkOutput();
 134 }
 135
 136 TEST_F(TextWriterTest, PreservesTrailingWhitespace)
 137 {
 138     writer_.writeString("Line   ");
 139     writer_.writeLine();
 140     writer_.writeString(std::string("Line   "));
 141     writer_.writeLine();
 142     writer_.writeLine("Line   ");
 143     writer_.writeLine(std::string("Line   "));
 144     writer_.writeString("Line   \n");
 145     writer_.writeString(std::string("Line   \n"));
 146     checkOutput();
 147 }
 148
 149 } // namespace