src/gromacs/commandline/tests/cmdlineprogramcontext.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \internal \file
  37  * \brief
  38  * Tests for gmx::CommandLineProgramContext.
  39  *
  40  * \author Teemu Murtola <teemu.murtola@gmail.com>
  41  * \ingroup module_commandline
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "gromacs/commandline/cmdlineprogramcontext.h"
  46
  47 #include "config.h"
  48
  49 #include <memory>
  50 #include <string>
  51 #include <vector>
  52
  53 #include <gtest/gtest.h>
  54
  55 #include "buildinfo.h"
  56 #include "gromacs/utility/classhelpers.h"
  57 #include "gromacs/utility/path.h"
  58
  59 #include "testutils/cmdlinetest.h"
  60
  61 using gmx::Path;
  62
  63 #if GMX_NATIVE_WINDOWS || GMX_CYGWIN
  64 //! Extension for executable files on the platform.
  65 #    define EXECUTABLE_EXTENSION ".exe"
  66 #else
  67 //! Extension for executable files on the platform.
  68 #    define EXECUTABLE_EXTENSION ""
  69 //! Defined if the platform supports symlinks and those can be tested.
  70 #    define TEST_SYMLINKS
  71 #endif
  72
  73 namespace
  74 {
  75
  76 class TestExecutableEnvironment : public gmx::IExecutableEnvironment
  77 {
  78 public:
  79     TestExecutableEnvironment() :
  80         workingDirectory_(CMAKE_BINARY_DIR "/src/gromacs/commandline/tests/test-bin")
  81     {
  82     }
  83
  84     std::string              getWorkingDirectory() const override { return workingDirectory_; }
  85     std::vector<std::string> getExecutablePaths() const override { return path_; }
  86
  87     std::string              workingDirectory_;
  88     std::vector<std::string> path_;
  89
  90     GMX_DISALLOW_COPY_AND_ASSIGN(TestExecutableEnvironment);
  91 };
  92
  93 //! Shorthand for a smart pointer to TestExecutableEnvironment.
  94 typedef std::unique_ptr<TestExecutableEnvironment> TestExecutableEnvironmentPointer;
  95
  96 class CommandLineProgramContextTest : public ::testing::Test
  97 {
  98 public:
  99     CommandLineProgramContextTest() : env_(new TestExecutableEnvironment())
 100     {
 101         expectedExecutable_ = Path::normalize(
 102                 Path::join(env_->getWorkingDirectory(), "bin/test-exe" EXECUTABLE_EXTENSION));
 103     }
 104
 105     void testBinaryPathSearch(const char* argv0)
 106     {
 107         ASSERT_TRUE(env_.get() != nullptr);
 108         gmx::CommandLineProgramContext info(1, &argv0, move(env_));
 109         EXPECT_EQ(expectedExecutable_, info.fullBinaryPath());
 110     }
 111     void testBinaryPathSearch(const std::string& argv0) { testBinaryPathSearch(argv0.c_str()); }
 112
 113     std::string                      expectedExecutable_;
 114     TestExecutableEnvironmentPointer env_;
 115 };
 116
 117 TEST_F(CommandLineProgramContextTest, FindsBinaryWithAbsolutePath)
 118 {
 119     testBinaryPathSearch(Path::join(env_->getWorkingDirectory(), "bin/test-exe"));
 120 }
 121
 122 TEST_F(CommandLineProgramContextTest, FindsBinaryWithRelativePath)
 123 {
 124     testBinaryPathSearch("bin/test-exe");
 125 }
 126
 127 TEST_F(CommandLineProgramContextTest, FindsBinaryFromPath)
 128 {
 129     env_->path_.push_back(Path::join(env_->getWorkingDirectory(), "bin"));
 130     testBinaryPathSearch("test-exe");
 131 }
 132
 133 TEST_F(CommandLineProgramContextTest, FindsBinaryFromCurrentDirectory)
 134 {
 135     env_->workingDirectory_ = Path::join(env_->getWorkingDirectory(), "bin");
 136     env_->path_.emplace_back("");
 137     testBinaryPathSearch("test-exe");
 138 }
 139
 140 #ifdef TEST_SYMLINKS
 141 TEST_F(CommandLineProgramContextTest, FindsBinaryFromAbsoluteSymLink)
 142 {
 143     testBinaryPathSearch("bin/test-abs-link");
 144 }
 145
 146 TEST_F(CommandLineProgramContextTest, FindsBinaryFromRelativeSymLink)
 147 {
 148     testBinaryPathSearch("bin/test-rel-link");
 149 }
 150 #endif
 151
 152 } // namespace