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,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  * Tests for gmx::CommandLineProgramContext.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_commandline
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "gromacs/commandline/cmdlineprogramcontext.h"
  45
  46 #include "config.h"
  47
  48 #include <memory>
  49 #include <string>
  50 #include <vector>
  51
  52 #include <gtest/gtest.h>
  53
  54 #include "buildinfo.h"
  55 #include "gromacs/utility/classhelpers.h"
  56 #include "gromacs/utility/path.h"
  57
  58 #include "testutils/cmdlinetest.h"
  59
  60 using gmx::Path;
  61
  62 #if GMX_NATIVE_WINDOWS || GMX_CYGWIN
  63 //! Extension for executable files on the platform.
  64 #    define EXECUTABLE_EXTENSION ".exe"
  65 #else
  66 //! Extension for executable files on the platform.
  67 #    define EXECUTABLE_EXTENSION ""
  68 //! Defined if the platform supports symlinks and those can be tested.
  69 #    define TEST_SYMLINKS
  70 #endif
  71
  72 namespace
  73 {
  74
  75 class TestExecutableEnvironment : public gmx::IExecutableEnvironment
  76 {
  77 public:
  78     TestExecutableEnvironment() :
  79         workingDirectory_(CMAKE_BINARY_DIR "/src/gromacs/commandline/tests/test-bin")
  80     {
  81     }
  82
  83     std::string              getWorkingDirectory() const override { return workingDirectory_; }
  84     std::vector<std::string> getExecutablePaths() const override { return path_; }
  85
  86     std::string              workingDirectory_;
  87     std::vector<std::string> path_;
  88
  89     GMX_DISALLOW_COPY_AND_ASSIGN(TestExecutableEnvironment);
  90 };
  91
  92 //! Shorthand for a smart pointer to TestExecutableEnvironment.
  93 typedef std::unique_ptr<TestExecutableEnvironment> TestExecutableEnvironmentPointer;
  94
  95 class CommandLineProgramContextTest : public ::testing::Test
  96 {
  97 public:
  98     CommandLineProgramContextTest() : env_(new TestExecutableEnvironment())
  99     {
 100         expectedExecutable_ = Path::normalize(
 101                 Path::join(env_->getWorkingDirectory(), "bin/test-exe" EXECUTABLE_EXTENSION));
 102     }
 103
 104     void testBinaryPathSearch(const char* argv0)
 105     {
 106         ASSERT_TRUE(env_.get() != nullptr);
 107         gmx::CommandLineProgramContext info(1, &argv0, move(env_));
 108         EXPECT_EQ(expectedExecutable_, info.fullBinaryPath());
 109     }
 110     void testBinaryPathSearch(const std::string& argv0) { testBinaryPathSearch(argv0.c_str()); }
 111
 112     std::string                      expectedExecutable_;
 113     TestExecutableEnvironmentPointer env_;
 114 };
 115
 116 TEST_F(CommandLineProgramContextTest, FindsBinaryWithAbsolutePath)
 117 {
 118     testBinaryPathSearch(Path::join(env_->getWorkingDirectory(), "bin/test-exe"));
 119 }
 120
 121 TEST_F(CommandLineProgramContextTest, FindsBinaryWithRelativePath)
 122 {
 123     testBinaryPathSearch("bin/test-exe");
 124 }
 125
 126 TEST_F(CommandLineProgramContextTest, FindsBinaryFromPath)
 127 {
 128     env_->path_.push_back(Path::join(env_->getWorkingDirectory(), "bin"));
 129     testBinaryPathSearch("test-exe");
 130 }
 131
 132 TEST_F(CommandLineProgramContextTest, FindsBinaryFromCurrentDirectory)
 133 {
 134     env_->workingDirectory_ = Path::join(env_->getWorkingDirectory(), "bin");
 135     env_->path_.emplace_back("");
 136     testBinaryPathSearch("test-exe");
 137 }
 138
 139 #ifdef TEST_SYMLINKS
 140 TEST_F(CommandLineProgramContextTest, FindsBinaryFromAbsoluteSymLink)
 141 {
 142     testBinaryPathSearch("bin/test-abs-link");
 143 }
 144
 145 TEST_F(CommandLineProgramContextTest, FindsBinaryFromRelativeSymLink)
 146 {
 147     testBinaryPathSearch("bin/test-rel-link");
 148 }
 149 #endif
 150
 151 } // namespace