src/gromacs/gmxana/legacytests/gmx_traj_tests.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 traj
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  */
  41
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/gmxana/gmx_ana.h"
  45 #include "testutils/integrationtests.h"
  46 #include "testutils/cmdlinetest.h"
  47 #include "gromacs/utility/arrayref.h"
  48
  49 #include "config.h"
  50
  51 namespace
  52 {
  53
  54 class GmxTraj : public gmx::test::IntegrationTestFixture,
  55                 public ::testing::WithParamInterface<const char *>
  56 {
  57     public:
  58         GmxTraj() : groFileName(fileManager_.getInputFilePath("spc2.gro")),
  59                     xvgFileName(fileManager_.getTemporaryFilePath("spc2.xvg"))
  60         {
  61         }
  62
  63         int runTest(const char *fileName)
  64         {
  65             gmx::test::CommandLine caller;
  66             caller.append("traj");
  67
  68             caller.addOption("-s",  groFileName);
  69             caller.addOption("-ox", xvgFileName);
  70
  71             std::string inputTrajectoryFileName = fileManager_.getInputFilePath(fileName);
  72             caller.addOption("-f", inputTrajectoryFileName);
  73
  74             redirectStringToStdin("0\n");
  75
  76             return gmx_traj(caller.argc(), caller.argv());
  77         }
  78
  79         std::string groFileName;
  80         std::string xvgFileName;
  81 };
  82
  83 /* TODO These tests are actually not very effective, because gmx-traj
  84  * can only return 0 or exit via gmx_fatal() (which currently also
  85  * exits the test binary). So, "no XDR/TNG support in the binary"
  86  * leads to the reading test appearing to pass. Still, no fatal error
  87  * and no segfault is useful information while modifying such code. */
  88
  89 TEST_P(GmxTraj, WithDifferentInputFormats)
  90 {
  91     runTest(GetParam());
  92 }
  93
  94 // ==
  95
  96 class TrjconvWithIndexGroupSubset : public gmx::test::IntegrationTestFixture,
  97                                     public ::testing::WithParamInterface<const char *>
  98 {
  99     public:
 100         int runTest(const char *fileName)
 101         {
 102             gmx::test::CommandLine caller;
 103             caller.append("trjconv");
 104
 105             caller.addOption("-s", fileManager_.getInputFilePath("spc2.gro"));
 106
 107             std::string inputTrajectoryFileName = fileManager_.getInputFilePath(fileName);
 108             caller.addOption("-f", inputTrajectoryFileName);
 109
 110             std::string ndxFileName = fileManager_.getInputFilePath("spc2.ndx");
 111             caller.addOption("-n", ndxFileName);
 112
 113             caller.addOption("-o", fileManager_.getTemporaryFilePath("spc-traj.tng"));
 114
 115             redirectStringToStdin("SecondWaterMolecule\n");
 116
 117             /* TODO Ideally, we would then check that the output file
 118                has only 3 of the 6 atoms (which it does), but the
 119                infrastructure for doing that automatically is still
 120                being built. This would also fix the TODO below. */
 121             return gmx_trjconv(caller.argc(), caller.argv());
 122         }
 123 };
 124 /* TODO These tests are actually not very effective, because trjconv
 125  * can only return 0 or exit via gmx_fatal() (which currently also
 126  * exits the test binary). So, "no XDR/TNG support in the binary"
 127  * leads to the reading test appearing to pass. Still, no fatal error
 128  * and no segfault is useful information while modifying such code. */
 129
 130 TEST_P(TrjconvWithIndexGroupSubset, WithDifferentInputFormats)
 131 {
 132     runTest(GetParam());
 133 }
 134
 135 // ==
 136
 137 /*! \brief Helper array of input files present in the source repo
 138  * database. These all have two identical frames of two SPC water
 139  * molecules, which were generated via trjconv from the .gro
 140  * version. */
 141 const char *trajectoryFileNames[] = {
 142     "spc2-traj.trr",
 143 #ifdef GMX_USE_TNG
 144     "spc2-traj.tng",
 145 #endif
 146     "spc2-traj.xtc",
 147     "spc2-traj.gro",
 148     "spc2-traj.pdb",
 149     "spc2-traj.g96"
 150 };
 151
 152 #ifdef __INTEL_COMPILER
 153 #pragma warning( disable : 177 )
 154 #endif
 155
 156 INSTANTIATE_TEST_CASE_P(NoFatalErrorWhenWritingFrom,
 157                         GmxTraj,
 158                             ::testing::ValuesIn(gmx::ArrayRef<const char*>(trajectoryFileNames)));
 159
 160 INSTANTIATE_TEST_CASE_P(NoFatalErrorWhenWritingFrom,
 161                         TrjconvWithIndexGroupSubset,
 162                             ::testing::ValuesIn(gmx::ArrayRef<const char*>(trajectoryFileNames)));
 163
 164 } // namespace