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, 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 <string>
  49 #include <vector>
  50
  51 #include <boost/shared_ptr.hpp>
  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::test::CommandLine;
  61 using gmx::Path;
  62
  63 #if (defined GMX_NATIVE_WINDOWS || defined 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::ExecutableEnvironmentInterface
  77 {
  78     public:
  79         TestExecutableEnvironment()
  80             : workingDirectory_(CMAKE_BINARY_DIR "/src/gromacs/commandline/tests/test-bin")
  81         {
  82         }
  83
  84         virtual std::string getWorkingDirectory() const
  85         {
  86             return workingDirectory_;
  87         }
  88         virtual std::vector<std::string> getExecutablePaths() const
  89         {
  90             return path_;
  91         }
  92
  93         std::string               workingDirectory_;
  94         std::vector<std::string>  path_;
  95
  96         GMX_DISALLOW_COPY_AND_ASSIGN(TestExecutableEnvironment);
  97 };
  98
  99 //! Shorthand for a smart pointer to TestExecutableEnvironment.
 100 typedef boost::shared_ptr<TestExecutableEnvironment>
 101     TestExecutableEnvironmentPointer;
 102
 103 class CommandLineProgramContextTest : public ::testing::Test
 104 {
 105     public:
 106         CommandLineProgramContextTest()
 107             : env_(new TestExecutableEnvironment())
 108         {
 109             expectedExecutable_ =
 110                 Path::normalize(
 111                         Path::join(env_->getWorkingDirectory(),
 112                                    "bin/test-exe" EXECUTABLE_EXTENSION));
 113         }
 114
 115         void testBinaryPathSearch(const char *argv0)
 116         {
 117             ASSERT_TRUE(env_.get() != NULL);
 118             gmx::CommandLineProgramContext  info(1, &argv0, env_);
 119             EXPECT_EQ(expectedExecutable_, info.fullBinaryPath());
 120         }
 121         void testBinaryPathSearch(const std::string &argv0)
 122         {
 123             testBinaryPathSearch(argv0.c_str());
 124         }
 125
 126         std::string                      expectedExecutable_;
 127         TestExecutableEnvironmentPointer env_;
 128 };
 129
 130 TEST_F(CommandLineProgramContextTest, FindsBinaryWithAbsolutePath)
 131 {
 132     testBinaryPathSearch(Path::join(env_->getWorkingDirectory(), "bin/test-exe"));
 133 }
 134
 135 TEST_F(CommandLineProgramContextTest, FindsBinaryWithRelativePath)
 136 {
 137     testBinaryPathSearch("bin/test-exe");
 138 }
 139
 140 TEST_F(CommandLineProgramContextTest, FindsBinaryFromPath)
 141 {
 142     env_->path_.push_back(Path::join(env_->getWorkingDirectory(), "bin"));
 143     testBinaryPathSearch("test-exe");
 144 }
 145
 146 TEST_F(CommandLineProgramContextTest, FindsBinaryFromCurrentDirectory)
 147 {
 148     env_->workingDirectory_ = Path::join(env_->getWorkingDirectory(), "bin");
 149     env_->path_.push_back("");
 150     testBinaryPathSearch("test-exe");
 151 }
 152
 153 #ifdef TEST_SYMLINKS
 154 TEST_F(CommandLineProgramContextTest, FindsBinaryFromAbsoluteSymLink)
 155 {
 156     testBinaryPathSearch("bin/test-abs-link");
 157 }
 158
 159 TEST_F(CommandLineProgramContextTest, FindsBinaryFromRelativeSymLink)
 160 {
 161     testBinaryPathSearch("bin/test-rel-link");
 162 }
 163 #endif
 164
 165 } // namespace