src/gromacs/onlinehelp/tests/helpwritercontext.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015, 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 help text formatting.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_onlinehelp
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/onlinehelp/helpwritercontext.h"
  45
  46 #include <string>
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/utility/arrayref.h"
  51 #include "gromacs/utility/gmxassert.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 #include "testutils/stringtest.h"
  55
  56 namespace
  57 {
  58
  59 /********************************************************************
  60  * Tests for HelpWriterContext
  61  */
  62
  63 class HelpWriterContextTest : public gmx::test::StringTestBase
  64 {
  65     public:
  66         void testFormatting(const std::string     &text,
  67                             gmx::HelpOutputFormat  format,
  68                             const char            *id)
  69         {
  70             gmx::HelpWriterContext context(NULL, format);
  71             std::string            result
  72                 = context.substituteMarkupAndWrapToString(settings_, text);
  73             if (id == NULL)
  74             {
  75                 switch (format)
  76                 {
  77                     case gmx::eHelpOutputFormat_Console:
  78                         id = "Console";
  79                         break;
  80                     case gmx::eHelpOutputFormat_Rst:
  81                         id = "reStructuredText";
  82                         break;
  83                     default:
  84                         GMX_RELEASE_ASSERT(false, "Help output format testing not implemented");
  85                 }
  86             }
  87             checkText(result, id);
  88         }
  89         void testFormatting(const gmx::ConstArrayRef<const char *> &text)
  90         {
  91             std::string testText = gmx::joinStrings(text, "\n");
  92             testFormatting(testText, gmx::eHelpOutputFormat_Console, NULL);
  93             testFormatting(testText, gmx::eHelpOutputFormat_Rst, NULL);
  94         }
  95
  96         gmx::TextLineWrapperSettings settings_;
  97 };
  98
  99 TEST_F(HelpWriterContextTest, FormatsParagraphs)
 100 {
 101     const char *const text[] = {
 102         "A quick",
 103         "brown fox",
 104         "jumps over a lazy dog.[PAR]",
 105         "A quick brown fox",
 106         "jumps over",
 107         "a lazy dog."
 108     };
 109     settings_.setLineLength(13);
 110     testFormatting(text);
 111 }
 112
 113 TEST_F(HelpWriterContextTest, FormatsRstStyleParagraphs)
 114 {
 115     const char *const text[] = {
 116         "A quick",
 117         "brown fox",
 118         "jumps over a lazy dog.",
 119         "",
 120         "A quick brown fox",
 121         "jumps over",
 122         "a lazy dog."
 123     };
 124     settings_.setLineLength(13);
 125     testFormatting(text);
 126 }
 127
 128 TEST_F(HelpWriterContextTest, CleansUpExtraWhitespace)
 129 {
 130     const char *const text[] = {
 131         "",
 132         "A quick ",
 133         "brown fox ",
 134         "jumps over a lazy dog.",
 135         "[PAR]",
 136         "A quick brown fox",
 137         "jumps over",
 138         "a lazy dog.[PAR]"
 139     };
 140     settings_.setLineLength(13);
 141     testFormatting(text);
 142 }
 143
 144 TEST_F(HelpWriterContextTest, FormatsLiteralText)
 145 {
 146     const char *const text[] = {
 147         "Sample paragraph::",
 148         "",
 149         "    literal block",
 150         "    another line",
 151         "",
 152         "Normal paragraph",
 153         "with wrapping"
 154     };
 155     testFormatting(text);
 156 }
 157
 158 TEST_F(HelpWriterContextTest, FormatsLiteralTextAtBeginning)
 159 {
 160     const char *const text[] = {
 161         "::",
 162         "",
 163         "    literal block",
 164         "    another line",
 165         "",
 166         "Normal paragraph"
 167     };
 168     testFormatting(text);
 169 }
 170
 171 TEST_F(HelpWriterContextTest, FormatsLiteralTextWithIndentation)
 172 {
 173     const char *const text[] = {
 174         "Sample paragraph::",
 175         "",
 176         "    literal block",
 177         "      another indented line",
 178         "",
 179         "Normal paragraph",
 180         "with wrapping"
 181     };
 182     testFormatting(text);
 183 }
 184
 185 TEST_F(HelpWriterContextTest, FormatsBulletList)
 186 {
 187     const char *const text[] = {
 188         "Sample list:",
 189         "",
 190         "* first item",
 191         "* second item that",
 192         "  spans multiple lines",
 193         "* third item that has a single long line",
 194         "",
 195         "Normal paragraph"
 196     };
 197     // Wrapping to rst with a fixed line length does not currently work
 198     // correctly, but it is not used, either.
 199     settings_.setLineLength(15);
 200     testFormatting(text);
 201 }
 202
 203 TEST_F(HelpWriterContextTest, FormatsEnumeratedList)
 204 {
 205     const char *const text[] = {
 206         "Sample list:",
 207         "",
 208         "1. first item",
 209         "2. second item that",
 210         "   spans multiple lines",
 211         "3. third item that has a single long line",
 212         "",
 213         "9.  Item with extra indentation",
 214         "10. Double digit item",
 215         "",
 216         "Normal paragraph"
 217     };
 218     // Wrapping to rst with a fixed line length does not currently work
 219     // correctly, but it is not used, either.
 220     settings_.setLineLength(15);
 221     testFormatting(text);
 222 }
 223
 224 TEST_F(HelpWriterContextTest, FormatsSimpleTable)
 225 {
 226     const char *const text[] = {
 227         "Simple table:",
 228         "",
 229         "============  =============",
 230         "First column  Second header",
 231         "============  =============",
 232         "text          text",
 233         "============  =============",
 234         "",
 235         "Normal paragraph",
 236         "again."
 237     };
 238     testFormatting(text);
 239 }
 240
 241 TEST_F(HelpWriterContextTest, FormatsGridTable)
 242 {
 243     const char *const text[] = {
 244         "Grid table:",
 245         "",
 246         "+--------------+---------------+",
 247         "| First column | Second header |",
 248         "+--------------+---------------+",
 249         "| text         | text          |",
 250         "+--------------+---------------+",
 251         "",
 252         "Normal paragraph",
 253         "again."
 254     };
 255     testFormatting(text);
 256 }
 257
 258 TEST_F(HelpWriterContextTest, FormatsTitles)
 259 {
 260     const char *const text[] = {
 261         "Title",
 262         "=====",
 263         "Some text without spacing",
 264         "",
 265         "Subtitle",
 266         "++++++++",
 267         "",
 268         "More text",
 269     };
 270     testFormatting(text);
 271 }
 272
 273 } // namespace