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