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