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