src/gromacs/tools/tests/trjconv.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2016,2017,2018,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 trjconv.
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  */
  41 #include "gmxpre.h"
  42
  43 #include "gromacs/tools/trjconv.h"
  44
  45 #include "config.h"
  46
  47 #include "testutils/cmdlinetest.h"
  48 #include "testutils/simulationdatabase.h"
  49 #include "testutils/stdiohelper.h"
  50 #include "testutils/textblockmatchers.h"
  51
  52 namespace
  53 {
  54
  55 class TrjconvWithIndexGroupSubset :
  56     public gmx::test::CommandLineTestBase,
  57     public ::testing::WithParamInterface<const char*>
  58 {
  59 public:
  60     void runTest(const char* fileName)
  61     {
  62         auto& cmdline = commandLine();
  63
  64         setInputFile("-s", "spc2.gro");
  65         setInputFile("-f", fileName);
  66         setInputFile("-n", "spc2.ndx");
  67         setOutputFile("-o", "spc-traj.tng", gmx::test::NoTextMatch());
  68
  69         gmx::test::StdioTestHelper stdioHelper(&fileManager());
  70         stdioHelper.redirectStringToStdin("SecondWaterMolecule\n");
  71
  72         /* TODO Ideally, we would then check that the output file
  73            has only 3 of the 6 atoms (which it does), but the
  74            infrastructure for doing that automatically is still
  75            being built. This would also fix the TODO below. */
  76         ASSERT_EQ(0, gmx_trjconv(cmdline.argc(), cmdline.argv()));
  77     }
  78 };
  79 /* TODO These tests are actually not very effective, because trjconv
  80  * can only return 0 or exit via gmx_fatal() (which currently also
  81  * exits the test binary). So, "no XDR/TNG support in the binary"
  82  * leads to the reading test appearing to pass. Still, no fatal error
  83  * and no segfault is useful information while modifying such code. */
  84
  85 TEST_P(TrjconvWithIndexGroupSubset, WithDifferentInputFormats)
  86 {
  87     runTest(GetParam());
  88 }
  89
  90 /*! \brief Helper array of input files present in the source repo
  91  * database. These all have two identical frames of two SPC water
  92  * molecules, which were generated via trjconv from the .gro
  93  * version. */
  94 const char* const trajectoryFileNames[] = { "spc2-traj.trr",
  95 #if GMX_USE_TNG
  96                                             "spc2-traj.tng",
  97 #endif
  98                                             "spc2-traj.xtc", "spc2-traj.gro",
  99                                             "spc2-traj.pdb", "spc2-traj.g96" };
 100
 101 INSTANTIATE_TEST_CASE_P(NoFatalErrorWhenWritingFrom,
 102                         TrjconvWithIndexGroupSubset,
 103                         ::testing::ValuesIn(trajectoryFileNames));
 104
 105 class TrjconvWithoutTopologyFile :
 106     public gmx::test::CommandLineTestBase,
 107     public ::testing::WithParamInterface<const char*>
 108 {
 109 public:
 110     void runTest(const char* fileName)
 111     {
 112         auto& cmdline = commandLine();
 113
 114         setInputFile("-f", fileName);
 115         setInputFile("-n", "spc2.ndx");
 116         setOutputFile("-o", "spc-traj.trr", gmx::test::NoTextMatch());
 117
 118         gmx::test::StdioTestHelper stdioHelper(&fileManager());
 119         stdioHelper.redirectStringToStdin("SecondWaterMolecule\n");
 120
 121         /* As mentioned above, the tests don't check much besides
 122          * that trjconv does not crash.
 123          */
 124         ASSERT_EQ(0, gmx_trjconv(cmdline.argc(), cmdline.argv()));
 125     }
 126 };
 127
 128 TEST_P(TrjconvWithoutTopologyFile, WithDifferentInputFormats)
 129 {
 130     runTest(GetParam());
 131 }
 132
 133 INSTANTIATE_TEST_CASE_P(NoFatalErrorWhenWritingFrom,
 134                         TrjconvWithoutTopologyFile,
 135                         ::testing::ValuesIn(trajectoryFileNames));
 136 } // namespace