src/gromacs/utility/tests/path.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2018,2019,2020,2021, 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 (some) functions in path.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/utility/path.h"
  45
  46 #include <utility>
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "testutils/refdata.h"
  51 #include "testutils/testasserts.h"
  52
  53 namespace gmx
  54 {
  55 namespace test
  56 {
  57 namespace
  58 {
  59
  60 TEST(PathTest, StripSourcePrefixWorks)
  61 {
  62     EXPECT_STREQ("", Path::stripSourcePrefix(""));
  63     EXPECT_STREQ("foo.cpp", Path::stripSourcePrefix("foo.cpp"));
  64     EXPECT_STREQ("foo.cpp", Path::stripSourcePrefix("some/dir/foo.cpp"));
  65     EXPECT_STREQ("foo.cpp", Path::stripSourcePrefix("src/some/dir/foo.cpp"));
  66     EXPECT_STREQ("foo.cpp", Path::stripSourcePrefix("srcx/gromacs/foo.cpp"));
  67     EXPECT_STREQ("src/gromacs/foo.cpp", Path::stripSourcePrefix("src/gromacs/foo.cpp"));
  68     EXPECT_STREQ("src/gromacs/foo.cpp", Path::stripSourcePrefix("some/dir/src/gromacs/foo.cpp"));
  69     // TODO: For in-source builds, this might not work.
  70     EXPECT_EQ(Path::normalize("src/gromacs/utility/tests/path.cpp"), Path::stripSourcePrefix(__FILE__))
  71             << "stripSourcePrefix() does not work with compiler-produced file names. "
  72             << "This only affects source paths reported in fatal error messages.";
  73 }
  74
  75 class PathSearchTest : public testing::TestWithParam<std::string>
  76 {
  77 };
  78
  79 TEST_P(PathSearchTest, SearchOperationsWork)
  80 {
  81     gmx::test::TestReferenceData    data;
  82     gmx::test::TestReferenceChecker rootChecker(data.rootChecker());
  83     std::string                     input = GetParam();
  84
  85     auto checker = rootChecker.checkCompound("PathToTest", input);
  86     {
  87         std::string result;
  88         ASSERT_NO_THROW_GMX(result = Path::getParentPath(input));
  89         checker.checkString(result, "getParentPath");
  90     }
  91     {
  92         std::string result;
  93         ASSERT_NO_THROW_GMX(result = Path::getFilename(input));
  94         checker.checkString(result, "getFilename");
  95     }
  96     {
  97         bool result = false;
  98         ASSERT_NO_THROW_GMX(result = Path::hasExtension(input));
  99         checker.checkBoolean(result, "hasExtension");
 100     }
 101     {
 102         bool result = false;
 103         ASSERT_NO_THROW_GMX(result = Path::extensionMatches(input, "pdb"));
 104         checker.checkBoolean(result, "extensionMatchesPdb");
 105         // The match is exclusive of the dot separator, so no
 106         // input string can match.
 107         ASSERT_FALSE(Path::extensionMatches(input, ".pdb"));
 108     }
 109     {
 110         std::string result;
 111         ASSERT_NO_THROW_GMX(result = Path::stripExtension(input));
 112         checker.checkString(result, "stripExtension");
 113     }
 114     {
 115         std::string result;
 116         ASSERT_NO_THROW_GMX(result = Path::concatenateBeforeExtension(input, "_34"));
 117         checker.checkString(result, "concatenateBeforeExtension");
 118     }
 119 }
 120
 121 INSTANTIATE_TEST_SUITE_P(WithInputPaths,
 122                          PathSearchTest,
 123                          testing::Values("",
 124                                          "md.log",
 125                                          "md",
 126                                          "/tmp/absolute.txt",
 127                                          "simpledir/traj.tng",
 128                                          "simpledir/traj",
 129                                          "windowsdir\\traj.tng",
 130                                          "complex.dir/traj.tng",
 131                                          "complex.dir/traj",
 132                                          "nested/dir/conf.pdb",
 133                                          "/tmp/absolutedir/conf.pdb"));
 134
 135 } // namespace
 136 } // namespace test
 137 } // namespace gmx