src/gromacs/onlinehelp/tests/helpmanager.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,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 help topic management and help topic formatting.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_onlinehelp
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/onlinehelp/helpmanager.h"
  45
  46 #include <string>
  47
  48 #include <gmock/gmock.h>
  49 #include <gtest/gtest.h>
  50
  51 #include "gromacs/onlinehelp/helptopic.h"
  52 #include "gromacs/onlinehelp/helpwritercontext.h"
  53 #include "gromacs/utility/exceptions.h"
  54 #include "gromacs/utility/stringstream.h"
  55 #include "gromacs/utility/textwriter.h"
  56
  57 #include "gromacs/onlinehelp/tests/mock_helptopic.h"
  58 #include "testutils/stringtest.h"
  59 #include "testutils/testasserts.h"
  60
  61 namespace
  62 {
  63
  64 using gmx::test::MockHelpTopic;
  65
  66 class HelpTestBase : public gmx::test::StringTestBase
  67 {
  68 public:
  69     HelpTestBase();
  70
  71     MockHelpTopic           rootTopic_;
  72     gmx::StringOutputStream helpFile_;
  73     gmx::TextWriter         writer_;
  74     gmx::HelpWriterContext  context_;
  75     gmx::HelpManager        manager_;
  76 };
  77
  78 HelpTestBase::HelpTestBase() :
  79     rootTopic_("", nullptr, "Root topic text"),
  80     writer_(&helpFile_),
  81     context_(&writer_, gmx::eHelpOutputFormat_Console),
  82     manager_(rootTopic_, context_)
  83 {
  84 }
  85
  86 /********************************************************************
  87  * Tests for HelpManager
  88  */
  89
  90 //! Test fixture for gmx::HelpManager.
  91 typedef HelpTestBase HelpManagerTest;
  92
  93 TEST_F(HelpManagerTest, HandlesRootTopic)
  94 {
  95     using ::testing::_;
  96     EXPECT_CALL(rootTopic_, writeHelp(_));
  97     manager_.writeCurrentTopic();
  98 }
  99
 100 TEST_F(HelpManagerTest, HandlesSubTopics)
 101 {
 102     MockHelpTopic& first    = rootTopic_.addSubTopic("first", "First topic", nullptr);
 103     MockHelpTopic& firstSub = first.addSubTopic("firstsub", "First subtopic", nullptr);
 104     rootTopic_.addSubTopic("second", "Second topic", nullptr);
 105
 106     using ::testing::_;
 107     EXPECT_CALL(firstSub, writeHelp(_));
 108     ASSERT_NO_THROW_GMX(manager_.enterTopic("first"));
 109     ASSERT_NO_THROW_GMX(manager_.enterTopic("firstsub"));
 110     manager_.writeCurrentTopic();
 111 }
 112
 113 TEST_F(HelpManagerTest, HandlesInvalidTopics)
 114 {
 115     MockHelpTopic& first = rootTopic_.addSubTopic("first", "First topic", nullptr);
 116     first.addSubTopic("firstsub", "First subtopic", nullptr);
 117     rootTopic_.addSubTopic("second", "Second topic", nullptr);
 118
 119     ASSERT_THROW_GMX(manager_.enterTopic("unknown"), gmx::InvalidInputError);
 120     ASSERT_NO_THROW_GMX(manager_.enterTopic("first"));
 121     ASSERT_THROW_GMX(manager_.enterTopic("unknown"), gmx::InvalidInputError);
 122     ASSERT_THROW_GMX(manager_.enterTopic("second"), gmx::InvalidInputError);
 123     ASSERT_NO_THROW_GMX(manager_.enterTopic("firstsub"));
 124 }
 125
 126 /********************************************************************
 127  * Tests for help topic formatting
 128  */
 129
 130 struct TestHelpText
 131 {
 132     static const char        name[];
 133     static const char        title[];
 134     static const char* const text[];
 135 };
 136
 137 const char        TestHelpText::name[]  = "testtopic";
 138 const char        TestHelpText::title[] = "Topic title";
 139 const char* const TestHelpText::text[]  = { "Test topic text.[PAR]", "Another paragraph of text." };
 140
 141 class HelpTopicFormattingTest : public HelpTestBase
 142 {
 143 public:
 144     void checkHelpFormatting();
 145 };
 146
 147 void HelpTopicFormattingTest::checkHelpFormatting()
 148 {
 149     ASSERT_NO_THROW_GMX(manager_.enterTopic("testtopic"));
 150     ASSERT_NO_THROW_GMX(manager_.writeCurrentTopic());
 151     helpFile_.close();
 152
 153     checkText(helpFile_.toString(), "HelpText");
 154 }
 155
 156 TEST_F(HelpTopicFormattingTest, FormatsSimpleTopic)
 157 {
 158     rootTopic_.addSubTopic(gmx::HelpTopicPointer(new gmx::SimpleHelpTopic<TestHelpText>));
 159     checkHelpFormatting();
 160 }
 161
 162 TEST_F(HelpTopicFormattingTest, FormatsCompositeTopicWithSubTopics)
 163 {
 164     gmx::CompositeHelpTopicPointer topic(new gmx::CompositeHelpTopic<TestHelpText>);
 165     MockHelpTopic::addSubTopic(topic.get(), "subtopic", "First subtopic", "Text");
 166     MockHelpTopic::addSubTopic(topic.get(), "other", "Second subtopic", "Text");
 167     rootTopic_.addSubTopic(std::move(topic));
 168     checkHelpFormatting();
 169 }
 170
 171 } // namespace