src/gromacs/commandline/tests/cmdlineprogramcontext.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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 <string>
  45 #include <vector>
  46
  47 #include <boost/shared_ptr.hpp>
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/commandline/cmdlineprogramcontext.h"
  51 #include "gromacs/utility/common.h"
  52 #include "gromacs/utility/path.h"
  53
  54 #include "testutils/cmdlinetest.h"
  55
  56 #include "config.h"
  57
  58 using gmx::test::CommandLine;
  59 using gmx::Path;
  60
  61 #if (defined GMX_NATIVE_WINDOWS || defined GMX_CYGWIN)
  62 //! Extension for executable files on the platform.
  63 #define EXECUTABLE_EXTENSION ".exe"
  64 #else
  65 //! Extension for executable files on the platform.
  66 #define EXECUTABLE_EXTENSION ""
  67 //! Defined if the platform supports symlinks and those can be tested.
  68 #define TEST_SYMLINKS
  69 #endif
  70
  71 namespace
  72 {
  73
  74 class TestExecutableEnvironment : public gmx::ExecutableEnvironmentInterface
  75 {
  76     public:
  77         TestExecutableEnvironment()
  78             : workingDirectory_(CMAKE_BINARY_DIR "/src/gromacs/commandline/tests/test-bin")
  79         {
  80         }
  81
  82         virtual std::string getWorkingDirectory() const
  83         {
  84             return workingDirectory_;
  85         }
  86         virtual std::vector<std::string> getExecutablePaths() const
  87         {
  88             return path_;
  89         }
  90
  91         std::string               workingDirectory_;
  92         std::vector<std::string>  path_;
  93
  94         GMX_DISALLOW_COPY_AND_ASSIGN(TestExecutableEnvironment);
  95 };
  96
  97 //! Shorthand for a smart pointer to TestExecutableEnvironment.
  98 typedef boost::shared_ptr<TestExecutableEnvironment>
  99     TestExecutableEnvironmentPointer;
 100
 101 class CommandLineProgramContextTest : public ::testing::Test
 102 {
 103     public:
 104         CommandLineProgramContextTest()
 105             : env_(new TestExecutableEnvironment())
 106         {
 107             expectedExecutable_ =
 108                 Path::normalize(
 109                         Path::join(env_->getWorkingDirectory(),
 110                                    "bin/test-exe" EXECUTABLE_EXTENSION));
 111         }
 112
 113         void testBinaryPathSearch(const char *argv0)
 114         {
 115             ASSERT_TRUE(env_.get() != NULL);
 116             gmx::CommandLineProgramContext  info(1, &argv0, env_);
 117             EXPECT_EQ(expectedExecutable_, info.fullBinaryPath());
 118         }
 119         void testBinaryPathSearch(const std::string &argv0)
 120         {
 121             testBinaryPathSearch(argv0.c_str());
 122         }
 123
 124         std::string                      expectedExecutable_;
 125         TestExecutableEnvironmentPointer env_;
 126 };
 127
 128 TEST_F(CommandLineProgramContextTest, FindsBinaryWithAbsolutePath)
 129 {
 130     testBinaryPathSearch(Path::join(env_->getWorkingDirectory(), "bin/test-exe"));
 131 }
 132
 133 TEST_F(CommandLineProgramContextTest, FindsBinaryWithRelativePath)
 134 {
 135     testBinaryPathSearch("bin/test-exe");
 136 }
 137
 138 TEST_F(CommandLineProgramContextTest, FindsBinaryFromPath)
 139 {
 140     env_->path_.push_back(Path::join(env_->getWorkingDirectory(), "bin"));
 141     testBinaryPathSearch("test-exe");
 142 }
 143
 144 TEST_F(CommandLineProgramContextTest, FindsBinaryFromCurrentDirectory)
 145 {
 146     env_->workingDirectory_ = Path::join(env_->getWorkingDirectory(), "bin");
 147     env_->path_.push_back("");
 148     testBinaryPathSearch("test-exe");
 149 }
 150
 151 #ifdef TEST_SYMLINKS
 152 TEST_F(CommandLineProgramContextTest, FindsBinaryFromAbsoluteSymLink)
 153 {
 154     testBinaryPathSearch("bin/test-abs-link");
 155 }
 156
 157 TEST_F(CommandLineProgramContextTest, FindsBinaryFromRelativeSymLink)
 158 {
 159     testBinaryPathSearch("bin/test-rel-link");
 160 }
 161 #endif
 162
 163 } // namespace