src/gromacs/coordinateio/tests/builder.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
  36  * \file
  37  * \brief
  38  * Tests for outputmanager
  39  *
  40  * \author Paul Bauer <paul.bauer.q@gmail.com>
  41  * \ingroup module_coordinateio
  42  */
  43
  44
  45 #include "gmxpre.h"
  46
  47 #include "config.h"
  48
  49 #include <utility>
  50
  51 #include "gromacs/coordinateio/coordinatefile.h"
  52
  53 #include "gromacs/coordinateio/tests/coordinate_test.h"
  54
  55 namespace gmx
  56 {
  57
  58 namespace test
  59 {
  60
  61 /*!\brief
  62  * Test fixture to test different file types are supported by the CoordinateFile.
  63  */
  64 class TrajectoryFrameWriterTest : public ModuleTest
  65 {
  66     public:
  67         /*! \brief
  68          * Test basic behaviour without special requirements.
  69          *
  70          * \param[in] filename Name for output file.
  71          */
  72         void basicTest(const char *filename)
  73         {
  74             addTopology();
  75
  76             OutputRequirements       requirements;
  77
  78             runTest(filename, requirements);
  79         }
  80         /*! \brief
  81          * Test with extra requirements.
  82          *
  83          * \param[in] filename Name for output file.
  84          * \param[in] requirements Specify extra reqs for output.
  85          */
  86         void testWithRequirements(const char               *filename,
  87                                   const OutputRequirements &requirements)
  88         {
  89             addTopology();
  90             runTest(filename, requirements);
  91         }
  92
  93 };
  94
  95 TEST_P(TrajectoryFrameWriterTest, WorksWithFormats)
  96 {
  97     EXPECT_NO_THROW(basicTest(GetParam()));
  98 }
  99
 100 TEST_F(TrajectoryFrameWriterTest, RejectsWrongFiletype)
 101 {
 102     EXPECT_THROW(basicTest("test.xvg"), InvalidInputError);
 103 }
 104
 105 TEST_F(TrajectoryFrameWriterTest, BuilderFailsWithPdbAndNoAtoms)
 106 {
 107     OutputRequirements       requirements;
 108     requirements.atoms = ChangeAtomsType::Never;
 109     EXPECT_THROW(testWithRequirements("test.pdb",
 110                                       requirements),
 111                  InconsistentInputError);
 112 }
 113
 114 TEST_F(TrajectoryFrameWriterTest, BuilderFailsWithGroAndNoAtoms)
 115 {
 116     OutputRequirements       requirements;
 117     requirements.atoms = ChangeAtomsType::Never;
 118     EXPECT_THROW(testWithRequirements("test.gro",
 119                                       requirements),
 120                  InconsistentInputError);
 121 }
 122
 123 TEST_F(TrajectoryFrameWriterTest, BuilderImplictlyAddsAtoms)
 124 {
 125     OutputRequirements       requirements;
 126     requirements.atoms = ChangeAtomsType::PreservedIfPresent;
 127     {
 128         EXPECT_NO_THROW(testWithRequirements("test.pdb",
 129                                              requirements));
 130     }
 131     {
 132         EXPECT_NO_THROW(testWithRequirements("test.gro",
 133                                              requirements));
 134     }
 135 }
 136
 137 #if GMX_USE_TNG
 138 TEST_F(TrajectoryFrameWriterTest, TNGOutputWorks)
 139 {
 140     OutputRequirements requirements;
 141     runTest("test.tng", requirements);
 142 }
 143 #endif
 144
 145 /*!\brief
 146  * Character array of different file names to test.
 147  */
 148 const char *const trajectoryFileNames[] = {
 149     "spc2-traj.trr",
 150 #if GMX_USE_TNG
 151     "spc2-traj.tng",
 152 #endif
 153     "spc2-traj.xtc",
 154     "spc2-traj.pdb",
 155     "spc2-traj.gro",
 156     "spc2-traj.g96"
 157 };
 158
 159 INSTANTIATE_TEST_CASE_P(CoordinateFileFileFormats,
 160                         TrajectoryFrameWriterTest, ::testing::ValuesIn(trajectoryFileNames));
 161
 162 } // namespace test
 163
 164 } // namespace gmx