src/gromacs/gmxpreprocess/tests/readir.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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  * Test routines that parse mdp fields from grompp input and writes
  38  * mdp back out.
  39  *
  40  * In particular these will provide test coverage as we refactor to
  41  * use a new Options-based key-value-style mdp implementation to
  42  * support a more modular mdrun.
  43  *
  44  * \author Mark Abraham <mark.j.abraham@gmail.com>
  45  */
  46 #include "gmxpre.h"
  47
  48 #include "gromacs/gmxpreprocess/readir.h"
  49
  50 #include <string>
  51
  52 #include <gtest/gtest.h>
  53
  54 #include "gromacs/fileio/warninp.h"
  55 #include "gromacs/mdrun/mdmodules.h"
  56 #include "gromacs/mdtypes/inputrec.h"
  57 #include "gromacs/utility/cstringutil.h"
  58 #include "gromacs/utility/stringutil.h"
  59 #include "gromacs/utility/textreader.h"
  60 #include "gromacs/utility/textwriter.h"
  61 #include "gromacs/utility/unique_cptr.h"
  62
  63 #include "testutils/refdata.h"
  64 #include "testutils/testfilemanager.h"
  65
  66 namespace gmx
  67 {
  68 namespace test
  69 {
  70
  71 class GetIrTest : public ::testing::Test
  72 {
  73     public:
  74         GetIrTest() :  opts_(),
  75                        wi_(init_warning(FALSE, 0)), wiGuard_(wi_)
  76
  77         {
  78             snew(opts_.include, STRLEN);
  79             snew(opts_.define, STRLEN);
  80         }
  81         ~GetIrTest() override
  82         {
  83             done_inputrec_strings();
  84             sfree(opts_.include);
  85             sfree(opts_.define);
  86         }
  87         /*! \brief Test mdp reading and writing
  88          *
  89          * \todo Modernize read_inp and write_inp to use streams,
  90          * which will make these tests run faster, because they don't
  91          * use disk files. */
  92         void runTest(const std::string &inputMdpFileContents)
  93         {
  94             auto inputMdpFilename  = fileManager_.getTemporaryFilePath("input.mdp");
  95             auto outputMdpFilename = fileManager_.getTemporaryFilePath("output.mdp");
  96
  97             TextWriter::writeFileFromString(inputMdpFilename, inputMdpFileContents);
  98
  99             get_ir(inputMdpFilename.c_str(), outputMdpFilename.c_str(),
 100                    &mdModules_, &ir_, &opts_, WriteMdpHeader::no, wi_);
 101
 102             check_ir(inputMdpFilename.c_str(), &ir_, &opts_, wi_);
 103             // Now check
 104             bool                 failure = warning_errors_exist(wi_);
 105             TestReferenceData    data;
 106             TestReferenceChecker checker(data.rootChecker());
 107             checker.checkBoolean(failure, "Error parsing mdp file");
 108             warning_reset(wi_);
 109
 110             auto outputMdpContents = TextReader::readFileToString(outputMdpFilename);
 111             checker.checkString(outputMdpContents, "OutputMdpFile");
 112         }
 113
 114         TestFileManager                    fileManager_;
 115         t_inputrec                         ir_;
 116         MDModules                          mdModules_;
 117         t_gromppopts                       opts_;
 118         warninp_t                          wi_;
 119         unique_cptr<warninp, free_warning> wiGuard_;
 120 };
 121
 122 TEST_F(GetIrTest, HandlesDifferentKindsOfMdpLines)
 123 {
 124     const char *inputMdpFile[] = {
 125         "; File to run my simulation",
 126         "title = simulation",
 127         "define = -DBOOLVAR -DVAR=VALUE",
 128         ";",
 129         "xtc_grps = System ; was Protein",
 130         "include = -I/home/me/stuff",
 131         "",
 132         "tau-t = 0.1 0.3",
 133         "ref-t = ;290 290",
 134         "tinit = 0.3",
 135         "init_step = 0",
 136         "nstcomm = 100",
 137         "integrator = steep"
 138     };
 139     runTest(joinStrings(inputMdpFile, "\n"));
 140 }
 141
 142 TEST_F(GetIrTest, RejectsNonCommentLineWithNoEquals)
 143 {
 144     const char *inputMdpFile = "title simulation";
 145     EXPECT_DEATH_IF_SUPPORTED(runTest(inputMdpFile), "No '=' to separate");
 146 }
 147
 148 TEST_F(GetIrTest, AcceptsKeyWithoutValue)
 149 {
 150     // Users are probably using lines like this
 151     const char *inputMdpFile = "xtc_grps = ";
 152     runTest(inputMdpFile);
 153 }
 154
 155 TEST_F(GetIrTest, RejectsValueWithoutKey)
 156 {
 157     const char *inputMdpFile = "= -I/home/me/stuff";
 158     EXPECT_DEATH_IF_SUPPORTED(runTest(inputMdpFile), "No .mdp parameter name was found");
 159 }
 160
 161 TEST_F(GetIrTest, RejectsEmptyKeyAndEmptyValue)
 162 {
 163     const char *inputMdpFile = " = ";
 164     EXPECT_DEATH_IF_SUPPORTED(runTest(inputMdpFile), "No .mdp parameter name or value was found");
 165 }
 166
 167 TEST_F(GetIrTest, AcceptsDefineParametersWithValuesIncludingAssignment)
 168 {
 169     const char *inputMdpFile[] = {
 170         "define = -DBOOL -DVAR=VALUE",
 171     };
 172     runTest(joinStrings(inputMdpFile, "\n"));
 173 }
 174
 175 TEST_F(GetIrTest, AcceptsEmptyLines)
 176 {
 177     const char *inputMdpFile = "";
 178     runTest(inputMdpFile);
 179 }
 180
 181 // These tests observe how the electric-field keys behave, since they
 182 // are currently the only ones using the new Options-style handling.
 183 TEST_F(GetIrTest, AcceptsElectricField)
 184 {
 185     const char *inputMdpFile = "electric-field-x = 1.2 0 0 0";
 186     runTest(inputMdpFile);
 187 }
 188
 189 TEST_F(GetIrTest, AcceptsElectricFieldPulsed)
 190 {
 191     const char *inputMdpFile = "electric-field-y = 3.7 2.0 6.5 1.0";
 192     runTest(inputMdpFile);
 193 }
 194
 195 TEST_F(GetIrTest, AcceptsElectricFieldOscillating)
 196 {
 197     const char *inputMdpFile = "electric-field-z = 3.7 7.5 0 0";
 198     runTest(inputMdpFile);
 199 }
 200
 201 TEST_F(GetIrTest, RejectsDuplicateOldAndNewKeys)
 202 {
 203     const char *inputMdpFile[] = {"verlet-buffer-drift = 1.3", "verlet-buffer-tolerance = 2.7"};
 204     EXPECT_DEATH_IF_SUPPORTED(runTest(joinStrings(inputMdpFile, "\n")), "A parameter is present with both");
 205 }
 206
 207 TEST_F(GetIrTest, AcceptsImplicitSolventNo)
 208 {
 209     const char *inputMdpFile = "implicit-solvent = no";
 210     runTest(inputMdpFile);
 211 }
 212
 213 TEST_F(GetIrTest, RejectsImplicitSolventYes)
 214 {
 215     const char *inputMdpFile = "implicit-solvent = yes";
 216     EXPECT_DEATH_IF_SUPPORTED(runTest(inputMdpFile), "Invalid enum");
 217 }
 218
 219 TEST_F(GetIrTest, AcceptsMimic)
 220 {
 221     const char *inputMdpFile[] = {"integrator = mimic", "QMMM-grps = QMatoms"};
 222     runTest(joinStrings(inputMdpFile, "\n"));
 223 }
 224
 225 }  // namespace test
 226 }  // namespace gmx