src/programs/mdrun/tests/helpwriting.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  * This implements tests on mdrun help writing.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \ingroup module_mdrun_integration_tests
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/commandline/cmdlinehelpcontext.h"
  45 #include "gromacs/utility/stringstream.h"
  46 #include "gromacs/utility/textwriter.h"
  47 #include "programs/mdrun/mdrun_main.h"
  48
  49 #include "testutils/cmdlinetest.h"
  50 #include "testutils/refdata.h"
  51
  52 namespace gmx
  53 {
  54 namespace test
  55 {
  56 namespace
  57 {
  58
  59 TEST(MdrunTest, WritesHelp)
  60 {
  61     // Make a stream to which we want gmx mdrun -h to write the help.
  62     StringOutputStream outputStream;
  63     TextWriter         writer(&outputStream);
  64
  65     // Use that stream to set up a global help context. Legacy tools
  66     // like mdrun call parse_common_args, which recognizes the
  67     // existence of a global help context. That context triggers the
  68     // writing of help and a fast exit of the tool.
  69     HelpLinks*                   links = nullptr;
  70     CommandLineHelpContext       context(&writer, eHelpOutputFormat_Console, links, "dummy");
  71     GlobalCommandLineHelpContext global(context);
  72
  73     // Call mdrun to get the help printed to the stream
  74     CommandLine caller;
  75     caller.append("mdrun");
  76     caller.append("-h");
  77     gmx_mdrun(caller.argc(), caller.argv());
  78
  79     // Check whether the stream matches the reference copy.
  80     TestReferenceData    refData;
  81     TestReferenceChecker checker(refData.rootChecker());
  82     checker.checkString(outputStream.toString(), "Help string");
  83 };
  84
  85 } // namespace
  86 } // namespace test
  87 } // namespace gmx